diff --git a/plugin/add_cas_login_button/README.md b/plugin/add_cas_login_button/README.md new file mode 100644 index 000000000..52071b311 --- /dev/null +++ b/plugin/add_cas_login_button/README.md @@ -0,0 +1,11 @@ +Add CAS login button plugin +====== +This plugin adds a button to allow users to login to Chamilo through CAS authentication. + +In order for the plugin to work, you'll have to: + +* enable your CAS connection to display this button +* configure your CAS connection to have the button work +* go to Administration > Configuration settings > CAS and follow the instructions + +This plugin has been made to be added in the login_top region, but you can put it wherever you want. \ No newline at end of file diff --git a/plugin/add_cas_login_button/css.css b/plugin/add_cas_login_button/css.css new file mode 100644 index 000000000..60689dd4b --- /dev/null +++ b/plugin/add_cas_login_button/css.css @@ -0,0 +1,12 @@ +.cas_plugin_image { + float:left; + height:50px; + margin: 0px 5px 5px 0px; +} +.cas_plugin_comm { + font-style:italic; +} +.cas_plugin_clear { + clear:both; + height:1px; +} diff --git a/plugin/add_cas_login_button/index.php b/plugin/add_cas_login_button/index.php new file mode 100644 index 000000000..dc10a6432 --- /dev/null +++ b/plugin/add_cas_login_button/index.php @@ -0,0 +1,29 @@ +Plugins). + * + * @package chamilo.plugin + * + * @author Julio Montoya + */ +/** + * Plugin details (must be present). + */ + +//the plugin title +$plugin_info['title'] = 'Add a button to login using CAS'; + +//the comments that go with the plugin +$plugin_info['comment'] = "If CAS is activated, this plugin add a text and a button on the login page to login with CAS. Configure plugin to add title, comment and logo."; +//the plugin version +$plugin_info['version'] = '1.0'; +//the plugin author +$plugin_info['author'] = 'Hubert Borderiou'; + +//the plugin configuration +$form = new FormValidator('add_cas_button_form'); +$form->addElement('text', 'cas_button_label', 'CAS connexion title', ''); +$form->addElement('text', 'cas_button_comment', 'CAS connexion description', ''); +$form->addElement('text', 'cas_image_url', 'Logo URL if any (image, 50px height)'); +$form->addButtonSave(get_lang('Save'), 'submit_button'); +//get default value for form +$tab_default_add_cas_login_button_cas_button_label = api_get_setting('add_cas_login_button_cas_button_label'); +$tab_default_add_cas_login_button_cas_button_comment = api_get_setting('add_cas_login_button_cas_button_comment'); +$tab_default_add_cas_login_button_cas_image_url = api_get_setting('add_cas_login_button_cas_image_url'); +$defaults = []; +if ($tab_default_add_cas_login_button_cas_button_label) { + $defaults['cas_button_label'] = $tab_default_add_cas_login_button_cas_button_label['add_cas_login_button']; +} +if ($tab_default_add_cas_login_button_cas_button_comment) { + $defaults['cas_button_comment'] = $tab_default_add_cas_login_button_cas_button_comment['add_cas_login_button']; +} +if ($tab_default_add_cas_login_button_cas_image_url) { + $defaults['cas_image_url'] = $tab_default_add_cas_login_button_cas_image_url['add_cas_login_button']; +} +$form->setDefaults($defaults); +//display form +$plugin_info['settings_form'] = $form; + +//set the templates that are going to be used +$plugin_info['templates'] = ['template.tpl']; diff --git a/plugin/add_cas_login_button/template.tpl b/plugin/add_cas_login_button/template.tpl new file mode 100644 index 000000000..45c784b8f --- /dev/null +++ b/plugin/add_cas_login_button/template.tpl @@ -0,0 +1,22 @@ +{% if add_cas_login_button.show_message %} + +
+ {% if add_cas_login_button.url_label %} + + {% endif %} +

{{ add_cas_login_button.button_label }}

+ {% if add_cas_login_button.url_label %} +
 
+ {% endif %} +
{{ add_cas_login_button.comm_label }}
+ {% if add_cas_login_button.cas_activated %} + {% if add_cas_login_button.cas_configured %} + {{ add_cas_login_button.form }} + {% else %} + CAS isn't configured. Go to Admin > Configuration > CAS.
+ {% endif %} + {% else %} + CAS isn't activated. Go to Admin > Configuration > CAS.
+ {% endif %} +
+{% endif %} diff --git a/plugin/add_cas_logout_button/README.md b/plugin/add_cas_logout_button/README.md new file mode 100644 index 000000000..c5ca74393 --- /dev/null +++ b/plugin/add_cas_logout_button/README.md @@ -0,0 +1,12 @@ +Add CAS logout button plugin +=== + +This plugin adds a button to allow users to logout from their CAS session. + +In order for the plugin to work, you'll have to: + +* enable your CAS connection to display this button. +* configure your CAS connection to have the button works. +* go to Administration > Configuration settings > CAS and follow the instructions. + +This plugin has been made to be added in the login_top region, but you can put it wherever you want. \ No newline at end of file diff --git a/plugin/add_cas_logout_button/css.css b/plugin/add_cas_logout_button/css.css new file mode 100644 index 000000000..60689dd4b --- /dev/null +++ b/plugin/add_cas_logout_button/css.css @@ -0,0 +1,12 @@ +.cas_plugin_image { + float:left; + height:50px; + margin: 0px 5px 5px 0px; +} +.cas_plugin_comm { + font-style:italic; +} +.cas_plugin_clear { + clear:both; + height:1px; +} diff --git a/plugin/add_cas_logout_button/index.php b/plugin/add_cas_logout_button/index.php new file mode 100644 index 000000000..668f60907 --- /dev/null +++ b/plugin/add_cas_logout_button/index.php @@ -0,0 +1,26 @@ +Plugins). + * + * @package chamilo.plugin + * + * @author Julio Montoya + */ +/** + * Plugin details (must be present). + */ + +//the plugin title +$plugin_info['title'] = 'Add a button to logout from CAS'; + +//the comments that go with the plugin +$plugin_info['comment'] = "If CAS is activated, this plugin add a text and a button on the user page to logout from a CAS session. Configure plugin to add title, comment and logo."; +//the plugin version +$plugin_info['version'] = '1.0'; +//the plugin author +$plugin_info['author'] = 'Hubert Borderiou'; +//the plugin configuration +$form = new FormValidator('add_cas_button_form'); +$form->addElement('text', 'cas_logout_label', 'CAS logout title', ''); +$form->addElement('text', 'cas_logout_comment', 'CAS logout description', ''); +$form->addElement('text', 'cas_logout_image_url', 'Logo URL if any (image, 50px height)'); +$form->addButtonSave(get_lang('Save'), 'submit_button'); +//get default value for form +$defaults = []; +$tab_default_add_cas_logout_button_cas_logout_label = api_get_setting('add_cas_logout_button_cas_logout_label'); +$tab_default_add_cas_logout_button_cas_logout_comment = api_get_setting('add_cas_logout_button_cas_logout_comment'); +$tab_default_add_cas_logout_button_cas_logout_image_url = api_get_setting('add_cas_logout_button_cas_logout_image_url'); +if ($tab_default_add_cas_logout_button_cas_logout_label) { + $defaults['cas_logout_label'] = $tab_default_add_cas_logout_button_cas_logout_label['add_cas_logout_button']; +} +if ($tab_default_add_cas_logout_button_cas_logout_comment) { + $defaults['cas_logout_comment'] = $tab_default_add_cas_logout_button_cas_logout_comment['add_cas_logout_button']; +} + +if ($tab_default_add_cas_logout_button_cas_logout_image_url) { + $defaults['cas_logout_image_url'] = $tab_default_add_cas_logout_button_cas_logout_image_url['add_cas_logout_button']; +} + +$form->setDefaults($defaults); +//display form +$plugin_info['settings_form'] = $form; + +// Set the templates that are going to be used +$plugin_info['templates'] = ['template.tpl']; diff --git a/plugin/add_cas_logout_button/template.tpl b/plugin/add_cas_logout_button/template.tpl new file mode 100644 index 000000000..44ad94991 --- /dev/null +++ b/plugin/add_cas_logout_button/template.tpl @@ -0,0 +1,15 @@ +{% if add_cas_logout_button.show_message %} + +
+ {% if add_cas_logout_button.logout_image_url %} + + {% endif %} +

{{add_cas_logout_button.logout_label}}

+ {% if add_cas_logout_button.logout_image_url %} +
 
+ {% endif %} +
{{add_cas_logout_button.logout_comment}}
+ {{ add_cas_logout_button.form }} + +
+{% endif %} diff --git a/plugin/add_facebook_login_button/README.md b/plugin/add_facebook_login_button/README.md new file mode 100644 index 000000000..dfd998095 --- /dev/null +++ b/plugin/add_facebook_login_button/README.md @@ -0,0 +1,16 @@ +Add Facebook login button plugin +=== + +This plugin adds a button to allow users to log into Chamilo through their Facebook account. + +To display this button on your portal, you have to: + +* enable the Facebook authentication setting and configure it +* enable and configure Facebook authentication on your Chamilo platform: go to Administration > Configuration settings > Facebook +* add the App ID and the Secret Key provided by Facebook inside the app/config/auth.conf.php file +* set the following line in your app/config/configuration.php +``` +$_configuration['facebook_auth'] = 1; +``` + +This plugin has been developed to be added to the login_top or login_bottom region in Chamilo, but you can put it in whichever region you want. diff --git a/plugin/add_facebook_login_button/css.css b/plugin/add_facebook_login_button/css.css new file mode 100644 index 000000000..945a00d0c --- /dev/null +++ b/plugin/add_facebook_login_button/css.css @@ -0,0 +1,12 @@ + .cas_plugin_image { + float:left; + height:50px; + margin: 0px 5px 5px 0px; + } + .cas_plugin_comm { + font-style:italic; + } + .cas_plugin_clear { + clear:both; + height:1px; + } diff --git a/plugin/add_facebook_login_button/index.php b/plugin/add_facebook_login_button/index.php new file mode 100644 index 000000000..ca8d52fce --- /dev/null +++ b/plugin/add_facebook_login_button/index.php @@ -0,0 +1,17 @@ + + */ +/** + * Plugin details. + */ + +//the plugin title +$plugin_info['title'] = 'Add a button to login using a FACEBOOK account'; + +//the comments that go with the plugin +$plugin_info['comment'] = "If Facebook authentication is enabled, this plugin adds a button Facebook Connexion on the login page. Configure the plugin to add a title, a comment and a logo. Should be placed in login_top region"; +//the plugin version +$plugin_info['version'] = '1.0'; +//the plugin author +$plugin_info['author'] = 'Konrad Banasiak, Hubert Borderiou'; +//the plugin configuration +$form = new FormValidator('add_facebook_button_form'); +$form->addElement( + 'text', + 'facebook_button_url', + 'Facebook connexion image URL', + '' +); +$form->addButtonSave(get_lang('Save'), 'submit_button'); +//get default value for form +$tab_default_add_facebook_login_button_facebook_button_url = api_get_setting( + 'add_facebook_login_button_facebook_button_url' +); + +$defaults = []; + +if ($tab_default_add_facebook_login_button_facebook_button_url) { + $defaults['facebook_button_url'] = $tab_default_add_facebook_login_button_facebook_button_url['add_facebook_login_button']; +} + +$form->setDefaults($defaults); +//display form +$plugin_info['settings_form'] = $form; + +// Set the templates that are going to be used +$plugin_info['templates'] = ['template.tpl']; diff --git a/plugin/add_facebook_login_button/template.tpl b/plugin/add_facebook_login_button/template.tpl new file mode 100644 index 000000000..f9165173d --- /dev/null +++ b/plugin/add_facebook_login_button/template.tpl @@ -0,0 +1,14 @@ +{% if add_facebook_login_button.show_message %} +
+ {% if add_facebook_login_button.facebook_button_url %} + + {{ 'FacebookMainActivateTitle'|get_lang }} + + {% else %} + + {{ 'FacebookMainActivateTitle'|get_lang }} + + {% endif %} +
+{% endif %} diff --git a/plugin/add_shibboleth_login_button/README.md b/plugin/add_shibboleth_login_button/README.md new file mode 100644 index 000000000..ef8899b24 --- /dev/null +++ b/plugin/add_shibboleth_login_button/README.md @@ -0,0 +1,10 @@ +Add Shibboleth login button plugin +=== + +This plugin adds a button to allow users to login to Chamilo through Shibboleth authentication. + +You have to configure your Shibboleth connexion before using this plugin. + +To activate and configure Shibboleth for your Chamilo platform, go to Administration > Configuration settings > Shibboleth + +This plugin has been created to be added in the login_top region, but you can put it wherever you want. \ No newline at end of file diff --git a/plugin/add_shibboleth_login_button/css.css b/plugin/add_shibboleth_login_button/css.css new file mode 100644 index 000000000..a79de810c --- /dev/null +++ b/plugin/add_shibboleth_login_button/css.css @@ -0,0 +1,12 @@ +.shibboleth_plugin_image { + float:left; + height:50px; + margin: 0px 5px 5px 0px; +} +.shibboleth_plugin_comm { + font-style:italic; +} +.shibboleth_plugin_clear { + clear:both; + height:1px; +} diff --git a/plugin/add_shibboleth_login_button/index.php b/plugin/add_shibboleth_login_button/index.php new file mode 100644 index 000000000..8b2d719dd --- /dev/null +++ b/plugin/add_shibboleth_login_button/index.php @@ -0,0 +1,22 @@ +Plugins). + * + * @package chamilo.plugin + * + * @author Julio Montoya + */ +/** + * Plugin details (must be present). + */ + +//the plugin title +$plugin_info['title'] = 'Add a button to login using Shibboleth'; + +//the comments that go with the plugin +$plugin_info['comment'] = "If Shibboleth is configured, this plugin add a text and a button on the login page to login with Shibboleth. Configure plugin to add title, comment and logo."; +//the plugin version +$plugin_info['version'] = '1.0'; +//the plugin author +$plugin_info['author'] = 'Hubert Borderiou'; + +//the plugin configuration +$form = new FormValidator('add_shibboleth_button_form'); +$form->addElement( + 'text', + 'shibboleth_button_label', + 'shibboleth connexion title', + '' +); +$form->addElement( + 'text', + 'shibboleth_button_comment', + 'shibboleth connexion description', + '' +); +$form->addElement( + 'text', + 'shibboleth_image_url', + 'Logo URL if any (image, 50px height)' +); +$form->addButtonSave(get_lang('Save'), 'submit_button'); +//get default value for form +$tab_default_add_shibboleth_login_button_shibboleth_button_label = api_get_setting( + 'add_shibboleth_login_button_shibboleth_button_label' +); +$tab_default_add_shibboleth_login_button_shibboleth_button_comment = api_get_setting( + 'add_shibboleth_login_button_shibboleth_button_comment' +); +$tab_default_add_shibboleth_login_button_shibboleth_image_url = api_get_setting( + 'add_shibboleth_login_button_shibboleth_image_url' +); +$defaults = []; +if ($tab_default_add_shibboleth_login_button_shibboleth_button_label) { + $defaults['shibboleth_button_label'] = $tab_default_add_shibboleth_login_button_shibboleth_button_label['add_shibboleth_login_button']; +} + +if ($tab_default_add_shibboleth_login_button_shibboleth_button_comment) { + $defaults['shibboleth_button_comment'] = $tab_default_add_shibboleth_login_button_shibboleth_button_comment['add_shibboleth_login_button']; +} + +if ($tab_default_add_shibboleth_login_button_shibboleth_image_url) { + $defaults['shibboleth_image_url'] = $tab_default_add_shibboleth_login_button_shibboleth_image_url['add_shibboleth_login_button']; +} + +$form->setDefaults($defaults); +//display form +$plugin_info['settings_form'] = $form; + +//set the templates that are going to be used +$plugin_info['templates'] = ['template.tpl']; diff --git a/plugin/add_shibboleth_login_button/template.tpl b/plugin/add_shibboleth_login_button/template.tpl new file mode 100644 index 000000000..e42d26d6a --- /dev/null +++ b/plugin/add_shibboleth_login_button/template.tpl @@ -0,0 +1,15 @@ + +{% if add_shibboleth_login_button.show_message %} + +
+ {% if add_shibboleth_login_button.url_label %} + + {% endif %} +

{{ add_shibboleth_login_button.button_label }}

+ {% if add_shibboleth_login_button.url_label %} +
 
+ {% endif %} +
{{ add_shibboleth_login_button.comm_label }}
+ +
+{% endif %} diff --git a/plugin/advanced_subscription/README.md b/plugin/advanced_subscription/README.md new file mode 100644 index 000000000..0036e183d --- /dev/null +++ b/plugin/advanced_subscription/README.md @@ -0,0 +1,59 @@ +Advanced subscription plugin for Chamilo LMS +======================================= +Plugin to manage the registration queue and communication to sessions +from an external website creating a queue to control session subscription +and sending emails to approve student subscription requests + +# Requirements +Chamilo LMS 1.10.0 or greater + +# Settings + +These settings have to be configured in the Configuration screen for the plugin + +Parameters | Description +------------- |------------- +Webservice url | Url to external website to get user profile (SOAP) +Induction requirement | Checkbox to enable induction as requirement +Courses count limit | Number of times a student is allowed at most to course by year +Yearly hours limit | Teaching hours a student is allowed at most to course by year +Yearly cost unit converter | The cost of a taxation unit value (TUV) +Yearly cost limit | Number of TUV student courses is allowed at most to cost by year +Year start date | Date (dd/mm) when the year limit is renewed +Minimum percentage profile | Minimum percentage required from external website profile + +# Hooks + +This plugin uses the following hooks (defined since Chamilo LMS 1.10.0): + +* HookAdminBlock +* HookWSRegistration +* HookNotificationContent +* HookNotificationTitle + + +# Web services + +This plugin also enables new webservices that can be used from registration.soap.php + +* HookAdvancedSubscription..WSSessionListInCategory +* HookAdvancedSubscription..WSSessionGetDetailsByUser +* HookAdvancedSubscription..WSListSessionsDetailsByCategory + +See `/plugin/advanced_subscription/src/HookAdvancedSubscription.php` to check Web services inputs and outputs + +# How does this plugin works? + +After install, fill the required parameters (described above) +Use web services to communicate course session inscription from external website +This allows students to search course sessions and subscribe if they match +the requirements. + +The normal process is: +* Student searches course session +* Student reads session info depending student data +* Student requests to be subscribed +* A confirmation email is sent to student +* An authorization email is sent to student's superior (STUDENT BOSS role) or admins (when there is no superior) who will accept or reject the student request +* When the superior accepts or rejects, an email will be sent to the student and superior (or admin), respectively +* To complete the subscription, the request must be validated and accepted by an admin \ No newline at end of file diff --git a/plugin/advanced_subscription/ajax/advanced_subscription.ajax.php b/plugin/advanced_subscription/ajax/advanced_subscription.ajax.php new file mode 100644 index 000000000..3af22fee3 --- /dev/null +++ b/plugin/advanced_subscription/ajax/advanced_subscription.ajax.php @@ -0,0 +1,350 @@ + + * + * @package chamilo.plugin.advanced_subscription + */ +/** + * Init. + */ +require_once __DIR__.'/../config.php'; + +$plugin = AdvancedSubscriptionPlugin::create(); +// Get validation hash +$hash = Security::remove_XSS($_REQUEST['v']); +// Get data from request (GET or POST) +$data['action'] = Security::remove_XSS($_REQUEST['a']); +$data['sessionId'] = intval($_REQUEST['s']); +$data['currentUserId'] = intval($_REQUEST['current_user_id']); +$data['studentUserId'] = intval($_REQUEST['u']); +$data['queueId'] = intval($_REQUEST['q']); +$data['newStatus'] = intval($_REQUEST['e']); +// Student always is connected +// $data['is_connected'] = isset($_REQUEST['is_connected']) ? boolval($_REQUEST['is_connected']) : false; +$data['is_connected'] = true; +$data['profile_completed'] = isset($_REQUEST['profile_completed']) ? floatval($_REQUEST['profile_completed']) : 0; +$data['accept_terms'] = isset($_REQUEST['accept_terms']) ? intval($_REQUEST['accept_terms']) : 0; +$data['courseId'] = isset($_REQUEST['c']) ? intval($_REQUEST['c']) : 0; +// Init result array +$result = ['error' => true, 'errorMessage' => get_lang('ThereWasAnError')]; +$showJSON = true; +// Check if data is valid or is for start subscription +$verified = $plugin->checkHash($data, $hash) || $data['action'] == 'subscribe'; +if ($verified) { + switch ($data['action']) { + case 'check': // Check minimum requirements + try { + $res = AdvancedSubscriptionPlugin::create()->isAllowedToDoRequest($data['studentUserId'], $data); + if ($res) { + $result['error'] = false; + $result['errorMessage'] = 'No error'; + $result['pass'] = true; + } else { + $result['errorMessage'] = 'User can not be subscribed'; + $result['pass'] = false; + } + } catch (\Exception $e) { + $result['errorMessage'] = $e->getMessage(); + } + break; + case 'subscribe': // Subscription + // Start subscription to queue + $res = AdvancedSubscriptionPlugin::create()->startSubscription( + $data['studentUserId'], + $data['sessionId'], + $data + ); + // Check if queue subscription was successful + if ($res === true) { + $legalEnabled = api_get_plugin_setting('courselegal', 'tool_enable'); + if ($legalEnabled) { + // Save terms confirmation + CourseLegalPlugin::create()->saveUserLegal( + $data['studentUserId'], + $data['courseId'], + $data['sessionId'], + false + ); + } + // Prepare data + // Get session data + // Assign variables + $fieldsArray = [ + 'description', + 'target', + 'mode', + 'publication_end_date', + 'recommended_number_of_participants', + ]; + $sessionArray = api_get_session_info($data['sessionId']); + $extraSession = new ExtraFieldValue('session'); + $extraField = new ExtraField('session'); + // Get session fields + $fieldList = $extraField->get_all([ + 'variable IN ( ?, ?, ?, ?, ?)' => $fieldsArray, + ]); + // Index session fields + foreach ($fieldList as $field) { + $fields[$field['id']] = $field['variable']; + } + + $mergedArray = array_merge([$data['sessionId']], array_keys($fields)); + $sessionFieldValueList = $extraSession->get_all( + [ + 'item_id = ? field_id IN ( ?, ?, ?, ?, ?, ?, ? )' => $mergedArray, + ] + ); + foreach ($sessionFieldValueList as $sessionFieldValue) { + // Check if session field value is set in session field list + if (isset($fields[$sessionFieldValue['field_id']])) { + $var = $fields[$sessionFieldValue['field_id']]; + $val = $sessionFieldValue['value']; + // Assign session field value to session + $sessionArray[$var] = $val; + } + } + // Get student data + $studentArray = api_get_user_info($data['studentUserId']); + $studentArray['picture'] = $studentArray['avatar']; + + // Get superior data if exist + $superiorId = UserManager::getFirstStudentBoss($data['studentUserId']); + if (!empty($superiorId)) { + $superiorArray = api_get_user_info($superiorId); + } else { + $superiorArray = null; + } + // Get admin data + $adminsArray = UserManager::get_all_administrators(); + $isWesternNameOrder = api_is_western_name_order(); + foreach ($adminsArray as &$admin) { + $admin['complete_name'] = $isWesternNameOrder ? + $admin['firstname'].', '.$admin['lastname'] : $admin['lastname'].', '.$admin['firstname'] + ; + } + unset($admin); + // Set data + $data['action'] = 'confirm'; + $data['student'] = $studentArray; + $data['superior'] = $superiorArray; + $data['admins'] = $adminsArray; + $data['session'] = $sessionArray; + $data['signature'] = api_get_setting('Institution'); + + // Check if student boss exists + if (empty($superiorId)) { + // Student boss does not exist + // Update status to accepted by boss + $res = $plugin->updateQueueStatus($data, ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED); + if (!empty($res)) { + // Prepare admin url + $data['admin_view_url'] = api_get_path(WEB_PLUGIN_PATH). + 'advanced_subscription/src/admin_view.php?s='.$data['sessionId']; + // Send mails + $result['mailIds'] = $plugin->sendMail( + $data, + ADVANCED_SUBSCRIPTION_ACTION_STUDENT_REQUEST_NO_BOSS + ); + // Check if mails were sent + if (!empty($result['mailIds'])) { + $result['error'] = false; + $result['errorMessage'] = 'No error'; + $result['pass'] = true; + // Check if exist an email to render + if (isset($result['mailIds']['render'])) { + // Render mail + $url = $plugin->getRenderMailUrl(['queueId' => $result['mailIds']['render']]); + header('Location: '.$url); + exit; + } + } + } + } else { + // Student boss does exist + // Get url to be accepted by boss + $data['newStatus'] = ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED; + $data['student']['acceptUrl'] = $plugin->getQueueUrl($data); + // Get url to be rejected by boss + $data['newStatus'] = ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_DISAPPROVED; + $data['student']['rejectUrl'] = $plugin->getQueueUrl($data); + // Send mails + $result['mailIds'] = $plugin->sendMail($data, ADVANCED_SUBSCRIPTION_ACTION_STUDENT_REQUEST); + // Check if mails were sent + if (!empty($result['mailIds'])) { + $result['error'] = false; + $result['errorMessage'] = 'No error'; + $result['pass'] = true; + // Check if exist an email to render + if (isset($result['mailIds']['render'])) { + // Render mail + $url = $plugin->getRenderMailUrl(['queueId' => $result['mailIds']['render']]); + header('Location: '.$url); + exit; + } + } + } + } else { + $lastMessageId = $plugin->getLastMessageId($data['studentUserId'], $data['sessionId']); + if ($lastMessageId !== false) { + // Render mail + $url = $plugin->getRenderMailUrl(['queueId' => $lastMessageId]); + header('Location: '.$url); + exit; + } else { + if (is_string($res)) { + $result['errorMessage'] = $res; + } else { + $result['errorMessage'] = 'User can not be subscribed'; + } + $result['pass'] = false; + $url = $plugin->getTermsUrl($data, ADVANCED_SUBSCRIPTION_TERMS_MODE_FINAL); + header('Location: '.$url); + exit; + } + } + + break; + case 'confirm': + // Check if new status is set + if (isset($data['newStatus'])) { + if ($data['newStatus'] === ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED) { + try { + $isAllowToDoRequest = $plugin->isAllowedToDoRequest($data['studentUserId'], $data); + } catch (Exception $ex) { + $messageTemplate = new Template(null, false, false); + $messageTemplate->assign( + 'content', + Display::return_message($ex->getMessage(), 'error', false) + ); + $messageTemplate->display_no_layout_template(); + $showJSON = false; + break; + } + } + + // Update queue status + $res = $plugin->updateQueueStatus($data, $data['newStatus']); + if ($res === true) { + // Prepare data + // Prepare session data + $fieldsArray = [ + 'description', + 'target', + 'mode', + 'publication_end_date', + 'recommended_number_of_participants', + ]; + $sessionArray = api_get_session_info($data['sessionId']); + $extraSession = new ExtraFieldValue('session'); + $extraField = new ExtraField('session'); + // Get session fields + $fieldList = $extraField->get_all([ + 'variable IN ( ?, ?, ?, ?, ?)' => $fieldsArray, + ]); + // Index session fields + foreach ($fieldList as $field) { + $fields[$field['id']] = $field['variable']; + } + + $mergedArray = array_merge([$data['sessionId']], array_keys($fields)); + $sessionFieldValueList = $extraSession->get_all( + ['session_id = ? field_id IN ( ?, ?, ?, ?, ?, ?, ? )' => $mergedArray] + ); + foreach ($sessionFieldValueList as $sessionFieldValue) { + // Check if session field value is set in session field list + if (isset($fields[$sessionFieldValue['field_id']])) { + $var = $fields[$sessionFieldValue['field_id']]; + $val = $sessionFieldValue['value']; + // Assign session field value to session + $sessionArray[$var] = $val; + } + } + // Prepare student data + $studentArray = api_get_user_info($data['studentUserId']); + $studentArray['picture'] = $studentArray['avatar']; + // Prepare superior data + $superiorId = UserManager::getFirstStudentBoss($data['studentUserId']); + if (!empty($superiorId)) { + $superiorArray = api_get_user_info($superiorId); + } else { + $superiorArray = null; + } + // Prepare admin data + $adminsArray = UserManager::get_all_administrators(); + $isWesternNameOrder = api_is_western_name_order(); + foreach ($adminsArray as &$admin) { + $admin['complete_name'] = $isWesternNameOrder ? + $admin['firstname'].', '.$admin['lastname'] : $admin['lastname'].', '.$admin['firstname'] + ; + } + unset($admin); + // Set data + $data['student'] = $studentArray; + $data['superior'] = $superiorArray; + $data['admins'] = $adminsArray; + $data['session'] = $sessionArray; + $data['signature'] = api_get_setting('Institution'); + $data['admin_view_url'] = api_get_path(WEB_PLUGIN_PATH) + .'advanced_subscription/src/admin_view.php?s='.$data['sessionId']; + // Check if exist and action in data + if (empty($data['mailAction'])) { + // set action in data by new status + switch ($data['newStatus']) { + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED: + $data['mailAction'] = ADVANCED_SUBSCRIPTION_ACTION_SUPERIOR_APPROVE; + break; + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_DISAPPROVED: + $data['mailAction'] = ADVANCED_SUBSCRIPTION_ACTION_SUPERIOR_DISAPPROVE; + break; + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED: + $data['mailAction'] = ADVANCED_SUBSCRIPTION_ACTION_ADMIN_APPROVE; + break; + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_DISAPPROVED: + $data['mailAction'] = ADVANCED_SUBSCRIPTION_ACTION_ADMIN_DISAPPROVE; + break; + default: + break; + } + } + + // Student Session inscription + if ($data['newStatus'] == ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED) { + SessionManager::subscribeUsersToSession( + $data['sessionId'], + [$data['studentUserId']], + null, + false + ); + } + + // Send mails + $result['mailIds'] = $plugin->sendMail($data, $data['mailAction']); + // Check if mails were sent + if (!empty($result['mailIds'])) { + $result['error'] = false; + $result['errorMessage'] = 'User has been processed'; + // Check if exist mail to render + if (isset($result['mailIds']['render'])) { + // Render mail + $url = $plugin->getRenderMailUrl(['queueId' => $result['mailIds']['render']]); + header('Location: '.$url); + exit; + } + } + } else { + $result['errorMessage'] = 'User queue can not be updated'; + } + } + break; + default: + $result['errorMessage'] = 'This action does not exist!'; + } +} + +if ($showJSON) { + // Echo result as json + echo json_encode($result); +} diff --git a/plugin/advanced_subscription/config.php b/plugin/advanced_subscription/config.php new file mode 100644 index 000000000..805d5b4d5 --- /dev/null +++ b/plugin/advanced_subscription/config.php @@ -0,0 +1,35 @@ + + * + * @package chamilo.plugin.advanced_subscription + */ +define('TABLE_ADVANCED_SUBSCRIPTION_QUEUE', 'plugin_advanced_subscription_queue'); + +define('ADVANCED_SUBSCRIPTION_ACTION_STUDENT_REQUEST', 0); +define('ADVANCED_SUBSCRIPTION_ACTION_SUPERIOR_APPROVE', 1); +define('ADVANCED_SUBSCRIPTION_ACTION_SUPERIOR_DISAPPROVE', 2); +define('ADVANCED_SUBSCRIPTION_ACTION_SUPERIOR_SELECT', 3); +define('ADVANCED_SUBSCRIPTION_ACTION_ADMIN_APPROVE', 4); +define('ADVANCED_SUBSCRIPTION_ACTION_ADMIN_DISAPPROVE', 5); +define('ADVANCED_SUBSCRIPTION_ACTION_STUDENT_REQUEST_NO_BOSS', 6); +define('ADVANCED_SUBSCRIPTION_ACTION_REMINDER_STUDENT', 7); +define('ADVANCED_SUBSCRIPTION_ACTION_REMINDER_SUPERIOR', 8); +define('ADVANCED_SUBSCRIPTION_ACTION_REMINDER_SUPERIOR_MAX', 9); +define('ADVANCED_SUBSCRIPTION_ACTION_REMINDER_ADMIN', 10); + +define('ADVANCED_SUBSCRIPTION_QUEUE_STATUS_NO_QUEUE', -1); +define('ADVANCED_SUBSCRIPTION_QUEUE_STATUS_START', 0); +define('ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_DISAPPROVED', 1); +define('ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED', 2); +define('ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_DISAPPROVED', 3); +define('ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED', 10); + +define('ADVANCED_SUBSCRIPTION_TERMS_MODE_POPUP', 0); +define('ADVANCED_SUBSCRIPTION_TERMS_MODE_REJECT', 1); +define('ADVANCED_SUBSCRIPTION_TERMS_MODE_FINAL', 2); + +require_once __DIR__.'/../../main/inc/global.inc.php'; diff --git a/plugin/advanced_subscription/cron/notify_by_mail.php b/plugin/advanced_subscription/cron/notify_by_mail.php new file mode 100644 index 000000000..3446aaa46 --- /dev/null +++ b/plugin/advanced_subscription/cron/notify_by_mail.php @@ -0,0 +1,153 @@ + [ + 's.access_start_date >= ? AND uu.relation_type = ? AND asq.updated_at <= ?' => [ + $now, + USER_RELATION_TYPE_BOSS, + $weekAgo, + ], + ], + 'order' => 's.id', +]; + +$queueList = Database::select($columns, $joinTables, $conditions); + +/** + * Remind students. + */ +$sessionInfoList = []; +foreach ($queueList as $queueItem) { + if (!isset($sessionInfoList[$queueItem['session_id']])) { + $sessionInfoList[$queueItem['session_id']] = api_get_session_info($queueItem['session_id']); + } +} + +foreach ($queueList as $queueItem) { + switch ($queueItem['status']) { + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_START: + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED: + $data = ['sessionId' => $queueItem['session_id']]; + $data['session'] = api_get_session_info($queueItem['session_id']); + $data['student'] = api_get_user_info($queueItem['student_id']); + $plugin->sendMail($data, ADVANCED_SUBSCRIPTION_ACTION_REMINDER_STUDENT); + break; + default: + break; + } +} + +/** + * Remind superiors. + */ +// Get recommended number of participants +$sessionRecommendedNumber = []; +foreach ($queueList as $queueItem) { + $row = + $sessionExtraFieldValue->get_values_by_handler_and_field_variable( + $queueItem['session_id'], + 'recommended_number_of_participants' + ); + $sessionRecommendedNumber[$queueItem['session_id']] = $row['value']; +} +// Group student by superior and session +$queueBySuperior = []; +foreach ($queueList as $queueItem) { + $queueBySuperior[$queueItem['session_id']][$queueItem['superior_id']][$queueItem['student_id']]['status'] = $queueItem['status']; +} + +foreach ($queueBySuperior as $sessionId => $superiorStudents) { + $data = [ + 'sessionId' => $sessionId, + 'session' => $sessionInfoList[$sessionId], + 'students' => [], + ]; + $dataUrl = [ + 'action' => 'confirm', + 'sessionId' => $sessionId, + 'currentUserId' => 0, + 'newStatus' => ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED, + 'studentUserId' => 0, + 'is_connected' => true, + 'profile_completed' => 0, + ]; + foreach ($superiorStudents as $superiorId => $students) { + $data['superior'] = api_get_user_info($superiorId); + // Check if superior has at least one student + if (count($students) > 0) { + foreach ($students as $studentId => $studentInfo) { + if ($studentInfo['status'] == ADVANCED_SUBSCRIPTION_QUEUE_STATUS_START) { + $data['students'][$studentId] = api_get_user_info($studentId); + $dataUrl['studentUserId'] = $studentId; + $dataUrl['newStatus'] = ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED; + $data['students'][$studentId]['acceptUrl'] = $plugin->getQueueUrl($dataUrl); + $dataUrl['newStatus'] = ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_DISAPPROVED; + $data['students'][$studentId]['rejectUrl'] = $plugin->getQueueUrl($dataUrl); + } + } + + if (is_array($data['students']) && count($data['students']) > 0) { + // Check if superior have more than recommended + if ($sessionRecommendedNumber[$sessionId] >= count($students)) { + // Is greater or equal than recommended + $plugin->sendMail($data, ADVANCED_SUBSCRIPTION_ACTION_REMINDER_SUPERIOR); + } else { + // Is less than recommended + $plugin->sendMail($data, ADVANCED_SUBSCRIPTION_ACTION_REMINDER_SUPERIOR_MAX); + } + } + } + } +} + +/** + * Remind admins. + */ +$admins = UserManager::get_all_administrators(); +$isWesternNameOrder = api_is_western_name_order(); +foreach ($admins as &$admin) { + $admin['complete_name'] = $isWesternNameOrder ? + $admin['firstname'].', '.$admin['lastname'] : $admin['lastname'].', '.$admin['firstname'] + ; +} +unset($admin); +$queueByAdmin = []; +foreach ($queueList as $queueItem) { + if ($queueItem['status'] == ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED) { + $queueByAdmin[$queueItem['session_id']]['students'][$queueItem['student_id']]['user_id'] = $queueItem['student_id']; + } +} +$data = [ + 'admins' => $admins, +]; +foreach ($queueByAdmin as $sessionId => $studentInfo) { + $data['sessionId'] = $sessionId; + $data['admin_view_url'] = api_get_path(WEB_PLUGIN_PATH). + 'advanced_subscription/src/admin_view.php?s='.$data['sessionId']; + $data['session'] = $sessionInfoList[$sessionId]; + $data['students'] = $studentInfo['students']; + $plugin->sendMail($data, ADVANCED_SUBSCRIPTION_ACTION_REMINDER_ADMIN); +} diff --git a/plugin/advanced_subscription/index.html b/plugin/advanced_subscription/index.html new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/plugin/advanced_subscription/index.html @@ -0,0 +1 @@ + diff --git a/plugin/advanced_subscription/install.php b/plugin/advanced_subscription/install.php new file mode 100644 index 000000000..846f6de68 --- /dev/null +++ b/plugin/advanced_subscription/install.php @@ -0,0 +1,17 @@ +install(); diff --git a/plugin/advanced_subscription/lang/english.php b/plugin/advanced_subscription/lang/english.php new file mode 100644 index 000000000..4ee55705f --- /dev/null +++ b/plugin/advanced_subscription/lang/english.php @@ -0,0 +1,149 @@ +not include induction courses"; +$strings['course_session_credit_year_start_date'] = 'Year start date'; +$strings['course_session_credit_year_start_date_help'] = "a date (dd/mm)"; +$strings['min_profile_percentage'] = "Minimum required of completed percentage profile"; +$strings['min_profile_percentage_help'] = "Percentage number( > 0.00 y < 100.00)"; +$strings['secret_key'] = 'Secret key'; +$strings['terms_and_conditions'] = 'Terms and conditions'; + +/* String for error message about requirements */ +$strings['AdvancedSubscriptionNotConnected'] = "You are not connected to platform. Please login first"; +$strings['AdvancedSubscriptionProfileIncomplete'] = "You must complete at least %d percent of your profile. You have only completed %d percent at this point"; +$strings['AdvancedSubscriptionIncompleteInduction'] = "You have not yet completed induction course. Please complete it first"; +$strings['AdvancedSubscriptionCostXLimitReached'] = "We are sorry, you have already reached yearly limit %s TUV cost for courses "; +$strings['AdvancedSubscriptionTimeXLimitReached'] = "We are sorry, you have already reached yearly limit %s hours for courses"; +$strings['AdvancedSubscriptionCourseXLimitReached'] = "We are sorry, you have already reached yearly limit %s times for courses"; +$strings['AdvancedSubscriptionNotMoreAble'] = "We are sorry, you no longer fulfills the initial conditions to subscribe this course"; +$strings['AdvancedSubscriptionIncompleteParams'] = "The parameters are wrong or incomplete."; +$strings['AdvancedSubscriptionIsNotEnabled'] = "Advanced subscription is not enabled"; + +$strings['AdvancedSubscriptionNoQueue'] = "You are not subscribed for this course."; +$strings['AdvancedSubscriptionNoQueueIsAble'] = "You are not subscribed, but you are qualified for this course."; +$strings['AdvancedSubscriptionQueueStart'] = "Your subscription request is pending for approval by your boss, please wait attentive."; +$strings['AdvancedSubscriptionQueueBossDisapproved'] = "We are sorry, your subscription was rejected by your boss."; +$strings['AdvancedSubscriptionQueueBossApproved'] = "Your subscription request has been accepted by your boss, now is pending for vacancies."; +$strings['AdvancedSubscriptionQueueAdminDisapproved'] = "We are sorry, your subscription was rejected by the administrator."; +$strings['AdvancedSubscriptionQueueAdminApproved'] = "Congratulations!, your subscription request has been accepted by administrator."; +$strings['AdvancedSubscriptionQueueDefaultX'] = "There was an error, queue status %d is not defined by system."; + +// Mail translations +$strings['MailStudentRequest'] = 'Student registration request'; +$strings['MailBossAccept'] = 'Registration request accepted by boss'; +$strings['MailBossReject'] = 'Registration request rejected by boss'; +$strings['MailStudentRequestSelect'] = 'Student registration requests selection'; +$strings['MailAdminAccept'] = 'Registration request accepted by administrator'; +$strings['MailAdminReject'] = 'Registration request rejected by administrator'; +$strings['MailStudentRequestNoBoss'] = 'Student registration request without boss'; +$strings['MailRemindStudent'] = 'Subscription request reminder'; +$strings['MailRemindSuperior'] = 'Subscription request are pending your approval'; +$strings['MailRemindAdmin'] = 'Course subscription are pending your approval'; + +// TPL langs +$strings['SessionXWithoutVacancies'] = "The course \"%s\" has no vacancies."; +$strings['SuccessSubscriptionToSessionX'] = "

¡Congratulations!

Your subscription to \"%s\" course has been completed successfully."; +$strings['SubscriptionToOpenSession'] = "Subscription to open course"; +$strings['GoToSessionX'] = "Go to \"%s\" course"; +$strings['YouAreAlreadySubscribedToSessionX'] = "You are already subscribed to \"%s\" course."; + +// Admin view +$strings['SelectASession'] = 'Select a training session'; +$strings['SessionName'] = 'Session name'; +$strings['Target'] = 'Target audience'; +$strings['Vacancies'] = 'Vacancies'; +$strings['RecommendedNumberOfParticipants'] = 'Recommended number of participants by area'; +$strings['PublicationEndDate'] = 'Publication end date'; +$strings['Mode'] = 'Mode'; +$strings['Postulant'] = 'Postulant'; +$strings['Area'] = 'Area'; +$strings['Institution'] = 'Institution'; +$strings['InscriptionDate'] = 'Inscription date'; +$strings['BossValidation'] = 'Boss validation'; +$strings['Decision'] = 'Decision'; +$strings['AdvancedSubscriptionAdminViewTitle'] = 'Subscription request confirmation result'; + +$strings['AcceptInfinitive'] = 'Accept'; +$strings['RejectInfinitive'] = 'Reject'; +$strings['AreYouSureYouWantToAcceptSubscriptionOfX'] = 'Are you sure you want to accept the subscription of %s?'; +$strings['AreYouSureYouWantToRejectSubscriptionOfX'] = 'Are you sure you want to reject the subscription of %s?'; + +$strings['MailTitle'] = 'Received request for course %s'; +$strings['MailDear'] = 'Dear:'; +$strings['MailThankYou'] = 'Thank you.'; +$strings['MailThankYouCollaboration'] = 'Thank you for your help.'; + +// Admin Accept +$strings['MailTitleAdminAcceptToAdmin'] = 'Notification: subscription validation received'; +$strings['MailContentAdminAcceptToAdmin'] = 'We have received and registered your subscription validation for student %s to course %s'; +$strings['MailTitleAdminAcceptToStudent'] = 'Accepted: Your subscription to course %s has been accepted!'; +$strings['MailContentAdminAcceptToStudent'] = 'We are pleased to inform you that your registration to course %s starting on %s was validated by an administrator. We wish you good luck and hope you will consider participating to another course soon.'; +$strings['MailTitleAdminAcceptToSuperior'] = 'Notification: Subscription validation of %s to course %s'; +$strings['MailContentAdminAcceptToSuperior'] = 'Subscription of student %s to course %s starting on %s was pending but has been validated a few minutes ago. We kindly hope we can count on you to ensure the necessary availability of your collaborator during the course period.'; + +// Admin Reject +$strings['MailTitleAdminRejectToAdmin'] = 'Notification: Rejection received'; +$strings['MailContentAdminRejectToAdmin'] = 'We have received and registered your rejection for the subscription of student %s to course %s'; +$strings['MailTitleAdminRejectToStudent'] = 'Your subscription to course %s was rejected'; +$strings['MailContentAdminRejectToStudent'] = 'We regret to inform you that your subscription to course %s starting on %s was rejected because of a lack of vacancies. We hope you will consider participating to another course soon.'; +$strings['MailTitleAdminRejectToSuperior'] = 'Notification: Subscription refusal for student %s to course %s'; +$strings['MailContentAdminRejectToSuperior'] = 'The subscription of %s to course %s that you previously validated was rejected because of a lack of vacancies. Our sincere apologies.'; + +// Superior Accept +$strings['MailTitleSuperiorAcceptToAdmin'] = 'Approval for subscription of %s to course %s '; +$strings['MailContentSuperiorAcceptToAdmin'] = 'The subscription of student %s to course %s has been accepted by his superior. You can manage subscriptions here'; +$strings['MailTitleSuperiorAcceptToSuperior'] = 'Confirmation: Approval received for %s'; +$strings['MailContentSuperiorAcceptToSuperior'] = 'We have received and registered you validation of subscription to course %s of your collaborator %s'; +$strings['MailContentSuperiorAcceptToSuperiorSecond'] = 'The subscription is now pending for a vacancies confirmation. We will keep you informed about changes of status for this subscription'; +$strings['MailTitleSuperiorAcceptToStudent'] = 'Accepted: Your subscription to course %s has been approved by your superior'; +$strings['MailContentSuperiorAcceptToStudent'] = 'We are pleased to inform you that your subscription to course %s has been accepted by your superior. Your inscription is now pending for a vacancies confirmation. We will notify you as soon as it is confirmed.'; + +// Superior Reject +$strings['MailTitleSuperiorRejectToStudent'] = 'Notification: Your subscription to course %s has been refused'; +$strings['MailContentSuperiorRejectToStudent'] = 'We regret to inform your subscription to course %s was NOT accepted. We hope this will not reduce your motivation and encourage you to register to another course or, on another occasion, this same course soon.'; +$strings['MailTitleSuperiorRejectToSuperior'] = 'Confirmation: Rejection of subscription received for %s'; +$strings['MailContentSuperiorRejectToSuperior'] = 'We have received and registered your rejection of subscription to course %s for your collaborator %s'; + +// Student Request +$strings['MailTitleStudentRequestToStudent'] = 'Notification: Subscription approval received'; +$strings['MailContentStudentRequestToStudent'] = 'We have received and registered your subscription request to course %s starting on %s'; +$strings['MailContentStudentRequestToStudentSecond'] = 'Your subscription is pending approval, first from your superior, then for the availability of vacancies. An email has been sent to your superior for review and approval. We will inform you when this situation changes.'; +$strings['MailTitleStudentRequestToSuperior'] = 'Course subscription request from your collaborator'; +$strings['MailContentStudentRequestToSuperior'] = 'We have received an subscription request of %s to course %s, starting on %s. Course details: %s.'; +$strings['MailContentStudentRequestToSuperiorSecond'] = 'Your are welcome to accept or reject this subscription, clicking the corresponding button.'; + +// Student Request No Boss +$strings['MailTitleStudentRequestNoSuperiorToStudent'] = 'Your subscription request for %s has been received'; +$strings['MailContentStudentRequestNoSuperiorToStudent'] = 'We have received and registered your subscription to course %s starting on %s.'; +$strings['MailContentStudentRequestNoSuperiorToStudentSecond'] = 'Your subscription is pending availability of vacancies. You will get the results of your request approval (or rejection) soon.'; +$strings['MailTitleStudentRequestNoSuperiorToAdmin'] = 'Subscription request of %s to course %s'; +$strings['MailContentStudentRequestNoSuperiorToAdmin'] = 'The subscription of %s to course %s has been approved by default (no direct superior defined). You can manage subscriptions here'; + +// Reminders +$strings['MailTitleReminderAdmin'] = 'Subscriptions to %s are pending confirmation'; +$strings['MailContentReminderAdmin'] = 'The subscription requests for course %s are pending validation to be accepted. Please, go to Administration page to validate them.'; +$strings['MailTitleReminderStudent'] = 'Information: Your subscription request is pending approval for course %s'; +$strings['MailContentReminderStudent'] = 'This email is just to confirm we have received and registered your subscription request to course %s, starting on %s.'; +$strings['MailContentReminderStudentSecond'] = 'Your subscription has not been approved by your superior yet, so we sent him a e-mail reminder.'; +$strings['MailTitleReminderSuperior'] = 'Course subscription request for your collaborators'; +$strings['MailContentReminderSuperior'] = 'We kindly remind you that we have received the subscription requests below to course %s from your collaborators. This course is starting on %s. Course details: %s.'; +$strings['MailContentReminderSuperiorSecond'] = 'We invite you to accept or reject this subscription request by clicking the corresponding button for each collaborator.'; +$strings['MailTitleReminderMaxSuperior'] = 'Reminder: Course subscription request for your collaborators'; +$strings['MailContentReminderMaxSuperior'] = 'We kindly remind you that we have received the subscription requests below to course %s from your collaborators. This course is starting on %s. Course details: %s.'; +$strings['MailContentReminderMaxSuperiorSecond'] = 'This course have limited vacancies and has received a high subscription request rate, So we recommend all areas to accept at most %s candidates. We invite you to accept or reject the inscription request by clicking the corresponding button for each collaborator.'; + +$strings['YouMustAcceptTermsAndConditions'] = 'To subscribe to course %s, you must accept these terms and conditions.'; diff --git a/plugin/advanced_subscription/lang/french.php b/plugin/advanced_subscription/lang/french.php new file mode 100644 index 000000000..a6d1af5c0 --- /dev/null +++ b/plugin/advanced_subscription/lang/french.php @@ -0,0 +1,148 @@ +ne sont pas le cours d'induction"; +$strings['course_session_credit_year_start_date'] = 'Date de début'; +$strings['course_session_credit_year_start_date_help'] = "Date de début de l'année (jour/mois)"; +$strings['min_profile_percentage'] = 'Pourcentage du profil complété mínimum requis'; +$strings['min_profile_percentage_help'] = 'Numéro pourcentage ( > 0.00 et < 100.00)'; +$strings['secret_key'] = 'Clef secrète'; +$strings['terms_and_conditions'] = 'Conditions d\'utilisation'; + +/* String for error message about requirements */ +$strings['AdvancedSubscriptionNotConnected'] = "Vous n'êtes pas connecté à la plateforme. Merci d'introduire votre nom d'utilisateur / mot de passe afin de vous inscrire"; +$strings['AdvancedSubscriptionProfileIncomplete'] = "Vous devez d'abord compléter votre profil à %d pourcents ou plus. Pour l'instant vous n'avez complété que %d pourcents"; +$strings['AdvancedSubscriptionIncompleteInduction'] = "Vous n'avez pas encore passé le cours d'induction. Merci de commencer par cette étape."; +$strings['AdvancedSubscriptionCostXLimitReached'] = "Désolé, vous avez déjà atteint la limite de %s unités de taxe pour les cours que vous avez suivi cette année"; +$strings['AdvancedSubscriptionTimeXLimitReached'] = "Désolé, vous avez déjà atteint la limite annuelle du nombre de %s heures pour les cours que vous avez suivi cette année"; +$strings['AdvancedSubscriptionCourseXLimitReached'] = "Désolé, vous avez déjà atteint la limite annuelle du nombre de cours (%s) à suivre cette année"; +$strings['AdvancedSubscriptionNotMoreAble'] = "Désolé, vous ne répondez plus aux conditions d'utilisation minimum pour l'inscription à un cours"; +$strings['AdvancedSubscriptionIncompleteParams'] = "Les paramètres envoyés ne sont pas complets ou sont incorrects."; +$strings['AdvancedSubscriptionIsNotEnabled'] = "L'inscription avancée n'est pas activée"; +$strings['AdvancedSubscriptionNoQueue'] = "Vous n'êtes pas inscrit dans ce cours"; +$strings['AdvancedSubscriptionNoQueueIsAble'] = "Vous n'êtes pas inscrit mais vous qualifiez pour ce cours"; +$strings['AdvancedSubscriptionQueueStart'] = "Votre demande d'inscription est en attente de l'approbation de votre supérieur(e). Merci de patienter."; +$strings['AdvancedSubscriptionQueueBossDisapproved'] = "Désolé, votre inscription a été déclinée par votre supérieur(e)."; +$strings['AdvancedSubscriptionQueueBossApproved'] = "Votre demande d'inscription a été acceptée par votre supérieur(e), mais est en attente de places libres."; +$strings['AdvancedSubscriptionQueueAdminDisapproved'] = "Désolé, votre inscription a été déclinée par l'administrateur."; +$strings['AdvancedSubscriptionQueueAdminApproved'] = "Félicitations! Votre inscription a été acceptée par l'administrateur."; +$strings['AdvancedSubscriptionQueueDefaultX'] = "Une erreur est survenue: l'état de la file d'attente %s n'est pas défini dans le système."; + +// Mail translations +$strings['MailStudentRequest'] = 'Demange d\'inscription d\'un(e) apprenant(e)'; +$strings['MailBossAccept'] = 'Demande d\'inscription acceptée par votre supérieur(e)'; +$strings['MailBossReject'] = 'Demande d\'inscription déclinée par votre supérieur(e)'; +$strings['MailStudentRequestSelect'] = 'Sélection des demandes d\'inscriptions d\'apprenants'; +$strings['MailAdminAccept'] = 'Demande d\'inscription acceptée par l\'administrateur'; +$strings['MailAdminReject'] = 'Demande d\'inscription déclinée par l\'administrateur'; +$strings['MailStudentRequestNoBoss'] = 'Demande d\'inscription d\'apprenant sans supérieur(e)'; +$strings['MailRemindStudent'] = 'Rappel de demande d\'inscription'; +$strings['MailRemindSuperior'] = 'Demandes d\'inscription en attente de votre approbation'; +$strings['MailRemindAdmin'] = 'Inscriptions en attente de votre approbation'; + +// TPL translations +$strings['SessionXWithoutVacancies'] = "Le cours \"%s\" ne dispose plus de places libres."; +$strings['SuccessSubscriptionToSessionX'] = "

Félicitations!

Votre inscription au cours \"%s\" est en ordre."; +$strings['SubscriptionToOpenSession'] = "Inscription à cours ouvert"; +$strings['GoToSessionX'] = "Aller dans le cours \"%s\""; +$strings['YouAreAlreadySubscribedToSessionX'] = "Vous êtes déjà inscrit(e) au cours \"%s\"."; + +// Admin view +$strings['SelectASession'] = 'Sélectionnez une session de formation'; +$strings['SessionName'] = 'Nom de la session'; +$strings['Target'] = 'Public cible'; +$strings['Vacancies'] = 'Places libres'; +$strings['RecommendedNumberOfParticipants'] = 'Nombre recommandé de participants par département'; +$strings['PublicationEndDate'] = 'Date de fin de publication'; +$strings['Mode'] = 'Modalité'; +$strings['Postulant'] = 'Candidats'; +$strings['Area'] = 'Département'; +$strings['Institution'] = 'Institution'; +$strings['InscriptionDate'] = 'Date d\'inscription'; +$strings['BossValidation'] = 'Validation du supérieur'; +$strings['Decision'] = 'Décision'; +$strings['AdvancedSubscriptionAdminViewTitle'] = 'Résultat de confirmation de demande d\'inscription'; + +$strings['AcceptInfinitive'] = 'Accepter'; +$strings['RejectInfinitive'] = 'Refuser'; +$strings['AreYouSureYouWantToAcceptSubscriptionOfX'] = 'Êtes-vous certain de vouloir accepter l\'inscription de %s?'; +$strings['AreYouSureYouWantToRejectSubscriptionOfX'] = 'Êtes-vous certain de vouloir refuser l\'inscription de %s?'; + +$strings['MailTitle'] = 'Demande reçue pour le cours %s'; +$strings['MailDear'] = 'Cher/Chère'; +$strings['MailThankYou'] = 'Merci.'; +$strings['MailThankYouCollaboration'] = 'Merci de votre collaboration.'; + +// Admin Accept +$strings['MailTitleAdminAcceptToAdmin'] = 'Information: Validation d\'inscription reçue'; +$strings['MailContentAdminAcceptToAdmin'] = 'Nous avons bien reçu et enregistré votre validation de l\'inscription de %s au cours %s'; +$strings['MailTitleAdminAcceptToStudent'] = 'Approuvé(e): Votre inscription au cours %s a été confirmée!'; +$strings['MailContentAdminAcceptToStudent'] = 'C\'est avec plaisir que nous vous informons que votre inscription au cours %s démarrant le %s a été validée par les administrateurs. Nous espérons que votre motivation s\'est maintenue à 100% et que vous participerez à d\'autres cours ou répétiez ce cours à l\'avenir.'; +$strings['MailTitleAdminAcceptToSuperior'] = 'Information: Validation de l\'inscription de %s au cours %s'; +$strings['MailContentAdminAcceptToSuperior'] = 'L\'inscription de %s au cours %s qui démarre le %s, qui était en attente de validation par les organisateurs du cours, vient d\'être validée. Nous espérons que vous nous donnerez un coup de main pour assurer la disponibilité complète de votre collaborateur pour toute la durée du cours'; + +// Admin Reject +$strings['MailTitleAdminRejectToAdmin'] = 'Information: refus d\'inscription reçu'; +$strings['MailContentAdminRejectToAdmin'] = 'Nous avons bien reçu et enregistré votre refus pour l\'inscription de %s au cours %s'; +$strings['MailTitleAdminRejectToStudent'] = 'Votre demande d\'inscription au cours %s a été refusée'; +$strings['MailContentAdminRejectToStudent'] = 'Nous déplorons le besoin de vous informer que vote demande d\'inscription au cours %s démarrant le %s a été refusée pour manque de place. Nous espérons que vous maintiendrez votre motivation et que vous pourrez participer au même ou à un autre cours lors d\'une prochaine occasion.'; +$strings['MailTitleAdminRejectToSuperior'] = 'Information: Refus d\'inscription de %s au cours %s'; +$strings['MailContentAdminRejectToSuperior'] = 'L\'inscription de %s au cours %s, qui avait été approuvée antérieurement, a été refusée par manque de place. Nous vous présentons nos excuses sincères.'; + +// Superior Accept +$strings['MailTitleSuperiorAcceptToAdmin'] = 'Aprobación de %s al curso %s '; +$strings['MailContentSuperiorAcceptToAdmin'] = 'La inscripción del alumno %s al curso %s ha sido aprobada por su superior. Puede gestionar las inscripciones al curso aquí'; +$strings['MailTitleSuperiorAcceptToSuperior'] = 'Confirmación: Aprobación recibida para %s'; +$strings['MailContentSuperiorAcceptToSuperior'] = 'Hemos recibido y registrado su decisión de aprobar el curso %s para su colaborador %s'; +$strings['MailContentSuperiorAcceptToSuperiorSecond'] = 'Ahora la inscripción al curso está pendiente de la disponibilidad de cupos. Le mantendremos informado sobre el resultado de esta etapa'; +$strings['MailTitleSuperiorAcceptToStudent'] = 'Aprobado: Su inscripción al curso %s ha sido aprobada por su superior '; +$strings['MailContentSuperiorAcceptToStudent'] = 'Nos complace informarle que su inscripción al curso %s ha sido aprobada por su superior. Su inscripción ahora solo se encuentra pendiente de disponibilidad de cupos. Le avisaremos tan pronto como se confirme este último paso.'; + +// Superior Reject +$strings['MailTitleSuperiorRejectToStudent'] = 'Información: Su inscripción al curso %s ha sido rechazada '; +$strings['MailContentSuperiorRejectToStudent'] = 'Lamentamos informarle que, en esta oportunidad, su inscripción al curso %s NO ha sido aprobada. Esperamos mantenga todo su ánimo y participe en otro curso o, en otra oportunidad, a este mismo curso.'; +$strings['MailTitleSuperiorRejectToSuperior'] = 'Confirmación: Desaprobación recibida para %s'; +$strings['MailContentSuperiorRejectToSuperior'] = 'Hemos recibido y registrado su decisión de desaprobar el curso %s para su colaborador %s'; + +// Student Request +$strings['MailTitleStudentRequestToStudent'] = 'Información: Validación de inscripción recibida'; +$strings['MailContentStudentRequestToStudent'] = 'Hemos recibido y registrado su solicitud de inscripción al curso %s para iniciarse el %s.'; +$strings['MailContentStudentRequestToStudentSecond'] = 'Su inscripción es pendiente primero de la aprobación de su superior, y luego de la disponibilidad de cupos. Un correo ha sido enviado a su superior para revisión y aprobación de su solicitud.'; +$strings['MailTitleStudentRequestToSuperior'] = 'Solicitud de consideración de curso para un colaborador'; +$strings['MailContentStudentRequestToSuperior'] = 'Hemos recibido una solicitud de inscripción de %s al curso %s, por iniciarse el %s. Detalles del curso: %s.'; +$strings['MailContentStudentRequestToSuperiorSecond'] = 'Le invitamos a aprobar o desaprobar esta inscripción, dando clic en el botón correspondiente a continuación.'; + +// Student Request No Boss +$strings['MailTitleStudentRequestNoSuperiorToStudent'] = 'Solicitud recibida para el curso %s'; +$strings['MailContentStudentRequestNoSuperiorToStudent'] = 'Hemos recibido y registrado su solicitud de inscripción al curso %s para iniciarse el %s.'; +$strings['MailContentStudentRequestNoSuperiorToStudentSecond'] = 'Su inscripción es pendiente de la disponibilidad de cupos. Pronto recibirá los resultados de su aprobación de su solicitud.'; +$strings['MailTitleStudentRequestNoSuperiorToAdmin'] = 'Solicitud de inscripción de %s para el curso %s'; +$strings['MailContentStudentRequestNoSuperiorToAdmin'] = 'La inscripción del alumno %s al curso %s ha sido aprobada por defecto, a falta de superior. Puede gestionar las inscripciones al curso aquí'; + +// Reminders +$strings['MailTitleReminderAdmin'] = 'Inscripciones a %s pendiente de confirmación'; +$strings['MailContentReminderAdmin'] = 'Las inscripciones siguientes al curso %s están pendientes de validación para ser efectivas. Por favor, dirigese a la página de administración para validarlos.'; +$strings['MailTitleReminderStudent'] = 'Información: Solicitud pendiente de aprobación para el curso %s'; +$strings['MailContentReminderStudent'] = 'Este correo es para confirmar que hemos recibido y registrado su solicitud de inscripción al curso %s, por iniciarse el %s.'; +$strings['MailContentReminderStudentSecond'] = 'Su inscripción todavía no ha sido aprobada por su superior, por lo que hemos vuelto a enviarle un correo electrónico de recordatorio.'; +$strings['MailTitleReminderSuperior'] = 'Solicitud de consideración de curso para un colaborador'; +$strings['MailContentReminderSuperior'] = 'Le recordamos que hemos recibido las siguientes solicitudes de suscripción para el curso %s de parte de sus colaboradores. El curso se iniciará el %s. Detalles del curso: %s.'; +$strings['MailContentReminderSuperiorSecond'] = 'Le invitamos a aprobar o desaprobar las suscripciones, dando clic en el botón correspondiente a continuación para cada colaborador.'; +$strings['MailTitleReminderMaxSuperior'] = 'Recordatorio: Solicitud de consideración de curso para colaborador(es)'; +$strings['MailContentReminderMaxSuperior'] = 'Le recordamos que hemos recibido las siguientes solicitudes de suscripción al curso %s de parte de sus colaboradores. El curso se iniciará el %s. Detalles del curso: %s.'; +$strings['MailContentReminderMaxSuperiorSecond'] = 'Este curso tiene una cantidad de cupos limitados y ha recibido una alta tasa de solicitudes de inscripción, por lo que recomendamos que cada área apruebe un máximo de %s candidatos. Le invitamos a aprobar o desaprobar las suscripciones, dando clic en el botón correspondiente a continuación para cada colaborador.'; + +$strings['YouMustAcceptTermsAndConditions'] = 'Para inscribirse al curso %s, debe aceptar estos términos y condiciones.'; diff --git a/plugin/advanced_subscription/lang/spanish.php b/plugin/advanced_subscription/lang/spanish.php new file mode 100644 index 000000000..9c5633c57 --- /dev/null +++ b/plugin/advanced_subscription/lang/spanish.php @@ -0,0 +1,149 @@ +no sean el curso de inducción"; +$strings['course_session_credit_year_start_date'] = 'Fecha de inicio'; +$strings['course_session_credit_year_start_date_help'] = "Fecha de inicio del año (día/mes)"; +$strings['min_profile_percentage'] = 'Porcentage de perfil completado mínimo requerido'; +$strings['min_profile_percentage_help'] = 'Número porcentage ( > 0.00 y < 100.00)'; +$strings['secret_key'] = 'LLave secreta'; +$strings['terms_and_conditions'] = 'Términos y condiciones'; + +/* String for error message about requirements */ +$strings['AdvancedSubscriptionNotConnected'] = "Usted no está conectado en la plataforma. Por favor ingrese su usuario / constraseña para poder inscribirse"; +$strings['AdvancedSubscriptionProfileIncomplete'] = "Debe llenar el %d porciento de tu perfil como mínimo. Por ahora has llenado el %d porciento"; +$strings['AdvancedSubscriptionIncompleteInduction'] = "Usted aún no ha completado el curso de inducción. Por favor complete el curso inducción"; +$strings['AdvancedSubscriptionCostXLimitReached'] = "Lo sentimos, usted ya ha alcanzado el límite anual de %s UIT para los cursos que ha seguido este año"; +$strings['AdvancedSubscriptionTimeXLimitReached'] = "Lo sentimos, usted ya ha alcanzado el límite anual de %s horas para los cursos que ha seguido este año"; +$strings['AdvancedSubscriptionCourseXLimitReached'] = "Lo sentimos, usted ya ha alcanzado el límite anual de %s cursos que ha seguido este año"; +$strings['AdvancedSubscriptionNotMoreAble'] = "Lo sentimos, usted ya no cumple con las condiciones iniciales para poder inscribirse al curso"; +$strings['AdvancedSubscriptionIncompleteParams'] = "Los parámetros enviados no están completos o no son los correctos."; +$strings['AdvancedSubscriptionIsNotEnabled'] = "La inscripción avanzada no está activada"; + +$strings['AdvancedSubscriptionNoQueue'] = "Usted no está inscrito para este curso."; +$strings['AdvancedSubscriptionNoQueueIsAble'] = "Usted no está inscrito, pero está calificado para este curso."; +$strings['AdvancedSubscriptionQueueStart'] = "Su solicitud de inscripción está pendiente de la aprobación de su jefe, por favor espere atentamente."; +$strings['AdvancedSubscriptionQueueBossDisapproved'] = "Lo sentimos, tu inscripción fue rechazada por tu jefe."; +$strings['AdvancedSubscriptionQueueBossApproved'] = "Tu solicitud de inscripción ha sido aceptado por tu jefe, ahora está en espera de vacantes."; +$strings['AdvancedSubscriptionQueueAdminDisapproved'] = "Lo sentimos, Tu inscripción ha sido rechazada por el administrador."; +$strings['AdvancedSubscriptionQueueAdminApproved'] = "¡Felicitaciones! Tu inscripción ha sido aceptada por el administrador."; +$strings['AdvancedSubscriptionQueueDefaultX'] = "Hubo un error el estado en cola %d no está definido en el sistema."; + +// Mail translations +$strings['MailStudentRequest'] = 'Solicitud de registro de estudiante'; +$strings['MailBossAccept'] = 'Solicitud de registro aceptada por superior'; +$strings['MailBossReject'] = 'Solicitud de registro rechazada por superior'; +$strings['MailStudentRequestSelect'] = 'Selección de solicitudes de registro de estudiante'; +$strings['MailAdminAccept'] = 'Solicitud de registro aceptada por administrador'; +$strings['MailAdminReject'] = 'Solicitud de registro rechazada por administrador'; +$strings['MailStudentRequestNoBoss'] = 'Solicitud de registro de estudiante sin superior'; +$strings['MailRemindStudent'] = 'Recordatorio de la solicitud de inscripción'; +$strings['MailRemindSuperior'] = 'Solicitudes de inscripción estan pendientes de tu aprobación'; +$strings['MailRemindAdmin'] = 'Inscripciones de cursos estan pendientes de tu aprobación'; + +// TPL translations +$strings['SessionXWithoutVacancies'] = "El curso \"%s\" no tiene cupos disponibles."; +$strings['SuccessSubscriptionToSessionX'] = "

¡Felicitaciones!

Tu inscripción al curso \"%s\" se realizó correctamente."; +$strings['SubscriptionToOpenSession'] = "Inscripcion a curso abierto"; +$strings['GoToSessionX'] = "Ir al curso \"%s\""; +$strings['YouAreAlreadySubscribedToSessionX'] = "Usted ya está inscrito al curso \"%s\"."; + +// Admin view +$strings['SelectASession'] = 'Elija una sesión de formación'; +$strings['SessionName'] = 'Nombre de la sesión'; +$strings['Target'] = 'Publico objetivo'; +$strings['Vacancies'] = 'Vacantes'; +$strings['RecommendedNumberOfParticipants'] = 'Número recomendado de participantes por área'; +$strings['PublicationEndDate'] = 'Fecha fin de publicación'; +$strings['Mode'] = 'Modalidad'; +$strings['Postulant'] = 'Postulante'; +$strings['Area'] = 'Área'; +$strings['Institution'] = 'Institución'; +$strings['InscriptionDate'] = 'Fecha de inscripción'; +$strings['BossValidation'] = 'Validación del superior'; +$strings['Decision'] = 'Decisión'; +$strings['AdvancedSubscriptionAdminViewTitle'] = 'Resultado de confirmación de solicitud de inscripción'; + +$strings['AcceptInfinitive'] = 'Aceptar'; +$strings['RejectInfinitive'] = 'Rechazar'; +$strings['AreYouSureYouWantToAcceptSubscriptionOfX'] = '¿Está seguro que quiere aceptar la inscripción de %s?'; +$strings['AreYouSureYouWantToRejectSubscriptionOfX'] = '¿Está seguro que quiere rechazar la inscripción de %s?'; + +$strings['MailTitle'] = 'Solicitud recibida para el curso %s'; +$strings['MailDear'] = 'Estimado(a):'; +$strings['MailThankYou'] = 'Gracias.'; +$strings['MailThankYouCollaboration'] = 'Gracias por su colaboración.'; + +// Admin Accept +$strings['MailTitleAdminAcceptToAdmin'] = 'Información: Validación de inscripción recibida'; +$strings['MailContentAdminAcceptToAdmin'] = 'Hemos recibido y registrado su validación de la inscripción de %s al curso %s'; +$strings['MailTitleAdminAcceptToStudent'] = 'Aprobada: ¡Su inscripción al curso %s fue confirmada!'; +$strings['MailContentAdminAcceptToStudent'] = 'Nos complace informarle que su inscripción al curso %s iniciando el %s fue validada por los administradores. Esperamos mantenga todo su ánimo y participe en otro curso o, en otra oportunidad, a este mismo curso.'; +$strings['MailTitleAdminAcceptToSuperior'] = 'Información: Validación de inscripción de %s al curso %s'; +$strings['MailContentAdminAcceptToSuperior'] = 'La inscripción de %s al curso %s iniciando el %s, que estaba pendiente de validación por los organizadores del curso, fue validada hacen unos minutos. Esperamos nos ayude en asegurar la completa disponibilidad de su colaborador(a) para la duración completa del curso.'; + +// Admin Reject +$strings['MailTitleAdminRejectToAdmin'] = 'Información: rechazo de inscripción recibido'; +$strings['MailContentAdminRejectToAdmin'] = 'Hemos recibido y registrado su rechazo de la inscripción de %s al curso %s'; +$strings['MailTitleAdminRejectToStudent'] = 'Rechazamos su inscripción al curso %s'; +$strings['MailContentAdminRejectToStudent'] = 'Lamentamos informarle que su inscripción al curso %s iniciando el %s fue rechazada por falta de cupos. Esperamos mantenga todo su ánimo y participe en otro curso o, en otra oportunidad, a este mismo curso.'; +$strings['MailTitleAdminRejectToSuperior'] = 'Información: Rechazo de inscripción de %s al curso %s'; +$strings['MailContentAdminRejectToSuperior'] = 'La inscripción de %s al curso %s, que había aprobado anteriormente, fue rechazada por falta de cupos. Les presentamos nuestras disculpas sinceras.'; + +// Superior Accept +$strings['MailTitleSuperiorAcceptToAdmin'] = 'Aprobación de %s al curso %s '; +$strings['MailContentSuperiorAcceptToAdmin'] = 'La inscripción del alumno %s al curso %s ha sido aprobada por su superior. Puede gestionar las inscripciones al curso aquí'; +$strings['MailTitleSuperiorAcceptToSuperior'] = 'Confirmación: Aprobación recibida para %s'; +$strings['MailContentSuperiorAcceptToSuperior'] = 'Hemos recibido y registrado su decisión de aprobar el curso %s para su colaborador %s'; +$strings['MailContentSuperiorAcceptToSuperiorSecond'] = 'Ahora la inscripción al curso está pendiente de la disponibilidad de cupos. Le mantendremos informado sobre el resultado de esta etapa'; +$strings['MailTitleSuperiorAcceptToStudent'] = 'Aprobado: Su inscripción al curso %s ha sido aprobada por su superior '; +$strings['MailContentSuperiorAcceptToStudent'] = 'Nos complace informarle que su inscripción al curso %s ha sido aprobada por su superior. Su inscripción ahora solo se encuentra pendiente de disponibilidad de cupos. Le avisaremos tan pronto como se confirme este último paso.'; + +// Superior Reject +$strings['MailTitleSuperiorRejectToStudent'] = 'Información: Su inscripción al curso %s ha sido rechazada '; +$strings['MailContentSuperiorRejectToStudent'] = 'Lamentamos informarle que, en esta oportunidad, su inscripción al curso %s NO ha sido aprobada. Esperamos mantenga todo su ánimo y participe en otro curso o, en otra oportunidad, a este mismo curso.'; +$strings['MailTitleSuperiorRejectToSuperior'] = 'Confirmación: Desaprobación recibida para %s'; +$strings['MailContentSuperiorRejectToSuperior'] = 'Hemos recibido y registrado su decisión de desaprobar el curso %s para su colaborador %s'; + +// Student Request +$strings['MailTitleStudentRequestToStudent'] = 'Información: Validación de inscripción recibida'; +$strings['MailContentStudentRequestToStudent'] = 'Hemos recibido y registrado su solicitud de inscripción al curso %s para iniciarse el %s.'; +$strings['MailContentStudentRequestToStudentSecond'] = 'Su inscripción es pendiente primero de la aprobación de su superior, y luego de la disponibilidad de cupos. Un correo ha sido enviado a su superior para revisión y aprobación de su solicitud.'; +$strings['MailTitleStudentRequestToSuperior'] = 'Solicitud de consideración de curso para un colaborador'; +$strings['MailContentStudentRequestToSuperior'] = 'Hemos recibido una solicitud de inscripción de %s al curso %s, por iniciarse el %s. Detalles del curso: %s.'; +$strings['MailContentStudentRequestToSuperiorSecond'] = 'Le invitamos a aprobar o desaprobar esta inscripción, dando clic en el botón correspondiente a continuación.'; + +// Student Request No Boss +$strings['MailTitleStudentRequestNoSuperiorToStudent'] = 'Solicitud recibida para el curso %s'; +$strings['MailContentStudentRequestNoSuperiorToStudent'] = 'Hemos recibido y registrado su solicitud de inscripción al curso %s para iniciarse el %s.'; +$strings['MailContentStudentRequestNoSuperiorToStudentSecond'] = 'Su inscripción es pendiente de la disponibilidad de cupos. Pronto recibirá los resultados de su aprobación de su solicitud.'; +$strings['MailTitleStudentRequestNoSuperiorToAdmin'] = 'Solicitud de inscripción de %s para el curso %s'; +$strings['MailContentStudentRequestNoSuperiorToAdmin'] = 'La inscripción del alumno %s al curso %s ha sido aprobada por defecto, a falta de superior. Puede gestionar las inscripciones al curso aquí'; + +// Reminders +$strings['MailTitleReminderAdmin'] = 'Inscripciones a %s pendiente de confirmación'; +$strings['MailContentReminderAdmin'] = 'Las inscripciones siguientes al curso %s están pendientes de validación para ser efectivas. Por favor, dirigese a la página de administración para validarlos.'; +$strings['MailTitleReminderStudent'] = 'Información: Solicitud pendiente de aprobación para el curso %s'; +$strings['MailContentReminderStudent'] = 'Este correo es para confirmar que hemos recibido y registrado su solicitud de inscripción al curso %s, por iniciarse el %s.'; +$strings['MailContentReminderStudentSecond'] = 'Su inscripción todavía no ha sido aprobada por su superior, por lo que hemos vuelto a enviarle un correo electrónico de recordatorio.'; +$strings['MailTitleReminderSuperior'] = 'Solicitud de consideración de curso para un colaborador'; +$strings['MailContentReminderSuperior'] = 'Le recordamos que hemos recibido las siguientes solicitudes de suscripción para el curso %s de parte de sus colaboradores. El curso se iniciará el %s. Detalles del curso: %s.'; +$strings['MailContentReminderSuperiorSecond'] = 'Le invitamos a aprobar o desaprobar las suscripciones, dando clic en el botón correspondiente a continuación para cada colaborador.'; +$strings['MailTitleReminderMaxSuperior'] = 'Recordatorio: Solicitud de consideración de curso para colaborador(es)'; +$strings['MailContentReminderMaxSuperior'] = 'Le recordamos que hemos recibido las siguientes solicitudes de suscripción al curso %s de parte de sus colaboradores. El curso se iniciará el %s. Detalles del curso: %s.'; +$strings['MailContentReminderMaxSuperiorSecond'] = 'Este curso tiene una cantidad de cupos limitados y ha recibido una alta tasa de solicitudes de inscripción, por lo que recomendamos que cada área apruebe un máximo de %s candidatos. Le invitamos a aprobar o desaprobar las suscripciones, dando clic en el botón correspondiente a continuación para cada colaborador.'; + +$strings['YouMustAcceptTermsAndConditions'] = 'Para inscribirse al curso %s, debe aceptar estos términos y condiciones.'; diff --git a/plugin/advanced_subscription/license.txt b/plugin/advanced_subscription/license.txt new file mode 100644 index 000000000..a7619191f --- /dev/null +++ b/plugin/advanced_subscription/license.txt @@ -0,0 +1 @@ +This plugin, as the rest of Chamilo, is released under the GNU/GPLv3 license. diff --git a/plugin/advanced_subscription/plugin.php b/plugin/advanced_subscription/plugin.php new file mode 100644 index 000000000..89cc82a6a --- /dev/null +++ b/plugin/advanced_subscription/plugin.php @@ -0,0 +1,13 @@ +Plugins). + * + * @package chamilo.plugin.advanced_subscription + */ +/** + * Plugin details (must be present). + */ +require_once __DIR__.'/config.php'; +$plugin_info = AdvancedSubscriptionPlugin::create()->get_info(); diff --git a/plugin/advanced_subscription/src/AdvancedSubscriptionPlugin.php b/plugin/advanced_subscription/src/AdvancedSubscriptionPlugin.php new file mode 100644 index 000000000..35f26d4e1 --- /dev/null +++ b/plugin/advanced_subscription/src/AdvancedSubscriptionPlugin.php @@ -0,0 +1,1534 @@ + 'text', + 'yearly_hours_limit' => 'text', + 'yearly_cost_unit_converter' => 'text', + 'courses_count_limit' => 'text', + 'course_session_credit_year_start_date' => 'text', + 'ws_url' => 'text', + 'min_profile_percentage' => 'text', + 'check_induction' => 'boolean', + 'secret_key' => 'text', + 'terms_and_conditions' => 'wysiwyg', + ]; + + parent::__construct('1.0', 'Imanol Losada, Daniel Barreto', $parameters); + $this->errorMessages = []; + } + + /** + * Instance the plugin. + * + * @staticvar null $result + * + * @return AdvancedSubscriptionPlugin + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * Install the plugin. + */ + public function install() + { + $this->installDatabase(); + $this->addAreaField(); + $this->installHook(); + } + + /** + * Uninstall the plugin. + */ + public function uninstall() + { + $setting = api_get_setting('advanced_subscription'); + if (!empty($setting)) { + $this->uninstallHook(); + // Note: Keeping area field data is intended so it will not be removed + $this->uninstallDatabase(); + } + } + + /** + * Get the error messages list. + * + * @return array The message list + */ + public function getErrorMessages() + { + return $this->errorMessages; + } + + /** + * Check if is allowed subscribe to open session. + * + * @param array $params WS params + * + * @return bool + */ + public function isAllowedSubscribeToOpenSession($params) + { + $self = self::create(); + $wsUrl = $self->get('ws_url'); + $profileCompleted = 0; + if (!empty($wsUrl)) { + $client = new SoapClient( + null, + ['location' => $wsUrl, 'uri' => $wsUrl] + ); + $userInfo = api_get_user_info( + $params['user_id'], + false, + false, + true + ); + + try { + $profileCompleted = $client->__soapCall( + 'getProfileCompletionPercentage', + $userInfo['extra']['drupal_user_id'] + ); + } catch (\Exception $e) { + $profileCompleted = 0; + } + } elseif (isset($params['profile_completed'])) { + $profileCompleted = (float) $params['profile_completed']; + } + $profileCompletedMin = (float) $self->get('min_profile_percentage'); + + if ($profileCompleted < $profileCompletedMin) { + $this->errorMessages[] = sprintf( + $this->get_lang('AdvancedSubscriptionProfileIncomplete'), + $profileCompletedMin, + $profileCompleted + ); + } + + $vacancy = $self->getVacancy($params['session_id']); + $sessionInfo = api_get_session_info($params['session_id']); + + if ($sessionInfo['nbr_users'] >= $vacancy) { + $this->errorMessages[] = sprintf( + $this->get_lang('SessionXWithoutVacancies'), + $sessionInfo['name'] + ); + } + + return empty($this->errorMessages); + } + + /** + * Return true if user is allowed to be added to queue for session subscription. + * + * @param int $userId + * @param array $params MUST have keys: + * "is_connected" Indicate if the user is online on external web + * "profile_completed" Percentage of completed profile, given by WS + * @param bool $collectErrors Optional. Default is false. Whether collect all errors or throw exeptions + * + * @throws Exception + * + * @return bool + */ + public function isAllowedToDoRequest($userId, $params = [], $collectErrors = false) + { + $plugin = self::create(); + $wsUrl = $plugin->get('ws_url'); + // Student always is connected + $isConnected = true; + + if (!$isConnected) { + $this->errorMessages[] = $this->get_lang('AdvancedSubscriptionNotConnected'); + + if (!$collectErrors) { + throw new \Exception($this->get_lang('AdvancedSubscriptionNotConnected')); + } + } + + $profileCompletedMin = (float) $plugin->get('min_profile_percentage'); + $profileCompleted = 0; + + if (is_string($wsUrl) && !empty($wsUrl)) { + $options = [ + 'location' => $wsUrl, + 'uri' => $wsUrl, + ]; + $client = new SoapClient(null, $options); + $userInfo = api_get_user_info($userId); + try { + $profileCompleted = $client->__soapCall('getProfileCompletionPercentage', $userInfo['extra']['drupal_user_id']); + } catch (\Exception $e) { + $profileCompleted = 0; + } + } elseif (isset($params['profile_completed'])) { + $profileCompleted = (float) $params['profile_completed']; + } + + if ($profileCompleted < $profileCompletedMin) { + $errorMessage = sprintf( + $this->get_lang('AdvancedSubscriptionProfileIncomplete'), + $profileCompletedMin, + $profileCompleted + ); + + $this->errorMessages[] = $errorMessage; + + if (!$collectErrors) { + throw new \Exception($errorMessage); + } + } + + $yearlyCostLimit = $plugin->get('yearly_cost_limit'); + $maxCost = $plugin->get('yearly_cost_unit_converter'); + $maxCost *= $yearlyCostLimit; + $userCost = 0; + $now = new DateTime(api_get_utc_datetime()); + $newYearDate = $plugin->get('course_session_credit_year_start_date'); + $newYearDate = !empty($newYearDate) ? + new \DateTime($newYearDate.$now->format('/Y')) : $now; + $extra = new ExtraFieldValue('session'); + $joinSessionTable = Database::get_main_table(TABLE_MAIN_SESSION_USER).' su INNER JOIN '. + Database::get_main_table(TABLE_MAIN_SESSION).' s ON s.id = su.session_id'; + $whereSessionParams = 'su.relation_type = ? AND s.access_start_date >= ? AND su.user_id = ?'; + $whereSessionParamsValues = [ + 0, + $newYearDate->format('Y-m-d'), + $userId, + ]; + $whereSession = [ + 'where' => [ + $whereSessionParams => $whereSessionParamsValues, + ], + ]; + $selectSession = 's.id AS id'; + $sessions = Database::select( + $selectSession, + $joinSessionTable, + $whereSession + ); + + $expendedTimeMax = $plugin->get('yearly_hours_limit'); + $expendedTime = 0; + + if (is_array($sessions) && count($sessions) > 0) { + foreach ($sessions as $session) { + $costField = $extra->get_values_by_handler_and_field_variable($session['id'], 'cost'); + $userCost += $costField['value']; + $teachingHoursField = $extra->get_values_by_handler_and_field_variable($session['id'], 'teaching_hours'); + $expendedTime += $teachingHoursField['value']; + } + } + + if (isset($params['sessionId'])) { + $costField = $extra->get_values_by_handler_and_field_variable($params['sessionId'], 'cost'); + $userCost += $costField['value']; + + $teachingHoursField = $extra->get_values_by_handler_and_field_variable($params['sessionId'], 'teaching_hours'); + $expendedTime += $teachingHoursField['value']; + } + + if ($maxCost <= $userCost) { + $errorMessage = sprintf( + $this->get_lang('AdvancedSubscriptionCostXLimitReached'), + $yearlyCostLimit + ); + + $this->errorMessages[] = $errorMessage; + + if (!$collectErrors) { + throw new \Exception($errorMessage); + } + } + + if ($expendedTimeMax <= $expendedTime) { + $errorMessage = sprintf( + $this->get_lang('AdvancedSubscriptionTimeXLimitReached'), + $expendedTimeMax + ); + + $this->errorMessages[] = $errorMessage; + + if (!$collectErrors) { + throw new \Exception($errorMessage); + } + } + + $expendedNumMax = $plugin->get('courses_count_limit'); + $expendedNum = count($sessions); + + if ($expendedNumMax <= $expendedNum) { + $errorMessage = sprintf( + $this->get_lang('AdvancedSubscriptionCourseXLimitReached'), + $expendedNumMax + ); + + $this->errorMessages[] = $errorMessage; + + if (!$collectErrors) { + throw new \Exception($errorMessage); + } + } + + $checkInduction = $plugin->get('check_induction'); + $numberOfApprovedInductionSessions = $this->getApprovedInductionSessions($userId); + $completedInduction = $numberOfApprovedInductionSessions > 0; + + if ($checkInduction == 'true' && !$completedInduction) { + $this->errorMessages[] = $this->get_lang('AdvancedSubscriptionIncompleteInduction'); + + if (!$collectErrors) { + throw new \Exception($this->get_lang('AdvancedSubscriptionIncompleteInduction')); + } + } + + return empty($this->errorMessages); + } + + /** + * Register a user into a queue for a session. + * + * @param $userId + * @param $sessionId + * + * @return bool|int + */ + public function addToQueue($userId, $sessionId) + { + // Filter input variables + $userId = intval($userId); + $sessionId = intval($sessionId); + $now = api_get_utc_datetime(); + $advancedSubscriptionQueueTable = Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE); + $attributes = [ + 'session_id' => $sessionId, + 'user_id' => $userId, + 'status' => 0, + 'created_at' => $now, + 'updated_at' => null, + ]; + + $id = Database::insert($advancedSubscriptionQueueTable, $attributes); + + return $id; + } + + /** + * Register message with type and status. + * + * @param $mailId + * @param $userId + * @param $sessionId + * + * @return bool|int + */ + public function saveLastMessage($mailId, $userId, $sessionId) + { + // Filter variables + $mailId = intval($mailId); + $userId = intval($userId); + $sessionId = intval($sessionId); + $queueTable = Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE); + $attributes = [ + 'last_message_id' => $mailId, + 'updated_at' => api_get_utc_datetime(), + ]; + + $num = Database::update( + $queueTable, + $attributes, + ['user_id = ? AND session_id = ?' => [$userId, $sessionId]] + ); + + return $num; + } + + /** + * Check for requirements and register user into queue. + * + * @param $userId + * @param $sessionId + * @param $params + * + * @return bool|string + */ + public function startSubscription($userId, $sessionId, $params) + { + $result = 'Params not found'; + if (!empty($sessionId) && !empty($userId)) { + $plugin = self::create(); + try { + if ($plugin->isAllowedToDoRequest($userId, $params)) { + $result = (bool) $plugin->addToQueue($userId, $sessionId); + } else { + throw new \Exception($this->get_lang('AdvancedSubscriptionNotMoreAble')); + } + } catch (Exception $e) { + $result = $e->getMessage(); + } + } + + return $result; + } + + /** + * Send message for the student subscription approval to a specific session. + * + * @param int|array $studentId + * @param int $receiverId + * @param string $subject + * @param string $content + * @param int $sessionId + * @param bool $save + * @param array $fileAttachments + * + * @return bool|int + */ + public function sendMailMessage( + $studentId, + $receiverId, + $subject, + $content, + $sessionId, + $save = false, + $fileAttachments = [] + ) { + if (!empty($fileAttachments) && + is_array($fileAttachments) && + isset($fileAttachments['files']) && + isset($fileAttachments['comments']) + ) { + $mailId = MessageManager::send_message( + $receiverId, + $subject, + $content, + $fileAttachments['files'], + $fileAttachments['comments'] + ); + } else { + $mailId = MessageManager::send_message( + $receiverId, + $subject, + $content + ); + } + + if ($save && !empty($mailId)) { + // Save as sent message + if (is_array($studentId) && !empty($studentId)) { + foreach ($studentId as $student) { + $this->saveLastMessage($mailId, $student['user_id'], $sessionId); + } + } else { + $studentId = intval($studentId); + $this->saveLastMessage($mailId, $studentId, $sessionId); + } + } elseif (!empty($mailId)) { + // Update queue row, updated_at + Database::update( + Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE), + [ + 'updated_at' => api_get_utc_datetime(), + ], + [ + 'user_id = ? AND session_id = ?' => [$studentId, $sessionId], + ] + ); + } + + return $mailId; + } + + /** + * Check if session is open for subscription. + * + * @param $sessionId + * @param string $fieldVariable + * + * @return bool + */ + public function isSessionOpen($sessionId, $fieldVariable = 'is_open_session') + { + $extraFieldValue = new ExtraFieldValue('session'); + $result = $extraFieldValue->get_values_by_handler_and_field_variable( + $sessionId, + $fieldVariable + ); + + $isOpen = false; + if (!empty($result)) { + $isOpen = (bool) $result['value']; + } + + return $isOpen; + } + + /** + * Check if user is in the session's target group based on its area. + * + * @param $userId + * @param $sessionId + * @param string $userFieldVariable + * @param string $sessionFieldVariable + * + * @return bool + */ + public function isUserInTargetGroup( + $userId, + $sessionId, + $userFieldVariable = 'area', + $sessionFieldVariable = 'target' + ) { + $extraSessionFieldValue = new ExtraFieldValue('session'); + $sessionTarget = $extraSessionFieldValue->get_values_by_handler_and_field_variable( + $sessionId, + $sessionFieldVariable + ); + $extraUserFieldValue = new ExtraFieldValue('user'); + $userArea = $extraUserFieldValue->get_values_by_handler_and_field_variable( + $userId, + $userFieldVariable + ); + $isInTargetGroup = false; + if (isset($sessionTarget) && (!empty($sessionTarget)) && $sessionTarget['value'] == 'minedu') { + if (substr($userArea['value'], 0, 6) == 'MINEDU') { + $isInTargetGroup = true; + } + } + if (isset($sessionTarget) && (!empty($sessionTarget)) && $sessionTarget['value'] == 'regiones') { + if ((substr($userArea['value'], 0, 4) == 'UGEL') || (substr($userArea['value'], 0, 3) == 'DRE')) { + $isInTargetGroup = true; + } + } + + return $isInTargetGroup; + } + + /** + * Update the queue status for subscription approval rejected or accepted. + * + * @param $params + * @param $newStatus + * + * @return bool + */ + public function updateQueueStatus($params, $newStatus) + { + $newStatus = intval($newStatus); + $res = false; + + if (isset($params['queue']['id'])) { + $where = [ + 'id = ?' => intval($params['queue']['id']), + ]; + } elseif (isset($params['studentUserId']) && isset($params['sessionId'])) { + $where = [ + 'user_id = ? AND session_id = ? AND status <> ? AND status <> ?' => [ + intval($params['studentUserId']), + intval($params['sessionId']), + $newStatus, + ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED, + ], + ]; + } + if (isset($where)) { + $res = (bool) Database::update( + Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE), + [ + 'status' => $newStatus, + 'updated_at' => api_get_utc_datetime(), + ], + $where + ); + } + + return $res; + } + + /** + * Render and send mail by defined advanced subscription action. + * + * @param $data + * @param $actionType + * + * @return array + */ + public function sendMail($data, $actionType) + { + $template = new Template($this->get_lang('plugin_title')); + $template->assign('data', $data); + $templateParams = [ + 'user', + 'student', + 'students', + 'superior', + 'admins', + 'session', + 'signature', + 'admin_view_url', + 'acceptUrl', + 'rejectUrl', + ]; + foreach ($templateParams as $templateParam) { + $template->assign($templateParam, $data[$templateParam]); + } + $mailIds = []; + switch ($actionType) { + case ADVANCED_SUBSCRIPTION_ACTION_STUDENT_REQUEST: + // Mail to student + $mailIds['render'] = $this->sendMailMessage( + $data['studentUserId'], + $data['student']['user_id'], + $this->get_lang('MailStudentRequest'), + $template->fetch('/advanced_subscription/views/student_notice_student.tpl'), + $data['sessionId'], + true + ); + // Mail to superior + $mailIds[] = $this->sendMailMessage( + $data['studentUserId'], + $data['superior']['user_id'], + $this->get_lang('MailStudentRequest'), + $template->fetch('/advanced_subscription/views/student_notice_superior.tpl'), + $data['sessionId'] + ); + break; + case ADVANCED_SUBSCRIPTION_ACTION_SUPERIOR_APPROVE: + // Mail to student + $mailIds[] = $this->sendMailMessage( + $data['studentUserId'], + $data['student']['user_id'], + $this->get_lang('MailBossAccept'), + $template->fetch('/advanced_subscription/views/superior_accepted_notice_student.tpl'), + $data['sessionId'], + true + ); + // Mail to superior + $mailIds['render'] = $this->sendMailMessage( + $data['studentUserId'], + $data['superior']['user_id'], + $this->get_lang('MailBossAccept'), + $template->fetch('/advanced_subscription/views/superior_accepted_notice_superior.tpl'), + $data['sessionId'] + ); + // Mail to admin + foreach ($data['admins'] as $adminId => $admin) { + $template->assign('admin', $admin); + $mailIds[] = $this->sendMailMessage( + $data['studentUserId'], + $adminId, + $this->get_lang('MailBossAccept'), + $template->fetch('/advanced_subscription/views/superior_accepted_notice_admin.tpl'), + $data['sessionId'] + ); + } + break; + case ADVANCED_SUBSCRIPTION_ACTION_SUPERIOR_DISAPPROVE: + // Mail to student + $mailIds[] = $this->sendMailMessage( + $data['studentUserId'], + $data['student']['user_id'], + $this->get_lang('MailBossReject'), + $template->fetch('/advanced_subscription/views/superior_rejected_notice_student.tpl'), + $data['sessionId'], + true + ); + // Mail to superior + $mailIds['render'] = $this->sendMailMessage( + $data['studentUserId'], + $data['superior']['user_id'], + $this->get_lang('MailBossReject'), + $template->fetch('/advanced_subscription/views/superior_rejected_notice_superior.tpl'), + $data['sessionId'] + ); + break; + case ADVANCED_SUBSCRIPTION_ACTION_SUPERIOR_SELECT: + // Mail to student + $mailIds[] = $this->sendMailMessage( + $data['studentUserId'], + $data['student']['user_id'], + $this->get_lang('MailStudentRequestSelect'), + $template->fetch('/advanced_subscription/views/student_notice_student.tpl'), + $data['sessionId'], + true + ); + // Mail to superior + $mailIds['render'] = $this->sendMailMessage( + $data['studentUserId'], + $data['superior']['user_id'], + $this->get_lang('MailStudentRequestSelect'), + $template->fetch('/advanced_subscription/views/student_notice_superior.tpl'), + $data['sessionId'] + ); + break; + case ADVANCED_SUBSCRIPTION_ACTION_ADMIN_APPROVE: + $fileAttachments = []; + if (api_get_plugin_setting('courselegal', 'tool_enable')) { + $courseLegal = CourseLegalPlugin::create(); + $courses = SessionManager::get_course_list_by_session_id($data['sessionId']); + $course = current($courses); + $data['courseId'] = $course['id']; + $data['course'] = api_get_course_info_by_id($data['courseId']); + $termsAndConditions = $courseLegal->getData($data['courseId'], $data['sessionId']); + $termsAndConditions = $termsAndConditions['content']; + $termsAndConditions = $this->renderTemplateString($termsAndConditions, $data); + $tpl = new Template(get_lang('TermsAndConditions')); + $tpl->assign('session', $data['session']); + $tpl->assign('student', $data['student']); + $tpl->assign('sessionId', $data['sessionId']); + $tpl->assign('termsContent', $termsAndConditions); + $termsAndConditions = $tpl->fetch('/advanced_subscription/views/terms_and_conditions_to_pdf.tpl'); + $pdf = new PDF(); + $filename = 'terms'.sha1(rand(0, 99999)); + $pdf->content_to_pdf($termsAndConditions, null, $filename, null, 'F'); + $fileAttachments['file'][] = [ + 'name' => $filename.'.pdf', + 'application/pdf' => $filename.'.pdf', + 'tmp_name' => api_get_path(SYS_ARCHIVE_PATH).$filename.'.pdf', + 'error' => UPLOAD_ERR_OK, + 'size' => filesize(api_get_path(SYS_ARCHIVE_PATH).$filename.'.pdf'), + ]; + $fileAttachments['comments'][] = get_lang('TermsAndConditions'); + } + // Mail to student + $mailIds[] = $this->sendMailMessage( + $data['studentUserId'], + $data['student']['user_id'], + $this->get_lang('MailAdminAccept'), + $template->fetch('/advanced_subscription/views/admin_accepted_notice_student.tpl'), + $data['sessionId'], + true, + $fileAttachments + ); + // Mail to superior + $mailIds[] = $this->sendMailMessage( + $data['studentUserId'], + $data['superior']['user_id'], + $this->get_lang('MailAdminAccept'), + $template->fetch('/advanced_subscription/views/admin_accepted_notice_superior.tpl'), + $data['sessionId'] + ); + // Mail to admin + $adminId = $data['currentUserId']; + $template->assign('admin', $data['admins'][$adminId]); + $mailIds['render'] = $this->sendMailMessage( + $data['studentUserId'], + $adminId, + $this->get_lang('MailAdminAccept'), + $template->fetch('/advanced_subscription/views/admin_accepted_notice_admin.tpl'), + $data['sessionId'] + ); + break; + case ADVANCED_SUBSCRIPTION_ACTION_ADMIN_DISAPPROVE: + // Mail to student + $mailIds[] = $this->sendMailMessage( + $data['studentUserId'], + $data['student']['user_id'], + $this->get_lang('MailAdminReject'), + $template->fetch('/advanced_subscription/views/admin_rejected_notice_student.tpl'), + $data['sessionId'], + true + ); + // Mail to superior + $mailIds[] = $this->sendMailMessage( + $data['studentUserId'], + $data['superior']['user_id'], + $this->get_lang('MailAdminReject'), + $template->fetch('/advanced_subscription/views/admin_rejected_notice_superior.tpl'), + $data['sessionId'] + ); + // Mail to admin + $adminId = $data['currentUserId']; + $template->assign('admin', $data['admins'][$adminId]); + $mailIds['render'] = $this->sendMailMessage( + $data['studentUserId'], + $adminId, + $this->get_lang('MailAdminReject'), + $template->fetch('/advanced_subscription/views/admin_rejected_notice_admin.tpl'), + $data['sessionId'] + ); + break; + case ADVANCED_SUBSCRIPTION_ACTION_STUDENT_REQUEST_NO_BOSS: + // Mail to student + $mailIds['render'] = $this->sendMailMessage( + $data['studentUserId'], + $data['student']['user_id'], + $this->get_lang('MailStudentRequestNoBoss'), + $template->fetch('/advanced_subscription/views/student_no_superior_notice_student.tpl'), + $data['sessionId'], + true + ); + // Mail to admin + foreach ($data['admins'] as $adminId => $admin) { + $template->assign('admin', $admin); + $mailIds[] = $this->sendMailMessage( + $data['studentUserId'], + $adminId, + $this->get_lang('MailStudentRequestNoBoss'), + $template->fetch('/advanced_subscription/views/student_no_superior_notice_admin.tpl'), + $data['sessionId'] + ); + } + break; + case ADVANCED_SUBSCRIPTION_ACTION_REMINDER_STUDENT: + $mailIds['render'] = $this->sendMailMessage( + $data['student']['user_id'], + $data['student']['user_id'], + $this->get_lang('MailRemindStudent'), + $template->fetch('/advanced_subscription/views/reminder_notice_student.tpl'), + $data['sessionId'], + true + ); + break; + case ADVANCED_SUBSCRIPTION_ACTION_REMINDER_SUPERIOR: + $mailIds['render'] = $this->sendMailMessage( + $data['students'], + $data['superior']['user_id'], + $this->get_lang('MailRemindSuperior'), + $template->fetch('/advanced_subscription/views/reminder_notice_superior.tpl'), + $data['sessionId'] + ); + break; + case ADVANCED_SUBSCRIPTION_ACTION_REMINDER_SUPERIOR_MAX: + $mailIds['render'] = $this->sendMailMessage( + $data['students'], + $data['superior']['user_id'], + $this->get_lang('MailRemindSuperior'), + $template->fetch('/advanced_subscription/views/reminder_notice_superior_max.tpl'), + $data['sessionId'] + ); + break; + case ADVANCED_SUBSCRIPTION_ACTION_REMINDER_ADMIN: + // Mail to admin + foreach ($data['admins'] as $adminId => $admin) { + $template->assign('admin', $admin); + $mailIds[] = $this->sendMailMessage( + $data['students'], + $adminId, + $this->get_lang('MailRemindAdmin'), + $template->fetch('/advanced_subscription/views/reminder_notice_admin.tpl'), + $data['sessionId'] + ); + } + break; + default: + break; + } + + return $mailIds; + } + + /** + * Count the users in queue filtered by params (sessions, status). + * + * @param array $params Input array containing the set of + * session and status to count from queue + * e.g: + * array('sessions' => array(215, 218, 345, 502), + * 'status' => array(0, 1, 2)) + * + * @return int + */ + public function countQueueByParams($params) + { + $count = 0; + if (!empty($params) && is_array($params)) { + $advancedSubscriptionQueueTable = Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE); + $where['1 = ? '] = 1; + if (isset($params['sessions']) && is_array($params['sessions'])) { + foreach ($params['sessions'] as &$sessionId) { + $sessionId = intval($sessionId); + } + $where['AND session_id IN ( ? ) '] = implode($params['sessions']); + } + if (isset($params['status']) && is_array($params['status'])) { + foreach ($params['status'] as &$status) { + $status = intval($status); + } + $where['AND status IN ( ? ) '] = implode($params['status']); + } + $where['where'] = $where; + $count = Database::select('COUNT(*)', $advancedSubscriptionQueueTable, $where); + $count = $count[0]['COUNT(*)']; + } + + return $count; + } + + /** + * This method will call the Hook management insertHook to add Hook observer from this plugin. + */ + public function installHook() + { + $hookObserver = HookAdvancedSubscription::create(); + HookAdminBlock::create()->attach($hookObserver); + HookWSRegistration::create()->attach($hookObserver); + HookNotificationContent::create()->attach($hookObserver); + HookNotificationTitle::create()->attach($hookObserver); + } + + /** + * This method will call the Hook management deleteHook to disable Hook observer from this plugin. + */ + public function uninstallHook() + { + $hookObserver = HookAdvancedSubscription::create(); + HookAdminBlock::create()->detach($hookObserver); + HookWSRegistration::create()->detach($hookObserver); + HookNotificationContent::create()->detach($hookObserver); + HookNotificationTitle::create()->detach($hookObserver); + } + + /** + * Return the status from user in queue to session subscription. + * + * @param int $userId + * @param int $sessionId + * + * @return bool|int + */ + public function getQueueStatus($userId, $sessionId) + { + $userId = intval($userId); + $sessionId = intval($sessionId); + if (!empty($userId) && !empty($sessionId)) { + $queueTable = Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE); + $row = Database::select( + 'status', + $queueTable, + [ + 'where' => [ + 'user_id = ? AND session_id = ?' => [$userId, $sessionId], + ], + ] + ); + + if (count($row) == 1) { + return $row[0]['status']; + } else { + return ADVANCED_SUBSCRIPTION_QUEUE_STATUS_NO_QUEUE; + } + } + + return false; + } + + /** + * Return the remaining vacancy. + * + * @param $sessionId + * + * @return bool|int + */ + public function getVacancy($sessionId) + { + if (!empty($sessionId)) { + $extra = new ExtraFieldValue('session'); + $var = $extra->get_values_by_handler_and_field_variable( + $sessionId, + 'vacancies' + ); + $vacancy = intval($var['value']); + if (!empty($vacancy)) { + $vacancy -= $this->countQueueByParams( + [ + 'sessions' => [$sessionId], + 'status' => [ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED], + ] + ); + if ($vacancy >= 0) { + return $vacancy; + } else { + return 0; + } + } + } + + return false; + } + + /** + * Return the session details data from a session ID (including the extra + * fields used for the advanced subscription mechanism). + * + * @param $sessionId + * + * @return bool|mixed + */ + public function getSessionDetails($sessionId) + { + if (!empty($sessionId)) { + // Assign variables + $fieldsArray = [ + 'code', + 'cost', + 'place', + 'allow_visitors', + 'teaching_hours', + 'brochure', + 'banner', + ]; + $extraField = new ExtraField('session'); + // Get session fields + $fieldList = $extraField->get_all([ + 'variable IN ( ?, ?, ?, ?, ?, ?, ? )' => $fieldsArray, + ]); + // Index session fields + $fields = []; + foreach ($fieldList as $field) { + $fields[$field['id']] = $field['variable']; + } + + $mergedArray = array_merge([$sessionId], array_keys($fields)); + + $sql = "SELECT * FROM ".Database::get_main_table(TABLE_EXTRA_FIELD_VALUES)." + WHERE item_id = %d AND field_id IN (%d, %d, %d, %d, %d, %d, %d)"; + $sql = vsprintf($sql, $mergedArray); + $sessionFieldValueList = Database::query($sql); + while ($sessionFieldValue = Database::fetch_assoc($sessionFieldValueList)) { + // Check if session field value is set in session field list + if (isset($fields[$sessionFieldValue['field_id']])) { + $var = $fields[$sessionFieldValue['field_id']]; + $val = $sessionFieldValue['value']; + // Assign session field value to session + $sessionArray[$var] = $val; + } + } + $sessionArray['description'] = SessionManager::getDescriptionFromSessionId($sessionId); + + if (isset($sessionArray['brochure'])) { + $sessionArray['brochure'] = api_get_path(WEB_UPLOAD_PATH).$sessionArray['brochure']; + } + if (isset($sessionArray['banner'])) { + $sessionArray['banner'] = api_get_path(WEB_UPLOAD_PATH).$sessionArray['banner']; + } + + return $sessionArray; + } + + return false; + } + + /** + * Get status message. + * + * @param int $status + * @param bool $isAble + * + * @return string + */ + public function getStatusMessage($status, $isAble = true) + { + switch ($status) { + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_NO_QUEUE: + $message = $this->get_lang('AdvancedSubscriptionNoQueue'); + if ($isAble) { + $message = $this->get_lang('AdvancedSubscriptionNoQueueIsAble'); + } + break; + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_START: + $message = $this->get_lang('AdvancedSubscriptionQueueStart'); + break; + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_DISAPPROVED: + $message = $this->get_lang('AdvancedSubscriptionQueueBossDisapproved'); + break; + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED: + $message = $this->get_lang('AdvancedSubscriptionQueueBossApproved'); + break; + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_DISAPPROVED: + $message = $this->get_lang('AdvancedSubscriptionQueueAdminDisapproved'); + break; + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED: + $message = $this->get_lang('AdvancedSubscriptionQueueAdminApproved'); + break; + default: + $message = sprintf($this->get_lang('AdvancedSubscriptionQueueDefault'), $status); + } + + return $message; + } + + /** + * Return the url to go to session. + * + * @param $sessionId + * + * @return string + */ + public function getSessionUrl($sessionId) + { + $url = api_get_path(WEB_CODE_PATH).'session/?session_id='.intval($sessionId); + + return $url; + } + + /** + * Get a url for subscribe a user in session. + * + * @param int $userId The user ID + * @param array $params Params from WS + * + * @return string + */ + public function getOpenSessionUrl($userId, $params) + { + $userIsSubscribed = SessionManager::isUserSubscribedAsStudent( + $params['session_id'], + $userId + ); + + if ($userIsSubscribed) { + return api_get_path(WEB_CODE_PATH) + .'session/index.php?session_id=' + .intval($params['session_id']); + } + + $params['secret_key'] = null; + $params['user_id'] = null; + $params['user_field'] = null; + $params['is_connected'] = null; + + $urlParams = array_merge($params, ['user_id' => $userId]); + + $url = api_get_path(WEB_PLUGIN_PATH); + $url .= 'advanced_subscription/src/open_session.php?'; + $url .= http_build_query($urlParams); + + return 'javascript:void(window.open(\'' + .$url + .'\',\'AdvancedSubscriptionTerms\', \'toolbar=no,location=no,' + .'status=no,menubar=no,scrollbars=yes,resizable=yes,width=700px,' + .'height=600px\', \'100\' ))'; + } + + /** + * Return the url to enter to subscription queue to session. + * + * @param $params + * + * @return string + */ + public function getQueueUrl($params) + { + $url = api_get_path(WEB_PLUGIN_PATH).'advanced_subscription/ajax/advanced_subscription.ajax.php?'. + 'a='.Security::remove_XSS($params['action']).'&'. + 's='.intval($params['sessionId']).'&'. + 'current_user_id='.intval($params['currentUserId']).'&'. + 'e='.intval($params['newStatus']).'&'. + 'u='.intval($params['studentUserId']).'&'. + 'q='.intval($params['queueId']).'&'. + 'is_connected=1&'. + 'profile_completed='.intval($params['profile_completed']).'&'. + 'v='.$this->generateHash($params); + + return $url; + } + + /** + * Return the list of student, in queue used by admin view. + * + * @param int $sessionId + * + * @return array + */ + public function listAllStudentsInQueueBySession($sessionId) + { + // Filter input variable + $sessionId = intval($sessionId); + // Assign variables + $fieldsArray = [ + 'target', + 'publication_end_date', + 'mode', + 'recommended_number_of_participants', + 'vacancies', + ]; + $sessionArray = api_get_session_info($sessionId); + $extraSession = new ExtraFieldValue('session'); + $extraField = new ExtraField('session'); + // Get session fields + $fieldList = $extraField->get_all([ + 'variable IN ( ?, ?, ?, ?, ?)' => $fieldsArray, + ]); + // Index session fields + $fields = []; + foreach ($fieldList as $field) { + $fields[$field['id']] = $field['variable']; + } + + $mergedArray = array_merge([$sessionId], array_keys($fields)); + $sessionFieldValueList = $extraSession->get_all( + [ + 'item_id = ? field_id IN ( ?, ?, ?, ?, ?, ?, ? )' => $mergedArray, + ] + ); + foreach ($sessionFieldValueList as $sessionFieldValue) { + // Check if session field value is set in session field list + if (isset($fields[$sessionFieldValue['field_id']])) { + $var = $fields[$sessionFieldValue['field_id']]; + $val = $sessionFieldValue['value']; + // Assign session field value to session + $sessionArray[$var] = $val; + } + } + $queueTable = Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $userJoinTable = $queueTable.' q INNER JOIN '.$userTable.' u ON q.user_id = u.user_id'; + $where = [ + 'where' => [ + 'q.session_id = ?' => [ + $sessionId, + ], + ], + 'order' => 'qstatus DESC, lastname ASC', + ]; + $select = 'u.user_id, u.firstname, u.lastname, q.created_at, q.updated_at, q.status as qstatus, q.id as queue_id'; + $students = Database::select($select, $userJoinTable, $where); + foreach ($students as &$student) { + $status = intval($student['qstatus']); + switch ($status) { + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_NO_QUEUE: + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_START: + $student['validation'] = ''; + break; + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_DISAPPROVED: + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_DISAPPROVED: + $student['validation'] = 'No'; + break; + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED: + case ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED: + $student['validation'] = 'Yes'; + break; + default: + error_log(__FILE__.' '.__FUNCTION__.' Student status no detected'); + } + } + $return = [ + 'session' => $sessionArray, + 'students' => $students, + ]; + + return $return; + } + + /** + * List all session (id, name) for select input. + * + * @param int $limit + * + * @return array + */ + public function listAllSessions($limit = 100) + { + $limit = intval($limit); + $sessionTable = Database::get_main_table(TABLE_MAIN_SESSION); + $columns = 'id, name'; + $conditions = []; + if ($limit > 0) { + $conditions = [ + 'order' => 'name', + 'limit' => $limit, + ]; + } + + return Database::select($columns, $sessionTable, $conditions); + } + + /** + * Generate security hash to check data send by url params. + * + * @param string $data + * + * @return string + */ + public function generateHash($data) + { + $key = sha1($this->get('secret_key')); + // Prepare array to have specific type variables + $dataPrepared['action'] = strval($data['action']); + $dataPrepared['sessionId'] = intval($data['sessionId']); + $dataPrepared['currentUserId'] = intval($data['currentUserId']); + $dataPrepared['studentUserId'] = intval($data['studentUserId']); + $dataPrepared['queueId'] = intval($data['queueId']); + $dataPrepared['newStatus'] = intval($data['newStatus']); + $dataPrepared = serialize($dataPrepared); + + return sha1($dataPrepared.$key); + } + + /** + * Verify hash from data. + * + * @param string $data + * @param string $hash + * + * @return bool + */ + public function checkHash($data, $hash) + { + return $this->generateHash($data) == $hash; + } + + /** + * Copied and fixed from plugin.class.php + * Returns the "system" name of the plugin in lowercase letters. + * + * @return string + */ + public function get_name() + { + return 'advanced_subscription'; + } + + /** + * Return the url to show subscription terms. + * + * @param array $params + * @param int $mode + * + * @return string + */ + public function getTermsUrl($params, $mode = ADVANCED_SUBSCRIPTION_TERMS_MODE_POPUP) + { + $urlParams = [ + 'a' => Security::remove_XSS($params['action']), + 's' => intval($params['sessionId']), + 'current_user_id' => intval($params['currentUserId']), + 'e' => intval($params['newStatus']), + 'u' => intval($params['studentUserId']), + 'q' => intval($params['queueId']), + 'is_connected' => 1, + 'profile_completed' => intval($params['profile_completed']), + 'v' => $this->generateHash($params), + ]; + + switch ($mode) { + case ADVANCED_SUBSCRIPTION_TERMS_MODE_POPUP: + case ADVANCED_SUBSCRIPTION_TERMS_MODE_FINAL: + $urlParams['r'] = 0; + break; + case ADVANCED_SUBSCRIPTION_TERMS_MODE_REJECT: + $urlParams['r'] = 1; + break; + } + + $url = api_get_path(WEB_PLUGIN_PATH)."advanced_subscription/src/terms_and_conditions.php?"; + $url .= http_build_query($urlParams); + + // Launch popup + if ($mode == ADVANCED_SUBSCRIPTION_TERMS_MODE_POPUP) { + $url = 'javascript:void(window.open(\''.$url.'\',\'AdvancedSubscriptionTerms\', \'toolbar=no,location=no,status=no,menubar=no,scrollbars=yes,resizable=yes,width=700px,height=600px\', \'100\' ))'; + } + + return $url; + } + + /** + * Return the url to get mail rendered. + * + * @param array $params + * + * @return string + */ + public function getRenderMailUrl($params) + { + $url = api_get_path(WEB_PLUGIN_PATH).'advanced_subscription/src/render_mail.php?'. + 'q='.$params['queueId'].'&'. + 'v='.$this->generateHash($params); + + return $url; + } + + /** + * Return the last message id from queue row. + * + * @param int $studentUserId + * @param int $sessionId + * + * @return int|bool + */ + public function getLastMessageId($studentUserId, $sessionId) + { + $studentUserId = intval($studentUserId); + $sessionId = intval($sessionId); + if (!empty($sessionId) && !empty($studentUserId)) { + $row = Database::select( + 'last_message_id', + Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE), + [ + 'where' => [ + 'user_id = ? AND session_id = ?' => [$studentUserId, $sessionId], + ], + ] + ); + + if (count($row) > 0) { + return $row[0]['last_message_id']; + } + } + + return false; + } + + /** + * Return string replacing tags "{{}}"with variables assigned in $data. + * + * @param string $templateContent + * @param array $data + * + * @return string + */ + public function renderTemplateString($templateContent, $data = []) + { + $twigString = new \Twig_Environment(new \Twig_Loader_String()); + $templateContent = $twigString->render( + $templateContent, + $data + ); + + return $templateContent; + } + + /** + * addAreaField() (adds an area field if it is not already created). + */ + private function addAreaField() + { + $extraField = new ExtraField('user'); + $extraFieldHandler = $extraField->get_handler_field_info_by_field_variable('area'); + $areaExists = $extraFieldHandler !== false; + + if (!$areaExists) { + $extraField = new ExtraField('user'); + $extraField->save([ + 'field_type' => 1, + 'variable' => 'area', + 'display_text' => get_plugin_lang('Area', 'AdvancedSubscriptionPlugin'), + 'default_value' => null, + 'field_order' => null, + 'visible_to_self' => 1, + 'changeable' => 1, + 'filter' => null, + ]); + } + } + + /** + * Create the database tables for the plugin. + */ + private function installDatabase() + { + $advancedSubscriptionQueueTable = Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE); + + $sql = "CREATE TABLE IF NOT EXISTS $advancedSubscriptionQueueTable (". + "id int UNSIGNED NOT NULL AUTO_INCREMENT, ". + "session_id int UNSIGNED NOT NULL, ". + "user_id int UNSIGNED NOT NULL, ". + "status int UNSIGNED NOT NULL, ". + "last_message_id int UNSIGNED NOT NULL, ". + "created_at datetime NOT NULL, ". + "updated_at datetime NULL, ". + "PRIMARY KEY PK_advanced_subscription_queue (id), ". + "UNIQUE KEY UK_advanced_subscription_queue (user_id, session_id)); "; + Database::query($sql); + } + + /** + * Drop the database tables for the plugin. + */ + private function uninstallDatabase() + { + /* Drop plugin tables */ + $advancedSubscriptionQueueTable = Database::get_main_table(TABLE_ADVANCED_SUBSCRIPTION_QUEUE); + $sql = "DROP TABLE IF EXISTS $advancedSubscriptionQueueTable; "; + Database::query($sql); + + /* Delete settings */ + $settingsTable = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT); + Database::query("DELETE FROM $settingsTable WHERE subkey = 'advanced_subscription'"); + } + + /** + * Get the count of approved induction sessions by a user. + * + * @param int $userId The user id + * + * @return int The count of approved sessions + */ + private function getApprovedInductionSessions($userId) + { + $tSession = Database::get_main_table(TABLE_MAIN_SESSION); + $tSessionField = Database::get_main_table(TABLE_EXTRA_FIELD); + $tSessionFieldValues = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES); + $tSessionUser = Database::get_main_table(TABLE_MAIN_SESSION_USER); + $extraFieldType = \Chamilo\CoreBundle\Entity\ExtraField::SESSION_FIELD_TYPE; + $sql = "SELECT s.id FROM $tSession AS s + INNER JOIN $tSessionFieldValues AS sfv ON s.id = sfv.item_id + INNER JOIN $tSessionField AS sf ON sfv.field_id = sf.id + INNER JOIN $tSessionUser AS su ON s.id = su.session_id + WHERE + sf.extra_field_type = $extraFieldType AND + sf.variable = 'is_induction_session' AND + su.relation_type = 0 AND + su.user_id = ".intval($userId); + + $result = Database::query($sql); + + if ($result === false) { + return 0; + } + + $numberOfApproved = 0; + + while ($session = Database::fetch_assoc($result)) { + $numberOfApprovedCourses = 0; + $courses = SessionManager::get_course_list_by_session_id($session['id']); + + foreach ($courses as $course) { + $courseCategories = Category::load( + null, + null, + $course['code'], + null, + null, + $session['id'], + false + ); + + if (count($courseCategories) > 0 && + Category::userFinishedCourse($userId, $courseCategories[0]) + ) { + $numberOfApprovedCourses++; + } + } + + if ($numberOfApprovedCourses === count($courses)) { + $numberOfApproved++; + } + } + + return $numberOfApproved; + } +} diff --git a/plugin/advanced_subscription/src/HookAdvancedSubscription.php b/plugin/advanced_subscription/src/HookAdvancedSubscription.php new file mode 100644 index 000000000..db89bcf64 --- /dev/null +++ b/plugin/advanced_subscription/src/HookAdvancedSubscription.php @@ -0,0 +1,681 @@ + + * + * @package chamilo.plugin.advanced_subscription + */ +require_once __DIR__.'/../config.php'; + +/** + * Class HookAdvancedSubscription extends the HookObserver to implements + * specific behaviour when the AdvancedSubscription plugin is enabled. + */ +class HookAdvancedSubscription extends HookObserver implements HookAdminBlockObserverInterface, HookWSRegistrationObserverInterface, HookNotificationContentObserverInterface +{ + public static $plugin; + + /** + * Constructor. Calls parent, mainly. + */ + protected function __construct() + { + self::$plugin = AdvancedSubscriptionPlugin::create(); + parent::__construct( + 'plugin/advanced_subscription/src/HookAdvancedSubscription.class.php', + 'advanced_subscription' + ); + } + + /** + * @return array + */ + public function hookAdminBlock(HookAdminBlockEventInterface $hook) + { + $data = $hook->getEventData(); + // if ($data['type'] === HOOK_EVENT_TYPE_PRE) // Nothing to do + if ($data['type'] === HOOK_EVENT_TYPE_POST) { + if (isset($data['blocks'])) { + $data['blocks']['sessions']['items'][] = [ + 'url' => '../../plugin/advanced_subscription/src/admin_view.php', + 'label' => get_plugin_lang('plugin_title', 'AdvancedSubscriptionPlugin'), + ]; + } + } // Else: Hook type is not valid, nothing to do + + return $data; + } + + /** + * Add Webservices to registration.soap.php. + * + * @return mixed (int or false) + */ + public function hookWSRegistration(HookWSRegistrationEventInterface $hook) + { + $data = $hook->getEventData(); + //if ($data['type'] === HOOK_EVENT_TYPE_PRE) // nothing to do + if ($data['type'] === HOOK_EVENT_TYPE_POST) { + /** @var \nusoap_server $server */ + $server = &$data['server']; + + /** WSSessionListInCategory */ + + // Output params for sessionBriefList WSSessionListInCategory + $server->wsdl->addComplexType( + 'sessionBrief', + 'complexType', + 'struct', + 'all', + '', + [ + // session.id + 'id' => ['name' => 'id', 'type' => 'xsd:int'], + // session.name + 'name' => ['name' => 'name', 'type' => 'xsd:string'], + // session.short_description + 'short_description' => ['name' => 'short_description', 'type' => 'xsd:string'], + // session.mode + 'mode' => ['name' => 'mode', 'type' => 'xsd:string'], + // session.date_start + 'date_start' => ['name' => 'date_start', 'type' => 'xsd:string'], + // session.date_end + 'date_end' => ['name' => 'date_end', 'type' => 'xsd:string'], + // session.human_text_duration + 'human_text_duration' => ['name' => 'human_text_duration', 'type' => 'xsd:string'], + // session.vacancies + 'vacancies' => ['name' => 'vacancies', 'type' => 'xsd:string'], + // session.schedule + 'schedule' => ['name' => 'schedule', 'type' => 'xsd:string'], + ] + ); + + //Output params for WSSessionListInCategory + $server->wsdl->addComplexType( + 'sessionBriefList', + 'complexType', + 'array', + '', + 'SOAP-ENC:Array', + [], + [ + ['ref' => 'SOAP-ENC:arrayType', + 'wsdl:arrayType' => 'tns:sessionBrief[]', ], + ], + 'tns:sessionBrief' + ); + + // Input params for WSSessionListInCategory + $server->wsdl->addComplexType( + 'sessionCategoryInput', + 'complexType', + 'struct', + 'all', + '', + [ + 'id' => ['name' => 'id', 'type' => 'xsd:string'], // session_category.id + 'name' => ['name' => 'name', 'type' => 'xsd:string'], // session_category.name + 'target' => ['name' => 'target', 'type' => 'xsd:string'], // session.target + 'secret_key' => ['name' => 'secret_key', 'type' => 'xsd:string'], + ] + ); + + // Input params for WSSessionGetDetailsByUser + $server->wsdl->addComplexType( + 'advsubSessionDetailInput', + 'complexType', + 'struct', + 'all', + '', + [ + // user_field_values.value + 'user_id' => ['name' => 'user_id', 'type' => 'xsd:int'], + // user_field.user_id + 'user_field' => ['name' => 'user_field', 'type' => 'xsd:string'], + // session.id + 'session_id' => ['name' => 'session_id', 'type' => 'xsd:int'], + // user.profile_completes + 'profile_completed' => ['name' => 'profile_completed', 'type' => 'xsd:float'], + // user.is_connected + 'is_connected' => ['name' => 'is_connected', 'type' => 'xsd:boolean'], + 'secret_key' => ['name' => 'secret_key', 'type' => 'xsd:string'], + ] + ); + + // Output params for WSSessionGetDetailsByUser + $server->wsdl->addComplexType( + 'advsubSessionDetail', + 'complexType', + 'struct', + 'all', + '', + [ + // session.id + 'id' => ['name' => 'id', 'type' => 'xsd:string'], + // session.code + 'code' => ['name' => 'code', 'type' => 'xsd:string'], + // session.place + 'cost' => ['name' => 'cost', 'type' => 'xsd:float'], + // session.place + 'place' => ['name' => 'place', 'type' => 'xsd:string'], + // session.allow_visitors + 'allow_visitors' => ['name' => 'allow_visitors', 'type' => 'xsd:string'], + // session.teaching_hours + 'teaching_hours' => ['name' => 'teaching_hours', 'type' => 'xsd:int'], + // session.brochure + 'brochure' => ['name' => 'brochure', 'type' => 'xsd:string'], + // session.banner + 'banner' => ['name' => 'banner', 'type' => 'xsd:string'], + // session.description + 'description' => ['name' => 'description', 'type' => 'xsd:string'], + // status + 'status' => ['name' => 'status', 'type' => 'xsd:string'], + // action_url + 'action_url' => ['name' => 'action_url', 'type' => 'xsd:string'], + // message + 'message' => ['name' => 'error_message', 'type' => 'xsd:string'], + ] + ); + + /** WSListSessionsDetailsByCategory */ + + // Input params for WSListSessionsDetailsByCategory + $server->wsdl->addComplexType( + 'listSessionsDetailsByCategory', + 'complexType', + 'struct', + 'all', + '', + [ + // session_category.id + 'id' => ['name' => 'id', 'type' => 'xsd:string'], + // session_category.access_url_id + 'access_url_id' => ['name' => 'access_url_id', 'type' => 'xsd:int'], + // session_category.name + 'category_name' => ['name' => 'category_name', 'type' => 'xsd:string'], + // secret key + 'secret_key' => ['name' => 'secret_key', 'type' => 'xsd:string'], + ], + [], + 'tns:listSessionsDetailsByCategory' + ); + + // Output params for sessionDetailsCourseList WSListSessionsDetailsByCategory + $server->wsdl->addComplexType( + 'sessionDetailsCourse', + 'complexType', + 'struct', + 'all', + '', + [ + 'course_id' => ['name' => 'course_id', 'type' => 'xsd:int'], // course.id + 'course_code' => ['name' => 'course_code', 'type' => 'xsd:string'], // course.code + 'course_title' => ['name' => 'course_title', 'type' => 'xsd:string'], // course.title + 'coach_username' => ['name' => 'coach_username', 'type' => 'xsd:string'], // user.username + 'coach_firstname' => ['name' => 'coach_firstname', 'type' => 'xsd:string'], // user.firstname + 'coach_lastname' => ['name' => 'coach_lastname', 'type' => 'xsd:string'], // user.lastname + ] + ); + + // Output array for sessionDetails WSListSessionsDetailsByCategory + $server->wsdl->addComplexType( + 'sessionDetailsCourseList', + 'complexType', + 'array', + '', + 'SOAP-ENC:Array', + [], + [ + [ + 'ref' => 'SOAP-ENC:arrayType', + 'wsdl:arrayType' => 'tns:sessionDetailsCourse[]', + ], + ], + 'tns:sessionDetailsCourse' + ); + + // Output params for sessionDetailsList WSListSessionsDetailsByCategory + $server->wsdl->addComplexType( + 'sessionDetails', + 'complexType', + 'struct', + 'all', + '', + [ + // session.id + 'id' => [ + 'name' => 'id', + 'type' => 'xsd:int', + ], + // session.id_coach + 'coach_id' => [ + 'name' => 'coach_id', + 'type' => 'xsd:int', + ], + // session.name + 'name' => [ + 'name' => 'name', + 'type' => 'xsd:string', + ], + // session.nbr_courses + 'courses_num' => [ + 'name' => 'courses_num', + 'type' => 'xsd:int', + ], + // session.nbr_users + 'users_num' => [ + 'name' => 'users_num', + 'type' => 'xsd:int', + ], + // session.nbr_classes + 'classes_num' => [ + 'name' => 'classes_num', + 'type' => 'xsd:int', + ], + // session.date_start + 'date_start' => [ + 'name' => 'date_start', + 'type' => 'xsd:string', + ], + // session.date_end + 'date_end' => [ + 'name' => 'date_end', + 'type' => 'xsd:string', + ], + // session.nb_days_access_before_beginning + 'access_days_before_num' => [ + 'name' => 'access_days_before_num', + 'type' => 'xsd:int', + ], + // session.nb_days_access_after_end + 'access_days_after_num' => [ + 'name' => 'access_days_after_num', + 'type' => 'xsd:int', + ], + // session.session_admin_id + 'session_admin_id' => [ + 'name' => 'session_admin_id', + 'type' => 'xsd:int', + ], + // session.visibility + 'visibility' => [ + 'name' => 'visibility', + 'type' => 'xsd:int', + ], + // session.session_category_id + 'session_category_id' => [ + 'name' => 'session_category_id', + 'type' => 'xsd:int', + ], + // session.promotion_id + 'promotion_id' => [ + 'name' => 'promotion_id', + 'type' => 'xsd:int', + ], + // session.number of registered users validated + 'validated_user_num' => [ + 'name' => 'validated_user_num', + 'type' => 'xsd:int', + ], + // session.number of registered users from waiting queue + 'waiting_user_num' => [ + 'name' => 'waiting_user_num', + 'type' => 'xsd:int', + ], + // extra fields + // Array(field_name, field_value) + 'extra' => [ + 'name' => 'extra', + 'type' => 'tns:extrasList', + ], + // course and coaches data + // Array(course_id, course_code, course_title, coach_username, coach_firstname, coach_lastname) + 'course' => [ + 'name' => 'courses', + 'type' => 'tns:sessionDetailsCourseList', + ], + ] + ); + + // Output params for WSListSessionsDetailsByCategory + $server->wsdl->addComplexType( + 'sessionDetailsList', + 'complexType', + 'array', + '', + 'SOAP-ENC:Array', + [], + [ + [ + 'ref' => 'SOAP-ENC:arrayType', + 'wsdl:arrayType' => 'tns:sessionDetails[]', + ], + ], + 'tns:sessionDetails' + ); + + // Register the method for WSSessionListInCategory + $server->register( + 'HookAdvancedSubscription..WSSessionListInCategory', // method name + ['sessionCategoryInput' => 'tns:sessionCategoryInput'], // input parameters + ['return' => 'tns:sessionBriefList'], // output parameters + 'urn:WSRegistration', // namespace + 'urn:WSRegistration#WSSessionListInCategory', // soapaction + 'rpc', // style + 'encoded', // use + 'This service checks if user assigned to course' // documentation + ); + + // Register the method for WSSessionGetDetailsByUser + $server->register( + 'HookAdvancedSubscription..WSSessionGetDetailsByUser', // method name + ['advsubSessionDetailInput' => 'tns:advsubSessionDetailInput'], // input parameters + ['return' => 'tns:advsubSessionDetail'], // output parameters + 'urn:WSRegistration', // namespace + 'urn:WSRegistration#WSSessionGetDetailsByUser', // soapaction + 'rpc', // style + 'encoded', // use + 'This service return session details to specific user' // documentation + ); + + // Register the method for WSListSessionsDetailsByCategory + $server->register( + 'HookAdvancedSubscription..WSListSessionsDetailsByCategory', // method name + ['name' => 'tns:listSessionsDetailsByCategory'], // input parameters + ['return' => 'tns:sessionDetailsList'], // output parameters + 'urn:WSRegistration', // namespace + 'urn:WSRegistration#WSListSessionsDetailsByCategory', // soapaction + 'rpc', // style + 'encoded', // use + 'This service returns a list of detailed sessions by a category' // documentation + ); + + return $data; + } // Else: Nothing to do + + return false; + } + + /** + * @param $params + * + * @return soap_fault|null + */ + public static function WSSessionListInCategory($params) + { + global $debug; + + if ($debug) { + error_log(__FUNCTION__); + error_log('Params '.print_r($params, 1)); + if (!WSHelperVerifyKey($params)) { + error_log(return_error(WS_ERROR_SECRET_KEY)); + } + } + // Check if category ID is set + if (!empty($params['id']) && empty($params['name'])) { + $sessionCategoryId = $params['id']; + } elseif (!empty($params['name'])) { + // Check if category name is set + $sessionCategoryId = SessionManager::getSessionCategoryIdByName($params['name']); + if (is_array($sessionCategoryId)) { + $sessionCategoryId = current($sessionCategoryId); + } + } else { + // Return soap fault Not valid input params + + return return_error(WS_ERROR_INVALID_INPUT); + } + + // Get the session brief List by category + $fields = [ + 'id', + 'short_description', + 'mode', + 'human_text_duration', + 'vacancies', + 'schedule', + ]; + $datePub = new DateTime(); + $sessionList = SessionManager::getShortSessionListAndExtraByCategory( + $sessionCategoryId, + $params['target'], + $fields, + $datePub + ); + + return $sessionList; + } + + /** + * @param $params + * + * @return soap_fault|null + */ + public static function WSSessionGetDetailsByUser($params) + { + global $debug; + + if ($debug) { + error_log('WSUserSubscribedInCourse'); + error_log('Params '.print_r($params, 1)); + } + if (!WSHelperVerifyKey($params)) { + return return_error(WS_ERROR_SECRET_KEY); + } + // Check params + if (is_array($params) && !empty($params['session_id']) && !empty($params['user_id'])) { + $userId = UserManager::get_user_id_from_original_id($params['user_id'], $params['user_field']); + $sessionId = (int) $params['session_id']; + // Check if user exists + if (UserManager::is_user_id_valid($userId) && + SessionManager::isValidId($sessionId) + ) { + // Check if student is already subscribed + $plugin = AdvancedSubscriptionPlugin::create(); + $isOpen = $plugin->isSessionOpen($sessionId); + $status = $plugin->getQueueStatus($userId, $sessionId); + $vacancy = $plugin->getVacancy($sessionId); + $data = $plugin->getSessionDetails($sessionId); + $isUserInTargetGroup = $plugin->isUserInTargetGroup($userId, $sessionId); + if (!empty($data) && is_array($data)) { + $data['status'] = $status; + // Vacancy and queue status cases: + if ($isOpen) { + // Go to Course session + $data['action_url'] = self::$plugin->getOpenSessionUrl($userId, $params); + if (SessionManager::isUserSubscribedAsStudent($sessionId, $userId)) { + $data['status'] = 10; + } + } else { + if (!$isUserInTargetGroup) { + $data['status'] = -2; + } else { + try { + $isAllowed = self::$plugin->isAllowedToDoRequest($userId, $params); + $data['message'] = self::$plugin->getStatusMessage($status, $isAllowed); + } catch (\Exception $e) { + $data['message'] = $e->getMessage(); + } + $params['action'] = 'subscribe'; + $params['sessionId'] = intval($sessionId); + $params['currentUserId'] = 0; // No needed + $params['studentUserId'] = intval($userId); + $params['queueId'] = 0; // No needed + $params['newStatus'] = ADVANCED_SUBSCRIPTION_QUEUE_STATUS_START; + if ($vacancy > 0) { + // Check conditions + if ($status == ADVANCED_SUBSCRIPTION_QUEUE_STATUS_NO_QUEUE) { + // No in Queue, require queue subscription url action + $data['action_url'] = self::$plugin->getTermsUrl($params); + } elseif ($status == ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED) { + // send url action + $data['action_url'] = self::$plugin->getSessionUrl($sessionId); + } // Else: In queue, output status message, no more info. + } else { + if ($status == ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED) { + $data['action_url'] = self::$plugin->getSessionUrl($sessionId); + } elseif ($status == ADVANCED_SUBSCRIPTION_QUEUE_STATUS_NO_QUEUE) { + // in Queue or not, cannot be subscribed to session + $data['action_url'] = self::$plugin->getTermsUrl($params); + } // Else: In queue, output status message, no more info. + } + } + } + $result = $data; + } else { + // Return soap fault No result was found + $result = return_error(WS_ERROR_NOT_FOUND_RESULT); + } + } else { + // Return soap fault No result was found + $result = return_error(WS_ERROR_NOT_FOUND_RESULT); + } + } else { + // Return soap fault Not valid input params + $result = return_error(WS_ERROR_INVALID_INPUT); + } + + return $result; + } + + /** + * Get a list of sessions (id, coach_id, name, courses_num, users_num, classes_num, + * access_start_date, access_end_date, access_days_before_num, session_admin_id, visibility, + * session_category_id, promotion_id, + * validated_user_num, waiting_user_num, + * extra, course) the validated_usernum and waiting_user_num are + * used when have the plugin for advance incsription enables. + * The extra data (field_name, field_value) + * The course data (course_id, course_code, course_title, + * coach_username, coach_firstname, coach_lastname). + * + * @param array $params List of parameters (id, category_name, access_url_id, secret_key) + * + * @return array|soap_fault Sessions list (id=>[title=>'title',url='http://...',date_start=>'...',date_end=>'']) + */ + public static function WSListSessionsDetailsByCategory($params) + { + global $debug; + + if ($debug) { + error_log('WSListSessionsDetailsByCategory'); + error_log('Params '.print_r($params, 1)); + } + $secretKey = $params['secret_key']; + + // Check if secret key is valid + if (!WSHelperVerifyKey($secretKey)) { + return return_error(WS_ERROR_SECRET_KEY); + } + + // Check if category ID is set + if (!empty($params['id']) && empty($params['category_name'])) { + $sessionCategoryId = $params['id']; + } elseif (!empty($params['category_name'])) { + // Check if category name is set + $sessionCategoryId = SessionManager::getSessionCategoryIdByName($params['category_name']); + if (is_array($sessionCategoryId)) { + $sessionCategoryId = current($sessionCategoryId); + } + } else { + // Return soap fault Not valid input params + + return return_error(WS_ERROR_INVALID_INPUT); + } + + // Get the session List by category + $sessionList = SessionManager::getSessionListAndExtraByCategoryId($sessionCategoryId); + + if (empty($sessionList)) { + // If not found any session, return error + + return return_error(WS_ERROR_NOT_FOUND_RESULT); + } + + // Get validated and waiting queue users count for each session + AdvancedSubscriptionPlugin::create(); + foreach ($sessionList as &$session) { + // Add validated and queue users count + $session['validated_user_num'] = self::$plugin->countQueueByParams( + [ + 'sessions' => [$session['id']], + 'status' => [ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED], + ] + ); + $session['waiting_user_num'] = self::$plugin->countQueueByParams( + [ + 'sessions' => [$session['id']], + 'status' => [ + ADVANCED_SUBSCRIPTION_QUEUE_STATUS_START, + ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED, + ], + ] + ); + } + + return $sessionList; + } + + /** + * Return notification content when the hook has been triggered. + * + * @return mixed (int or false) + */ + public function hookNotificationContent(HookNotificationContentEventInterface $hook) + { + $data = $hook->getEventData(); + if ($data['type'] === HOOK_EVENT_TYPE_PRE) { + $data['advanced_subscription_pre_content'] = $data['content']; + + return $data; + } elseif ($data['type'] === HOOK_EVENT_TYPE_POST) { + if (isset($data['content']) && + !empty($data['content']) && + isset($data['advanced_subscription_pre_content']) && + !empty($data['advanced_subscription_pre_content']) + ) { + $data['content'] = str_replace( + [ + '
', + '
', + '
', + ], + '', + $data['advanced_subscription_pre_content'] + ); + } + + return $data; + } //Else hook type is not valid, nothing to do + + return false; + } + + /** + * Return the notification data title if the hook was triggered. + * + * @return array|bool + */ + public function hookNotificationTitle(HookNotificationTitleEventInterface $hook) + { + $data = $hook->getEventData(); + if ($data['type'] === HOOK_EVENT_TYPE_PRE) { + $data['advanced_subscription_pre_title'] = $data['title']; + + return $data; + } elseif ($data['type'] === HOOK_EVENT_TYPE_POST) { + if (isset($data['advanced_subscription_pre_title']) && + !empty($data['advanced_subscription_pre_title']) + ) { + $data['title'] = $data['advanced_subscription_pre_title']; + } + + return $data; + } // Else: hook type is not valid, nothing to do + + return false; + } +} diff --git a/plugin/advanced_subscription/src/admin_view.php b/plugin/advanced_subscription/src/admin_view.php new file mode 100644 index 000000000..62f823ed9 --- /dev/null +++ b/plugin/advanced_subscription/src/admin_view.php @@ -0,0 +1,104 @@ +get_lang('plugin_title')); +// Get all sessions +$sessionList = $plugin->listAllSessions(); + +if (!empty($sessionId)) { + // Get student list in queue + $studentList = $plugin->listAllStudentsInQueueBySession($sessionId); + // Set selected to current session + $sessionList[$sessionId]['selected'] = 'selected="selected"'; + $studentList['session']['id'] = $sessionId; + // Assign variables + $fieldsArray = [ + 'description', + 'target', + 'mode', + 'publication_end_date', + 'recommended_number_of_participants', + 'vacancies', + ]; + $sessionArray = api_get_session_info($sessionId); + $extraSession = new ExtraFieldValue('session'); + $extraField = new ExtraField('session'); + // Get session fields + $fieldList = $extraField->get_all([ + 'variable IN ( ?, ?, ?, ?, ?, ?)' => $fieldsArray, + ]); + // Index session fields + foreach ($fieldList as $field) { + $fields[$field['id']] = $field['variable']; + } + $params = [' item_id = ? ' => $sessionId]; + $sessionFieldValueList = $extraSession->get_all(['where' => $params]); + foreach ($sessionFieldValueList as $sessionFieldValue) { + // Check if session field value is set in session field list + if (isset($fields[$sessionFieldValue['field_id']])) { + $var = $fields[$sessionFieldValue['field_id']]; + $val = $sessionFieldValue['value']; + // Assign session field value to session + $sessionArray[$var] = $val; + } + } + $adminsArray = UserManager::get_all_administrators(); + + $data['action'] = 'confirm'; + $data['sessionId'] = $sessionId; + $data['currentUserId'] = api_get_user_id(); + $isWesternNameOrder = api_is_western_name_order(); + + foreach ($studentList['students'] as &$student) { + $studentId = intval($student['user_id']); + $data['studentUserId'] = $studentId; + + $fieldValue = new ExtraFieldValue('user'); + $areaField = $fieldValue->get_values_by_handler_and_field_variable($studentId, 'area', true); + + $student['area'] = $areaField['value']; + if (substr($student['area'], 0, 6) == 'MINEDU') { + $student['institution'] = 'Minedu'; + } else { + $student['institution'] = 'Regiones'; + } + $student['userLink'] = api_get_path(WEB_CODE_PATH).'social/profile.php?u='.$studentId; + $data['queueId'] = intval($student['queue_id']); + $data['newStatus'] = ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED; + $data['profile_completed'] = 100; + $student['acceptUrl'] = $plugin->getQueueUrl($data); + $data['newStatus'] = ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_DISAPPROVED; + $student['rejectUrl'] = $plugin->getQueueUrl($data); + $student['complete_name'] = $isWesternNameOrder ? + $student['firstname'].', '.$student['lastname'] : $student['lastname'].', '.$student['firstname']; + } + $tpl->assign('session', $sessionArray); + $tpl->assign('students', $studentList['students']); +} + +// Assign variables +$tpl->assign('sessionItems', $sessionList); +$tpl->assign('approveAdmin', ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_APPROVED); +$tpl->assign('disapproveAdmin', ADVANCED_SUBSCRIPTION_QUEUE_STATUS_ADMIN_DISAPPROVED); +// Get rendered template +$content = $tpl->fetch('/advanced_subscription/views/admin_view.tpl'); +// Assign into content +$tpl->assign('content', $content); +// Display +$tpl->display_one_col_template(); diff --git a/plugin/advanced_subscription/src/open_session.php b/plugin/advanced_subscription/src/open_session.php new file mode 100644 index 000000000..70a4ceea2 --- /dev/null +++ b/plugin/advanced_subscription/src/open_session.php @@ -0,0 +1,61 @@ + + * + * @package chamilo.plugin.advanced_subscription + */ +require_once __DIR__.'/../config.php'; + +$plugin = AdvancedSubscriptionPlugin::create(); + +if (!isset($_GET['session_id'], $_GET['user_id'], $_GET['profile_completed'])) { + exit; +} + +$sessionInfo = api_get_session_info($_GET['session_id']); + +$tpl = new Template( + $plugin->get_lang('plugin_title'), + false, + false, + false, + false, + false +); +$tpl->assign('session', $sessionInfo); + +if (SessionManager::isUserSubscribedAsStudent( + $_GET['session_id'], + $_GET['user_id'] +)) { + $tpl->assign('is_subscribed', false); + $tpl->assign( + 'errorMessages', + [sprintf( + $plugin->get_lang('YouAreAlreadySubscribedToSessionX'), + $sessionInfo['name'] + )] + ); +} else { + if (!$plugin->isAllowedSubscribeToOpenSession($_GET)) { + $tpl->assign('is_subscribed', false); + $tpl->assign('errorMessages', $plugin->getErrorMessages()); + } else { + SessionManager::subscribeUsersToSession( + $_GET['session_id'], + [$_GET['user_id']], + SESSION_VISIBLE_READ_ONLY, + false + ); + + $tpl->assign('is_subscribed', true); + } +} + +$content = $tpl->fetch('/advanced_subscription/views/open_session.tpl'); + +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/advanced_subscription/src/render_mail.php b/plugin/advanced_subscription/src/render_mail.php new file mode 100644 index 000000000..da23d9230 --- /dev/null +++ b/plugin/advanced_subscription/src/render_mail.php @@ -0,0 +1,26 @@ +checkHash($data, $hash); +if ($verified) { + // Render mail + $message = MessageManager::get_message_by_id($data['queueId']); + $message = str_replace(['
', '
', '
'], '', $message['content']); + echo $message; +} diff --git a/plugin/advanced_subscription/src/scripts/insert_session_fields.php b/plugin/advanced_subscription/src/scripts/insert_session_fields.php new file mode 100644 index 000000000..913ad09ef --- /dev/null +++ b/plugin/advanced_subscription/src/scripts/insert_session_fields.php @@ -0,0 +1,204 @@ +save([ + 'field_type' => ExtraField::FIELD_TYPE_INTEGER, + 'variable' => 'teaching_hours', + 'display_text' => get_lang('TeachingHours'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$cost = new ExtraField('session'); +$cost->save([ + 'field_type' => ExtraField::FIELD_TYPE_FLOAT, + 'variable' => 'cost', + 'display_text' => get_lang('Cost'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$vacancies = new ExtraField('session'); +$vacancies->save([ + 'field_type' => ExtraField::FIELD_TYPE_INTEGER, + 'variable' => 'vacancies', + 'display_text' => get_lang('Vacancies'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$recommendedNumberOfParticipants = new ExtraField('session'); +$recommendedNumberOfParticipants->save([ + 'field_type' => ExtraField::FIELD_TYPE_INTEGER, + 'variable' => 'recommended_number_of_participants', + 'display_text' => get_lang('RecommendedNumberOfParticipants'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$place = new ExtraField('session'); +$place->save([ + 'field_type' => ExtraField::FIELD_TYPE_TEXT, + 'variable' => 'place', + 'display_text' => get_lang('Place'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$schedule = new ExtraField('session'); +$schedule->save([ + 'field_type' => ExtraField::FIELD_TYPE_TEXT, + 'variable' => 'schedule', + 'display_text' => get_lang('Schedule'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$allowVisitors = new ExtraField('session'); +$allowVisitors->save([ + 'field_type' => ExtraField::FIELD_TYPE_CHECKBOX, + 'variable' => 'allow_visitors', + 'display_text' => get_lang('AllowVisitors'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$modeOptions = [ + get_lang('Online'), + get_lang('Presencial'), + get_lang('B-Learning'), +]; + +$mode = new ExtraField('session'); +$mode->save([ + 'field_type' => ExtraField::FIELD_TYPE_SELECT, + 'variable' => 'mode', + 'display_text' => get_lang('Mode'), + 'visible_to_self' => 1, + 'changeable' => 1, + 'field_options' => implode('; ', $modeOptions), +]); + +$isInductionSession = new ExtraField('session'); +$isInductionSession->save([ + 'field_type' => ExtraField::FIELD_TYPE_CHECKBOX, + 'variable' => 'is_induction_session', + 'display_text' => get_lang('IsInductionSession'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$isOpenSession = new ExtraField('session'); +$isOpenSession->save([ + 'field_type' => ExtraField::FIELD_TYPE_CHECKBOX, + 'variable' => 'is_open_session', + 'display_text' => get_lang('IsOpenSession'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$duration = new ExtraField('session'); +$duration->save([ + 'field_type' => ExtraField::FIELD_TYPE_TEXT, + 'variable' => 'human_text_duration', + 'display_text' => get_lang('DurationInWords'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$showStatusOptions = [ + get_lang('Open'), + get_lang('InProcess'), + get_lang('Closed'), +]; + +$showStatus = new ExtraField('session'); +$showStatus->save([ + 'field_type' => ExtraField::FIELD_TYPE_SELECT, + 'variable' => 'show_status', + 'display_text' => get_lang('ShowStatus'), + 'visible_to_self' => 1, + 'changeable' => 1, + 'field_options' => implode('; ', $showStatusOptions), +]); + +$publicationStartDate = new ExtraField('session'); +$publicationStartDate->save([ + 'field_type' => ExtraField::FIELD_TYPE_DATE, + 'variable' => 'publication_start_date', + 'display_text' => get_lang('PublicationStartDate'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$publicationEndDate = new ExtraField('session'); +$publicationEndDate->save([ + 'field_type' => ExtraField::FIELD_TYPE_DATE, + 'variable' => 'publication_end_date', + 'display_text' => get_lang('PublicationEndDate'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$banner = new ExtraField('session'); +$banner->save([ + 'field_type' => ExtraField::FIELD_TYPE_FILE_IMAGE, + 'variable' => 'banner', + 'display_text' => get_lang('SessionBanner'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$brochure = new ExtraField('session'); +$brochure->save([ + 'field_type' => ExtraField::FIELD_TYPE_FILE, + 'variable' => 'brochure', + 'display_text' => get_lang('Brochure'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$targetOptions = [ + get_lang('Minedu'), + get_lang('Regiones'), +]; + +$target = new ExtraField('session'); +$target->save([ + 'field_type' => ExtraField::FIELD_TYPE_SELECT, + 'variable' => 'target', + 'display_text' => get_lang('TargetAudience'), + 'visible_to_self' => 1, + 'changeable' => 1, + 'field_options' => implode('; ', $targetOptions), +]); + +$shortDescription = new ExtraField('session'); +$shortDescription->save([ + 'field_type' => ExtraField::FIELD_TYPE_TEXT, + 'variable' => 'short_description', + 'display_text' => get_lang('ShortDescription'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); + +$id = new ExtraField('session'); +$id->save([ + 'field_type' => ExtraField::FIELD_TYPE_TEXT, + 'variable' => 'code', + 'display_text' => get_lang('Code'), + 'visible_to_self' => 1, + 'changeable' => 1, +]); diff --git a/plugin/advanced_subscription/src/scripts/insert_sessions_categories.php b/plugin/advanced_subscription/src/scripts/insert_sessions_categories.php new file mode 100644 index 000000000..6395be8ae --- /dev/null +++ b/plugin/advanced_subscription/src/scripts/insert_sessions_categories.php @@ -0,0 +1,21 @@ +get_lang('plugin_title')); + +$isAllowToDoRequest = $plugin->isAllowedToDoRequest($data['studentUserId'], $data, true); + +if (!$isAllowToDoRequest) { + $tpl->assign('errorMessages', $plugin->getErrorMessages()); +} + +if ( + !empty($data['sessionId']) && + !empty($data['studentUserId']) && + api_get_plugin_setting('courselegal', 'tool_enable') +) { + $lastMessageId = $plugin->getLastMessageId($data['studentUserId'], $data['sessionId']); + if ($lastMessageId !== false) { + // Render mail + $url = $plugin->getRenderMailUrl(['queueId' => $lastMessageId]); + header('Location: '.$url); + exit; + } + $courses = SessionManager::get_course_list_by_session_id($data['sessionId']); + $course = current($courses); + $data['courseId'] = $course['id']; + $legalEnabled = api_get_plugin_setting('courselegal', 'tool_enable'); + if ($legalEnabled) { + $courseLegal = CourseLegalPlugin::create(); + $termsAndConditions = $courseLegal->getData($data['courseId'], $data['sessionId']); + $termsAndConditions = $termsAndConditions['content']; + $termFiles = $courseLegal->getCurrentFile($data['courseId'], $data['sessionId']); + } else { + $termsAndConditions = $plugin->get('terms_and_conditions'); + $termFiles = ''; + } + + $data['session'] = api_get_session_info($data['sessionId']); + $data['student'] = api_get_user_info($data['studentUserId']); + $data['course'] = api_get_course_info_by_id($data['courseId']); + $data['acceptTermsUrl'] = $plugin->getQueueUrl($data); + $data['rejectTermsUrl'] = $plugin->getTermsUrl($data, ADVANCED_SUBSCRIPTION_TERMS_MODE_REJECT); + // Use Twig with String loader + $termsContent = $plugin->renderTemplateString($termsAndConditions, $data); +} else { + $termsContent = ''; + $termFiles = ''; + $data['acceptTermsUrl'] = '#'; + $data['rejectTermsUrl'] = '#'; +} + +// Assign into content +$tpl->assign('termsRejected', $data['termsRejected']); +$tpl->assign('acceptTermsUrl', $data['acceptTermsUrl']); +$tpl->assign('rejectTermsUrl', $data['rejectTermsUrl']); +$tpl->assign('session', $data['session']); +$tpl->assign('student', $data['student']); +$tpl->assign('sessionId', $data['sessionId']); +$tpl->assign('termsContent', $termsContent); +$tpl->assign('termsFiles', $termFiles); + +$content = $tpl->fetch('/advanced_subscription/views/terms_and_conditions.tpl'); +echo $content; diff --git a/plugin/advanced_subscription/test/mails.php b/plugin/advanced_subscription/test/mails.php new file mode 100644 index 000000000..824c061eb --- /dev/null +++ b/plugin/advanced_subscription/test/mails.php @@ -0,0 +1,134 @@ +get_all([ + 'variable IN ( ?, ?, ?, ?, ?)' => $fieldsArray, +]); +$fields = []; +// Index session fields +foreach ($fieldList as $field) { + $fields[$field['id']] = $field['variable']; +} + +$mergedArray = array_merge([$data['sessionId']], array_keys($fields)); +$sessionFieldValueList = $extraSession->get_all( + ['item_id = ? field_id IN ( ?, ?, ?, ?, ?, ?, ? )' => $mergedArray] +); +foreach ($sessionFieldValueList as $sessionFieldValue) { + // Check if session field value is set in session field list + if (isset($fields[$sessionFieldValue['field_id']])) { + $var = $fields[$sessionFieldValue['field_id']]; + $val = $sessionFieldValue['value']; + // Assign session field value to session + $sessionArray[$var] = $val; + } +} +// Get student data +$studentArray = api_get_user_info($data['studentUserId']); +$studentArray['picture'] = $studentArray['avatar']; + +// Get superior data if exist +$superiorId = UserManager::getFirstStudentBoss($data['studentUserId']); +if (!empty($superiorId)) { + $superiorArray = api_get_user_info($superiorId); +} else { + $superiorArray = api_get_user_info(3); +} +// Get admin data +$adminsArray = UserManager::get_all_administrators(); +$isWesternNameOrder = api_is_western_name_order(); +foreach ($adminsArray as &$admin) { + $admin['complete_name'] = $isWesternNameOrder ? + $admin['firstname'].', '.$admin['lastname'] : $admin['lastname'].', '.$admin['firstname'] + ; +} +unset($admin); +// Set data +$data['action'] = 'confirm'; +$data['student'] = $studentArray; +$data['superior'] = $superiorArray; +$data['admins'] = $adminsArray; +$data['admin'] = current($adminsArray); +$data['session'] = $sessionArray; +$data['signature'] = api_get_setting('Institution'); +$data['admin_view_url'] = api_get_path(WEB_PLUGIN_PATH). + 'advanced_subscription/src/admin_view.php?s='.$data['sessionId']; +$data['newStatus'] = ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_APPROVED; +$data['student']['acceptUrl'] = $plugin->getQueueUrl($data); +$data['newStatus'] = ADVANCED_SUBSCRIPTION_QUEUE_STATUS_BOSS_DISAPPROVED; +$data['student']['rejectUrl'] = $plugin->getQueueUrl($data); +$tpl = new Template($plugin->get_lang('plugin_title')); +$tpl->assign('data', $data); +$tplParams = [ + 'user', + 'student', + 'students', + 'superior', + 'admins', + 'admin', + 'session', + 'signature', + 'admin_view_url', + 'acceptUrl', + 'rejectUrl', +]; +foreach ($tplParams as $tplParam) { + $tpl->assign($tplParam, $data[$tplParam]); +} + +$dir = __DIR__.'/../views/'; +$files = scandir($dir); + +echo '
', '
', print_r($files, 1), '
'; + +foreach ($files as $k => &$file) { + if ( + is_file($dir.$file) && + strpos($file, '.tpl') && + $file != 'admin_view.tpl' + ) { + echo '
', $file, '
'; + echo $tpl->fetch('/advanced_subscription/views/'.$file); + } else { + unset($files[$k]); + } +} +echo '
', '
', print_r($files, 1), '
'; diff --git a/plugin/advanced_subscription/test/terms_to_pdf.php b/plugin/advanced_subscription/test/terms_to_pdf.php new file mode 100644 index 000000000..fe363fbb0 --- /dev/null +++ b/plugin/advanced_subscription/test/terms_to_pdf.php @@ -0,0 +1,47 @@ +getData($data['courseId'], $data['sessionId']); + $termsAndConditions = $termsAndConditions['content']; + $termsAndConditions = $plugin->renderTemplateString($termsAndConditions, $data); + $tpl = new Template($plugin->get_lang('Terms')); + $tpl->assign('session', $data['session']); + $tpl->assign('student', $data['student']); + $tpl->assign('sessionId', $data['sessionId']); + $tpl->assign('termsContent', $termsAndConditions); + $termsAndConditions = $tpl->fetch('/advanced_subscription/views/terms_and_conditions_to_pdf.tpl'); + $pdf = new PDF(); + $filename = 'terms'.sha1(rand(0, 99999)); + $pdf->content_to_pdf($termsAndConditions, null, $filename, null, 'F'); + $fileDir = api_get_path(WEB_ARCHIVE_PATH).$filename.'.pdf'; + echo '
', print_r($fileDir, 1), '
'; + } +} diff --git a/plugin/advanced_subscription/test/ws_session_user.php b/plugin/advanced_subscription/test/ws_session_user.php new file mode 100644 index 000000000..4bd196c20 --- /dev/null +++ b/plugin/advanced_subscription/test/ws_session_user.php @@ -0,0 +1,86 @@ + $wsUrl, + 'uri' => $wsUrl, +]; + +/** + * WS test. + */ +try { + // Init soap client + $client = new SoapClient(null, $options); + // Soap call to WS + $result = $client->__soapCall('HookAdvancedSubscription..WSSessionGetDetailsByUser', [$params]); + if (is_object($result) && isset($result->action_url)) { + echo '
'; + echo Display::url("message".$result->message, $result->action_url); + } +} catch (\Exception $e) { + var_dump($e); +} diff --git a/plugin/advanced_subscription/uninstall.php b/plugin/advanced_subscription/uninstall.php new file mode 100644 index 000000000..0de327718 --- /dev/null +++ b/plugin/advanced_subscription/uninstall.php @@ -0,0 +1,18 @@ +uninstall(); diff --git a/plugin/advanced_subscription/views/admin_accepted_notice_admin.tpl b/plugin/advanced_subscription/views/admin_accepted_notice_admin.tpl new file mode 100644 index 000000000..6bd49c602 --- /dev/null +++ b/plugin/advanced_subscription/views/admin_accepted_notice_admin.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleAdminAcceptToAdmin"| get_plugin_lang('AdvancedSubscriptionPlugin') }} 
   
   
 

{{ "MailDear" | get_plugin_lang('AdvancedSubscriptionPlugin') }}

+

{{ admin.complete_name }}

+

{{ "MailContentAdminAcceptToAdmin" | get_plugin_lang('AdvancedSubscriptionPlugin') | format(student.complete_name_with_username, session.name) }}

+

{{ "MailThankYou" | get_plugin_lang('AdvancedSubscriptionPlugin') }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/admin_accepted_notice_student.tpl b/plugin/advanced_subscription/views/admin_accepted_notice_student.tpl new file mode 100644 index 000000000..d4e4ae8cc --- /dev/null +++ b/plugin/advanced_subscription/views/admin_accepted_notice_student.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle" | get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleAdminAcceptToStudent" | get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} 
   
   
 

{{ "MailDear" | get_plugin_lang('AdvancedSubscriptionPlugin') }}

+

{{ student.complete_name }}

+

{{ "MailContentAdminAcceptToStudent" | get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name, session.date_start) }}

+

{{ "MailThankYou" | get_plugin_lang('AdvancedSubscriptionPlugin') }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/admin_accepted_notice_superior.tpl b/plugin/advanced_subscription/views/admin_accepted_notice_superior.tpl new file mode 100644 index 000000000..e072640b3 --- /dev/null +++ b/plugin/advanced_subscription/views/admin_accepted_notice_superior.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleAdminAcceptToSuperior"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(student.complete_name, session.name) }} 
   
   
 

{{ "MailDear"| get_plugin_lang('AdvancedSubscriptionPlugin') }}

+

{{ superior.complete_name }}

+

{{ "MailContentAdminAcceptToSuperior"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(student.complete_name, session.name, session.date_start) }}

+

{{ "MailThankYou"| get_plugin_lang('AdvancedSubscriptionPlugin') }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/admin_rejected_notice_admin.tpl b/plugin/advanced_subscription/views/admin_rejected_notice_admin.tpl new file mode 100644 index 000000000..3610ffd81 --- /dev/null +++ b/plugin/advanced_subscription/views/admin_rejected_notice_admin.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleAdminRejectToAdmin" | get_plugin_lang('AdvancedSubscriptionPlugin') }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ admin.complete_name }}

+

{{ "MailContentAdminRejectToAdmin"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(student.complete_name_with_username, session.name) }}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/admin_rejected_notice_student.tpl b/plugin/advanced_subscription/views/admin_rejected_notice_student.tpl new file mode 100644 index 000000000..35e1292f9 --- /dev/null +++ b/plugin/advanced_subscription/views/admin_rejected_notice_student.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleAdminRejectToStudent"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ student.complete_name }}

+

{{ "MailContentAdminRejectToStudent"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name, session.date_start) }}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/admin_rejected_notice_superior.tpl b/plugin/advanced_subscription/views/admin_rejected_notice_superior.tpl new file mode 100644 index 000000000..926d675cb --- /dev/null +++ b/plugin/advanced_subscription/views/admin_rejected_notice_superior.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleAdminRejectToSuperior"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(student.complete_name, session.name) }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ superior.complete_name }}

+

{{ "MailContentAdminRejectToSuperior"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(student.complete_name, session.name) }}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/admin_view.tpl b/plugin/advanced_subscription/views/admin_view.tpl new file mode 100644 index 000000000..532b0c7c3 --- /dev/null +++ b/plugin/advanced_subscription/views/admin_view.tpl @@ -0,0 +1,167 @@ + + + + diff --git a/plugin/advanced_subscription/views/css/style.css b/plugin/advanced_subscription/views/css/style.css new file mode 100644 index 000000000..317fca713 --- /dev/null +++ b/plugin/advanced_subscription/views/css/style.css @@ -0,0 +1,84 @@ +.text-title-select{ + display: inline-block; +} +#session-select{ + display: inline-block; +} +.title-name-session{ + display: block; + padding-top: 10px; + padding-bottom: 10px; + font-weight: normal; + margin-top: 5px; + margin-bottom: 5px; +} +.badge-dis{ + background-color: #008080; + font-size: 20px; +} +.badge-recom{ + background-color:#88aa00 ; + font-size: 20px; +} +.badge-info { + font-size: 20px; +} +.separate-badge{ + margin-bottom: 20px; + margin-top: 20px; +} +.date, .mode{ + display: inline-block; +} +.img-circle{ + border-radius: 500px; + -moz-border-radius: 500px; + -webkit-border-radius: 500px; +} +#student_table.table td{ + vertical-align: middle; + text-align: center; +} +#student_table.table td.name{ + color: #084B8A; + text-align: left; + +} +#student_table.table th{ + font-size: 14px; + vertical-align: middle; + text-align: center; +} + +#modalMail .modal-body { + height: 360px; + overflow: visible; +} + +#iframeAdvsub { + width: 100%; + height: 100%; +} + +.legal-terms-popup{ + margin-top: 5%; + margin-left: 5%; + margin-right: 5%; +} + +.legal-terms{ + width: 90%; + height: 50%; +} + +.legal-terms-buttons { + text-align: right; +} + +.legal-terms-title { + text-align: center; +} + +.advanced-subscription-decision-column { + width: 200px; +} diff --git a/plugin/advanced_subscription/views/img/aprobar.png b/plugin/advanced_subscription/views/img/aprobar.png new file mode 100644 index 000000000..90250ca75 Binary files /dev/null and b/plugin/advanced_subscription/views/img/aprobar.png differ diff --git a/plugin/advanced_subscription/views/img/avatar.png b/plugin/advanced_subscription/views/img/avatar.png new file mode 100644 index 000000000..070ec64d6 Binary files /dev/null and b/plugin/advanced_subscription/views/img/avatar.png differ diff --git a/plugin/advanced_subscription/views/img/desaprobar.png b/plugin/advanced_subscription/views/img/desaprobar.png new file mode 100644 index 000000000..1d73cd739 Binary files /dev/null and b/plugin/advanced_subscription/views/img/desaprobar.png differ diff --git a/plugin/advanced_subscription/views/img/footer.png b/plugin/advanced_subscription/views/img/footer.png new file mode 100644 index 000000000..8a7603e6a Binary files /dev/null and b/plugin/advanced_subscription/views/img/footer.png differ diff --git a/plugin/advanced_subscription/views/img/header.png b/plugin/advanced_subscription/views/img/header.png new file mode 100644 index 000000000..455806467 Binary files /dev/null and b/plugin/advanced_subscription/views/img/header.png differ diff --git a/plugin/advanced_subscription/views/img/icon-avatar.png b/plugin/advanced_subscription/views/img/icon-avatar.png new file mode 100644 index 000000000..86477a92c Binary files /dev/null and b/plugin/advanced_subscription/views/img/icon-avatar.png differ diff --git a/plugin/advanced_subscription/views/img/line.png b/plugin/advanced_subscription/views/img/line.png new file mode 100644 index 000000000..7c349e255 Binary files /dev/null and b/plugin/advanced_subscription/views/img/line.png differ diff --git a/plugin/advanced_subscription/views/open_session.tpl b/plugin/advanced_subscription/views/open_session.tpl new file mode 100644 index 000000000..842e00755 --- /dev/null +++ b/plugin/advanced_subscription/views/open_session.tpl @@ -0,0 +1,54 @@ + + + + +

+ {{ "SubscriptionToOpenSession"|get_plugin_lang('AdvancedSubscriptionPlugin') }} +

+ +{% if not is_subscribed %} +
+
    + {% for errorMessage in errorMessages %} +
  • {{ errorMessage }}
    • + {% endfor %} +
+
+ +
+ + + {{ "AcceptInfinitive"|get_plugin_lang('AdvancedSubscriptionPlugin') }} + +
+{% else %} +
+ {{ 'SuccessSubscriptionToSessionX'|get_plugin_lang('AdvancedSubscriptionPlugin')|format(session.name) }} +
+ +
+ + + {{ "GoToSessionX"|get_plugin_lang('AdvancedSubscriptionPlugin')|format(session.name) }} + +
+{% endif %} diff --git a/plugin/advanced_subscription/views/reminder_notice_admin.tpl b/plugin/advanced_subscription/views/reminder_notice_admin.tpl new file mode 100644 index 000000000..a76474063 --- /dev/null +++ b/plugin/advanced_subscription/views/reminder_notice_admin.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleReminderAdmin" | get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name)}} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ admin.complete_name }}

+

{{ "MailContentReminderAdmin" | get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name, admin_view_url)}}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/reminder_notice_student.tpl b/plugin/advanced_subscription/views/reminder_notice_student.tpl new file mode 100644 index 000000000..7ff1f5e10 --- /dev/null +++ b/plugin/advanced_subscription/views/reminder_notice_student.tpl @@ -0,0 +1,76 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleReminderStudent"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ student.complete_name }}

+

{{ "MailContentReminderStudent"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name, session.date_start) }}

+

{{ "MailContentReminderStudentSecond"| get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ "MailThankYouCollaboration"| get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/reminder_notice_superior.tpl b/plugin/advanced_subscription/views/reminder_notice_superior.tpl new file mode 100644 index 000000000..cc78893d2 --- /dev/null +++ b/plugin/advanced_subscription/views/reminder_notice_superior.tpl @@ -0,0 +1,86 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleReminderSuperior" | get_plugin_lang("AdvancedSubscriptionPlugin") }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ superior.complete_name }}

+

{{ "MailContentReminderSuperior" | get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name, session.date_start, session.description) }}

+

{{ "MailContentReminderSuperiorSecond" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+ + {% for student in students %} + + + + + + + {% endfor %} +

{{ student.complete_name }}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/reminder_notice_superior_max.tpl b/plugin/advanced_subscription/views/reminder_notice_superior_max.tpl new file mode 100644 index 000000000..cdc1c6af3 --- /dev/null +++ b/plugin/advanced_subscription/views/reminder_notice_superior_max.tpl @@ -0,0 +1,87 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleReminderMaxSuperior" | get_plugin_lang("AdvancedSubscriptionPlugin") }} 
   
   
  +

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ superior.complete_name }}

+

{{ "MailContentReminderMaxSuperior" | get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name, session.date_start, session.description) }}

+

{{ "MailContentReminderMaxSuperiorSecond" | get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.recommended_number_of_participants) }}

+ + {% for student in students %} + + + + + + + {% endfor %} +

{{ student.complete_name }}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/student_no_superior_notice_admin.tpl b/plugin/advanced_subscription/views/student_no_superior_notice_admin.tpl new file mode 100644 index 000000000..0662c13cd --- /dev/null +++ b/plugin/advanced_subscription/views/student_no_superior_notice_admin.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleStudentRequestNoSuperiorToAdmin"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(student.complete_name, session.name) }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ admin.complete_name }}

+

{{ "MailContentStudentRequestNoSuperiorToAdmin"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(student.complete_name_with_username, session.name, admin_view_url) }}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/student_no_superior_notice_student.tpl b/plugin/advanced_subscription/views/student_no_superior_notice_student.tpl new file mode 100644 index 000000000..117e54ffd --- /dev/null +++ b/plugin/advanced_subscription/views/student_no_superior_notice_student.tpl @@ -0,0 +1,76 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleStudentRequestNoSuperiorToStudent"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name) }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ student.complete_name }}

+

{{ "MailContentStudentRequestNoSuperiorToStudent"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name, session.date_start) }}

+

{{ "MailContentStudentRequestNoSuperiorToStudentSecond"| get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/student_notice_student.tpl b/plugin/advanced_subscription/views/student_notice_student.tpl new file mode 100644 index 000000000..b3a473449 --- /dev/null +++ b/plugin/advanced_subscription/views/student_notice_student.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleStudentRequestToStudent"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name) }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ student.complete_name }}

+

{{ "MailContentStudentRequestToStudent"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name, session.date_start) }}

+

{{ "MailContentStudentRequestToStudentSecond" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/student_notice_superior.tpl b/plugin/advanced_subscription/views/student_notice_superior.tpl new file mode 100644 index 000000000..65c9ab98d --- /dev/null +++ b/plugin/advanced_subscription/views/student_notice_superior.tpl @@ -0,0 +1,84 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleStudentRequestToSuperior" | get_plugin_lang("AdvancedSubscriptionPlugin") }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ superior.complete_name }}

+

{{ "MailContentStudentRequestToSuperior" | get_plugin_lang("AdvancedSubscriptionPlugin") | format(student.complete_name, session.name, session.date_start, session.description) }}

+

{{ "MailContentStudentRequestToSuperiorSecond" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+ + + + + + + +

{{ student.complete_name }}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/superior_accepted_notice_admin.tpl b/plugin/advanced_subscription/views/superior_accepted_notice_admin.tpl new file mode 100644 index 000000000..2a15922c6 --- /dev/null +++ b/plugin/advanced_subscription/views/superior_accepted_notice_admin.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleSuperiorAcceptToAdmin"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(student.complete_name, session.name) }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ admin.complete_name }}

+

{{ "MailContentSuperiorAcceptToAdmin"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(student.complete_name_with_username, session.name, admin_view_url) }}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/superior_accepted_notice_student.tpl b/plugin/advanced_subscription/views/superior_accepted_notice_student.tpl new file mode 100644 index 000000000..b2d39fe69 --- /dev/null +++ b/plugin/advanced_subscription/views/superior_accepted_notice_student.tpl @@ -0,0 +1,76 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleSuperiorAcceptToStudent" | get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name) }} 
   
   
  +

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ student.complete_name }}

+

{{ "MailContentSuperiorAcceptToStudent" | get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name ) }}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/superior_accepted_notice_superior.tpl b/plugin/advanced_subscription/views/superior_accepted_notice_superior.tpl new file mode 100644 index 000000000..938d3057f --- /dev/null +++ b/plugin/advanced_subscription/views/superior_accepted_notice_superior.tpl @@ -0,0 +1,76 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleSuperiorAcceptToSuperior"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(student.complete_name) }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ superior.complete_name }}

+

{{ "MailContentSuperiorAcceptToSuperior"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name, student.complete_name) }}

+

{{ "MailContentSuperiorAcceptToSuperiorSecond"| get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ "MailThankYouCollaboration" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/superior_rejected_notice_student.tpl b/plugin/advanced_subscription/views/superior_rejected_notice_student.tpl new file mode 100644 index 000000000..4e16e121c --- /dev/null +++ b/plugin/advanced_subscription/views/superior_rejected_notice_student.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleSuperiorRejectToStudent" | get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name) }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ student.complete_name }}

+

{{ "MailContentSuperiorRejectToStudent" | get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name) }}

+

{{ "MailThankYou" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/superior_rejected_notice_superior.tpl b/plugin/advanced_subscription/views/superior_rejected_notice_superior.tpl new file mode 100644 index 000000000..bf8b06ac5 --- /dev/null +++ b/plugin/advanced_subscription/views/superior_rejected_notice_superior.tpl @@ -0,0 +1,75 @@ + + + + + {{ "MailTitle"| get_plugin_lang('AdvancedSubscriptionPlugin') | format(session.name) }} + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 Ministerio de Educación 
   
   
 {{ "MailTitleSuperiorRejectToSuperior"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(student.complete_name) }} 
   
   
 

{{ "MailDear" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ superior.complete_name }}

+

{{ "MailContentSuperiorRejectToSuperior"| get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name, student.complete_name) }}

+

{{ "MailThankYouCollaboration" | get_plugin_lang("AdvancedSubscriptionPlugin") }}

+

{{ signature }}

 
   
 
+ + diff --git a/plugin/advanced_subscription/views/terms_and_conditions.tpl b/plugin/advanced_subscription/views/terms_and_conditions.tpl new file mode 100644 index 000000000..540fbd367 --- /dev/null +++ b/plugin/advanced_subscription/views/terms_and_conditions.tpl @@ -0,0 +1,61 @@ +{# start copy from head.tpl #} + + + + +{{ prefetch }} +{{ favico }} +{{ browser_specific_head }} + + + +{# Use the latest engine in ie8/ie9 or use google chrome engine if available #} +{# Improve usability in portal devices #} + +{{ title_string }} +{{ css_static_file_to_string }} +{{ js_file_to_string }} +{{ css_custom_file_to_string }} +{{ css_style_print }} +{# end copy from head.tpl #} +

+{{ "TermsAndConditions" | get_lang }} +

+{% if termsRejected == 1 %} +
+ {{ "YouMustAcceptTermsAndConditions" | get_plugin_lang("AdvancedSubscriptionPlugin") | format(session.name) }} +
+{% endif %} + +{% if errorMessages is defined %} +
+
    + {% for errorMessage in errorMessages %} +
  • {{ errorMessage }}
    • + {% endfor %} +
+
+{% endif %} + +
+ {{ termsContent }} +
+
+ {{ termsFiles }} +
+
+ + {{ "AcceptInfinitive" | get_plugin_lang("AdvancedSubscriptionPlugin") }} + + + {{ "RejectInfinitive" | get_plugin_lang("AdvancedSubscriptionPlugin") }} + +
+ + \ No newline at end of file diff --git a/plugin/advanced_subscription/views/terms_and_conditions_to_pdf.tpl b/plugin/advanced_subscription/views/terms_and_conditions_to_pdf.tpl new file mode 100644 index 000000000..dcbbc810e --- /dev/null +++ b/plugin/advanced_subscription/views/terms_and_conditions_to_pdf.tpl @@ -0,0 +1,23 @@ +{# start copy from head.tpl #} + + + + +{{ prefetch }} +{{ favico }} +{{ browser_specific_head }} + + + + +{# Use the latest engine in ie8/ie9 or use google chrome engine if available #} +{# Improve usability in portal devices #} + +{{ title_string }} +{{ css_file_to_string }} +{{ css_style_print }} +{{ js_file_to_string }} +{# end copy from head.tpl #} +
+ {{ termsContent }} +
\ No newline at end of file diff --git a/plugin/ai_helper/AiHelperPlugin.php b/plugin/ai_helper/AiHelperPlugin.php new file mode 100644 index 000000000..868d56269 --- /dev/null +++ b/plugin/ai_helper/AiHelperPlugin.php @@ -0,0 +1,421 @@ + '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 available. + * + * @return array + */ + public function getApiList() + { + $list = [ + self::OPENAI_API => 'OpenAI', + self::DEEPSEEK_API => 'DeepSeek', + ]; + + return $list; + } + + /** + * Get the completion text from the selected API. + * + * @return string|array + */ + public function getCompletionText(string $prompt, string $toolName) + { + if (!$this->validateUserTokensLimit(api_get_user_id())) { + return [ + 'error' => true, + 'message' => $this->get_lang('ErrorTokensLimit'), + ]; + } + + $apiName = $this->get('api_name'); + + switch ($apiName) { + case self::OPENAI_API: + return $this->openAiGetCompletionText($prompt, $toolName); + case self::DEEPSEEK_API: + return $this->deepSeekGetCompletionText($prompt, $toolName); + default: + return [ + 'error' => true, + 'message' => 'API not supported.', + ]; + } + } + + /** + * Get completion text from OpenAI. + */ + public function openAiGetCompletionText(string $prompt, string $toolName) + { + try { + require_once __DIR__.'/src/openai/OpenAi.php'; + + $apiKey = $this->get('api_key'); + $organizationId = $this->get('organization_id'); + + $ai = new OpenAi($apiKey, $organizationId); + + $params = [ + 'model' => 'gpt-3.5-turbo-instruct', + 'prompt' => $prompt, + 'temperature' => 0.2, + 'max_tokens' => 2000, + 'frequency_penalty' => 0, + 'presence_penalty' => 0.6, + 'top_p' => 1.0, + ]; + + $complete = $ai->completion($params); + $result = json_decode($complete, true); + + if (isset($result['error'])) { + $errorMessage = $result['error']['message'] ?? 'Unknown error'; + error_log("OpenAI Error: $errorMessage"); + + return [ + 'error' => true, + 'message' => $errorMessage, + ]; + } + + $resultText = $result['choices'][0]['text'] ?? ''; + + if (!empty($resultText)) { + $this->saveRequest([ + 'user_id' => api_get_user_id(), + 'tool_name' => $toolName, + 'prompt' => $prompt, + 'prompt_tokens' => (int) ($result['usage']['prompt_tokens'] ?? 0), + 'completion_tokens' => (int) ($result['usage']['completion_tokens'] ?? 0), + 'total_tokens' => (int) ($result['usage']['total_tokens'] ?? 0), + ]); + } + + return $resultText ?: 'No response generated.'; + } catch (Exception $e) { + return [ + 'error' => true, + 'message' => 'An error occurred while connecting to OpenAI: '.$e->getMessage(), + ]; + } + } + + /** + * Get completion text from DeepSeek. + */ + public function deepSeekGetCompletionText(string $prompt, string $toolName) + { + $apiKey = $this->get('api_key'); + + $url = 'https://api.deepseek.com/chat/completions'; + + $payload = [ + 'model' => 'deepseek-chat', + 'messages' => [ + [ + 'role' => 'system', + 'content' => ($toolName === 'quiz') + ? 'You are a helpful assistant that generates Aiken format questions.' + : 'You are a helpful assistant that generates learning path contents.', + ], + [ + 'role' => 'user', + 'content' => $prompt, + ], + ], + 'stream' => false, + ]; + + $ch = curl_init($url); + curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); + curl_setopt($ch, CURLOPT_POST, true); + curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload)); + curl_setopt($ch, CURLOPT_HTTPHEADER, [ + 'Content-Type: application/json', + "Authorization: Bearer $apiKey", + ]); + + $response = curl_exec($ch); + + if ($response === false) { + error_log('cURL error: '.curl_error($ch)); + curl_close($ch); + + return ['error' => true, 'message' => 'Request to AI provider failed.']; + } + + curl_close($ch); + + $result = json_decode($response, true); + + if (isset($result['error'])) { + return [ + 'error' => true, + 'message' => $result['error']['message'] ?? 'Unknown error', + ]; + } + + $resultText = $result['choices'][0]['message']['content'] ?? ''; + $this->saveRequest([ + 'user_id' => api_get_user_id(), + 'tool_name' => $toolName, + 'prompt' => $prompt, + 'prompt_tokens' => 0, + 'completion_tokens' => 0, + 'total_tokens' => 0, + ]); + + return $resultText; + } + + /** + * Generate questions based on the selected AI provider. + * + * @param int $nQ Number of questions + * @param string $lang Language for the questions + * @param string $topic Topic of the questions + * @param string $questionType Type of questions (e.g., 'multiple_choice') + * + * @throws Exception If an error occurs + * + * @return string Questions generated in Aiken format + */ + public function generateQuestions(int $nQ, string $lang, string $topic, string $questionType = 'multiple_choice'): string + { + $apiName = $this->get('api_name'); + + switch ($apiName) { + case self::OPENAI_API: + return $this->generateOpenAiQuestions($nQ, $lang, $topic, $questionType); + case self::DEEPSEEK_API: + return $this->generateDeepSeekQuestions($nQ, $lang, $topic, $questionType); + default: + throw new Exception("Unsupported API provider: $apiName"); + } + } + + /** + * 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), + ] + ); + } + + /** + * Generate questions using OpenAI. + */ + private function generateOpenAiQuestions(int $nQ, string $lang, string $topic, string $questionType): string + { + $prompt = sprintf( + '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.', + $nQ, + $questionType, + $lang, + $topic + ); + + $result = $this->openAiGetCompletionText($prompt, 'quiz'); + if (isset($result['error']) && true === $result['error']) { + throw new Exception($result['message']); + } + + return $result; + } + + /** + * Generate questions using DeepSeek. + */ + private function generateDeepSeekQuestions(int $nQ, string $lang, string $topic, string $questionType): string + { + $apiKey = $this->get('api_key'); + $prompt = sprintf( + '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.', + $nQ, + $questionType, + $lang, + $topic + ); + $payload = [ + 'model' => 'deepseek-chat', + 'messages' => [ + [ + 'role' => 'system', + 'content' => 'You are a helpful assistant that generates Aiken format questions.', + ], + [ + 'role' => 'user', + 'content' => $prompt, + ], + ], + 'stream' => false, + ]; + + $deepSeek = new DeepSeek($apiKey); + $response = $deepSeek->generateQuestions($payload); + + return $response; + } +} diff --git a/plugin/ai_helper/Entity/Requests.php b/plugin/ai_helper/Entity/Requests.php new file mode 100644 index 000000000..85931cda6 --- /dev/null +++ b/plugin/ai_helper/Entity/Requests.php @@ -0,0 +1,171 @@ +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; + } +} diff --git a/plugin/ai_helper/README.md b/plugin/ai_helper/README.md new file mode 100644 index 000000000..fb245d8b8 --- /dev/null +++ b/plugin/ai_helper/README.md @@ -0,0 +1,68 @@ +AI Helper Plugin +====== + +Version 1.2 + +> This plugin is designed to integrate AI functionality into Chamilo, providing tools for generating educational content, such as quizzes or learning paths, using AI providers like OpenAI or DeepSeek. + +--- + +### Overview + +The AI Helper plugin integrates into parts of the Chamilo platform that are most useful to teachers/trainers or learners. It allows pre-generating content, letting teachers/trainers review it before publishing. + +Currently, this plugin is integrated into: + +- **Exercises:** In the Aiken import form, with options to generate questions using OpenAI or DeepSeek. +- **Learnpaths:** Option to create structured learning paths with OpenAI or DeepSeek. + +--- + +### Supported AI Providers + +#### OpenAI/ChatGPT +The plugin, created in early 2023, supports OpenAI's ChatGPT API. +- **Setup:** +1. Create an account at [OpenAI](https://platform.openai.com/signup) (or login if you already have one). +2. Generate a secret key at [API Keys](https://platform.openai.com/account/api-keys). +3. Click "Create new secret key", copy the key, and paste it into the "API key" field in the plugin configuration. + +#### DeepSeek +DeepSeek is an alternative Open Source AI provider. +- **Setup:** +1. Create an account at [DeepSeek](https://www.deepseek.com/) (or login if you already have one). +2. Generate an API key at [API Keys](https://platform.deepseek.com/api_keys). +3. Click "Create new API key", copy the key, and paste it into the "API key" field in the plugin configuration. + +--- + +### Features + +- Generate quizzes in the Aiken format using AI. +- Create structured learning paths with AI assistance. +- Support for multiple AI providers, enabling easy switching between OpenAI and DeepSeek. +- Tracks API requests for monitoring usage and limits. + +--- + +### Database Requirements + +No additional database changes are required for v1.2. +The existing table `plugin_ai_helper_requests` is sufficient for tracking requests from both OpenAI and DeepSeek. + +If you're updating from **v1.0**, ensure the following table exists: + +```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. diff --git a/plugin/ai_helper/install.php b/plugin/ai_helper/install.php new file mode 100644 index 000000000..ec2627011 --- /dev/null +++ b/plugin/ai_helper/install.php @@ -0,0 +1,16 @@ +install(); diff --git a/plugin/ai_helper/lang/english.php b/plugin/ai_helper/lang/english.php new file mode 100644 index 000000000..36ede273f --- /dev/null +++ b/plugin/ai_helper/lang/english.php @@ -0,0 +1,20 @@ +get_info(); diff --git a/plugin/ai_helper/src/deepseek/DeepSeek.php b/plugin/ai_helper/src/deepseek/DeepSeek.php new file mode 100644 index 000000000..e50494f48 --- /dev/null +++ b/plugin/ai_helper/src/deepseek/DeepSeek.php @@ -0,0 +1,91 @@ +apiKey = $apiKey; + $this->headers = [ + 'Content-Type: application/json', + "Authorization: Bearer {$this->apiKey}", + ]; + } + + /** + * Generate questions using the DeepSeek API. + * + * @param array $payload Data to send to the API + * + * @throws Exception If an error occurs during the request + * + * @return string Decoded response from the API + */ + public function generateQuestions(array $payload): string + { + $url = DeepSeekUrl::completionsUrl(); + $response = $this->sendRequest($url, 'POST', $payload); + + if (empty($response)) { + throw new Exception('The DeepSeek API returned no response.'); + } + + $result = json_decode($response, true); + + // Validate errors returned by the API + if (isset($result['error'])) { + throw new Exception("DeepSeek API Error: {$result['error']['message']}"); + } + + // Ensure the response contains the expected "choices" field + if (!isset($result['choices'][0]['message']['content'])) { + throw new Exception('Unexpected response format from the DeepSeek API.'); + } + + return $result['choices'][0]['message']['content']; + } + + /** + * Send a request to the DeepSeek API. + * + * @param string $url Endpoint to send the request to + * @param string $method HTTP method (e.g., GET, POST) + * @param array $data Data to send as JSON + * + * @throws Exception If a cURL error occurs + * + * @return string Raw response from the API + */ + private function sendRequest(string $url, string $method, array $data = []): string + { + $ch = curl_init($url); + + curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); + curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method); + curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data)); + curl_setopt($ch, CURLOPT_HTTPHEADER, $this->headers); + + $response = curl_exec($ch); + $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); + + if (curl_errno($ch)) { + $errorMessage = curl_error($ch); + curl_close($ch); + throw new Exception("cURL Error: {$errorMessage}"); + } + + curl_close($ch); + + // Validate HTTP status codes + if ($httpCode < 200 || $httpCode >= 300) { + throw new Exception("Request to DeepSeek failed with HTTP status code: {$httpCode}"); + } + + return $response; + } +} diff --git a/plugin/ai_helper/src/deepseek/DeepSeekUrl.php b/plugin/ai_helper/src/deepseek/DeepSeekUrl.php new file mode 100644 index 000000000..5d9b1453d --- /dev/null +++ b/plugin/ai_helper/src/deepseek/DeepSeekUrl.php @@ -0,0 +1,17 @@ +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(array $opts, callable $stream = null) + { + if ($stream !== null && isset($opts['stream']) && $opts['stream']) { + $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 = []): string + { + $post_fields = json_encode($opts); + + if (isset($opts['file']) || isset($opts['image'])) { + $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 (empty($opts)) { + unset($curl_info[CURLOPT_POSTFIELDS]); + } + + if (isset($opts['stream']) && $opts['stream']) { + $curl_info[CURLOPT_WRITEFUNCTION] = $this->streamMethod; + } + + $curl = curl_init(); + + curl_setopt_array($curl, $curl_info); + $response = curl_exec($curl); + $httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE); + + if (curl_errno($curl)) { + $errorMessage = curl_error($curl); + curl_close($curl); + throw new Exception("cURL Error: {$errorMessage}"); + } + + curl_close($curl); + + if ($httpCode === 429) { + throw new Exception("Insufficient quota. Please check your OpenAI account plan and billing details."); + } + + if ($httpCode < 200 || $httpCode >= 300) { + throw new Exception("HTTP Error: {$httpCode}, Response: {$response}"); + } + + return $response; + } +} diff --git a/plugin/ai_helper/src/openai/OpenAiUrl.php b/plugin/ai_helper/src/openai/OpenAiUrl.php new file mode 100644 index 000000000..1b05ea2a0 --- /dev/null +++ b/plugin/ai_helper/src/openai/OpenAiUrl.php @@ -0,0 +1,74 @@ +generateQuestions($nQ, $lang, $topic, $questionType); + + echo json_encode([ + 'success' => true, + 'text' => trim($resultText), + ]); +} catch (Exception $e) { + error_log("Error: ".$e->getMessage()); + echo json_encode([ + 'success' => false, + 'text' => $e->getMessage(), + ]); +} diff --git a/plugin/ai_helper/tool/learnpath.php b/plugin/ai_helper/tool/learnpath.php new file mode 100644 index 000000000..05f20c8dd --- /dev/null +++ b/plugin/ai_helper/tool/learnpath.php @@ -0,0 +1,218 @@ +getApiList(); +$apiName = $plugin->get('api_name'); + +if (!in_array($apiName, array_keys($apiList))) { + echo json_encode(['success' => false, 'text' => 'AI Provider not available.']); + exit; +} + +$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 fewer chapters on the topic "%s". Return it as a list of items separated by new lines. Do not include a conclusion chapter.'; +$prompt = sprintf($messageGetItems, $courseLanguage, $chaptersCount, $topic); + +$resultText = $plugin->getCompletionText($prompt, 'learnpath'); + +if (isset($resultText['error']) && $resultText['error']) { + echo json_encode(['success' => false, 'text' => $resultText['message']]); + exit; +} + +if (empty($resultText)) { + echo json_encode(['success' => false, 'text' => 'AI returned no results.']); + 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 .= ''; + + $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->getCompletionText($promptItem, 'learnpath'); + if (isset($resultContentText['error']) && $resultContentText['error']) { + continue; + } + $lpItemContent = (!empty($resultContentText) ? trim($resultContentText) : ''); + if (false !== stripos($lpItemContent, '')) { + $lpItemContent = preg_replace("||i", "\r\n$style\r\n\\0", $lpItemContent); + } else { + $lpItemContent = ''.trim($title).''.$style.''.$lpItemContent.''; + } + $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->getCompletionText($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); diff --git a/plugin/ai_helper/uninstall.php b/plugin/ai_helper/uninstall.php new file mode 100644 index 000000000..e9729b1e3 --- /dev/null +++ b/plugin/ai_helper/uninstall.php @@ -0,0 +1,16 @@ +uninstall(); diff --git a/plugin/azure_active_directory/CHANGELOG.md b/plugin/azure_active_directory/CHANGELOG.md new file mode 100644 index 000000000..f2c618ee3 --- /dev/null +++ b/plugin/azure_active_directory/CHANGELOG.md @@ -0,0 +1,48 @@ +# Azure Active Directory Changelog + +## 2.5 - 2024-11-18 + +* Added new options to get the user and groups with delta query (or change tracking) when syncing with scripts. +this requires manually doing the following changes to your database if you are upgrading from v2.4 +```sql +CREATE TABLE azure_ad_sync_state (id INT AUTO_INCREMENT NOT NULL, title VARCHAR(255) NOT NULL, value LONGTEXT NOT NULL, created_at DATETIME NOT NULL, updated_at DATETIME NOT NULL, PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB; +``` + +## 2.4 - 2024-08-28 + +* Added a new user extra field to save the unique Azure ID (internal UID). +This requires manually doing the following changes to your database if you are upgrading from v2.3 +```sql +INSERT INTO extra_field (extra_field_type, field_type, variable, display_text, default_value, field_order, visible_to_self, visible_to_others, changeable, filter, created_at) VALUES (1, 1, 'azure_uid', 'Azure UID (internal ID)', '', 1, null, null, null, null, '2024-08-28 00:00:00'); +``` +* Added a new option to set the order to verify the existing user in Chamilo +```sql +INSERT INTO settings_current (variable, subkey, type, category, selected_value, title, comment, scope, subkeytext, access_url, access_url_changeable, access_url_locked) VALUES ('azure_active_directory_existing_user_verification_order', 'azure_active_directory', 'setting', 'Plugins', '', 'azure_active_directory', '', '', '', 1, 1, 0); +``` +* Added a new option to update user info during the login proccess. +```sql +INSERT INTO settings_current (variable, subkey, type, category, selected_value, title, comment, scope, subkeytext, access_url, access_url_changeable, access_url_locked) VALUES ('azure_active_directory_update_users', 'azure_active_directory', 'setting', 'Plugins', '', 'azure_active_directory', '', '', '', 1, 1, 0); +``` +* Added new scripts to syncronize users and groups with users and usergroups (classes). And an option to deactivate accounts in Chamilo that do not exist in Azure. +```sql +INSERT INTO settings_current (variable, subkey, type, category, selected_value, title, comment, scope, subkeytext, access_url, access_url_changeable, access_url_locked) VALUES ('azure_active_directory_tenant_id', 'azure_active_directory', 'setting', 'Plugins', '', 'azure_active_directory', '', '', '', 1, 1, 0); +INSERT INTO settings_current (variable, subkey, type, category, selected_value, title, comment, scope, subkeytext, access_url, access_url_changeable, access_url_locked) VALUES ('azure_active_directory_deactivate_nonexisting_users', 'azure_active_directory', 'setting', 'Plugins', '', 'azure_active_directory', '', '', '', 1, 1, 0); +``` + +## 2.3 - 2021-03-30 + +* Added admin, session admin and teacher groups. This requires adding the following fields to your database if + upgrading from a previous version of the plugin manually: +``` +INSERT INTO settings_current (variable, subkey, type, category, selected_value, title, comment, scope, subkeytext, access_url, access_url_changeable, access_url_locked) VALUES ('azure_active_directory_group_id_admin', 'azure_active_directory', 'setting', 'Plugins', '', 'azure_active_directory', '', null, null, 1, 1, 0); +INSERT INTO settings_current (variable, subkey, type, category, selected_value, title, comment, scope, subkeytext, access_url, access_url_changeable, access_url_locked) VALUES ('azure_active_directory_group_id_session_admin', 'azure_active_directory', 'setting', 'Plugins', '', 'azure_active_directory', '', null, null, 1, 1, 0); +INSERT INTO settings_current (variable, subkey, type, category, selected_value, title, comment, scope, subkeytext, access_url, access_url_changeable, access_url_locked) VALUES ('azure_active_directory_group_id_teacher', 'azure_active_directory', 'setting', 'Plugins', '', 'azure_active_directory', '', null, null, 1, 1, 0); +``` + +## 2.2 - 2021-03-02 + +* Added provisioning setting + +## 2.1 - 2020 + +* Initial tested implementation of Azure Active Directory single sign on \ No newline at end of file diff --git a/plugin/azure_active_directory/README.md b/plugin/azure_active_directory/README.md new file mode 100644 index 000000000..460199dc3 --- /dev/null +++ b/plugin/azure_active_directory/README.md @@ -0,0 +1,46 @@ +# The Azure Active Directory Plugin + +This plugin allows users to authenticate (with OAuth2) through Microsoft's Azure Active Directory. +This will modify the login form to either substitute the default login form or add another option to connect through +Azure. +An option allows you to automatically provision/create users in Chamilo from their account on Azure if they don't exist +in Chamilo yet. + +This plugin adds two extra fields for users: + +* `organisationemail`, the email registered in Azure Active Directory for each user (under _Email_ in the _Contact info_ section). +* `azure_id`, to save the internal ID for each user in Azure (which is also the prefix before the _@_ sign in the _User Principal Name_). + +### Prerequisites +This plugin will *not* work if you do not use HTTPS. +Make sure your portal is in HTTPS before you configure this plugin. + +### To configure Azure Active Directory +* Create and configure an application in your Azure panel (Azure Active Directory -> Applications registration -> New registration)). +* In the _Authentication_ section, set an _Reply URL_ (or _Redirect URIs_) of `https://{CHAMILO_URL}/plugin/azure_active_directory/src/callback.php`. +* In the _Front-channel logout URL_, use `https://{CHAMILO_URL}/index.php?logout=logout`. +* Leave the rest of the _Authentication_ section unchanged. +* In _Certificates & secrets_, create a secret string (or application password). Keep the _Value_ field at hand. If you don't copy it somewhere at this point, it will later be hidden, so take a copy, seriously! +* Make sure you actually have users. + +### To configure this plugin +* _Enable_: You can enable the plugin once everything is configured correctly. Disabling it will return to the normal Chamilo login procedure. +* _Application ID_: Enter the _Application (client) ID_ assigned to your app when you created it in your Azure Active Directory interface, under _App registrations_. +* _Application secret_: Enter the client secret _value_ created in _Certificate & secrets_ above. +* _Block name_: (Optional) The name to show above the login button. +* _Force logout button_: (Optional) Add a button to force logout from Azure. +* _Management login_: (Optional) Disable the chamilo login and enable an alternative login page for users. + You will need copy the `/plugin/azure_active_directory/layout/login_form.tpl` file to `/main/template/overrides/layout/` directory. +* _Name for the management login_: A name for the manager login. By default, it is set to "Management Login". +* _Automated provisioning_: Enable if you want users to be created automatically in Chamilo (as students) when they don't exist yet. +* Assign a region in which the login option will appear. Preferably `login_bottom`. + +### Enable through the normal login form +You can configure the external login procedure to work with the classic Chamilo form login. +To do it, make sure users have _azure_ in their auth_source field, then add this line in `configuration.php` file +```php +$extAuthSource["azure"]["login"] = $_configuration['root_sys']."main/auth/external_login/login.azure.php"; +``` + +### Dependencies +> This plugin uses the [`thenetworg/oauth2-azure`](https://github.com/TheNetworg/oauth2-azure) package. diff --git a/plugin/azure_active_directory/index.php b/plugin/azure_active_directory/index.php new file mode 100644 index 000000000..d966e32eb --- /dev/null +++ b/plugin/azure_active_directory/index.php @@ -0,0 +1,38 @@ + + * + * @package chamilo.plugin.azure_active_directory + */ + +// Check if AzureActiveDirectory exists, since this is not loaded as a page. +// index.php is shown as a block when showing the region to which the plugin is assigned +if (class_exists(AzureActiveDirectory::class)) { + /** @var AzureActiveDirectory $activeDirectoryPlugin */ + $activeDirectoryPlugin = AzureActiveDirectory::create(); + + if ($activeDirectoryPlugin->get(AzureActiveDirectory::SETTING_ENABLE) === 'true') { + $_template['block_title'] = $activeDirectoryPlugin->get(AzureActiveDirectory::SETTING_BLOCK_NAME); + + $_template['signin_url'] = $activeDirectoryPlugin->getUrl(AzureActiveDirectory::URL_TYPE_AUTHORIZE); + + if ('true' === $activeDirectoryPlugin->get(AzureActiveDirectory::SETTING_FORCE_LOGOUT_BUTTON)) { + $_template['signout_url'] = $activeDirectoryPlugin->getUrl(AzureActiveDirectory::URL_TYPE_LOGOUT); + } + + $managementLoginEnabled = 'true' === $activeDirectoryPlugin->get(AzureActiveDirectory::SETTING_MANAGEMENT_LOGIN_ENABLE); + + $_template['management_login_enabled'] = $managementLoginEnabled; + + if ($managementLoginEnabled) { + $managementLoginName = $activeDirectoryPlugin->get(AzureActiveDirectory::SETTING_MANAGEMENT_LOGIN_NAME); + + if (empty($managementLoginName)) { + $managementLoginName = $activeDirectoryPlugin->get_lang('ManagementLogin'); + } + + $_template['management_login_name'] = $managementLoginName; + } + } +} diff --git a/plugin/azure_active_directory/install.php b/plugin/azure_active_directory/install.php new file mode 100644 index 000000000..b1a74509a --- /dev/null +++ b/plugin/azure_active_directory/install.php @@ -0,0 +1,8 @@ +install(); diff --git a/plugin/azure_active_directory/lang/dutch.php b/plugin/azure_active_directory/lang/dutch.php new file mode 100644 index 000000000..22d229cd8 --- /dev/null +++ b/plugin/azure_active_directory/lang/dutch.php @@ -0,0 +1,54 @@ + + * + * @package chamilo.plugin.azure_active_directory + */ +$strings['plugin_title'] = 'Azure Active Directory'; +$strings['plugin_comment'] = 'Sta authenticatie met Microsoft\'s Azure Active Directory toe'; + +$strings['enable'] = 'Inschakelen'; +$strings['app_id'] = 'Applicatie ID'; +$strings['app_id_help'] = 'Voeg de Applicatie Id toegewezen aan uw app bij de Azure portal, b.v. 580e250c-8f26-49d0-bee8-1c078add1609'; +$strings['app_secret'] = 'Applicatie gehem'; +$strings['force_logout'] = 'Forceer uitlogknop'; +$strings['force_logout_help'] = 'Toon een knop om afmeldingssessie van Azure af te dwingen.'; +$strings['block_name'] = 'Blok naam'; +$strings['management_login_enable'] = 'Beheer login'; +$strings['management_login_enable_help'] = 'Schakel de chamilo-login uit en schakel een alternatieve inlogpagina in voor gebruikers.
' + .'U zult moeten kopiëren de /plugin/azure_active_directory/layout/login_form.tpl bestand in het /main/template/overrides/layout/ dossier.'; +$strings['management_login_name'] = 'Naam voor de beheeraanmelding'; +$strings['management_login_name_help'] = 'De standaardinstelling is "Beheer login".'; +$strings['existing_user_verification_order'] = 'Existing user verification order'; +$strings['existing_user_verification_order_help'] = 'This value indicates the order in which the user will be searched in Chamilo to verify its existence. ' + .'By default is 1, 2, 3.' + .'
  1. EXTRA_FIELD_ORGANISATION_EMAIL (mail)
  2. EXTRA_FIELD_AZURE_ID (mailNickname)
  3. EXTRA_FIELD_AZURE_UID (id of objectId)
'; +$strings['OrganisationEmail'] = 'Organisatie e-mail'; +$strings['AzureId'] = 'Azure ID (mailNickname)'; +$strings['AzureUid'] = 'Azure UID (internal ID)'; +$strings['ManagementLogin'] = 'Beheer Login'; +$strings['InvalidId'] = 'Deze identificatie is niet geldig (verkeerde log-in of wachtwoord). Errocode: AZMNF'; +$strings['provisioning'] = 'Geautomatiseerde inrichting'; +$strings['update_users'] = 'Update users'; +$strings['update_users_help'] = 'Allow user data to be updated at the start of the session.'; +$strings['provisioning_help'] = 'Maak automatisch nieuwe gebruikers (als studenten) vanuit Azure wanneer ze niet in Chamilo zijn.'; +$strings['group_id_admin'] = 'Groeps-ID voor platformbeheerders'; +$strings['group_id_admin_help'] = 'De groeps-ID is te vinden in de details van de gebruikersgroep en ziet er ongeveer zo uit: ae134eef-cbd4-4a32-ba99-49898a1314b6. Indien leeg, wordt er automatisch geen gebruiker aangemaakt als admin.'; +$strings['group_id_session_admin'] = 'Groeps-ID voor sessiebeheerders'; +$strings['group_id_session_admin_help'] = 'De groeps-ID voor sessiebeheerders. Indien leeg, wordt er automatisch geen gebruiker aangemaakt als sessiebeheerder.'; +$strings['group_id_teacher'] = 'Groeps-ID voor docenten'; +$strings['group_id_teacher_help'] = 'De groeps-ID voor docenten. Indien leeg, wordt er automatisch geen gebruiker aangemaakt als docent.'; +$strings['additional_interaction_required'] = 'Er is aanvullende interactie vereist om u te authenticeren. Log rechtstreeks in via uw authenticatiesysteem en kom dan terug naar deze pagina om in te loggen.'; +$strings['tenant_id'] = 'Mandanten-ID'; +$strings['tenant_id_help'] = 'Required to run scripts.'; +$strings['deactivate_nonexisting_users'] = 'Deactivate non-existing users'; +$strings['deactivate_nonexisting_users_help'] = 'Compare registered users in Chamilo with those in Azure and deactivate accounts in Chamilo that do not exist in Azure.'; +$strings['script_users_delta'] = 'Delta query for users'; +$strings['script_users_delta_help'] = 'Get newly created, updated, or deleted users without having to perform a full read of the entire user collection. By default, is No.'; +$strings['script_usergroups_delta'] = 'Delta query for usergroups'; +$strings['script_usergroups_delta_help'] = 'Get newly created, updated, or deleted groups, including group membership changes, without having to perform a full read of the entire group collection. By default, is No.'; +$strings['group_filter_regex'] = 'Group filter RegEx'; +$strings['group_filter_regex_help'] = 'Regular expression to filter groups (only matches will be synchronized), e.g. .*-FIL-.* .*-PAR-.* .*(FIL|PAR).* ^(FIL|PAR).*'; diff --git a/plugin/azure_active_directory/lang/english.php b/plugin/azure_active_directory/lang/english.php new file mode 100644 index 000000000..8cfd60969 --- /dev/null +++ b/plugin/azure_active_directory/lang/english.php @@ -0,0 +1,54 @@ + + * + * @package chamilo.plugin.azure_active_directory + */ +$strings['plugin_title'] = 'Azure Active Directory'; +$strings['plugin_comment'] = 'Allow authentication with Microsoft\'s Azure Active Directory'; + +$strings['enable'] = 'Enable'; +$strings['app_id'] = 'Application ID'; +$strings['app_id_help'] = 'Enter the Application Id assigned to your app by the Azure portal, e.g. 580e250c-8f26-49d0-bee8-1c078add1609'; +$strings['app_secret'] = 'Application secret'; +$strings['force_logout'] = 'Force logout button'; +$strings['force_logout_help'] = 'Show a button to force logout session from Azure.'; +$strings['block_name'] = 'Block name'; +$strings['management_login_enable'] = 'Management login'; +$strings['management_login_enable_help'] = 'Disable the chamilo login and enable an alternative login page for admin users.
' + .'You will need to copy the /plugin/azure_active_directory/layout/login_form.tpl file to /main/template/overrides/layout/ directory.'; +$strings['management_login_name'] = 'Name for the management login'; +$strings['management_login_name_help'] = 'The default is "Management Login".'; +$strings['existing_user_verification_order'] = 'Existing user verification order'; +$strings['existing_user_verification_order_help'] = 'This value indicates the order in which the user will be searched in Chamilo to verify its existence. ' + .'By default is 1, 2, 3.' + .'
  1. EXTRA_FIELD_ORGANISATION_EMAIL (mail)
  2. EXTRA_FIELD_AZURE_ID (mailNickname)
  3. EXTRA_FIELD_AZURE_UID (id or objectId)
'; +$strings['OrganisationEmail'] = 'Organisation e-mail'; +$strings['AzureId'] = 'Azure ID (mailNickname)'; +$strings['AzureUid'] = 'Azure UID (internal ID)'; +$strings['ManagementLogin'] = 'Management Login'; +$strings['InvalidId'] = 'Login failed - incorrect login or password. Errocode: AZMNF'; +$strings['provisioning'] = 'Automated provisioning'; +$strings['provisioning_help'] = 'Automatically create new users (as students) from Azure when they are not in Chamilo.'; +$strings['update_users'] = 'Update users'; +$strings['update_users_help'] = 'Allow user data to be updated at the start of the session.'; +$strings['group_id_admin'] = 'Group ID for platform admins'; +$strings['group_id_admin_help'] = 'The group ID can be found in the user group details, looking similar to this: ae134eef-cbd4-4a32-ba99-49898a1314b6. If empty, no user will be automatically created as admin.'; +$strings['group_id_session_admin'] = 'Group ID for session admins'; +$strings['group_id_session_admin_help'] = 'The group ID for session admins. If empty, no user will be automatically created as session admin.'; +$strings['group_id_teacher'] = 'Group ID for teachers'; +$strings['group_id_teacher_help'] = 'The group ID for teachers. If empty, no user will be automatically created as teacher.'; +$strings['additional_interaction_required'] = 'Some additional interaction is required to authenticate you. Please login directly through your authentication system, then come back to this page to login.'; +$strings['tenant_id'] = 'Tenant ID'; +$strings['tenant_id_help'] = 'Required to run scripts.'; +$strings['deactivate_nonexisting_users'] = 'Deactivate non-existing users'; +$strings['deactivate_nonexisting_users_help'] = 'Compare registered users in Chamilo with those in Azure and deactivate accounts in Chamilo that do not exist in Azure.'; +$strings['script_users_delta'] = 'Delta query for users'; +$strings['script_users_delta_help'] = 'Get newly created, updated, or deleted users without having to perform a full read of the entire user collection. By default, is No.'; +$strings['script_usergroups_delta'] = 'Delta query for usergroups'; +$strings['script_usergroups_delta_help'] = 'Get newly created, updated, or deleted groups, including group membership changes, without having to perform a full read of the entire group collection. By default, is No.'; +$strings['group_filter_regex'] = 'Group filter RegEx'; +$strings['group_filter_regex_help'] = 'Regular expression to filter groups (only matches will be synchronized), e.g. .*-FIL-.* .*-PAR-.* .*(FIL|PAR).* ^(FIL|PAR).*'; diff --git a/plugin/azure_active_directory/lang/french.php b/plugin/azure_active_directory/lang/french.php new file mode 100644 index 000000000..d49ce8072 --- /dev/null +++ b/plugin/azure_active_directory/lang/french.php @@ -0,0 +1,54 @@ + + * + * @package chamilo.plugin.azure_active_directory + */ +$strings['plugin_title'] = 'Azure Active Directory'; +$strings['plugin_comment'] = 'Permet l\'authentification des utilisateurs via Azure Active Directory de Microsoft'; + +$strings['enable'] = 'Activer'; +$strings['app_id'] = 'ID de l\'application'; +$strings['app_id_help'] = 'Introduisez l\'ID de l\'application assigné à votre app par le portail d\'Azure, p.ex. 580e250c-8f26-49d0-bee8-1c078add1609'; +$strings['app_secret'] = 'Clef secrète de l\'application'; +$strings['force_logout'] = 'Bouton de logout'; +$strings['force_logout_help'] = 'Affiche un bouton pour se délogger d\'Azure.'; +$strings['block_name'] = 'Nom du bloc'; +$strings['management_login_enable'] = 'Login de gestion'; +$strings['management_login_enable_help'] = 'Désactiver le login de Chamilo et permettre une page de login alternative pour les utilisateurs administrateurs.
' + .'Vous devez, pour cela, copier le fichier /plugin/azure_active_directory/layout/login_form.tpl dans le répertoire /main/template/overrides/layout/.'; +$strings['management_login_name'] = 'Nom du login de gestion'; +$strings['management_login_name_help'] = 'Le nom par défaut est "Login de gestion".'; +$strings['existing_user_verification_order'] = 'Existing user verification order'; +$strings['existing_user_verification_order_help'] = 'This value indicates the order in which the user will be searched in Chamilo to verify its existence. ' + .'By default is 1, 2, 3.' + .'
  1. EXTRA_FIELD_ORGANISATION_EMAIL (mail)
  2. EXTRA_FIELD_AZURE_ID (mailNickname)
  3. EXTRA_FIELD_AZURE_UID (id ou objectId)
'; +$strings['OrganisationEmail'] = 'E-mail professionnel'; +$strings['AzureId'] = 'ID Azure (mailNickname)'; +$strings['AzureUid'] = 'Azure UID (internal ID)'; +$strings['ManagementLogin'] = 'Login de gestion'; +$strings['InvalidId'] = 'Échec du login - nom d\'utilisateur ou mot de passe incorrect. Errocode: AZMNF'; +$strings['provisioning'] = 'Création automatisée'; +$strings['provisioning_help'] = 'Créer les utilisateurs automatiquement (en tant qu\'apprenants) depuis Azure s\'ils n\'existent pas encore dans Chamilo.'; +$strings['update_users'] = 'Actualiser les utilisateurs'; +$strings['update_users_help'] = 'Permettre d\'actualiser les données de l\'utilisateur lors du démarrage de la session.'; +$strings['group_id_admin'] = 'ID du groupe administrateur'; +$strings['group_id_admin_help'] = 'L\'id du groupe peut être trouvé dans les détails du groupe, et ressemble à ceci : ae134eef-cbd4-4a32-ba99-49898a1314b6. Si ce champ est laissé vide, aucun utilisateur ne sera créé en tant qu\'administrateur.'; +$strings['group_id_session_admin'] = 'ID du groupe administrateur de sessions'; +$strings['group_id_session_admin_help'] = 'The group ID for session admins. Si ce champ est laissé vide, aucun utilisateur ne sera créé en tant qu\'administrateur de sessions.'; +$strings['group_id_teacher'] = 'ID du groupe enseignant'; +$strings['group_id_teacher_help'] = 'The group ID for teachers. Si ce champ est laissé vide, aucun utilisateur ne sera créé en tant qu\'enseignant.'; +$strings['additional_interaction_required'] = 'Une interaction supplémentaire est nécessaire pour vous authentifier. Veuillez vous connecter directement auprès de votre système d\'authentification, puis revenir ici pour vous connecter.'; +$strings['tenant_id'] = 'ID du client'; +$strings['tenant_id_help'] = 'Nécessaire pour exécuter des scripts.'; +$strings['deactivate_nonexisting_users'] = 'Deactivate non-existing users'; +$strings['deactivate_nonexisting_users_help'] = 'Compare registered users in Chamilo with those in Azure and deactivate accounts in Chamilo that do not exist in Azure.'; +$strings['script_users_delta'] = 'Requête delta pour les utilisateurs'; +$strings['script_users_delta_help'] = 'Get newly created, updated, or deleted users without having to perform a full read of the entire user collection. By default, is No.'; +$strings['script_usergroups_delta'] = 'Requête delta pour les groupes d\'utilisateurs'; +$strings['script_usergroups_delta_help'] = 'Get newly created, updated, or deleted groups, including group membership changes, without having to perform a full read of the entire group collection. By default, is No.'; +$strings['group_filter_regex'] = 'Group filter RegEx'; +$strings['group_filter_regex_help'] = 'Regular expression to filter groups (only matches will be synchronized), e.g. .*-FIL-.* .*-PAR-.* .*(FIL|PAR).* ^(FIL|PAR).*'; diff --git a/plugin/azure_active_directory/lang/spanish.php b/plugin/azure_active_directory/lang/spanish.php new file mode 100644 index 000000000..f2b9f093f --- /dev/null +++ b/plugin/azure_active_directory/lang/spanish.php @@ -0,0 +1,54 @@ + + * + * @package chamilo.plugin.azure_active_directory + */ +$strings['plugin_title'] = 'Azure Active Directory'; +$strings['plugin_comment'] = 'Permite la autenticación de usuarios por Azure Active Directory de Microsoft'; + +$strings['enable'] = 'Activar'; +$strings['app_id'] = 'ID de la aplicación'; +$strings['app_id_help'] = 'Introduzca el ID de la aplicación asignado a su app en el portal de Azure, p.ej. 580e250c-8f26-49d0-bee8-1c078add1609'; +$strings['app_secret'] = 'Clave secreta de la aplicación'; +$strings['force_logout'] = 'Botón de logout'; +$strings['force_logout_help'] = 'Muestra un botón para hacer logout de Azure.'; +$strings['block_name'] = 'Nombre del bloque'; +$strings['management_login_enable'] = 'Login de gestión'; +$strings['management_login_enable_help'] = 'Desactivar el login de Chamilo y activar una página de login alternativa para los usuarios de administración.
' + .'Para ello, tendrá que copiar el archivo /plugin/azure_active_directory/layout/login_form.tpl en la carpeta /main/template/overrides/layout/.'; +$strings['management_login_name'] = 'Nombre del bloque de login de gestión'; +$strings['management_login_name_help'] = 'El nombre por defecto es "Login de gestión".'; +$strings['existing_user_verification_order'] = 'Orden de verificación de usuario existente'; +$strings['existing_user_verification_order_help'] = 'Este valor indica el orden en que el usuario serña buscado en Chamilo para verificar su existencia. ' + .'Por defecto es 1, 2, 3.' + .'
  1. EXTRA_FIELD_ORGANISATION_EMAIL (mail)
  2. EXTRA_FIELD_AZURE_ID (mailNickname)
  3. EXTRA_FIELD_AZURE_UID (id o objectId)
'; +$strings['OrganisationEmail'] = 'E-mail profesional'; +$strings['AzureId'] = 'ID Azure (mailNickname)'; +$strings['AzureUid'] = 'UID Azure (ID interno)'; +$strings['ManagementLogin'] = 'Login de gestión'; +$strings['InvalidId'] = 'Problema en el login - nombre de usuario o contraseña incorrecto. Errocode: AZMNF'; +$strings['provisioning'] = 'Creación automatizada'; +$strings['provisioning_help'] = 'Crear usuarios automáticamente (como alumnos) desde Azure si no existen en Chamilo todavía.'; +$strings['update_users'] = 'Actualizar los usuarios'; +$strings['update_users_help'] = 'Permite actualizar los datos del usuario al iniciar sesión.'; +$strings['group_id_admin'] = 'ID de grupo administrador'; +$strings['group_id_admin_help'] = 'El ID de grupo se encuentra en los detalles del grupo en Azure, y parece a: ae134eef-cbd4-4a32-ba99-49898a1314b6. Si deja este campo vacío, ningún usuario será creado como administrador.'; +$strings['group_id_session_admin'] = 'ID de grupo admin de sesiones'; +$strings['group_id_session_admin_help'] = 'El ID de grupo para administradores de sesiones. Si deja este campo vacío, ningún usuario será creado como administrador de sesiones.'; +$strings['group_id_teacher'] = 'ID de grupo profesor'; +$strings['group_id_teacher_help'] = 'El ID de grupo para profesores. Si deja este campo vacío, ningún usuario será creado como profesor.'; +$strings['additional_interaction_required'] = 'Alguna interacción adicional es necesaria para identificarlo/a. Por favor conéctese primero a través de su sistema de autenticación, luego regrese aquí para logearse.'; +$strings['tenant_id'] = 'Id. del inquilino'; +$strings['tenant_id_help'] = 'Necesario para ejecutar scripts.'; +$strings['deactivate_nonexisting_users'] = 'Desactivar usuarios no existentes'; +$strings['deactivate_nonexisting_users_help'] = 'Compara los usuarios registrados en Chamilo con los de Azure y desactiva las cuentas en Chamilo que no existan en Azure.'; +$strings['script_users_delta'] = 'Consula delta para usuarios'; +$strings['script_users_delta_help'] = 'Obtiene usuarios recién creados, actualizados o eliminados sin tener que realizar una lectura completa de toda la colección de usuarios. De forma predeterminada, es No.'; +$strings['script_usergroups_delta'] = 'Consulta delta para grupos de usuarios'; +$strings['script_usergroups_delta_help'] = 'Obtiene grupos recién creados, actualizados o eliminados, incluidos los cambios de membresía del grupo, sin tener que realizar una lectura completa de toda la colección de grupos. De forma predeterminada, es No'; +$strings['group_filter_regex'] = 'Group filter RegEx'; +$strings['group_filter_regex_help'] = 'Expresión regular para filtrar grupos (solo las coincidencias serán sincronizadas), p.ej. .*-FIL-.* .*-PAR-.* .*(FIL|PAR).* ^(FIL|PAR).*'; diff --git a/plugin/azure_active_directory/layout/login_form.tpl b/plugin/azure_active_directory/layout/login_form.tpl new file mode 100644 index 000000000..498422b23 --- /dev/null +++ b/plugin/azure_active_directory/layout/login_form.tpl @@ -0,0 +1,51 @@ +{% if _u.logged == 0 %} + {% if login_form %} +
+
+ {{ login_language_form }} + {% if plugin_login_top is not null %} +
+ {{ plugin_login_top }} +
+ {% endif %} + + {{ login_failed }} + + {% set azure_plugin_enabled = 'azure_active_directory'|api_get_plugin_setting('enable') %} + {% set azure_plugin_manage_login = 'azure_active_directory'|api_get_plugin_setting('manage_login_enable') %} + + {% if 'false' == azure_plugin_enabled or 'false' == azure_plugin_manage_login %} + {{ login_form }} + + {% if "allow_lostpassword" | api_get_setting == 'true' or "allow_registration"|api_get_setting == 'true' %} +
    + {% if "allow_registration"|api_get_setting != 'false' %} +
  • {{ 'SignUp'|get_lang }}
    • + {% endif %} + + {% if "allow_lostpassword" | api_get_setting == 'true' %} + {% set pass_reminder_link = 'pass_reminder_custom_link'|api_get_configuration_value %} + {% set lost_password_link = _p.web_main ~ 'auth/lostPassword.php' %} + + {% if not pass_reminder_link is empty %} + {% set lost_password_link = pass_reminder_link %} + {% endif %} + +
  • + {{ 'LostPassword' | get_lang }} +
    • + {% endif %} +
+ {% endif %} + + {% endif %} + + {% if plugin_login_bottom is not null %} +
+ {{ plugin_login_bottom }} +
+ {% endif %} +
+
+ {% endif %} +{% endif %} diff --git a/plugin/azure_active_directory/login.php b/plugin/azure_active_directory/login.php new file mode 100644 index 000000000..a6f790f4b --- /dev/null +++ b/plugin/azure_active_directory/login.php @@ -0,0 +1,35 @@ +get(AzureActiveDirectory::SETTING_ENABLE); +$managementLoginEnabled = $plugin->get(AzureActiveDirectory::SETTING_MANAGEMENT_LOGIN_ENABLE); + +if ('true' !== $pluginEnabled || 'true' !== $managementLoginEnabled) { + header('Location: '.api_get_path(WEB_PATH)); + + exit; +} + +$userId = api_get_user_id(); + +if (!($userId) || api_is_anonymous($userId)) { + $managementLoginName = $plugin->get(AzureActiveDirectory::SETTING_MANAGEMENT_LOGIN_NAME); + + if (empty($managementLoginName)) { + $managementLoginName = $plugin->get_lang('ManagementLogin'); + } + + $template = new Template($managementLoginName); + // Only display if the user isn't logged in. + $template->assign('login_language_form', api_display_language_form(true, true)); + $template->assign('login_form', $template->displayLoginForm()); + + $content = $template->fetch('azure_active_directory/view/login.tpl'); + + $template->assign('content', $content); + $template->display_one_col_template(); +} diff --git a/plugin/azure_active_directory/plugin.php b/plugin/azure_active_directory/plugin.php new file mode 100644 index 000000000..c9f699a73 --- /dev/null +++ b/plugin/azure_active_directory/plugin.php @@ -0,0 +1,10 @@ + + * + * @package chamilo.plugin.azure_active_directory + */ +$plugin_info = AzureActiveDirectory::create()->get_info(); + +$plugin_info['templates'] = ['view/block.tpl']; diff --git a/plugin/azure_active_directory/src/AzureActiveDirectory.php b/plugin/azure_active_directory/src/AzureActiveDirectory.php new file mode 100644 index 000000000..53cfdc5ff --- /dev/null +++ b/plugin/azure_active_directory/src/AzureActiveDirectory.php @@ -0,0 +1,442 @@ + + * + * @package chamilo.plugin.azure_active_directory + */ +class AzureActiveDirectory extends Plugin +{ + public const SETTING_ENABLE = 'enable'; + public const SETTING_APP_ID = 'app_id'; + public const SETTING_APP_SECRET = 'app_secret'; + public const SETTING_BLOCK_NAME = 'block_name'; + public const SETTING_FORCE_LOGOUT_BUTTON = 'force_logout'; + public const SETTING_MANAGEMENT_LOGIN_ENABLE = 'management_login_enable'; + public const SETTING_MANAGEMENT_LOGIN_NAME = 'management_login_name'; + public const SETTING_PROVISION_USERS = 'provisioning'; + public const SETTING_UPDATE_USERS = 'update_users'; + public const SETTING_GROUP_ID_ADMIN = 'group_id_admin'; + public const SETTING_GROUP_ID_SESSION_ADMIN = 'group_id_session_admin'; + public const SETTING_GROUP_ID_TEACHER = 'group_id_teacher'; + public const SETTING_EXISTING_USER_VERIFICATION_ORDER = 'existing_user_verification_order'; + public const SETTING_TENANT_ID = 'tenant_id'; + public const SETTING_DEACTIVATE_NONEXISTING_USERS = 'deactivate_nonexisting_users'; + public const SETTING_GET_USERS_DELTA = 'script_users_delta'; + public const SETTING_GET_USERGROUPS_DELTA = 'script_usergroups_delta'; + public const SETTING_GROUP_FILTER = 'group_filter_regex'; + + public const URL_TYPE_AUTHORIZE = 'login'; + public const URL_TYPE_LOGOUT = 'logout'; + + public const EXTRA_FIELD_ORGANISATION_EMAIL = 'organisationemail'; + public const EXTRA_FIELD_AZURE_ID = 'azure_id'; + public const EXTRA_FIELD_AZURE_UID = 'azure_uid'; + + public const API_PAGE_SIZE = 999; + + /** + * AzureActiveDirectory constructor. + */ + protected function __construct() + { + $settings = [ + self::SETTING_ENABLE => 'boolean', + self::SETTING_APP_ID => 'text', + self::SETTING_APP_SECRET => 'text', + self::SETTING_BLOCK_NAME => 'text', + self::SETTING_FORCE_LOGOUT_BUTTON => 'boolean', + self::SETTING_MANAGEMENT_LOGIN_ENABLE => 'boolean', + self::SETTING_MANAGEMENT_LOGIN_NAME => 'text', + self::SETTING_PROVISION_USERS => 'boolean', + self::SETTING_UPDATE_USERS => 'boolean', + self::SETTING_GROUP_ID_ADMIN => 'text', + self::SETTING_GROUP_ID_SESSION_ADMIN => 'text', + self::SETTING_GROUP_ID_TEACHER => 'text', + self::SETTING_EXISTING_USER_VERIFICATION_ORDER => 'text', + self::SETTING_TENANT_ID => 'text', + self::SETTING_DEACTIVATE_NONEXISTING_USERS => 'boolean', + self::SETTING_GET_USERS_DELTA => 'boolean', + self::SETTING_GET_USERGROUPS_DELTA => 'boolean', + self::SETTING_GROUP_FILTER => 'text', + ]; + + parent::__construct('2.5', 'Angel Fernando Quiroz Campos, Yannick Warnier', $settings); + } + + /** + * Instance the plugin. + * + * @staticvar null $result + * + * @return $this + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * @return string + */ + public function get_name() + { + return 'azure_active_directory'; + } + + public function getProvider(): Azure + { + return new Azure([ + 'clientId' => $this->get(self::SETTING_APP_ID), + 'clientSecret' => $this->get(self::SETTING_APP_SECRET), + 'redirectUri' => api_get_path(WEB_PLUGIN_PATH).'azure_active_directory/src/callback.php', + 'urlAPI' => 'https://graph.microsoft.com/v1.0/', + 'resource' => 'https://graph.microsoft.com', + ]); + } + + public function getProviderForApiGraph(): Azure + { + $provider = $this->getProvider(); + $provider->tenant = $this->get(AzureActiveDirectory::SETTING_TENANT_ID); + $provider->authWithResource = false; + + return $provider; + } + + /** + * @param string $urlType Type of URL to generate + * + * @return string + */ + public function getUrl($urlType) + { + if (self::URL_TYPE_LOGOUT === $urlType) { + $provider = $this->getProvider(); + + return $provider->getLogoutUrl( + api_get_path(WEB_PATH) + ); + } + + return api_get_path(WEB_PLUGIN_PATH).$this->get_name().'/src/callback.php'; + } + + /** + * Create extra fields for user when installing. + * + * @throws ToolsException + */ + public function install() + { + UserManager::create_extra_field( + self::EXTRA_FIELD_ORGANISATION_EMAIL, + ExtraField::FIELD_TYPE_TEXT, + $this->get_lang('OrganisationEmail'), + '' + ); + UserManager::create_extra_field( + self::EXTRA_FIELD_AZURE_ID, + ExtraField::FIELD_TYPE_TEXT, + $this->get_lang('AzureId'), + '' + ); + UserManager::create_extra_field( + self::EXTRA_FIELD_AZURE_UID, + ExtraField::FIELD_TYPE_TEXT, + $this->get_lang('AzureUid'), + '' + ); + + $em = Database::getManager(); + + if ($em->getConnection()->getSchemaManager()->tablesExist(['azure_ad_sync_state'])) { + return; + } + + $schemaTool = new SchemaTool($em); + $schemaTool->createSchema( + [ + $em->getClassMetadata(AzureSyncState::class), + ] + ); + } + + public function uninstall() + { + $em = Database::getManager(); + + if (!$em->getConnection()->getSchemaManager()->tablesExist(['azure_ad_sync_state'])) { + return; + } + + $schemaTool = new SchemaTool($em); + $schemaTool->dropSchema( + [ + $em->getClassMetadata(AzureSyncState::class), + ] + ); + } + + public function getExistingUserVerificationOrder(): array + { + $defaultOrder = [1, 2, 3]; + + $settingValue = $this->get(self::SETTING_EXISTING_USER_VERIFICATION_ORDER); + $selectedOrder = array_filter( + array_map( + 'trim', + explode(',', $settingValue) + ) + ); + $selectedOrder = array_map('intval', $selectedOrder); + $selectedOrder = array_filter( + $selectedOrder, + function ($position) use ($defaultOrder): bool { + return in_array($position, $defaultOrder); + } + ); + + if ($selectedOrder) { + return $selectedOrder; + } + + return $defaultOrder; + } + + public function getUserIdByVerificationOrder(array $azureUserData): ?int + { + $selectedOrder = $this->getExistingUserVerificationOrder(); + + $extraFieldValue = new ExtraFieldValue('user'); + $positionsAndFields = [ + 1 => $extraFieldValue->get_item_id_from_field_variable_and_field_value( + AzureActiveDirectory::EXTRA_FIELD_ORGANISATION_EMAIL, + $azureUserData['mail'] + ), + 2 => $extraFieldValue->get_item_id_from_field_variable_and_field_value( + AzureActiveDirectory::EXTRA_FIELD_AZURE_ID, + $azureUserData['mailNickname'] + ), + 3 => $extraFieldValue->get_item_id_from_field_variable_and_field_value( + AzureActiveDirectory::EXTRA_FIELD_AZURE_UID, + $azureUserData['id'] + ), + ]; + + foreach ($selectedOrder as $position) { + if (!empty($positionsAndFields[$position]) && isset($positionsAndFields[$position]['item_id'])) { + return (int) $positionsAndFields[$position]['item_id']; + } + } + + return null; + } + + /** + * @throws Exception + */ + public function registerUser(array $azureUserInfo) + { + if (empty($azureUserInfo)) { + throw new Exception('Groups info not found.'); + } + + $userId = $this->getUserIdByVerificationOrder($azureUserInfo); + + if (empty($userId)) { + // If we didn't find the user + if ($this->get(self::SETTING_PROVISION_USERS) !== 'true') { + throw new Exception('User not found when checking the extra fields from '.$azureUserInfo['mail'].' or '.$azureUserInfo['mailNickname'].' or '.$azureUserInfo['id'].'.'); + } + + [ + $firstNme, + $lastName, + $username, + $email, + $phone, + $authSource, + $active, + $extra, + ] = $this->formatUserData($azureUserInfo); + + // If the option is set to create users, create it + $userId = UserManager::create_user( + $firstNme, + $lastName, + STUDENT, + $email, + $username, + '', + null, + null, + $phone, + null, + $authSource, + null, + $active, + null, + $extra, + null, + null + ); + + if (!$userId) { + throw new Exception(get_lang('UserNotAdded').' '.$azureUserInfo['userPrincipalName']); + } + + return $userId; + } + + if ($this->get(self::SETTING_UPDATE_USERS) === 'true') { + [ + $firstNme, + $lastName, + $username, + $email, + $phone, + $authSource, + $active, + $extra, + ] = $this->formatUserData($azureUserInfo); + + $userId = UserManager::update_user( + $userId, + $firstNme, + $lastName, + $username, + '', + $authSource, + $email, + STUDENT, + null, + $phone, + null, + null, + $active, + null, + 0, + $extra + ); + + if (!$userId) { + throw new Exception(get_lang('CouldNotUpdateUser').' '.$azureUserInfo['userPrincipalName']); + } + } + + return $userId; + } + + /** + * @return array + */ + public function getGroupUidByRole(): array + { + $groupUidList = [ + 'admin' => $this->get(self::SETTING_GROUP_ID_ADMIN), + 'sessionAdmin' => $this->get(self::SETTING_GROUP_ID_SESSION_ADMIN), + 'teacher' => $this->get(self::SETTING_GROUP_ID_TEACHER), + ]; + + return array_filter($groupUidList); + } + + /** + * @return array + */ + public function getUpdateActionByRole(): array + { + return [ + 'admin' => function (User $user) { + $user->setStatus(COURSEMANAGER); + + UserManager::addUserAsAdmin($user, false); + }, + 'sessionAdmin' => function (User $user) { + $user->setStatus(SESSIONADMIN); + + UserManager::removeUserAdmin($user, false); + }, + 'teacher' => function (User $user) { + $user->setStatus(COURSEMANAGER); + + UserManager::removeUserAdmin($user, false); + }, + ]; + } + + public function getSyncState(string $title): ?AzureSyncState + { + $stateRepo = Database::getManager()->getRepository(AzureSyncState::class); + + return $stateRepo->findOneBy(['title' => $title]); + } + + public function saveSyncState(string $title, $value) + { + $state = $this->getSyncState($title); + + if (!$state) { + $state = new AzureSyncState(); + $state->setTitle($title); + + Database::getManager()->persist($state); + } + + $state->setValue($value); + + Database::getManager()->flush(); + } + + /** + * @throws Exception + */ + private function formatUserData(array $azureUserInfo): array + { + $phone = null; + + if (isset($azureUserInfo['telephoneNumber'])) { + $phone = $azureUserInfo['telephoneNumber']; + } elseif (isset($azureUserInfo['businessPhones'][0])) { + $phone = $azureUserInfo['businessPhones'][0]; + } elseif (isset($azureUserInfo['mobilePhone'])) { + $phone = $azureUserInfo['mobilePhone']; + } + + // If the option is set to create users, create it + $firstNme = $azureUserInfo['givenName']; + $lastName = $azureUserInfo['surname']; + $email = $azureUserInfo['mail']; + $username = $azureUserInfo['userPrincipalName']; + $authSource = 'azure'; + $active = ($azureUserInfo['accountEnabled'] ? 1 : 0); + $extra = [ + 'extra_'.self::EXTRA_FIELD_ORGANISATION_EMAIL => $azureUserInfo['mail'], + 'extra_'.self::EXTRA_FIELD_AZURE_ID => $azureUserInfo['mailNickname'], + 'extra_'.self::EXTRA_FIELD_AZURE_UID => $azureUserInfo['id'], + ]; + + return [ + $firstNme, + $lastName, + $username, + $email, + $phone, + $authSource, + $active, + $extra, + ]; + } +} diff --git a/plugin/azure_active_directory/src/AzureCommand.php b/plugin/azure_active_directory/src/AzureCommand.php new file mode 100644 index 000000000..b70c85e21 --- /dev/null +++ b/plugin/azure_active_directory/src/AzureCommand.php @@ -0,0 +1,239 @@ +plugin = AzureActiveDirectory::create(); + $this->plugin->get_settings(true); + $this->provider = $this->plugin->getProviderForApiGraph(); + } + + /** + * @throws IdentityProviderException + */ + protected function generateOrRefreshToken(?AccessTokenInterface &$token) + { + if (!$token || ($token->getExpires() && !$token->getRefreshToken())) { + $token = $this->provider->getAccessToken( + 'client_credentials', + ['resource' => $this->provider->resource] + ); + } + } + + /** + * @throws Exception + * + * @return Generator> + */ + protected function getAzureUsers(): Generator + { + $userFields = [ + 'givenName', + 'surname', + 'mail', + 'userPrincipalName', + 'businessPhones', + 'mobilePhone', + 'accountEnabled', + 'mailNickname', + 'id', + ]; + + $getUsersDelta = 'true' === $this->plugin->get(AzureActiveDirectory::SETTING_GET_USERS_DELTA); + + if ($getUsersDelta) { + $usersDeltaLink = $this->plugin->getSyncState(AzureSyncState::USERS_DATALINK); + + $query = $usersDeltaLink + ? $usersDeltaLink->getValue() + : sprintf('$select=%s', implode(',', $userFields)); + } else { + $query = sprintf( + '$top=%d&$select=%s', + AzureActiveDirectory::API_PAGE_SIZE, + implode(',', $userFields) + ); + } + + $token = null; + + do { + $this->generateOrRefreshToken($token); + + try { + $azureUsersRequest = $this->provider->request( + 'get', + $getUsersDelta ? "users/delta?$query" : "users?$query", + $token + ); + } catch (Exception $e) { + throw new Exception('Exception when requesting users from Azure: '.$e->getMessage()); + } + + $azureUsersInfo = $azureUsersRequest['value'] ?? []; + + foreach ($azureUsersInfo as $azureUserInfo) { + $azureUserInfo['mail'] = $azureUserInfo['mail'] ?? null; + $azureUserInfo['surname'] = $azureUserInfo['surname'] ?? null; + $azureUserInfo['givenName'] = $azureUserInfo['givenName'] ?? null; + + yield $azureUserInfo; + } + + $hasNextLink = false; + + if (!empty($azureUsersRequest['@odata.nextLink'])) { + $hasNextLink = true; + $query = parse_url($azureUsersRequest['@odata.nextLink'], PHP_URL_QUERY); + } + + if ($getUsersDelta && !empty($azureUsersRequest['@odata.deltaLink'])) { + $this->plugin->saveSyncState( + AzureSyncState::USERS_DATALINK, + parse_url($azureUsersRequest['@odata.deltaLink'], PHP_URL_QUERY), + ); + } + } while ($hasNextLink); + } + + /** + * @throws Exception + * + * @return Generator> + */ + protected function getAzureGroups(): Generator + { + $groupFilter = $this->plugin->get(AzureActiveDirectory::SETTING_GROUP_FILTER); + + $groupFields = [ + 'id', + 'displayName', + 'description', + ]; + + $getUsergroupsDelta = 'true' === $this->plugin->get(AzureActiveDirectory::SETTING_GET_USERGROUPS_DELTA); + + if ($getUsergroupsDelta) { + $usergroupsDeltaLink = $this->plugin->getSyncState(AzureSyncState::USERGROUPS_DATALINK); + + $query = $usergroupsDeltaLink + ? $usergroupsDeltaLink->getValue() + : sprintf('$select=%s', implode(',', $groupFields)); + } else { + $query = sprintf( + '$top=%d&$select=%s', + AzureActiveDirectory::API_PAGE_SIZE, + implode(',', $groupFields) + ); + } + + $token = null; + + do { + $this->generateOrRefreshToken($token); + + try { + $azureGroupsRequest = $this->provider->request( + 'get', + $getUsergroupsDelta ? "groups/delta?$query" : "groups?$query", + $token + ); + } catch (Exception $e) { + throw new Exception('Exception when requesting groups from Azure: '.$e->getMessage()); + } + + $azureGroupsInfo = $azureGroupsRequest['value'] ?? []; + + foreach ($azureGroupsInfo as $azureGroupInfo) { + if (!empty($groupFilter) && + !preg_match("/$groupFilter/", $azureGroupInfo['displayName']) + ) { + continue; + } + + yield $azureGroupInfo; + } + + $hasNextLink = false; + + if (!empty($azureGroupsRequest['@odata.nextLink'])) { + $hasNextLink = true; + $query = parse_url($azureGroupsRequest['@odata.nextLink'], PHP_URL_QUERY); + } + + if ($getUsergroupsDelta && !empty($azureGroupsRequest['@odata.deltaLink'])) { + $this->plugin->saveSyncState( + AzureSyncState::USERGROUPS_DATALINK, + parse_url($azureGroupsRequest['@odata.deltaLink'], PHP_URL_QUERY), + ); + } + } while ($hasNextLink); + } + + /** + * @throws Exception + * + * @return Generator> + */ + protected function getAzureGroupMembers(string $groupUid): Generator + { + $userFields = [ + 'mail', + 'mailNickname', + 'id', + ]; + + $query = sprintf( + '$top=%d&$select=%s', + AzureActiveDirectory::API_PAGE_SIZE, + implode(',', $userFields) + ); + + $token = null; + + do { + $this->generateOrRefreshToken($token); + + try { + $azureGroupMembersRequest = $this->provider->request( + 'get', + "groups/$groupUid/members?$query", + $token + ); + } catch (Exception $e) { + throw new Exception('Exception when requesting group members from Azure: '.$e->getMessage()); + } + + $azureGroupMembers = $azureGroupMembersRequest['value'] ?? []; + + foreach ($azureGroupMembers as $azureGroupMember) { + yield $azureGroupMember; + } + + $hasNextLink = false; + + if (!empty($azureGroupMembersRequest['@odata.nextLink'])) { + $hasNextLink = true; + $query = parse_url($azureGroupMembersRequest['@odata.nextLink'], PHP_URL_QUERY); + } + } while ($hasNextLink); + } +} diff --git a/plugin/azure_active_directory/src/AzureSyncUsergroupsCommand.php b/plugin/azure_active_directory/src/AzureSyncUsergroupsCommand.php new file mode 100644 index 000000000..a22169403 --- /dev/null +++ b/plugin/azure_active_directory/src/AzureSyncUsergroupsCommand.php @@ -0,0 +1,74 @@ + + */ + public function __invoke(): Generator + { + yield 'Synchronizing groups from Azure.'; + + $usergroup = new UserGroup(); + + $groupIdByUid = []; + + foreach ($this->getAzureGroups() as $azureGroupInfo) { + if ($usergroup->usergroup_exists($azureGroupInfo['displayName'])) { + $groupId = $usergroup->getIdByName($azureGroupInfo['displayName']); + + if ($groupId) { + $usergroup->subscribe_users_to_usergroup($groupId, []); + + yield sprintf('Class exists, all users unsubscribed: %s', $azureGroupInfo['displayName']); + } + } else { + $groupId = $usergroup->save([ + 'name' => $azureGroupInfo['displayName'], + 'description' => $azureGroupInfo['description'], + ]); + + if ($groupId) { + yield sprintf('Class created: %s', $azureGroupInfo['displayName']); + } + } + + $groupIdByUid[$azureGroupInfo['id']] = $groupId; + } + + yield '----------------'; + yield 'Subscribing users to groups'; + + foreach ($groupIdByUid as $azureGroupUid => $groupId) { + $newGroupMembers = []; + + yield sprintf('Obtaining members for group (ID %d)', $groupId); + + try { + foreach ($this->getAzureGroupMembers($azureGroupUid) as $azureGroupMember) { + if ($userId = $this->plugin->getUserIdByVerificationOrder($azureGroupMember)) { + $newGroupMembers[] = $userId; + } + } + } catch (Exception $e) { + yield $e->getMessage(); + + continue; + } + + if ($newGroupMembers) { + $usergroup->subscribe_users_to_usergroup($groupId, $newGroupMembers); + + yield sprintf( + 'User IDs subscribed in class (ID %d): %s', + $groupId, + implode(', ', $newGroupMembers) + ); + } + } + } +} diff --git a/plugin/azure_active_directory/src/AzureSyncUsersCommand.php b/plugin/azure_active_directory/src/AzureSyncUsersCommand.php new file mode 100644 index 000000000..61a2123f4 --- /dev/null +++ b/plugin/azure_active_directory/src/AzureSyncUsersCommand.php @@ -0,0 +1,100 @@ + + */ + public function __invoke(): Generator + { + yield 'Synchronizing users from Azure.'; + + /** @var array $azureCreatedUserIdList */ + $azureCreatedUserIdList = []; + + foreach ($this->getAzureUsers() as $azureUserInfo) { + try { + $userId = $this->plugin->registerUser($azureUserInfo); + } catch (Exception $e) { + yield $e->getMessage(); + + continue; + } + + $azureCreatedUserIdList[$azureUserInfo['id']] = $userId; + + yield sprintf('User (ID %d) with received info: %s ', $userId, serialize($azureUserInfo)); + } + + yield '----------------'; + yield 'Updating users status'; + + $roleGroups = $this->plugin->getGroupUidByRole(); + $roleActions = $this->plugin->getUpdateActionByRole(); + + $userManager = UserManager::getManager(); + $em = Database::getManager(); + + foreach ($roleGroups as $userRole => $groupUid) { + try { + $azureGroupMembersInfo = iterator_to_array($this->getAzureGroupMembers($groupUid)); + } catch (Exception $e) { + yield $e->getMessage(); + + continue; + } + + $azureGroupMembersUids = array_column($azureGroupMembersInfo, 'id'); + + foreach ($azureGroupMembersUids as $azureGroupMembersUid) { + $userId = $azureCreatedUserIdList[$azureGroupMembersUid] ?? null; + + if (!$userId) { + continue; + } + + if (isset($roleActions[$userRole])) { + /** @var User $user */ + $user = $userManager->find($userId); + + $roleActions[$userRole]($user); + + yield sprintf('User (ID %d) status %s', $userId, $userRole); + } + } + + $em->flush(); + } + + if ('true' === $this->plugin->get(AzureActiveDirectory::SETTING_DEACTIVATE_NONEXISTING_USERS) + && 'true' !== $this->plugin->get(AzureActiveDirectory::SETTING_GET_USERS_DELTA) + ) { + yield '----------------'; + + yield 'Trying deactivate non-existing users in Azure'; + + $users = UserManager::getRepository()->findByAuthSource('azure'); + $chamiloUserIdList = array_map( + function ($user) { + return $user->getId(); + }, + $users + ); + + $nonExistingUsers = array_diff($chamiloUserIdList, $azureCreatedUserIdList); + + UserManager::deactivate_users($nonExistingUsers); + + yield sprintf( + 'Deactivated users IDs: %s', + implode(', ', $nonExistingUsers) + ); + } + } +} diff --git a/plugin/azure_active_directory/src/Entity/AzureSyncState.php b/plugin/azure_active_directory/src/Entity/AzureSyncState.php new file mode 100644 index 000000000..bda48f6fd --- /dev/null +++ b/plugin/azure_active_directory/src/Entity/AzureSyncState.php @@ -0,0 +1,68 @@ +id; + } + + public function getTitle(): string + { + return $this->title; + } + + public function setTitle(string $title): AzureSyncState + { + $this->title = $title; + + return $this; + } + + public function getValue(): string + { + return $this->value; + } + + public function setValue(string $value): AzureSyncState + { + $this->value = $value; + + return $this; + } +} diff --git a/plugin/azure_active_directory/src/callback.php b/plugin/azure_active_directory/src/callback.php new file mode 100644 index 000000000..2c2eef353 --- /dev/null +++ b/plugin/azure_active_directory/src/callback.php @@ -0,0 +1,166 @@ +get(AzureActiveDirectory::SETTING_ENABLE)) { + api_not_allowed(true); +} + +$provider = $plugin->getProvider(); + +if (!isset($_GET['code'])) { + // If we don't have an authorization code then get one by redirecting + // users to Azure (with the callback URL information) + $authUrl = $provider->getAuthorizationUrl(); + + ChamiloSession::write('oauth2state', $provider->getState()); + + header('Location: '.$authUrl); + exit; +} + +// Check given state against previously stored one to mitigate CSRF attack +if (empty($_GET['state']) || ($_GET['state'] !== ChamiloSession::read('oauth2state'))) { + ChamiloSession::erase('oauth2state'); + + exit; +} + +// Try to get an access token (using the authorization code grant) +try { + $token = $provider->getAccessToken('authorization_code', [ + 'code' => $_GET['code'], + ]); +} catch (Exception $exception) { + if ($exception->getMessage() == 'interaction_required') { + $message = Display::return_message($plugin->get_lang('additional_interaction_required'), 'error', false); + } else { + $message = Display::return_message($exception->getMessage(), 'error'); + } + Display::addFlash($message); + header('Location: '.api_get_path(WEB_PATH)); + exit; +} + +$me = null; + +try { + $userFields = [ + 'givenName', + 'surname', + 'mail', + 'userPrincipalName', + 'businessPhones', + 'mobilePhone', + 'accountEnabled', + 'mailNickname', + 'id', + ]; + + $querySelect = implode(',', $userFields); + + $me = $provider->get( + sprintf('me?$select=%s', $querySelect), + $token + ); + + if (empty($me)) { + throw new Exception('Token not found.'); + } + + // We use the e-mail to authenticate the user, so check that at least one + // e-mail source exists + if (empty($me['mail'])) { + throw new Exception('The mail field is empty in Azure AD and is needed to set the organisation email for this user.'); + } + if (empty($me['mailNickname'])) { + throw new Exception('The mailNickname field is empty in Azure AD and is needed to set the unique username for this user.'); + } + if (empty($me['id'])) { + throw new Exception('The id field is empty in Azure AD and is needed to set the unique Azure ID for this user.'); + } + + $userId = $plugin->registerUser($me); + + if ($roleGroups = $plugin->getGroupUidByRole()) { + $roleActions = $plugin->getUpdateActionByRole(); + /** @var User $user */ + $user = UserManager::getManager()->find($userId); + + $azureGroups = $provider->get('me/memberOf', $token); + + foreach ($roleGroups as $userRole => $groupUid) { + foreach ($azureGroups as $azureGroup) { + $azureGroupUid = $azureGroup['id']; + if ($azureGroupUid === $groupUid) { + $roleActions[$userRole]($user); + + break 2; + } + } + } + + Database::getManager()->flush(); + } + + $userInfo = api_get_user_info($userId); + + /* @TODO add support if user exists in another URL but is validated in this one, add the user to access_url_rel_user */ + + if (empty($userInfo)) { + throw new Exception('User '.$userId.' not found.'); + } + + if ($userInfo['active'] != '1') { + throw new Exception(get_lang('AccountInactive')); + } +} catch (Exception $exception) { + $message = Display::return_message($exception->getMessage(), 'error'); + Display::addFlash($message); + header('Location: '.api_get_path(WEB_PATH)); + exit; +} + +$userInfo['uidReset'] = true; + +$_GET['redirect_after_not_allow_page'] = 1; + +$redirectAfterNotAllowPage = ChamiloSession::read('redirect_after_not_allow_page'); + +ChamiloSession::clear(); + +ChamiloSession::write('redirect_after_not_allow_page', $redirectAfterNotAllowPage); + +ChamiloSession::write('_user', $userInfo); +ChamiloSession::write('_user_auth_source', 'azure_active_directory'); +Event::eventLogin($userInfo['user_id']); + +$GLOBALS['noredirection'] = false; + +Redirect::session_request_uri(true, $userInfo['user_id']); diff --git a/plugin/azure_active_directory/src/scripts/sync_usergroups.php b/plugin/azure_active_directory/src/scripts/sync_usergroups.php new file mode 100644 index 000000000..8ad128c5d --- /dev/null +++ b/plugin/azure_active_directory/src/scripts/sync_usergroups.php @@ -0,0 +1,21 @@ +getMessage()); +} diff --git a/plugin/azure_active_directory/src/scripts/sync_users.php b/plugin/azure_active_directory/src/scripts/sync_users.php new file mode 100644 index 000000000..33eb4768e --- /dev/null +++ b/plugin/azure_active_directory/src/scripts/sync_users.php @@ -0,0 +1,21 @@ +getMessage()); +} diff --git a/plugin/azure_active_directory/uninstall.php b/plugin/azure_active_directory/uninstall.php new file mode 100644 index 000000000..43a1f4fa7 --- /dev/null +++ b/plugin/azure_active_directory/uninstall.php @@ -0,0 +1,9 @@ +uninstall(); diff --git a/plugin/azure_active_directory/view/block.tpl b/plugin/azure_active_directory/view/block.tpl new file mode 100644 index 000000000..af7928256 --- /dev/null +++ b/plugin/azure_active_directory/view/block.tpl @@ -0,0 +1,22 @@ +{% if not _u.logged %} +
+ {% if not azure_active_directory.block_title is empty %} +

{{ azure_active_directory.block_title }}

+ {% endif %} + + {% if not azure_active_directory.signin_url is empty %} + {{ 'SignIn'|get_lang }} + {% endif %} + + {% if not azure_active_directory.signout_url is empty %} + {{ 'Logout'|get_lang }} + {% endif %} + + {% if azure_active_directory.management_login_enabled %} +
+ + {{ azure_active_directory.management_login_name }} + + {% endif %} +
+{% endif %} diff --git a/plugin/azure_active_directory/view/login.tpl b/plugin/azure_active_directory/view/login.tpl new file mode 100644 index 000000000..89810414a --- /dev/null +++ b/plugin/azure_active_directory/view/login.tpl @@ -0,0 +1,26 @@ +
+
+ {{ login_language_form }} + + {{ login_form }} + + {% if "allow_lostpassword"|api_get_setting == 'true' or "allow_registration"|api_get_setting == 'true' %} +
    + {% if "allow_registration"|api_get_setting != 'false' %} +
  • {{ 'SignUp'|get_lang }}
    • + {% endif %} + + {% if "allow_lostpassword" | api_get_setting == 'true' %} + {% set pass_reminder_link = 'pass_reminder_custom_link'|api_get_configuration_value %} + {% set lost_password_link = _p.web_main ~ 'auth/lostPassword.php' %} + + {% if not pass_reminder_link is empty %} + {% set lost_password_link = pass_reminder_link %} + {% endif %} + +
  • {{ 'LostPassword' | get_lang }}
    • + {% endif %} +
+ {% endif %} +
+
diff --git a/plugin/bbb/CHANGELOG.md b/plugin/bbb/CHANGELOG.md new file mode 100644 index 000000000..97d33a358 --- /dev/null +++ b/plugin/bbb/CHANGELOG.md @@ -0,0 +1,61 @@ +Version 2.11 - 2022-04 +---------------------- +* Add option to close all rooms on all campus on a multi-url enviroment + +Version 2.10 - 2021-10 +---------------------- +* Add support for multiple recording formats + +Version 2.9 - 2021-08 +--------------------- +* Remove interface option (HTML5/Flash) + +Version 2.8 - 2019-07 +--------------------- +* Add rooms + internal meeting id + +Version 2.7 - 2018-07 +--------------------- +* Add interface option (HTML5 or Flash) + +Version 2.6 - 2017-05 +--------------------- +* Add max users limit + +Version 2.5 - 2016-07 +--------------------- +* User global conference support + +Version 2.4 - 2016-05 +------------------------ + +* Global conference support (Requires to update the plugin settings). +* Course group conference support + +Version 2.3 - 2015-05-18 +------------------------ +Changes: +* Added support for variable voiceBridge to be sent on meeting creation. See: +https://code.google.com/p/bigbluebutton/issues/detail?can=2&start=0&num=100&q=&colspec=ID%20Type%20Status%20Priority%20Milestone%20Owner%20Component%20Summary&groupby=&sort=&id=1186 +and https://support.chamilo.org/issues/7669 for details. + +Version 2.2 - 2014-10-15 +------------------------ +Changes: +* Add a pseudo-random guid to avoid clashing conferences when several Chamilo portals use the same server. +* Add possibility to hide recordings of previous conferences from the list. +* Show action icons in the action column +* Hide the ID of the meeting (this was an internal ID, useless to the final user). It is still in the HTML source, however +* Show number of minutes of the recording (in the recordings list) + +Version 2.1 +----------- +Released with: Chamilo LMS 1.9.8 +* Session support + +Version 2.0 +----------- + +Version 1.0 +----------- +Released with: Chamilo LMS 1.9.0 diff --git a/plugin/bbb/README.md b/plugin/bbb/README.md new file mode 100644 index 000000000..16e0894e0 --- /dev/null +++ b/plugin/bbb/README.md @@ -0,0 +1,95 @@ +BigBlueButton Chamilo plugin +============================ +This plugin allows you to have videoconference rooms in each course. +It requires you to have a BigBlueButton videoconference server installed on another server (ideally). +Check www.bigbluebutton.org for more about BigBlueButton. + +## Migrating to Chamilo LMS 1.10.x +For Chamilo 1.10.x, the Videoconference plugin has two new settings options: +*Enable global conference* and *Enable conference in course groups*. + +##### Database changes +You need execute these SQL queries in your database after making the migration process from 1.9.x. + +```sql +ALTER TABLE plugin_bbb_meeting ADD voice_bridge int NOT NULL DEFAULT 1; +ALTER TABLE plugin_bbb_meeting ADD group_id int unsigned NOT NULL DEFAULT 0; +``` +## Migrating to Chamilo LMS 1.11.x +For Chamilo 1.11.x, Videoconference plugin has one new setting option: +*Disable Course Settings*. + +##### Database changes +You need execute this SQL query in your database after making the Chamilo migration process from 1.10.x. +> If you are migrating from 1.9.x versions, you need execute the SQL queries from the migration to 1.10.x before. + +```sql +ALTER TABLE plugin_bbb_meeting ADD user_id int unsigned NOT NULL DEFAULT 0; +ALTER TABLE plugin_bbb_meeting ADD access_url int NOT NULL DEFAULT 1; +``` +For version 2.5 you need execute these SQL queries +```sql +CREATE TABLE IF NOT EXISTS plugin_bbb_room ( + id int NOT NULL AUTO_INCREMENT PRIMARY KEY, + meeting_id int(10) unsigned NOT NULL, + participant_id int(11) NOT NULL, + in_at datetime NOT NULL, + out_at datetime NOT NULL +); +ALTER TABLE plugin_bbb_meeting ADD COLUMN video_url TEXT NULL; +ALTER TABLE plugin_bbb_meeting ADD COLUMN has_video_m4v TINYINT NOT NULL DEFAULT 0; +ALTER TABLE plugin_bbb_meeting ADD COLUMN user_id INT DEFAULT 0; +ALTER TABLE plugin_bbb_meeting ADD COLUMN access_url INT DEFAULT 0; +ALTER TABLE plugin_bbb_meeting ADD COLUMN remote_id char(30); +ALTER TABLE plugin_bbb_meeting ADD COLUMN visibility TINYINT NOT NULL DEFAULT 1; +ALTER TABLE plugin_bbb_meeting ADD COLUMN session_id INT DEFAULT 0; +``` +For version 2.6 (adding limits) you need execute these SQL queries +```sql +INSERT INTO settings_current (variable, subkey, type, category, selected_value, title, comment, scope, subkeytext, access_url, access_url_changeable, access_url_locked) VALUES ('bbb_max_users_limit', 'bbb', 'setting', 'Plugins', '3', 'bbb', null, null, null, 1, 1, 0); +INSERT INTO extra_field (extra_field_type, field_type, variable, display_text, default_value, field_order, visible_to_self, visible_to_others, changeable, filter, created_at) VALUES (2, 15, 'plugin_bbb_course_users_limit', 'MaxUsersInConferenceRoom', '0', 1, 1, 0, 1, null, '2017-05-28 01:19:32'); +INSERT INTO extra_field (extra_field_type, field_type, variable, display_text, default_value, field_order, visible_to_self, visible_to_others, changeable, filter, created_at) VALUES (3, 15, 'plugin_bbb_session_users_limit', 'MaxUsersInConferenceRoom', null, 1, 1, 0, 1, null, '2017-05-28 01:19:32'); +``` + +For version 2.7 +```sql +ALTER TABLE plugin_bbb_meeting ADD COLUMN interface INT NOT NULL DEFAULT 0; +ALTER TABLE plugin_bbb_room ADD COLUMN interface INT NOT NULL DEFAULT 0; +ALTER TABLE plugin_bbb_room MODIFY COLUMN in_at datetime; +ALTER TABLE plugin_bbb_room MODIFY COLUMN out_at datetime; +``` + +For version 2.8 +```sql +ALTER TABLE plugin_bbb_meeting ADD COLUMN internal_meeting_id VARCHAR(255) DEFAULT NULL; +ALTER TABLE plugin_bbb_room ADD close INT NOT NULL DEFAULT 0; +``` + +For version 2.9 (Optional, requires an update version of BBB) + +```sql +ALTER TABLE plugin_bbb_room DROP COLUMN interface; +ALTER TABLE plugin_bbb_meeting DROP COLUMN interface; +``` + +For version 2.10 (Handles multiple recording formats - Check https://github.com/chamilo/chamilo-lms/issues/3703) + +```sql +CREATE TABLE plugin_bbb_meeting_format ( + id int unsigned not null PRIMARY KEY AUTO_INCREMENT, + meeting_id int unsigned not null, + format_type varchar(255) not null, + resource_url text not null +) +``` + +## Improve access tracking in BBB +You need to configure the cron using the *cron_close_meeting.php* file. + +# Digital ocean VM + +In order to use DigitalOceanVM classes a new package is required: + +``` +composer requires toin0u/digitalocean +``` \ No newline at end of file diff --git a/plugin/bbb/admin.php b/plugin/bbb/admin.php new file mode 100644 index 000000000..d1b3304fe --- /dev/null +++ b/plugin/bbb/admin.php @@ -0,0 +1,166 @@ +get_lang('Videoconference'); +$isGlobal = isset($_GET['global']) ? true : false; + +$bbb = new bbb('', '', $isGlobal); +$action = isset($_GET['action']) ? $_GET['action'] : null; + +$currentMonth = date('n'); +$dateStart = isset($_REQUEST['search_meeting_start']) ? $_REQUEST['search_meeting_start'] : date('Y-m-d', mktime(1, 1, 1, $currentMonth, 1, date('Y'))); +$dateEnd = isset($_REQUEST['search_meeting_end']) ? $_REQUEST['search_meeting_end'] : date('Y-m-d', mktime(1, 1, 1, ++$currentMonth, 0, date('Y'))); + +$dateRange = [ + 'search_meeting_start' => $dateStart, + 'search_meeting_end' => $dateEnd, +]; + +$form = new FormValidator(get_lang('Search')); +$form->addDatePicker('search_meeting_start', get_lang('DateStart')); +$form->addDatePicker('search_meeting_end', get_lang('DateEnd')); +$form->addButtonSearch(get_lang('Search')); +$form->setDefaults($dateRange); + +if ($form->validate()) { + $dateRange = $form->getSubmitValues(); +} + +$meetings = $bbb->getMeetings(0, 0, 0, true, $dateRange); + +foreach ($meetings as &$meeting) { + $participants = $bbb->findConnectedMeetingParticipants($meeting['id']); + foreach ($participants as $meetingParticipant) { + /** @var User $participant */ + $participant = $meetingParticipant['participant']; + if ($participant) { + $meeting['participants'][] = $participant->getCompleteName().' ('.$participant->getEmail().')'; + } + } +} + +if ($action) { + switch ($action) { + case 'export': + $dataToExport = [ + [$tool_name, $plugin->get_lang('RecordList')], + [], + [ + get_lang('CreatedAt'), + get_lang('Status'), + $plugin->get_lang('Records'), + get_lang('Course'), + get_lang('Session'), + get_lang('Participants'), + ], + ]; + + foreach ($meetings as $meeting) { + $dataToExport[] = [ + $meeting['created_at'], + $meeting['status'] == 1 ? $plugin->get_lang('MeetingOpened') : $plugin->get_lang('MeetingClosed'), + $meeting['record'] == 1 ? get_lang('Yes') : get_lang('No'), + $meeting['course'] ? $meeting['course']->getTitle() : '-', + $meeting['session'] ? $meeting['session']->getName() : '-', + isset($meeting['participants']) ? implode(PHP_EOL, $meeting['participants']) : null, + ]; + } + + Export::arrayToXls($dataToExport); + break; + } +} + +if (!empty($meetings)) { + $meetings = array_reverse($meetings); +} + +if (!$bbb->isServerRunning()) { + Display::addFlash( + Display::return_message(get_lang('ServerIsNotRunning'), 'error') + ); +} + +$htmlHeadXtra[] = api_get_js_simple( + api_get_path(WEB_PLUGIN_PATH).'bbb/resources/utils.js' +); +$htmlHeadXtra[] = ""; + +$tpl = new Template($tool_name); +$tpl->assign('meetings', $meetings); +$tpl->assign('search_form', $form->returnForm()); + +$settingsForm = new FormValidator('settings', api_get_self()); +$settingsForm->addHeader($plugin->get_lang('UpdateAllCourseSettings')); +$settingsForm->addHtml(Display::return_message($plugin->get_lang('ThisWillUpdateAllSettingsInAllCourses'))); +$settings = $plugin->course_settings; +$defaults = []; +foreach ($settings as $setting) { + $setting = $setting['name']; + $text = $settingsForm->addText($setting, $plugin->get_lang($setting), false); + $text->freeze(); + $defaults[$setting] = api_get_plugin_setting('bbb', $setting) === 'true' ? get_lang('Yes') : get_lang('No'); +} + +$settingsForm->addButtonSave($plugin->get_lang('UpdateAllCourses')); + +if ($settingsForm->validate()) { + $table = Database::get_course_table(TABLE_COURSE_SETTING); + foreach ($settings as $setting) { + $setting = $setting['name']; + $setting = Database::escape_string($setting); + + if (empty($setting)) { + continue; + } + $value = api_get_plugin_setting('bbb', $setting); + if ($value === 'true') { + $value = 1; + } else { + $value = ''; + } + $sql = "UPDATE $table SET value = '$value' WHERE variable = '$setting'"; + Database::query($sql); + } + Display::addFlash(Display::return_message(get_lang('Updated'))); + header('Location: '.api_get_self()); + exit; +} + +$settingsForm->setDefaults($defaults); +$tpl->assign('settings_form', $settingsForm->returnForm()); +$content = $tpl->fetch('bbb/view/admin.tpl'); +if ($meetings) { + $actions = Display::toolbarButton( + get_lang('ExportInExcel'), + api_get_self().'?'.http_build_query([ + 'action' => 'export', + 'search_meeting_start' => $dateStart, + 'search_meeting_end' => $dateEnd, + ]), + 'file-excel-o', + 'success' + ); + + $tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$actions]) + ); +} + +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/bbb/ajax.php b/plugin/bbb/ajax.php new file mode 100644 index 000000000..fa92c5a94 --- /dev/null +++ b/plugin/bbb/ajax.php @@ -0,0 +1,47 @@ +checkDirectMeetingVideoUrl($meetingId)) { + $meetingInfo = Database::select( + '*', + 'plugin_bbb_meeting', + ['where' => ['id = ?' => intval($meetingId)]], + 'first' + ); + + $url = $meetingInfo['video_url'].'/capture.m4v'; + $link = Display::url( + Display::return_icon('save.png', get_lang('DownloadFile')), + $meetingInfo['video_url'].'/capture.m4v', + ['target' => '_blank'] + ); + + header('Content-Type: application/json'); + echo json_encode(['url' => $url, 'link' => $link]); + } + break; +} diff --git a/plugin/bbb/config.php b/plugin/bbb/config.php new file mode 100644 index 000000000..325f9b9d3 --- /dev/null +++ b/plugin/bbb/config.php @@ -0,0 +1,6 @@ + true, + 'vms' => [ + [ + 'enabled' => true, + 'name' => 'DigitalOcean', + 'vm_client_id' => 'client_id', + 'api_key' => '123456', + 'vm_id' => '123456', // The VM ID we want to access + 'vm_min_size_id' => '66', // VM size ID example for 512mb use 66 + 'vm_max_size_id' => '65', // For 1GB use 63 + ], + // The Amazon hook is not implemented yet + [ + 'enabled' => false, + 'name' => 'Amazon', + ], + ], +]; diff --git a/plugin/bbb/course_index.php b/plugin/bbb/course_index.php new file mode 100644 index 000000000..c03e274ff --- /dev/null +++ b/plugin/bbb/course_index.php @@ -0,0 +1,11 @@ +isEnabled()) { + $bbb = new bbb(); + if ($bbb->pluginEnabled) { + $activeSessions = $bbb->getActiveSessionsCount(); + if (empty($activeSessions)) { + $vm->runCron(); + } else { + echo "Can't run cron active sessions found: ".$activeSessions; + } + } + } +} diff --git a/plugin/bbb/cron_close_meeting.php b/plugin/bbb/cron_close_meeting.php new file mode 100644 index 000000000..030841660 --- /dev/null +++ b/plugin/bbb/cron_close_meeting.php @@ -0,0 +1,113 @@ +get('plugin_bbb_multiple_urls_cron_apply_to_all'); + +$bbb = new bbb(); + +if (!$bbb->pluginEnabled) { + return; +} + +$activeSessions = $bbb->getActiveSessions($applyAllUrls); + +if (empty($activeSessions)) { + return; +} + +foreach ($activeSessions as $value) { + $meetingId = $value['id']; + $courseCode = null; + $courseInfo = api_get_course_info_by_id($value['c_id']); + if (!empty($courseInfo)) { + $courseCode = $courseInfo['code']; + } + + $meetingBBB = $bbb->getMeetingInfo( + [ + 'meetingId' => $value['remote_id'], + 'password' => $value['moderator_pw'], + ] + ); + + if ($meetingBBB === false) { + //checking with the remote_id didn't work, so just in case and + // to provide backwards support, check with the id + $params = [ + 'meetingId' => $value['id'], + 'password' => $value['moderator_pw'], + ]; + $meetingBBB = $bbb->getMeetingInfo($params); + } + + if (empty($meetingBBB)) { + continue; + } + + if (!isset($meetingBBB['returncode'])) { + continue; + } + + $action = (string) $meetingBBB['returncode']; + + switch ($action) { + case 'FAILED': + $bbb->endMeeting($value['id'], $courseCode); + break; + case 'SUCCESS': + Database::update( + $roomTable, + ['close' => BBBPlugin::ROOM_CHECK], + ['meeting_id = ? AND close= ?' => [$meetingId, BBBPlugin::ROOM_OPEN]] + ); + + $i = 0; + while ($i < $meetingBBB['participantCount']) { + $participantId = $meetingBBB[$i]['userId']; + $roomData = Database::select( + '*', + $roomTable, + [ + 'where' => [ + 'meeting_id = ? AND participant_id = ? AND close = ?' => [ + $meetingId, + $participantId, + BBBPlugin::ROOM_CHECK, + ], + ], + 'order' => 'id DESC', + ], + 'first' + ); + + if (!empty($roomData)) { + $roomId = $roomData['id']; + if (!empty($roomId)) { + Database::update( + $roomTable, + ['out_at' => api_get_utc_datetime(), 'close' => BBBPlugin::ROOM_OPEN], + ['id = ? ' => $roomId] + ); + } + } + $i++; + } + + Database::update( + $roomTable, + ['out_at' => api_get_utc_datetime(), 'close' => BBBPlugin::ROOM_CLOSE], + ['meeting_id = ? AND close= ?' => [$meetingId, BBBPlugin::ROOM_CHECK]] + ); + + break; + } +} diff --git a/plugin/bbb/index.php b/plugin/bbb/index.php new file mode 100644 index 000000000..b3d9bbc7f --- /dev/null +++ b/plugin/bbb/index.php @@ -0,0 +1 @@ +install(); diff --git a/plugin/bbb/lang/english.php b/plugin/bbb/lang/english.php new file mode 100644 index 000000000..26b532762 --- /dev/null +++ b/plugin/bbb/lang/english.php @@ -0,0 +1,78 @@ +set one up or ask the Chamilo official providers for a quote. BigBlueButton is a free (as in freedom *and* beer), but its installation requires a set of technical skills that might not be immediately available to all. You can install it on your own or seek professional help to assist you or do it for you. This help, however, will generate a certain cost. In the pure logic of the free software, we offer you the tools to make your work easier and recommend professionals (the Chamilo Official Providers) that will be able to help you if this were too difficult.
"; + +$strings['big_blue_button_welcome_message'] = 'Welcome message'; +$strings['enable_global_conference'] = 'Enable global conference'; +$strings['enable_global_conference_per_user'] = 'Enable global conference per user'; +$strings['enable_conference_in_course_groups'] = 'Enable conference in course groups'; +$strings['enable_global_conference_link'] = 'Enable the link to the global conference in the homepage'; +$strings['disable_download_conference_link'] = 'Disable download conference'; +$strings['big_blue_button_record_and_store'] = 'Record and store sessions'; +$strings['bbb_enable_conference_in_groups'] = 'Allow conference in groups'; +$strings['plugin_tool_bbb'] = 'Video'; +$strings['ThereAreNotRecordingsForTheMeetings'] = 'There are not recording for the meeting sessions'; +$strings['NoRecording'] = 'No recording'; +$strings['ClickToContinue'] = 'Click to continue'; +$strings['NoGroup'] = 'No group'; +$strings['UrlMeetingToShare'] = 'URL to share'; +$strings['AdminView'] = 'View for administrators'; +$strings['max_users_limit'] = 'Max users limit'; +$strings['max_users_limit_help'] = 'Set this to the maximum number of users you want to allow by course or session-course. Leave empty or set to 0 to disable this limit.'; +$strings['MaxXUsersWarning'] = 'This conference room has a maximum number of %s simultaneous users.'; +$strings['MaxXUsersReached'] = 'The limit of %s simultaneous users has been reached for this conference room. Please wait for one seat to be freed or for another conference to start in order to join.'; +$strings['MaxXUsersReachedManager'] = 'The limit of %s simultaneous users has been reached for this conference room. To increase this limit, please contact the platform administrator.'; +$strings['MaxUsersInConferenceRoom'] = 'Max simultaneous users in a conference room'; +$strings['global_conference_allow_roles'] = "Global conference link only visible for these user roles"; +$strings['CreatedAt'] = 'Created at'; +$strings['allow_regenerate_recording'] = 'Allow regenerate recording'; +$strings['bbb_force_record_generation'] = 'Force record generation at the end of the meeting'; +$strings['disable_course_settings'] = 'Disable course settings'; +$strings['UpdateAllCourses'] = 'Update all courses'; +$strings['UpdateAllCourseSettings'] = 'Update all course settings'; +$strings['ThisWillUpdateAllSettingsInAllCourses'] = 'This will update at once all your course settings.'; +$strings['ThereIsNoVideoConferenceActive'] = 'There is no videoconference currently active'; +$strings['RoomClosed'] = 'Room closed'; +$strings['RoomClosedComment'] = ' '; +$strings['meeting_duration'] = 'Meeting duration (in minutes)'; +$strings['big_blue_button_students_start_conference_in_groups'] = 'Allow students to start conference in their groups.'; +$strings['plugin_bbb_multiple_urls_cron_apply_to_all'] = 'Automatically closes all rooms on ALL campuses.'; +$strings['plugin_bbb_multiple_urls_cron_apply_to_all_help'] = 'Option for multi-url environments. Allows the CRON task to close all open rooms on mother and child campus.'; diff --git a/plugin/bbb/lang/french.php b/plugin/bbb/lang/french.php new file mode 100644 index 000000000..5db2266c2 --- /dev/null +++ b/plugin/bbb/lang/french.php @@ -0,0 +1,71 @@ +en installer un avant de poursuivre, ou demander un devis à l'un des fournisseurs officiels de Chamilo. BigBlueButton est un outil de logiciel libre (et gratuit), mais son installation pourrait présenter une certaine complexité et demander des compétences qui ne sont peut-être pas à la portée de tous. Vous pouvez l'installer vous-même à partir de la documentation (disponible publiquement) de BigBlueButton, ou recherchez un soutien professionnel. Ce soutien pourrait générer certains coûts (au moins le temps de la personne qui vous assiste dans l'opération). Dans le plus pur esprit du logiciel libre, nous vous fournissons les outils pour simplifier votre travail dans la mesure de nos possibilités, et nous vous recommandons des professionnels (les fournisseurs officiels de Chamilo) pour vous venir en aide au cas où ceux-ci seraient insuffisants.
"; + +$strings['big_blue_button_welcome_message'] = 'Message de bienvenue de BigBlueButton'; +$strings['enable_global_conference'] = 'Activer les conférences globales'; +$strings['enable_global_conference_per_user'] = 'Activer les conférences globales par utilisateur'; +$strings['enable_conference_in_course_groups'] = 'Activer les conférences dans les groupes'; +$strings['enable_global_conference_link'] = 'Activer le lien vers la conférence globale sur la page principale'; + +$strings['big_blue_button_record_and_store'] = 'Enregistrer les sessions de vidéoconférence'; +$strings['bbb_enable_conference_in_groups'] = 'Permettre la création de vidéoconférence pour les groupes'; +$strings['plugin_tool_bbb'] = 'Vidéo'; +$strings['ThereAreNotRecordingsForTheMeetings'] = 'Aucun enregistrement disponible'; +$strings['NoRecording'] = "Pas d'enregistrement"; +$strings['ClickToContinue'] = 'Cliquez pour continuer'; +$strings['NoGroup'] = 'Sans groupe'; +$strings['UrlMeetingToShare'] = 'URL à partager'; + +$strings['AdminView'] = 'Vue administrateur'; +$strings['max_users_limit'] = 'Utilisateurs maximum'; +$strings['max_users_limit_help'] = 'Nombre maximum d\'utilisateurs simultanés dans une salle de vidéoconférence de cours ou cours-session. Laisser vide ou sur 0 pour ne pas assigner de limite.'; +$strings['MaxXUsersWarning'] = 'Cette salle de conférence est limitée à %s utilisateurs simultanés.'; +$strings['MaxXUsersReached'] = 'La limite de %s utilisateurs simultanés a été atteinte dans cette salle de conférence. Veuillez rafraîchir dans quelque minutes pour voir si un siège s\'est libéré, ou attendre l\'ouverture d\'une nouvelle salle de conférence pour participer.'; +$strings['MaxXUsersReachedManager'] = 'La limite de %s utilisateurs simultanés a été atteinte dans cette salle de conférence. Pour augmenter la limite, prenez contact avec l\'administrateur du portail.'; +$strings['MaxUsersInConferenceRoom'] = 'Nombre max d\'utilisateurs simultanés dans une salle de conférence'; +$strings['global_conference_allow_roles'] = "Visibilité du lien de vidéo conférence global pour les profils suivant"; +$strings['CreatedAt'] = "Créé à"; + +$strings['bbb_force_record_generation'] = 'Forcer la génération de l\'enregistrement à la fin de la session'; +$strings['ThereIsNoVideoConferenceActive'] = "Il n'y a aucune vidéoconférence actuellement active"; +$strings['meeting_duration'] = 'Durée de la conférence (en minutes)'; +$strings['big_blue_button_students_start_conference_in_groups'] = 'Permettre aux apprenants de démarrer les vidéoconferénces de leurs groupes'; diff --git a/plugin/bbb/lang/german.php b/plugin/bbb/lang/german.php new file mode 100644 index 000000000..f670f321e --- /dev/null +++ b/plugin/bbb/lang/german.php @@ -0,0 +1,65 @@ +set one up or ask the Chamilo official providers for a quote. BigBlueButton is a free (as in freedom *and* beer), but its installation requires a set of technical skills that might not be immediately available to all. You can install it on your own or seek professional help to assist you or do it for you. This help, however, will generate a certain cost. In the pure logic of the free software, we offer you the tools to make your work easier and recommend professionals (the Chamilo Official Providers) that will be able to help you if this were too difficult.
"; + +$strings['big_blue_button_welcome_message'] = 'Willkommensnachricht'; +$strings['enable_global_conference'] = 'Globale Konferenz aktivieren'; +$strings['enable_global_conference_per_user'] = 'Globale Konferenz pro Benutzer aktivieren'; +$strings['enable_conference_in_course_groups'] = 'Konferenz in Kurs-Gruppen aktivieren'; +$strings['enable_global_conference_link'] = 'Aktivieren Sie den Link zur globalen Konferenz auf der Website'; + +$strings['big_blue_button_record_and_store'] = 'Aufnehmen und Speichern von Meetings'; +$strings['bbb_enable_conference_in_groups'] = 'Konferenz in Gruppen zulassen'; +$strings['plugin_tool_bbb'] = 'Video'; +$strings['ThereAreNotRecordingsForTheMeetings'] = 'Es gibt keine Aufnahmen von den Meetings'; +$strings['NoRecording'] = 'Keine Videoaufzeichnung'; +$strings['ClickToContinue'] = 'Klicken um fortzufahren'; +$strings['NoGroup'] = 'Keine Gruppe'; +$strings['UrlMeetingToShare'] = 'URL zu teilen'; + +$strings['AdminView'] = 'Administrator Ansicht'; +$strings['max_users_limit'] = 'Maximale Anzahl von Benutzern'; +$strings['max_users_limit_help'] = 'Setzen Sie diese auf die maximale Anzahl der Benutzer, die Sie nach Kurs oder Session-Kurs erlauben möchten. Leer lassen oder auf 0 setzen, um dieses Limit zu deaktivieren.'; +$strings['MaxXUsersWarning'] = 'Dieser Konferenzraum hat eine maximale Anzahl von %s gleichzeitigen Benutzern.'; +$strings['MaxXUsersReached'] = 'The limit of %s simultaneous users has been reached for this conference room. Please wait for one seat to be freed or for another conference to start in order to join.'; +$strings['MaxXUsersReachedManager'] = 'The limit of %s simultaneous users has been reached for this conference room. To increase this limit, please contact the platform administrator.'; +$strings['MaxUsersInConferenceRoom'] = 'Max simultaneous users in a conference room'; +$strings['global_conference_allow_roles'] = "Globaler Konferenz-Link nur für diese Benutzerrollen sichtbar"; +$strings['CreatedAt'] = "Erstellt am"; diff --git a/plugin/bbb/lang/spanish.php b/plugin/bbb/lang/spanish.php new file mode 100644 index 000000000..6be449b6d --- /dev/null +++ b/plugin/bbb/lang/spanish.php @@ -0,0 +1,71 @@ +configure uno antes de seguir, o pida una cotización a uno de los proveedores oficiales de Chamilo. BigBlueButton es una herramienta de software libre (y gratuita), pero su instalación requiere de competencias que quizás no sean inmediatamente disponibles para todos. Puede instalarla usted mismo o buscar ayuda profesional. Esta ayuda podría no obstante generar algunos costos (por lo menos el tiempo de la persona quien lo ayude). En el puro espíritu del software libre, le ofrecemos las herramientas para hacer su trabajo más simple, en la medida de nuestras posibilidades, y le recomendamos profesionales (los proveedores oficiales de Chamilo) para ayudarlo en caso esto fuera demasiado complicado.
"; + +$strings['big_blue_button_welcome_message'] = 'Mensaje de bienvenida de BigBlueButton'; +$strings['enable_global_conference'] = 'Activar la conferencia global'; +$strings['enable_global_conference_per_user'] = 'Activar la conferencia global por usuario'; +$strings['enable_conference_in_course_groups'] = 'Activar las conferencias en grupos'; +$strings['enable_global_conference_link'] = 'Activar el enlace hacia la conferencia global desde la página principal'; + +$strings['big_blue_button_record_and_store'] = 'Grabar las sesiones de videoconferencia.'; +$strings['bbb_enable_conference_in_groups'] = 'Activar la creación de videoconferencia en los grupos.'; +$strings['plugin_tool_bbb'] = 'Videoconferencia'; +$strings['ThereAreNotRecordingsForTheMeetings'] = 'No hay grabaciones de sesiones de videoconferencia'; +$strings['NoRecording'] = 'No hay grabación'; +$strings['ClickToContinue'] = 'Hacer click para continuar'; +$strings['NoGroup'] = 'No hay grupo'; +$strings['UrlMeetingToShare'] = 'URL a compartir'; + +$strings['AdminView'] = 'Vista para administradores'; +$strings['max_users_limit'] = 'Cantidad máxima de usuarios'; +$strings['max_users_limit_help'] = 'Este valor indica la cantidad máxima de usuarios simultáneos en una conferencia en un curso o curso-sesión. Dejar vacío o en 0 para no poner límite.'; +$strings['MaxXUsersWarning'] = 'Esta sala de conferencia es limitada a un máximo de %s usuarios simultáneos.'; +$strings['MaxXUsersReached'] = 'El límite de %s usuarios simultáneos ha sido alcanzado en esta sala de conferencia. Por favor refresque la página en unos minutos para ver si un asiento se ha liberado, o espere la apertura de una nueva sala para poder participar.'; +$strings['MaxXUsersReachedManager'] = 'El límite de %s usuarios simultáneos ha sido alcanzado en esta sala de conferencia. Para aumentar el límite, contáctese con el administrador del portal.'; +$strings['MaxUsersInConferenceRoom'] = 'Número máximo de usuarios simultáneos en una sala de conferencia'; +$strings['global_conference_allow_roles'] = 'El enlace de videoconferencia global es disponible para estos perfiles'; +$strings['CreatedAt'] = 'Creado el'; +$strings['ThereIsNoVideoConferenceActive'] = "No hay una videoconferencia actualmente activa"; +$strings['meeting_duration'] = 'Duración de la reunión (en minutos)'; +$strings['big_blue_button_students_start_conference_in_groups'] = 'Permitir a los estudiantes iniciar una videoconferencia en sus grupos.'; +$strings['plugin_bbb_multiple_urls_cron_apply_to_all'] = 'Cerrar automáticamente todas las salas sin actividad en TODOS los campus.'; +$strings['plugin_bbb_multiple_urls_cron_apply_to_all_help'] = 'Opción para entornos multi-url. Permite a la tarea CRON cerrar todas las salas abiertas del campus madre e hijos.'; diff --git a/plugin/bbb/lib/VM.php b/plugin/bbb/lib/VM.php new file mode 100644 index 000000000..591371797 --- /dev/null +++ b/plugin/bbb/lib/VM.php @@ -0,0 +1,116 @@ +config = $config; + } + + /** + * @return array + */ + public function getConfig() + { + return $this->config; + } + + /** + * @param bool $checkEnabled Check if, additionnally to being installed, the plugin is enabled + * @return bool + */ + public function isEnabled(bool $checkEnabled = false): bool + { + $config = $this->getConfig(); + + if (!isset($config)) { + + return false; + } + + if (!is_array($config)) { + return false; + } + + if (isset($config['enabled']) && $config['enabled']) { + + return true; + } + + return false; + } + + /** + * @return VirtualMachineInterface + */ + public function getVirtualMachine() + { + return $this->virtualMachine; + } + + /** + * @param VirtualMachineInterface $virtualMachine + */ + public function setVirtualMachine(VirtualMachineInterface $virtualMachine) + { + $this->virtualMachine = $virtualMachine; + } + + /** + * @return VirtualMachineInterface + */ + public function getVirtualMachineFromConfig() + { + $vmList = $this->config['vms']; + + foreach ($vmList as $vm) { + if (isset($vm['enabled']) && $vm['enabled'] == true) { + $className = $vm['name'].'VM'; + + return new $className($vm); + break; + } + } + + return false; + } + + /** + * Resize the VM to the max size + */ + public function resizeToMaxLimit() + { + $virtualMachine = $this->getVirtualMachineFromConfig(); + $this->setVirtualMachine($virtualMachine); + $virtualMachine->resizeToMaxLimit(); + } + + /** + * Resize the VM to the min size + */ + public function resizeToMinLimit() + { + $virtualMachine = $this->getVirtualMachineFromConfig(); + $this->setVirtualMachine($virtualMachine); + $virtualMachine->resizeToMinLimit(); + } + + public function runCron() + { + $virtualMachine = $this->getVirtualMachineFromConfig(); + $this->setVirtualMachine($virtualMachine); + + $virtualMachine->runCron(); + } +} diff --git a/plugin/bbb/lib/bbb.lib.php b/plugin/bbb/lib/bbb.lib.php new file mode 100644 index 000000000..904774596 --- /dev/null +++ b/plugin/bbb/lib/bbb.lib.php @@ -0,0 +1,2232 @@ +courseCode = api_get_course_id(); + $this->courseId = api_get_course_int_id(); + $this->sessionId = api_get_session_id(); + $this->groupId = api_get_group_id(); + + // Initialize video server settings from global settings + $this->plugin = BBBPlugin::create(); + $bbbPluginEnabled = $this->plugin->get('tool_enable'); + + $bbb_host = !empty($host) ? $host : $this->plugin->get('host'); + $bbb_salt = !empty($salt) ? $salt : $this->plugin->get('salt'); + + $this->table = Database::get_main_table('plugin_bbb_meeting'); + $this->enableGlobalConference = $this->plugin->get('enable_global_conference') === 'true'; + $this->isGlobalConference = (bool) $isGlobalConference; + + $columns = Database::listTableColumns($this->table); + $this->groupSupport = isset($columns['group_id']) ? true : false; + $this->userSupport = isset($columns['user_id']) ? true : false; + $this->accessUrl = api_get_current_access_url_id(); + + $this->enableGlobalConferencePerUser = false; + if ($this->userSupport && !empty($isGlobalPerUser)) { + $this->enableGlobalConferencePerUser = $this->plugin->get('enable_global_conference_per_user') === 'true'; + $this->userId = $isGlobalPerUser; + } + + if ($this->groupSupport) { + // Plugin check + $this->groupSupport = $this->plugin->get('enable_conference_in_course_groups') === 'true' ? true : false; + if ($this->groupSupport) { + // Platform check + $bbbSetting = api_get_setting('bbb_enable_conference_in_course_groups'); + $bbbSetting = isset($bbbSetting['bbb']) ? $bbbSetting['bbb'] === 'true' : false; + + if ($bbbSetting) { + // Course check + $courseInfo = api_get_course_info(); + if ($courseInfo) { + $this->groupSupport = api_get_course_plugin_setting( + 'bbb', + 'bbb_enable_conference_in_groups', + $courseInfo + ) === '1'; + } + } + } + } + $this->maxUsersLimit = $this->plugin->get('max_users_limit'); + + if ($bbbPluginEnabled === 'true') { + $userInfo = api_get_user_info(); + if (empty($userInfo) && !empty($isGlobalPerUser)) { + // If we are following a link to a global "per user" conference + // then generate a random guest name to join the conference + // because there is no part of the process where we give a name + //$this->userCompleteName = 'Guest'.rand(1000, 9999); + } else { + $this->userCompleteName = $userInfo['complete_name']; + } + + if (api_is_anonymous()) { + $this->userCompleteName = get_lang('Guest').'_'.rand(1000, 9999); + } + + $this->salt = $bbb_salt; + if (!empty($bbb_host)) { + if (substr($bbb_host, -1, 1) !== '/') { + $bbb_host .= '/'; + } + $this->url = $bbb_host; + if (!preg_match('#/bigbluebutton/$#', $bbb_host)) { + $this->url = $bbb_host.'bigbluebutton/'; + } + } + $info = parse_url($bbb_host); + + if (isset($info['scheme'])) { + $this->protocol = $info['scheme'].'://'; + $this->url = str_replace($this->protocol, '', $this->url); + $urlWithProtocol = $bbb_host; + } else { + // We assume it's an http, if user wants to use https, the host *must* include the protocol. + $this->protocol = 'http://'; + $urlWithProtocol = $this->protocol.$bbb_host; + } + + // Setting BBB api + define('CONFIG_SECURITY_SALT', $this->salt); + define('CONFIG_SERVER_URL_WITH_PROTOCOL', $urlWithProtocol); + define('CONFIG_SERVER_BASE_URL', $this->url); + define('CONFIG_SERVER_PROTOCOL', $this->protocol); + + $this->api = new BigBlueButtonBN(); + $this->pluginEnabled = true; + $this->logoutUrl = $this->getListingUrl(); + } + } + + /** + * @param int $courseId Optional. Course ID. + * @param int $sessionId Optional. Session ID. + * @param int $groupId Optional. Group ID. + * + * @return string + */ + public function getListingUrl($courseId = 0, $sessionId = 0, $groupId = 0) + { + return api_get_path(WEB_PLUGIN_PATH).'bbb/listing.php?' + .$this->getUrlParams($courseId, $sessionId, $groupId); + } + + /** + * @param int $courseId Optional. Course ID. + * @param int $sessionId Optional. Session ID. + * @param int $groupId Optional. Group ID. + * + * @return string + */ + public function getUrlParams($courseId = 0, $sessionId = 0, $groupId = 0) + { + if (empty($this->courseCode) && !$courseId) { + if ($this->isGlobalConferencePerUserEnabled()) { + return 'global=1&user_id='.$this->userId; + } + + if ($this->isGlobalConference()) { + return 'global=1'; + } + + return ''; + } + + $courseCode = $this->courseCode; + if (!empty($courseId)) { + $course = api_get_course_info_by_id($courseId); + if ($course) { + $courseCode = $course['code']; + } + } + + return http_build_query( + [ + 'cidReq' => $courseCode, + 'id_session' => $sessionId ?: $this->sessionId, + 'gidReq' => $groupId ?: $this->groupId, + ] + ); + } + + /** + * @return bool + */ + public function isGlobalConferencePerUserEnabled() + { + return $this->enableGlobalConferencePerUser; + } + + /** + * @return bool + */ + public function isGlobalConference() + { + if ($this->isGlobalConferenceEnabled() === false) { + return false; + } + + return (bool) $this->isGlobalConference; + } + + /** + * @return bool + */ + public function isGlobalConferenceEnabled() + { + return $this->enableGlobalConference; + } + + /** + * @param array $userInfo + * + * @return bool + */ + public static function showGlobalConferenceLink($userInfo) + { + if (empty($userInfo)) { + return false; + } + $setting = api_get_plugin_setting('bbb', 'enable_global_conference'); + $settingLink = api_get_plugin_setting('bbb', 'enable_global_conference_link'); + if ($setting === 'true' && $settingLink === 'true') { + //$content = Display::url(get_lang('LaunchVideoConferenceRoom'), $url); + $allowedRoles = api_get_plugin_setting( + 'bbb', + 'global_conference_allow_roles' + ); + + if (api_is_platform_admin()) { + $userInfo['status'] = PLATFORM_ADMIN; + } + + $showGlobalLink = true; + if (!empty($allowedRoles)) { + if (!in_array($userInfo['status'], $allowedRoles)) { + $showGlobalLink = false; + } + } + + return $showGlobalLink; + } + } + + /** + * Gets the global limit of users in a video-conference room. + * This value can be overridden by course-specific values + * @return int Maximum number of users set globally + */ + public function getMaxUsersLimit() + { + $limit = $this->maxUsersLimit; + if ($limit <= 0) { + $limit = 0; + } + $courseLimit = 0; + $sessionLimit = 0; + // Check the extra fields for this course and session + // Session limit takes priority over course limit + // Course limit takes priority over global limit + if (!empty($this->courseId)) { + $extraField = new ExtraField('course'); + $fieldId = $extraField->get_all( + array('variable = ?' => 'plugin_bbb_course_users_limit') + ); + $extraValue = new ExtraFieldValue('course'); + $value = $extraValue->get_values_by_handler_and_field_id($this->courseId, $fieldId[0]['id']); + if (!empty($value['value'])) { + $courseLimit = (int) $value['value']; + } + } + if (!empty($this->sessionId)) { + $extraField = new ExtraField('session'); + $fieldId = $extraField->get_all( + array('variable = ?' => 'plugin_bbb_session_users_limit') + ); + $extraValue = new ExtraFieldValue('session'); + $value = $extraValue->get_values_by_handler_and_field_id($this->sessionId, $fieldId[0]['id']); + if (!empty($value['value'])) { + $sessionLimit = (int) $value['value']; + } + } + + if (!empty($sessionLimit)) { + return $sessionLimit; + } elseif (!empty($courseLimit)) { + return $courseLimit; + } + + return (int) $limit; + } + + /** + * Sets the global limit of users in a video-conference room. + * + * @param int Maximum number of users (globally) + */ + public function setMaxUsersLimit($max) + { + if ($max < 0) { + $max = 0; + } + $this->maxUsersLimit = (int) $max; + } + + /** + * See this file in you BBB to set up default values + * + * @param array $params Array of parameters that will be completed if not containing all expected variables + * + * /var/lib/tomcat6/webapps/bigbluebutton/WEB-INF/classes/bigbluebutton.properties + * + * More record information: + * http://code.google.com/p/bigbluebutton/wiki/RecordPlaybackSpecification + * + * Default maximum number of users a meeting can have. + * Doesn't get enforced yet but is the default value when the create + * API doesn't pass a value. + * defaultMaxUsers=20 + * + * Default duration of the meeting in minutes. + * Current default is 0 (meeting doesn't end). + * defaultMeetingDuration=0 + * + * Remove the meeting from memory when the end API is called. + * This allows 3rd-party apps to recycle the meeting right-away + * instead of waiting for the meeting to expire (see below). + * removeMeetingWhenEnded=false + * + * The number of minutes before the system removes the meeting from memory. + * defaultMeetingExpireDuration=1 + * + * The number of minutes the system waits when a meeting is created and when + * a user joins. If after this period, a user hasn't joined, the meeting is + * removed from memory. + * defaultMeetingCreateJoinDuration=5 + * + * @return mixed + */ + public function createMeeting($params) + { + $params['c_id'] = api_get_course_int_id(); + $params['session_id'] = api_get_session_id(); + + if ($this->hasGroupSupport()) { + $params['group_id'] = api_get_group_id(); + } + + if ($this->isGlobalConferencePerUserEnabled() && !empty($this->userId)) { + $params['user_id'] = (int) $this->userId; + } + + $params['attendee_pw'] = isset($params['attendee_pw']) ? $params['attendee_pw'] : $this->getUserMeetingPassword(); + $attendeePassword = $params['attendee_pw']; + $params['moderator_pw'] = isset($params['moderator_pw']) ? $params['moderator_pw'] : $this->getModMeetingPassword(); + $moderatorPassword = $params['moderator_pw']; + + $params['record'] = api_get_course_plugin_setting('bbb', 'big_blue_button_record_and_store') == 1; + $max = api_get_course_plugin_setting('bbb', 'max_users_limit'); + $max = isset($max) ? $max : -1; + + $params['status'] = 1; + // Generate a pseudo-global-unique-id to avoid clash of conferences on + // the same BBB server with several Chamilo portals + $params['remote_id'] = uniqid(true, true); + // Each simultaneous conference room needs to have a different + // voice_bridge composed of a 5 digits number, so generating a random one + $params['voice_bridge'] = rand(10000, 99999); + $params['created_at'] = api_get_utc_datetime(); + $params['access_url'] = $this->accessUrl; + + $id = Database::insert($this->table, $params); + + if ($id) { + Event::addEvent( + 'bbb_create_meeting', + 'meeting_id', + (int) $id, + null, + api_get_user_id(), + api_get_course_int_id(), + api_get_session_id() + ); + + $meetingName = $params['meeting_name'] ?? $this->generateVideoConferenceName(); + $welcomeMessage = $params['welcome_msg'] ?? null; + $record = $params['record'] ? 'true' : 'false'; + //$duration = isset($params['duration']) ? intval($params['duration']) : 0; + // This setting currently limits the maximum conference duration, + // to avoid lingering sessions on the video-conference server #6261 + $duration = 300; + $meetingDuration = (int) $this->plugin->get('meeting_duration'); + if (!empty($meetingDuration)) { + $duration = $meetingDuration; + } + $url = api_get_access_url(api_get_current_access_url_id())['url']; + $bbbParams = array( + 'meetingId' => $params['remote_id'], // REQUIRED + 'meetingName' => $meetingName, // REQUIRED + 'attendeePw' => $attendeePassword, // Match this value in getJoinMeetingURL() to join as attendee. + 'moderatorPw' => $moderatorPassword, // Match this value in getJoinMeetingURL() to join as moderator. + 'welcomeMsg' => $welcomeMessage, // ''= use default. Change to customize. + 'dialNumber' => '', // The main number to call into. Optional. + 'voiceBridge' => $params['voice_bridge'], // PIN to join voice. Required. + 'webVoice' => '', // Alphanumeric to join voice. Optional. + 'logoutUrl' => $this->logoutUrl.'&action=logout&remote_id='.$params['remote_id'], + 'maxParticipants' => $max, // Optional. -1 = unlimitted. Not supported in BBB. [number] + 'record' => $record, // New. 'true' will tell BBB to record the meeting. + 'duration' => $duration, // Default = 0 which means no set duration in minutes. [number] + 'meta_OriginURL' => $url, // Add url information to BBB meeting info (see 'meta' info at https://docs.bigbluebutton.org/dev/api.html#create) + //'meta_category' => '', // Use to pass additional info to BBB server. See API docs. + ); + + $status = false; + $meeting = null; + while ($status === false) { + $result = $this->api->createMeetingWithXmlResponseArray($bbbParams); + if (isset($result) && strval($result['returncode']) == 'SUCCESS') { + if ($this->plugin->get('allow_regenerate_recording') === 'true') { + $internalId = Database::escape_string($result['internalMeetingID']); + $sql = "UPDATE $this->table SET internal_meeting_id = '".$internalId."' + WHERE id = $id"; + Database::query($sql); + } + $meeting = $this->joinMeeting($meetingName, true); + + return $meeting; + } + } + } + + return false; + } + + /** + * @return bool + */ + public function hasGroupSupport() + { + return $this->groupSupport; + } + + /** + * Gets the password for a specific meeting for the current user + * + * @param string $courseCode + * + * @return string A moderator password if user is teacher, or the course code otherwise + * + */ + public function getUserMeetingPassword($courseCode = null) + { + if ($this->isGlobalConferencePerUserEnabled()) { + return 'url_'.$this->userId.'_'.api_get_current_access_url_id(); + } + + if ($this->isGlobalConference()) { + return 'url_'.api_get_current_access_url_id(); + } + $courseCode = empty($courseCode) ? api_get_course_id() : $courseCode; + + return $courseCode; + } + + /** + * Generated a moderator password for the meeting. + * + * @param string $courseCode + * + * @return string A password for the moderation of the videoconference + */ + public function getModMeetingPassword($courseCode = null) + { + if ($this->isGlobalConferencePerUserEnabled()) { + return 'url_'.$this->userId.'_'.api_get_current_access_url_id().'_mod'; + } + + if ($this->isGlobalConference()) { + return 'url_'.api_get_current_access_url_id().'_mod'; + } + + $courseCode = empty($courseCode) ? api_get_course_id() : $courseCode; + + return $courseCode.'mod'; + } + + /** + * Get the info from the current open videoconference. + * Otherwise, return false. + * + * @return array|bool + */ + public function getCurrentVideoConference() + { + $whereConditions = [ + 'status = ?' => 1, + ]; + + if ($this->isGlobalConferencePerUserEnabled()) { + $whereConditions[' AND user_id = ?'] = $this->userId; + } + + if ($this->isGlobalConference()) { + $whereConditions[' AND access_url = ?'] = api_get_current_access_url_id(); + } + + if ($this->hasGroupSupport()) { + $whereConditions[' AND group_id = ?'] = api_get_group_id(); + } + + $cId = api_get_course_int_id(); + $sessionId = api_get_session_id(); + + if ($cId) { + $whereConditions[' AND c_id = ?'] = api_get_course_int_id(); + } + + if ($sessionId) { + $whereConditions[' AND session_id = ?'] = api_get_session_id(); + } + + return Database::select( + '*', + $this->table, + [ + 'where' => $whereConditions, + 'order' => 'created_at DESC', + ], + 'first' + ); + } + + public function generateVideoConferenceName(string $defaultName = null): string + { + $nameFilter = function ($name) { + return URLify::filter( + $name, + 64, + '', + true, + true, + true, + false + ); + }; + + if (!empty($defaultName)) { + $name = $nameFilter($defaultName); + + if (!empty($name)) { + return $name; + } + } + + $urlId = api_get_current_access_url_id(); + + if ($this->isGlobalConferencePerUserEnabled()) { + return $nameFilter("url_{$this->userId}_$urlId"); + } + + if ($this->isGlobalConference()) { + return $nameFilter("url_$urlId"); + } + + $course = api_get_course_entity(); + $session = api_get_session_entity(); + $group = api_get_group_entity(); + + if ($this->hasGroupSupport()) { + $name = implode( + '-', + [ + $course->getCode(), + $session ? $session->getName() : '', + $group ? $group->getName() : '', + ] + ); + + return $nameFilter($name); + } + + $name = implode( + '-', + [ + $course->getCode(), + $session ? $session->getName() : '', + ] + ); + + return $nameFilter($name); + } + + /** + * Returns a meeting "join" URL + * + * @param string The name of the meeting (usually the course code) + * + * @return mixed The URL to join the meeting, or false on error + * @todo implement moderator pass + * @assert ('') === false + * @assert ('abcdefghijklmnopqrstuvwxyzabcdefghijklmno') === false + */ + public function joinMeeting($meetingName) + { + if ($this->debug) { + error_log("joinMeeting: $meetingName"); + } + + if (empty($meetingName)) { + return false; + } + + $manager = $this->isConferenceManager(); + if ($manager) { + $pass = $this->getModMeetingPassword(); + } else { + $pass = $this->getUserMeetingPassword(); + } + + $meetingData = Database::select( + '*', + $this->table, + array( + 'where' => array( + 'meeting_name = ? AND status = 1' => array( + $meetingName, + ), + ), + ), + 'first' + ); + + if (empty($meetingData) || !is_array($meetingData)) { + if ($this->debug) { + error_log("meeting does not exist: $meetingName"); + } + + return false; + } + + $params = array( + 'meetingId' => $meetingData['remote_id'], + // -- REQUIRED - The unique id for the meeting + 'password' => $this->getModMeetingPassword() + // -- REQUIRED - The moderator password for the meeting + ); + + $meetingInfoExists = false; + $meetingIsRunningInfo = $this->getMeetingInfo($params); + if ($this->debug) { + error_log('Searching meeting with params:'); + error_log(print_r($params, 1)); + error_log('Result:'); + error_log(print_r($meetingIsRunningInfo, 1)); + } + + if ($meetingIsRunningInfo === false) { + // checking with the remote_id didn't work, so just in case and + // to provide backwards support, check with the id + $params = array( + 'meetingId' => $meetingData['id'], + // -- REQUIRED - The unique id for the meeting + 'password' => $this->getModMeetingPassword() + // -- REQUIRED - The moderator password for the meeting + ); + $meetingIsRunningInfo = $this->getMeetingInfo($params); + if ($this->debug) { + error_log('Searching meetingId with params:'); + error_log(print_r($params, 1)); + error_log('Result:'); + error_log(print_r($meetingIsRunningInfo, 1)); + } + } + + if (strval($meetingIsRunningInfo['returncode']) === 'SUCCESS' && + isset($meetingIsRunningInfo['meetingName']) && + !empty($meetingIsRunningInfo['meetingName']) + ) { + $meetingInfoExists = true; + } + + if ($this->debug) { + error_log( + "meeting is running: ".intval($meetingInfoExists) + ); + } + + $url = false; + if ($meetingInfoExists) { + $joinParams = [ + 'meetingId' => $meetingData['remote_id'], + // -- REQUIRED - A unique id for the meeting + 'username' => $this->userCompleteName, + //-- REQUIRED - The name that will display for the user in the meeting + 'password' => $pass, + //-- REQUIRED - The attendee or moderator password, depending on what's passed here + //'createTime' => api_get_utc_datetime(), //-- OPTIONAL - string. Leave blank ('') unless you set this correctly. + 'userID' => api_get_user_id(), + //-- OPTIONAL - string + 'webVoiceConf' => '', + ]; + $url = $this->api->getJoinMeetingURL($joinParams); + $url = $this->protocol.$url; + } + + if ($this->debug) { + error_log("return url :".$url); + } + + return $url; + } + + /** + * Checks whether a user is teacher in the current course + * @return bool True if the user can be considered a teacher in this course, false otherwise + */ + public function isConferenceManager() + { + if (api_is_coach() || api_is_platform_admin(false, true)) { + return true; + } + + if ($this->isGlobalConferencePerUserEnabled()) { + $currentUserId = api_get_user_id(); + if ($this->userId === $currentUserId) { + return true; + } else { + return false; + } + } + + $courseInfo = api_get_course_info(); + $groupId = api_get_group_id(); + if (!empty($groupId) && !empty($courseInfo)) { + $groupEnabled = api_get_course_plugin_setting('bbb', 'bbb_enable_conference_in_groups') === '1'; + if ($groupEnabled) { + $studentCanStartConference = api_get_course_plugin_setting( + 'bbb', + 'big_blue_button_students_start_conference_in_groups' + ) === '1'; + + if ($studentCanStartConference) { + $isSubscribed = GroupManager::is_user_in_group( + api_get_user_id(), + GroupManager::get_group_properties($groupId) + ); + if ($isSubscribed) { + return true; + } + } + } + } + + if (!empty($courseInfo)) { + return api_is_course_admin(); + } + + return false; + } + + /** + * Get information about the given meeting + * + * @param array ...? + * + * @return mixed Array of information on success, false on error + * @assert (array()) === false + */ + public function getMeetingInfo($params) + { + try { + $result = $this->api->getMeetingInfoWithXmlResponseArray($params); + if ($result == null) { + if ($this->debug) { + error_log("Failed to get any response. Maybe we can't contact the BBB server."); + } + } + + return $result; + } catch (Exception $e) { + if ($this->debug) { + error_log('Caught exception: ', $e->getMessage(), "\n"); + } + } + + return false; + } + + + /** + * @param int $meetingId + * @param int $userId + * + * @return array + */ + public function getMeetingParticipantInfo($meetingId, $userId) + { + $meetingData = Database::select( + '*', + 'plugin_bbb_room', + array('where' => array('meeting_id = ? AND participant_id = ?' => [$meetingId, $userId])), + 'first' + ); + + if ($meetingData) { + return $meetingData; + } + + return []; + } + + /** + * Save a participant in a meeting room + * + * @param int $meetingId + * @param int $participantId + * + * @return false|int The last inserted ID. Otherwise return false + */ + public function saveParticipant($meetingId, $participantId) + { + $meetingData = Database::select( + '*', + 'plugin_bbb_room', + [ + 'where' => [ + 'meeting_id = ? AND participant_id = ? AND close = ?' => [ + $meetingId, + $participantId, + BBBPlugin::ROOM_OPEN, + ], + ], + ] + ); + + foreach ($meetingData as $roomItem) { + $inAt = $roomItem['in_at']; + $outAt = $roomItem['out_at']; + $roomId = $roomItem['id']; + if (!empty($roomId)) { + if ($inAt != $outAt) { + Database::update( + 'plugin_bbb_room', + ['close' => BBBPlugin::ROOM_CLOSE], + ['id = ? ' => $roomId] + ); + } else { + Database::update( + 'plugin_bbb_room', + ['out_at' => api_get_utc_datetime(), 'close' => BBBPlugin::ROOM_CLOSE], + ['id = ? ' => $roomId] + ); + } + } + } + + $params = [ + 'meeting_id' => $meetingId, + 'participant_id' => $participantId, + 'in_at' => api_get_utc_datetime(), + 'out_at' => api_get_utc_datetime(), + 'close' => BBBPlugin::ROOM_OPEN, + ]; + + return Database::insert( + 'plugin_bbb_room', + $params + ); + } + + /** + * Tells whether the given meeting exists and is running + * (using course code as name) + * + * @param string $meetingName Meeting name (usually the course code) + * + * @return bool True if meeting exists, false otherwise + * @assert ('') === false + * @assert ('abcdefghijklmnopqrstuvwxyzabcdefghijklmno') === false + */ + public function meetingExists($meetingName) + { + $meetingData = $this->getMeetingByName($meetingName); + + return !empty($meetingData); + } + + /** + * @param string $meetingName + * + * @return array + */ + public function getMeetingByName($meetingName) + { + if (empty($meetingName)) { + return []; + } + + $courseId = api_get_course_int_id(); + $sessionId = api_get_session_id(); + $conditions = array( + 'where' => array( + 'c_id = ? AND session_id = ? AND meeting_name = ? AND status = 1' => + array($courseId, $sessionId, $meetingName), + )); + + if ($this->hasGroupSupport()) { + $groupId = api_get_group_id(); + $conditions = array( + 'where' => array( + 'c_id = ? AND session_id = ? AND meeting_name = ? AND group_id = ? AND status = 1 AND access_url = ?' => + array( + $courseId, + $sessionId, + $meetingName, + $groupId, + $this->accessUrl, + ), + ), + ); + } + + $meetingData = Database::select( + '*', + $this->table, + $conditions, + 'first' + ); + + if ($this->debug) { + error_log('meeting_exists '.print_r($meetingData, 1)); + } + + return $meetingData; + } + + /** + * Gets a list from the database of all meetings attached to a course with the given status + * @param int $courseId + * @param int $sessionId + * @param int $status 0 for closed meetings, 1 for open meetings + * + * @return array + */ + public function getAllMeetingsInCourse($courseId, $sessionId, $status) + { + $conditions = array( + 'where' => array( + 'status = ? AND c_id = ? AND session_id = ? ' => array( + $status, + $courseId, + $sessionId, + ), + ), + ); + + return Database::select( + '*', + $this->table, + $conditions + ); + } + + /** + * Gets all the course meetings saved in the plugin_bbb_meeting table and + * generate actionable links (join/close/delete/etc) + * + * @param int $courseId + * @param int $sessionId + * @param int $groupId + * @param bool $isAdminReport Optional. Set to true then the report is for admins + * @param array $dateRange Optional + * @param int $start Optional + * @param int $limit Optional + * + * @return array Array of current open meeting rooms + * @throws Exception + */ + public function getMeetings( + $courseId = 0, + $sessionId = 0, + $groupId = 0, + $isAdminReport = false, + $dateRange = [], + $start = 0, + $limit = 0, + $order = "ASC" + ) { + $em = Database::getManager(); + $manager = $this->isConferenceManager(); + + $conditions = []; + if ($courseId || $sessionId || $groupId) { + $conditions = array( + 'where' => array( + 'c_id = ? AND session_id = ? ' => array($courseId, $sessionId), + ), + ); + + if ($this->hasGroupSupport()) { + $conditions = array( + 'where' => array( + 'c_id = ? AND session_id = ? AND group_id = ? ' => array( + $courseId, + $sessionId, + $groupId, + ), + ), + ); + } + + if ($this->isGlobalConferencePerUserEnabled()) { + $conditions = array( + 'where' => array( + 'c_id = ? AND session_id = ? AND user_id = ?' => array( + $courseId, + $sessionId, + $this->userId, + ), + ), + ); + } + } + if ($this->isGlobalConference()) { + $conditions = array( + 'where' => array( + 'c_id = ? AND user_id = ?' => array( + 0, + $this->userId, + ), + ), + ); + } + + if (!empty($dateRange)) { + $dateStart = date_create($dateRange['search_meeting_start']); + $dateStart = date_format($dateStart, 'Y-m-d H:i:s'); + $dateEnd = date_create($dateRange['search_meeting_end']); + $dateEnd = $dateEnd->add(new DateInterval('P1D')); + $dateEnd = date_format($dateEnd, 'Y-m-d H:i:s'); + + $conditions = array( + 'where' => array( + 'created_at BETWEEN ? AND ? ' => array($dateStart, $dateEnd), + ), + ); + } + + $conditions['order'] = 'created_at ' . $order; + + if ($limit) { + $conditions['limit'] = "$start , $limit"; + } + + $meetingList = Database::select( + '*', + $this->table, + $conditions + ); + $isGlobal = $this->isGlobalConference(); + $newMeetingList = array(); + foreach ($meetingList as $meetingDB) { + $item = array(); + $item['metting_name'] = $meetingDB['meeting_name']; + $courseId = $meetingDB['c_id']; + $courseInfo = api_get_course_info_by_id($courseId); + $courseCode = ''; + if (!empty($courseInfo)) { + $courseCode = $courseInfo['code']; + } + + if ($manager) { + $pass = $meetingDB['moderator_pw']; + } else { + $pass = $meetingDB['attendee_pw']; + } + + $meetingBBB = $this->getMeetingInfo( + [ + 'meetingId' => $meetingDB['remote_id'], + 'password' => $pass, + ] + ); + + if ($meetingBBB === false) { + // Checking with the remote_id didn't work, so just in case and + // to provide backwards support, check with the id + $params = array( + 'meetingId' => $meetingDB['id'], + // -- REQUIRED - The unique id for the meeting + 'password' => $pass + // -- REQUIRED - The moderator password for the meeting + ); + $meetingBBB = $this->getMeetingInfo($params); + } + + if ($meetingDB['visibility'] == 0 && $this->isConferenceManager() === false) { + continue; + } + + $meetingBBB['end_url'] = $this->endUrl($meetingDB); + + if (isset($meetingBBB['returncode']) && (string) $meetingBBB['returncode'] === 'FAILED') { + if ($meetingDB['status'] == 1 && $this->isConferenceManager()) { + $this->endMeeting($meetingDB['id'], $courseCode); + } + } else { + $meetingBBB['add_to_calendar_url'] = $this->addToCalendarUrl($meetingDB); + } + + if ($meetingDB['record'] == 1) { + // backwards compatibility (when there was no remote ID) + $mId = $meetingDB['remote_id']; + if (empty($mId)) { + $mId = $meetingDB['id']; + } + if (empty($mId)) { + // if the id is still empty (should *never* occur as 'id' is + // the table's primary key), skip this conference + continue; + } + + $record = []; + $recordingParams = ['meetingId' => $mId]; + $records = $this->api->getRecordingsWithXmlResponseArray($recordingParams); + + if (!empty($records)) { + if (!isset($records['messageKey']) || $records['messageKey'] !== 'noRecordings') { + $record = end($records); + if (!is_array($record) || !isset($record['recordId'])) { + continue; + } + + if (!empty($record['playbackFormat'])) { + $this->updateMeetingVideoUrl($meetingDB['id'], $record['playbackFormatUrl']); + } + } + } + + if (isset($record['playbackFormat']) && !empty($record['playbackFormat'])) { + $recordLink = []; + foreach ($record['playbackFormat'] as $format) { + $this->insertMeetingFormat(intval($meetingDB['id']), $format->type->__toString(), $format->url->__toString()); + $recordLink['record'][] = 1; + $recordLink[] = Display::url( + $this->plugin->get_lang($format->type->__toString()), + $format->url->__toString(), + ['target' => '_blank', 'class' => 'btn btn-default'] + ); + } + } else { + $recordLink = $this->plugin->get_lang('NoRecording'); + } + + if ($isAdminReport) { + $this->forceCIdReq( + $courseInfo['code'], + $meetingDB['session_id'], + $meetingDB['group_id'] + ); + } + + $actionLinks = $this->getActionLinks( + $meetingDB, + $record, + $isGlobal, + $isAdminReport + ); + $item['show_links'] = $recordLink; + $item['record'] = true; + } else { + $actionLinks = $this->getActionLinks( + $meetingDB, + [], + $isGlobal, + $isAdminReport + ); + + $item['show_links'] = $this->plugin->get_lang('NoRecording'); + $item['record'] = false; + } + + $item['action_links'] = implode(PHP_EOL, $actionLinks); + $item['created_at'] = api_convert_and_format_date($meetingDB['created_at']); + // created_at + $meetingDB['created_at'] = $item['created_at']; //avoid overwrite in array_merge() below + + $item['closed_at'] = ''; + if (!empty($meetingDB['closed_at'])) { + $item['closed_at'] = api_convert_and_format_date($meetingDB['closed_at']); + $meetingDB['closed_at'] = $item['closed_at']; + } + + $item['publish_url'] = $this->publishUrl($meetingDB); + $item['unpublish_url'] = $this->unPublishUrl($meetingBBB); + + if ($meetingDB['status'] == 1) { + $joinParams = [ + 'meetingId' => $meetingDB['remote_id'], + //-- REQUIRED - A unique id for the meeting + 'username' => $this->userCompleteName, + //-- REQUIRED - The name that will display for the user in the meeting + 'password' => $pass, + //-- REQUIRED - The attendee or moderator password, depending on what's passed here + 'createTime' => '', + //-- OPTIONAL - string. Leave blank ('') unless you set this correctly. + 'userID' => '', + // -- OPTIONAL - string + 'webVoiceConf' => '', + ]; + $item['go_url'] = $this->protocol.$this->api->getJoinMeetingURL($joinParams); + } + $item = array_merge($item, $meetingDB, $meetingBBB); + + $item['course'] = $em->find('ChamiloCoreBundle:Course', $item['c_id']); + $item['session'] = $em->find('ChamiloCoreBundle:Session', $item['session_id']); + $newMeetingList[] = $item; + } + + return $newMeetingList; + } + + /** + * Counts all the course meetings saved in the plugin_bbb_meeting table. + * + * @param int $courseId + * @param int $sessionId + * @param int $groupId + * @param array $dateRange + * + * @return int Count of meetings + * @throws Exception + */ + public function getCountMeetings( + $courseId = 0, + $sessionId = 0, + $groupId = 0, + $dateRange = [] + ) { + $conditions = []; + if ($courseId || $sessionId || $groupId) { + $conditions = array( + 'where' => array( + 'c_id = ? AND session_id = ? ' => array($courseId, $sessionId), + ), + ); + + if ($this->hasGroupSupport()) { + $conditions = array( + 'where' => array( + 'c_id = ? AND session_id = ? AND group_id = ? ' => array( + $courseId, + $sessionId, + $groupId, + ), + ), + ); + } + + if ($this->isGlobalConferencePerUserEnabled()) { + $conditions = array( + 'where' => array( + 'c_id = ? AND session_id = ? AND user_id = ?' => array( + $courseId, + $sessionId, + $this->userId, + ), + ), + ); + } + } + + if (!empty($dateRange)) { + $dateStart = date_create($dateRange['search_meeting_start']); + $dateStart = date_format($dateStart, 'Y-m-d H:i:s'); + $dateEnd = date_create($dateRange['search_meeting_end']); + $dateEnd = $dateEnd->add(new DateInterval('P1D')); + $dateEnd = date_format($dateEnd, 'Y-m-d H:i:s'); + + $conditions = array( + 'where' => array( + 'created_at BETWEEN ? AND ? ' => array($dateStart, $dateEnd), + ), + ); + } + + $row = Database::select( + 'count(*) as count', + $this->table, + $conditions, + 'first' + ); + + return $row['count']; + } + + /** + * @param array $meeting + * + * @return string + */ + public function endUrl($meeting) + { + if (!isset($meeting['id'])) { + return ''; + } + + return api_get_path(WEB_PLUGIN_PATH).'bbb/listing.php?'.$this->getUrlParams().'&action=end&id='.$meeting['id']; + } + + /** + * Closes a meeting (usually when the user click on the close button from + * the conferences listing. + * + * @param string The internal ID of the meeting (id field for this meeting) + * @param string $courseCode + * + * @return void + * @assert (0) === false + */ + public function endMeeting($id, $courseCode = null) + { + if (empty($id)) { + return false; + } + + $meetingData = Database::select( + '*', + $this->table, + array('where' => array('id = ?' => array($id))), + 'first' + ); + $manager = $this->isConferenceManager(); + if ($manager) { + $pass = $meetingData['moderator_pw']; + } else { + $pass = $meetingData['attendee_pw']; + } + + Event::addEvent( + 'bbb_end_meeting', + 'meeting_id', + (int) $id, + null, + api_get_user_id(), + api_get_course_int_id(), + api_get_session_id() + ); + + $endParams = array( + 'meetingId' => $meetingData['remote_id'], // REQUIRED - We have to know which meeting to end. + 'password' => $pass, // REQUIRED - Must match moderator pass for meeting. + ); + $this->api->endMeetingWithXmlResponseArray($endParams); + Database::update( + $this->table, + array('status' => 0, 'closed_at' => api_get_utc_datetime()), + array('id = ? ' => $id) + ); + + // Update users with in_at y ou_at field equal + $roomTable = Database::get_main_table('plugin_bbb_room'); + $conditions['where'] = ['meeting_id=? AND in_at=out_at AND close=?' => [$id, BBBPlugin::ROOM_OPEN]]; + $roomList = Database::select( + '*', + $roomTable, + $conditions + ); + + foreach ($roomList as $roomDB) { + $roomId = $roomDB['id']; + if (!empty($roomId)) { + Database::update( + $roomTable, + ['out_at' => api_get_utc_datetime(), 'close' => BBBPlugin::ROOM_CLOSE], + ['id = ? ' => $roomId] + ); + } + } + + // Close all meeting rooms with meeting ID + Database::update( + $roomTable, + ['close' => BBBPlugin::ROOM_CLOSE], + ['meeting_id = ? ' => $id] + ); + } + + /** + * @param array $meeting + * @param array $record + * + * @return string + */ + public function addToCalendarUrl($meeting, $record = []) + { + $url = isset($record['playbackFormatUrl']) ? $record['playbackFormatUrl'] : ''; + + return api_get_path(WEB_PLUGIN_PATH).'bbb/listing.php?'.$this->getUrlParams( + ).'&action=add_to_calendar&id='.$meeting['id'].'&start='.api_strtotime($meeting['created_at']).'&url='.$url; + } + + /** + * @param int $meetingId + * @param string $videoUrl + * + * @return bool|int + */ + public function updateMeetingVideoUrl($meetingId, $videoUrl) + { + return Database::update( + 'plugin_bbb_meeting', + ['video_url' => $videoUrl], + ['id = ?' => intval($meetingId)] + ); + } + + /** + * @param int $meetingId + * @param string $formatType + * @param string $resourceUrl + * + * @return bool|int + */ + public function insertMeetingFormat(int $meetingId, string $formatType, string $resourceUrl) + { + $em = Database::getManager(); + $sm = $em->getConnection()->getSchemaManager(); + if ($sm->tablesExist('plugin_bbb_meeting_format')) { + return Database::insert( + 'plugin_bbb_meeting_format', + [ + 'format_type' => $formatType, + 'resource_url' => $resourceUrl, + 'meeting_id' => $meetingId + ] + ); + } + + } + + /** + * Force the course, session and/or group IDs + * + * @param string $courseCode + * @param int $sessionId + * @param int $groupId + */ + public function forceCIdReq($courseCode, $sessionId = 0, $groupId = 0) + { + $this->courseCode = $courseCode; + $this->sessionId = (int) $sessionId; + $this->groupId = (int) $groupId; + } + + /** + * @param array $meetingInfo + * @param array $recordInfo + * @param bool $isGlobal + * @param bool $isAdminReport + * + * @return array + */ + private function getActionLinks( + $meetingInfo, + $recordInfo, + $isGlobal = false, + $isAdminReport = false + ) { + $isVisible = $meetingInfo['visibility'] != 0; + $linkVisibility = $isVisible + ? Display::url( + Display::return_icon('visible.png', get_lang('MakeInvisible')), + $this->unPublishUrl($meetingInfo) + ) + : Display::url( + Display::return_icon('invisible.png', get_lang('MakeVisible')), + $this->publishUrl($meetingInfo) + ); + + $links = []; + if ($this->plugin->get('allow_regenerate_recording') === 'true' && $meetingInfo['record'] == 1) { + if (!empty($recordInfo)) { + $links[] = Display::url( + Display::return_icon('reload.png', get_lang('RegenerateRecord')), + $this->regenerateRecordUrl($meetingInfo, $recordInfo) + ); + } else { + $links[] = Display::url( + Display::return_icon('reload.png', get_lang('RegenerateRecord')), + $this->regenerateRecordUrlFromMeeting($meetingInfo) + ); + } + } + + if (empty($recordInfo)) { + if (!$isAdminReport) { + if ($meetingInfo['status'] == 0) { + $links[] = Display::url( + Display::return_icon('delete.png', get_lang('Delete')), + $this->deleteRecordUrl($meetingInfo) + ); + $links[] = $linkVisibility; + } + + return $links; + } else { + $links[] = Display::url( + Display::return_icon('course_home.png', get_lang('GoToCourse')), + $this->getListingUrl($meetingInfo['c_id'], $meetingInfo['session_id'], $meetingInfo['group_id']) + ); + + return $links; + } + } + + if (!$isGlobal) { + $links[] = Display::url( + Display::return_icon('link.gif', get_lang('UrlMeetingToShare')), + $this->copyToRecordToLinkTool($meetingInfo) + ); + $links[] = Display::url( + Display::return_icon('agenda.png', get_lang('AddToCalendar')), + $this->addToCalendarUrl($meetingInfo, $recordInfo) + ); + } + + $hide = $this->plugin->get('disable_download_conference_link') === 'true' ? true : false; + + if ($hide == false) { + if ($meetingInfo['has_video_m4v']) { + foreach ($recordInfo['playbackFormat'] as $format) { + if ($format->type->__toString() == 'video') { + $recordingUrl = $format->url->__toString(); + } + } + $links[] = Display::url( + Display::return_icon('save.png', get_lang('DownloadFile')), + $recordingUrl.'video-0.m4v', + ['target' => '_blank'] + ); + } else { + $links[] = Display::url( + Display::return_icon('save.png', get_lang('DownloadFile')), + '#', + [ + 'id' => "btn-check-meeting-video-{$meetingInfo['id']}", + 'class' => 'check-meeting-video', + 'data-id' => $meetingInfo['id'], + ] + ); + } + } + + + if (!$isAdminReport) { + $links[] = Display::url( + Display::return_icon('delete.png', get_lang('Delete')), + $this->deleteRecordUrl($meetingInfo) + ); + $links[] = $linkVisibility; + } else { + $links[] = Display::url( + Display::return_icon('course_home.png', get_lang('GoToCourse')), + $this->getListingUrl($meetingInfo['c_id'], $meetingInfo['session_id'], $meetingInfo['group_id']) + ); + } + + + return $links; + } + + /** + * @param array $meeting + * + * @return string + */ + public function unPublishUrl($meeting) + { + if (!isset($meeting['id'])) { + return null; + } + + return api_get_path(WEB_PLUGIN_PATH).'bbb/listing.php?'.$this->getUrlParams( + ).'&action=unpublish&id='.$meeting['id']; + } + + /** + * @param array $meeting + * + * @return string + */ + public function publishUrl($meeting) + { + if (!isset($meeting['id'])) { + return ''; + } + + return api_get_path(WEB_PLUGIN_PATH).'bbb/listing.php?'.$this->getUrlParams( + ).'&action=publish&id='.$meeting['id']; + } + + /** + * @param array $meeting + * @param array $recordInfo + * + * @return string + */ + public function regenerateRecordUrl($meeting, $recordInfo) + { + if ($this->plugin->get('allow_regenerate_recording') !== 'true') { + return ''; + } + + if (!isset($meeting['id'])) { + return ''; + } + + if (empty($recordInfo) || (!empty($recordInfo['recordId']) && !isset($recordInfo['recordId']))) { + return ''; + } + + return api_get_path(WEB_PLUGIN_PATH).'bbb/listing.php?'.$this->getUrlParams(). + '&action=regenerate_record&id='.$meeting['id'].'&record_id='.$recordInfo['recordId']; + } + + /** + * @param array $meeting + * + * @return string + */ + public function regenerateRecordUrlFromMeeting($meeting) + { + if ($this->plugin->get('allow_regenerate_recording') !== 'true') { + return ''; + } + + if (!isset($meeting['id'])) { + return ''; + } + + return api_get_path(WEB_PLUGIN_PATH).'bbb/listing.php?'.$this->getUrlParams(). + '&action=regenerate_record&id='.$meeting['id']; + } + + /** + * @param array $meeting + * + * @return string + */ + public function deleteRecordUrl($meeting) + { + if (!isset($meeting['id'])) { + return ''; + } + + return api_get_path(WEB_PLUGIN_PATH).'bbb/listing.php?'.$this->getUrlParams( + ).'&action=delete_record&id='.$meeting['id']; + } + + /** + * @param array $meeting + * + * @return string + */ + public function copyToRecordToLinkTool($meeting) + { + if (!isset($meeting['id'])) { + return ''; + } + + return api_get_path(WEB_PLUGIN_PATH). + 'bbb/listing.php?'.$this->getUrlParams().'&action=copy_record_to_link_tool&id='.$meeting['id']; + } + + /** + * Function disabled + */ + public function publishMeeting($id) + { + //return BigBlueButtonBN::setPublishRecordings($id, 'true', $this->url, $this->salt); + if (empty($id)) { + return false; + } + $id = intval($id); + Database::update($this->table, array('visibility' => 1), array('id = ? ' => $id)); + + return true; + } + + /** + * Function disabled + */ + public function unpublishMeeting($id) + { + //return BigBlueButtonBN::setPublishRecordings($id, 'false', $this->url, $this->salt); + if (empty($id)) { + return false; + } + $id = intval($id); + Database::update($this->table, array('visibility' => 0), array('id = ?' => $id)); + + return true; + } + + /** + * Get users online in the current course room. + * + * @return int The number of users currently connected to the videoconference + * @assert () > -1 + */ + public function getUsersOnlineInCurrentRoom() + { + $courseId = api_get_course_int_id(); + $sessionId = api_get_session_id(); + + $conditions = array( + 'where' => array( + 'c_id = ? AND session_id = ? AND status = 1 AND access_url = ?' => array( + $courseId, + $sessionId, + $this->accessUrl, + ), + ), + ); + + if ($this->hasGroupSupport()) { + $groupId = api_get_group_id(); + $conditions = array( + 'where' => array( + 'c_id = ? AND session_id = ? AND group_id = ? AND status = 1 AND access_url = ?' => array( + $courseId, + $sessionId, + $groupId, + $this->accessUrl, + ), + ), + ); + } + + if ($this->isGlobalConferencePerUserEnabled()) { + $conditions = array( + 'where' => array( + 'user_id = ? AND status = 1 AND access_url = ?' => array( + $this->userId, + $this->accessUrl, + ), + ), + ); + } + + $meetingData = Database::select( + '*', + $this->table, + $conditions, + 'first' + ); + + if (empty($meetingData)) { + return 0; + } + $pass = $meetingData['moderator_pw']; + $info = $this->getMeetingInfo(array('meetingId' => $meetingData['remote_id'], 'password' => $pass)); + if ($info === false) { + //checking with the remote_id didn't work, so just in case and + // to provide backwards support, check with the id + $params = array( + 'meetingId' => $meetingData['id'], + // -- REQUIRED - The unique id for the meeting + 'password' => $pass + // -- REQUIRED - The moderator password for the meeting + ); + $info = $this->getMeetingInfo($params); + } + + if (!empty($info) && isset($info['participantCount'])) { + return $info['participantCount']; + } + + return 0; + } + + /** + * @param int $id + * @param string $recordId + * + * @return bool + */ + public function regenerateRecording($id, $recordId = '') + { + if ($this->plugin->get('allow_regenerate_recording') !== 'true') { + return false; + } + + if (empty($id)) { + return false; + } + + $meetingData = Database::select( + '*', + $this->table, + array('where' => array('id = ?' => array($id))), + 'first' + ); + + Event::addEvent( + 'bbb_regenerate_record', + 'record_id', + (int) $recordId, + null, + api_get_user_id(), + api_get_course_int_id(), + api_get_session_id() + ); + + // Check if there are recordings for this meeting + $recordings = $this->api->getRecordings(['meetingId' => $meetingData['remote_id']]); + if (!empty($recordings) && isset($recordings['messageKey']) && $recordings['messageKey'] === 'noRecordings') { + // Regenerate the meeting id + if (!empty($meetingData['internal_meeting_id'])) { + return $this->api->generateRecording(['recordId' => $meetingData['internal_meeting_id']]); + } + + /*$pass = $this->getModMeetingPassword(); + $info = $this->getMeetingInfo(['meetingId' => $meetingData['remote_id'], 'password' => $pass]); + if (!empty($info) && isset($info['internalMeetingID'])) { + return $this->api->generateRecording(['recordId' => $meetingData['internal_meeting_id']]); + }*/ + + return false; + } else { + if (!empty($recordings['records'])) { + $recordExists = false; + foreach ($recordings['records'] as $record) { + if ($recordId == $record['recordId']) { + $recordExists = true; + break; + } + } + + if ($recordExists) { + return $this->api->generateRecording(['recordId' => $recordId]); + } + } + } + + return false; + } + + /** + * Deletes a recording of a meeting + * + * @param int $id ID of the recording + * + * @return bool + * + * @assert () === false + * @todo Also delete links and agenda items created from this recording + */ + public function deleteRecording($id) + { + if (empty($id)) { + return false; + } + + $meetingData = Database::select( + '*', + $this->table, + array('where' => array('id = ?' => array($id))), + 'first' + ); + + Event::addEvent( + 'bbb_delete_record', + 'meeting_id', + $id, + null, + api_get_user_id(), + api_get_course_int_id(), + api_get_session_id() + ); + + $delete = false; + $recordings = []; + // Check if there are recordings for this meeting + if (!empty($meetingData['remote_id'])) { + Event::addEvent( + 'bbb_delete_record', + 'remote_id', + $meetingData['remote_id'], + null, + api_get_user_id(), + api_get_course_int_id(), + api_get_session_id() + ); + $recordings = $this->api->getRecordings(['meetingId' => $meetingData['remote_id']]); + } + if (!empty($recordings) && isset($recordings['messageKey']) && $recordings['messageKey'] == 'noRecordings') { + $delete = true; + } else { + if (!empty($recordings['records'])) { + $recordsToDelete = []; + foreach ($recordings['records'] as $record) { + $recordsToDelete[] = $record['recordId']; + } + $delete = true; + if (!empty($recordsToDelete)) { + $recordingParams = ['recordId' => implode(',', $recordsToDelete)]; + Event::addEvent( + 'bbb_delete_record', + 'record_id_list', + implode(',', $recordsToDelete), + null, + api_get_user_id(), + api_get_course_int_id(), + api_get_session_id() + ); + $result = $this->api->deleteRecordingsWithXmlResponseArray($recordingParams); + if (!empty($result) && isset($result['deleted']) && $result['deleted'] === 'true') { + $delete = true; + } + } + } + } + + if ($delete) { + Database::delete( + 'plugin_bbb_room', + array('meeting_id = ?' => array($id)) + ); + + Database::delete( + $this->table, + array('id = ?' => array($id)) + ); + } + + return $delete; + } + + /** + * Creates a link in the links tool from the given videoconference recording + * + * @param int $id ID of the item in the plugin_bbb_meeting table + * @param string Hash identifying the recording, as provided by the API + * + * @return mixed ID of the newly created link, or false on error + * @assert (null, null) === false + * @assert (1, null) === false + * @assert (null, 'abcdefabcdefabcdefabcdef') === false + */ + public function copyRecordingToLinkTool($id) + { + if (empty($id)) { + return false; + } + //$records = BigBlueButtonBN::getRecordingsUrl($id); + $meetingData = Database::select( + '*', + $this->table, + array('where' => array('id = ?' => array($id))), + 'first' + ); + + $records = $this->api->getRecordingsWithXmlResponseArray( + array('meetingId' => $meetingData['remote_id']) + ); + + if (!empty($records)) { + if (isset($records['message']) && !empty($records['message'])) { + if ($records['messageKey'] == 'noRecordings') { + $recordArray[] = $this->plugin->get_lang('NoRecording'); + } else { + //$recordArray[] = $records['message']; + } + + return false; + } else { + $record = $records[0]; + if (is_array($record) && isset($record['recordId'])) { + $url = $record['playbackFormatUrl']; + $link = new Link(); + $params['url'] = $url; + $params['title'] = $meetingData['meeting_name']; + $id = $link->save($params); + + return $id; + } + } + } + + return false; + } + + /** + * Checks if the video conference server is running. + * Function currently disabled (always returns 1) + * @return bool True if server is running, false otherwise + * @assert () === false + */ + public function isServerRunning() + { + return true; + //return BigBlueButtonBN::isServerRunning($this->protocol.$this->url); + } + + /** + * Checks if the video conference plugin is properly configured + * @return bool True if plugin has a host and a salt, false otherwise + * @assert () === false + */ + public function isServerConfigured() + { + $host = $this->plugin->get('host'); + + if (empty($host)) { + return false; + } + + $salt = $this->plugin->get('salt'); + + if (empty($salt)) { + return false; + } + + return true; + //return BigBlueButtonBN::isServerRunning($this->protocol.$this->url); + } + + /** + * Get active session in the all platform + */ + public function getActiveSessionsCount() + { + $meetingList = Database::select( + 'count(id) as count', + $this->table, + array('where' => array('status = ? AND access_url = ?' => array(1, $this->accessUrl))), + 'first' + ); + + return $meetingList['count']; + } + + /** + * Get active session in the all platform + * + * @param boolean $allSites Parameter to indicate whether to get the result from all sites + * + * @return array + */ + public function getActiveSessions(bool $allSites = false): array + { + $where = ['where' => ['status = ?' => 1]]; + + if (!$allSites) { + $where['where'][' AND access_url = ?'] = $this->accessUrl; + } + + return Database::select( + '*', + $this->table, + $where + ); + } + + /** + * @param string $url + */ + public function redirectToBBB($url) + { + if (file_exists(__DIR__.'/../config.vm.php')) { + // Using VM + echo Display::url($this->plugin->get_lang('ClickToContinue'), $url); + exit; + } else { + // Classic + header("Location: $url"); + exit; + } + } + + /** + * @return string + */ + public function getConferenceUrl() + { + return api_get_path(WEB_PLUGIN_PATH).'bbb/start.php?launch=1&'.$this->getUrlParams(); + } + + /** + * Get the meeting info from DB by its name + * + * @param string $name + * + * @return array + */ + public function findMeetingByName($name) + { + $meetingData = Database::select( + '*', + 'plugin_bbb_meeting', + array('where' => array('meeting_name = ? AND status = 1 ' => $name)), + 'first' + ); + + return $meetingData; + } + + /** + * Get the meeting info from DB by its name + * + * @param int $id + * + * @return array + */ + public function getMeeting($id) + { + $meetingData = Database::select( + '*', + 'plugin_bbb_meeting', + array('where' => array('id = ?' => $id)), + 'first' + ); + + return $meetingData; + } + + /** + * Get the meeting info. + * + * @param int $id + * + * @return array + */ + public function getMeetingByRemoteId($id) + { + $meetingData = Database::select( + '*', + 'plugin_bbb_meeting', + array('where' => array('remote_id = ?' => $id)), + 'first' + ); + + return $meetingData; + } + + /** + * @param int $meetingId + * + * @return array + */ + public function findConnectedMeetingParticipants($meetingId) + { + $meetingData = Database::select( + '*', + 'plugin_bbb_room', + array('where' => array('meeting_id = ? AND in_at IS NOT NULL' => $meetingId)) + ); + $participantIds = []; + $return = []; + + foreach ($meetingData as $participantInfo) { + if (in_array($participantInfo['participant_id'], $participantIds)) { + continue; + } + + $participantIds[] = $participantInfo['participant_id']; + + $return[] = [ + 'id' => $participantInfo['id'], + 'meeting_id' => $participantInfo['meeting_id'], + 'participant' => api_get_user_entity($participantInfo['participant_id']), + 'in_at' => $participantInfo['in_at'], + 'out_at' => $participantInfo['out_at'], + ]; + } + + return $return; + } + + /** + * Check if the meeting has a capture.m4v video file. If exists then the has_video_m4v field is updated + * + * @param int $meetingId + * + * @return bool + */ + public function checkDirectMeetingVideoUrl($meetingId) + { + $meetingInfo = Database::select( + '*', + 'plugin_bbb_meeting', + [ + 'where' => ['id = ?' => intval($meetingId)], + ], + 'first' + ); + + if (!isset($meetingInfo['video_url'])) { + return false; + } + + $hasCapture = SocialManager::verifyUrl($meetingInfo['video_url'].'/capture.m4v'); + + if ($hasCapture) { + return Database::update( + 'plugin_bbb_meeting', + ['has_video_m4v' => true], + ['id = ?' => intval($meetingId)] + ); + } + + return $hasCapture; + } +} diff --git a/plugin/bbb/lib/bbb_api.php b/plugin/bbb/lib/bbb_api.php new file mode 100644 index 000000000..5a4ec9239 --- /dev/null +++ b/plugin/bbb/lib/bbb_api.php @@ -0,0 +1,697 @@ +_securitySalt = CONFIG_SECURITY_SALT; + $this->_bbbServerBaseUrl = CONFIG_SERVER_BASE_URL; + $this->_bbbServerProtocol = CONFIG_SERVER_PROTOCOL; + } + + private function _processXmlResponse($url) + { + /* + A private utility method used by other public methods to process XML responses. + */ + if (extension_loaded('curl')) { + $ch = curl_init() or die ( curl_error($ch) ); + $timeout = 10; + curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false); + curl_setopt( $ch, CURLOPT_URL, $this->_bbbServerProtocol.$url ); + curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 ); + curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, $timeout); + // Following redirect required to use Scalelite, BBB's Load Balancer + curl_setopt( $ch, CURLOPT_FOLLOWLOCATION, true); + $data = curl_exec( $ch ); + curl_close( $ch ); + + if ($data) { + return (new SimpleXMLElement($data)); + } else { + return false; + } + } + return (simplexml_load_file($url)); + } + + private function _requiredParam($param) { + /* Process required params and throw errors if we don't get values */ + if ((isset($param)) && ($param != '')) { + return $param; + } + elseif (!isset($param)) { + throw new Exception('Missing parameter.'); + } + else { + throw new Exception(''.$param.' is required.'); + } + } + + private function _optionalParam($param) { + /* Pass most optional params through as set value, or set to '' */ + /* Don't know if we'll use this one, but let's build it in case. */ + if ((isset($param)) && ($param != '')) { + return $param; + } + else { + $param = ''; + return $param; + } + } + + /* __________________ BBB ADMINISTRATION METHODS _________________ */ + /* The methods in the following section support the following categories of the BBB API: + -- create + -- join + -- end + */ + + public function getCreateMeetingUrl($creationParams) { + /* + USAGE: + (see $creationParams array in createMeetingArray method.) + */ + $this->_meetingId = $this->_requiredParam($creationParams['meetingId']); + $this->_meetingName = $this->_requiredParam($creationParams['meetingName']); + // Set up the basic creation URL: + $creationUrl = $this->_bbbServerBaseUrl."api/create?"; + // Add params: + $params = + 'name='.urlencode($this->_meetingName). + '&meetingID='.urlencode($this->_meetingId). + '&attendeePW='.urlencode($creationParams['attendeePw']). + '&moderatorPW='.urlencode($creationParams['moderatorPw']). + '&dialNumber='.urlencode($creationParams['dialNumber']). + '&voiceBridge='.urlencode($creationParams['voiceBridge']). + '&webVoice='.urlencode($creationParams['webVoice']). + '&logoutURL='.urlencode($creationParams['logoutUrl']). + '&maxParticipants='.urlencode($creationParams['maxParticipants']). + '&record='.urlencode($creationParams['record']). + '&duration='.urlencode($creationParams['duration']). + '&meta_OriginURL'.urlencode($creationParams['meta_OriginURL']) + ; + + //'&meta_category='.urlencode($creationParams['meta_category']); + $welcomeMessage = $creationParams['welcomeMsg']; + if (trim($welcomeMessage)) { + $params .= '&welcome='.urlencode($welcomeMessage); + } + + // Return the complete URL: + return ($creationUrl.$params.'&checksum='.sha1("create".$params.$this->_securitySalt)); + } + + public function createMeetingWithXmlResponseArray($creationParams) + { + /* + USAGE: + $creationParams = array( + 'name' => 'Meeting Name', -- A name for the meeting (or username) + 'meetingId' => '1234', -- A unique id for the meeting + 'attendeePw' => 'ap', -- Set to 'ap' and use 'ap' to join = no user pass required. + 'moderatorPw' => 'mp', -- Set to 'mp' and use 'mp' to join = no user pass required. + 'welcomeMsg' => '', -- ''= use default. Change to customize. + 'dialNumber' => '', -- The main number to call into. Optional. + 'voiceBridge' => '', -- 5 digits PIN to join voice. Required. + 'webVoice' => '', -- Alphanumeric to join voice. Optional. + 'logoutUrl' => '', -- Default in bigbluebutton.properties. Optional. + 'maxParticipants' => '-1', -- Optional. -1 = unlimitted. Not supported in BBB. [number] + 'record' => 'false', -- New. 'true' will tell BBB to record the meeting. + 'duration' => '0', -- Default = 0 which means no set duration in minutes. [number] + 'meta_category' => '', -- Use to pass additional info to BBB server. See API docs to enable. + ); + */ + $xml = $this->_processXmlResponse($this->getCreateMeetingURL($creationParams)); + + if ($xml) { + if ($xml->meetingID) { + return [ + 'returncode' => $xml->returncode->__toString(), + 'message' => $xml->message->__toString(), + 'messageKey' => $xml->messageKey->__toString(), + 'meetingId' => $xml->meetingID->__toString(), + 'attendeePw' => $xml->attendeePW->__toString(), + 'moderatorPw' => $xml->moderatorPW->__toString(), + 'hasBeenForciblyEnded' => $xml->hasBeenForciblyEnded->__toString(), + 'createTime' => $xml->createTime->__toString(), + 'internalMeetingID' => $xml->internalMeetingID->__toString(), + ]; + } else { + return [ + 'returncode' => $xml->returncode->__toString(), + 'message' => $xml->message->__toString(), + 'messageKey' => $xml->messageKey->__toString(), + ]; + } + } else { + return null; + } + } + + public function getJoinMeetingURL($joinParams) + { + /* + NOTE: At this point, we don't use a corresponding joinMeetingWithXmlResponse here because the API + doesn't respond on success, but you can still code that method if you need it. Or, you can take the URL + that's returned from this method and simply send your users off to that URL in your code. + USAGE: + $joinParams = array( + 'meetingId' => '1234', -- REQUIRED - A unique id for the meeting + 'username' => 'Jane Doe', -- REQUIRED - The name that will display for the user in the meeting + 'password' => 'ap', -- REQUIRED - The attendee or moderator password, depending on what's passed here + 'createTime' => '', -- OPTIONAL - string. Leave blank ('') unless you set this correctly. + 'userID' => '', -- OPTIONAL - string + 'webVoiceConf' => '' -- OPTIONAL - string + ); + */ + $this->_meetingId = $this->_requiredParam($joinParams['meetingId']); + $this->_username = $this->_requiredParam($joinParams['username']); + $this->_password = $this->_requiredParam($joinParams['password']); + + // Establish the basic join URL: + $joinUrl = $this->_bbbServerBaseUrl."api/join?"; + + // Add parameters to the URL: + $params = + 'meetingID='.urlencode($this->_meetingId). + '&fullName='.urlencode($this->_username). + '&password='.urlencode($this->_password). + '&userID='.urlencode($joinParams['userID']). + '&webVoiceConf='.urlencode($joinParams['webVoiceConf']) + ; + + // Only use createTime if we really want to use it. If it's '', then don't pass it: + if ((isset($joinParams['createTime']) && $joinParams['createTime'] != '')) { + $params .= '&createTime='.urlencode($joinParams['createTime']); + } + + /*if (isset($joinParams['interface']) && (int) $joinParams['interface'] === BBBPlugin::INTERFACE_HTML5) { + $bbbHost = api_remove_trailing_slash(CONFIG_SERVER_URL_WITH_PROTOCOL); + if (preg_match('#/bigbluebutton$#', $bbbHost)) { + $bbbHost = preg_replace('#/bigbluebutton$#', '', $bbbHost); + } + $params .= '&redirectClient=true&clientURL='.$bbbHost.'/html5client/join'; + }*/ + + // Return the URL: + return $joinUrl.$params.'&checksum='.sha1('join'.$params.$this->_securitySalt); + } + + public function getEndMeetingURL($endParams) + { + /* USAGE: + $endParams = array ( + 'meetingId' => '1234', -- REQUIRED - The unique id for the meeting + 'password' => 'mp' -- REQUIRED - The moderator password for the meeting + ); + */ + $this->_meetingId = $this->_requiredParam($endParams['meetingId']); + $this->_password = $this->_requiredParam($endParams['password']); + $endUrl = $this->_bbbServerBaseUrl."api/end?"; + $params = + 'meetingID='.urlencode($this->_meetingId). + '&password='.urlencode($this->_password) + ; + + return ($endUrl.$params.'&checksum='.sha1("end".$params.$this->_securitySalt)); + } + + public function endMeetingWithXmlResponseArray($endParams) { + /* USAGE: + $endParams = array ( + 'meetingId' => '1234', -- REQUIRED - The unique id for the meeting + 'password' => 'mp' -- REQUIRED - The moderator password for the meeting + ); + */ + $xml = $this->_processXmlResponse($this->getEndMeetingURL($endParams)); + if ($xml) { + return array( + 'returncode' => $xml->returncode->__toString(), + 'message' => $xml->message->__toString(), + 'messageKey' => $xml->messageKey->__toString() + ); + } + else { + return null; + } + + } + + /* __________________ BBB MONITORING METHODS _________________ */ + /* The methods in the following section support the following categories of the BBB API: + -- isMeetingRunning + -- getMeetings + -- getMeetingInfo + */ + public function getIsMeetingRunningUrl($meetingId) { + /* USAGE: + $meetingId = '1234' -- REQUIRED - The unique id for the meeting + */ + $this->_meetingId = $this->_requiredParam($meetingId); + $runningUrl = $this->_bbbServerBaseUrl."api/isMeetingRunning?"; + $params = + 'meetingID='.urlencode($this->_meetingId); + return ($runningUrl.$params.'&checksum='.sha1("isMeetingRunning".$params.$this->_securitySalt)); + } + + public function isMeetingRunningWithXmlResponseArray($meetingId) { + /* USAGE: + $meetingId = '1234' -- REQUIRED - The unique id for the meeting + */ + $xml = $this->_processXmlResponse($this->getIsMeetingRunningUrl($meetingId)); + if($xml) { + return array( + 'returncode' => $xml->returncode->__toString(), + 'running' => $xml->running->__toString() // -- Returns true/false. + ); + } + else { + return null; + } + } + + public function getGetMeetingsUrl() { + /* Simply formulate the getMeetings URL + We do this in a separate function so we have the option to just get this + URL and print it if we want for some reason. + */ + $getMeetingsUrl = $this->_bbbServerBaseUrl."api/getMeetings?checksum=".sha1("getMeetings".$this->_securitySalt); + return $getMeetingsUrl; + } + + public function getMeetingsWithXmlResponseArray() + { + /* USAGE: + We don't need to pass any parameters with this one, so we just send the query URL off to BBB + and then handle the results that we get in the XML response. + */ + $xml = $this->_processXmlResponse($this->getGetMeetingsUrl()); + if($xml) { + // If we don't get a success code, stop processing and return just the returncode: + if ($xml->returncode != 'SUCCESS') { + $result = array( + 'returncode' => $xml->returncode->__toString() + ); + return $result; + } + elseif ($xml->messageKey == 'noMeetings') { + /* No meetings on server, so return just this info: */ + $result = array( + 'returncode' => $xml->returncode->__toString(), + 'messageKey' => $xml->messageKey->__toString(), + 'message' => $xml->message->__toString() + ); + return $result; + } + else { + // In this case, we have success and meetings. First return general response: + $result = array( + 'returncode' => $xml->returncode->__toString(), + 'messageKey' => $xml->messageKey->__toString(), + 'message' => $xml->message->__toString() + ); + // Then interate through meeting results and return them as part of the array: + foreach ($xml->meetings->meeting as $m) { + $result[] = array( + 'meetingId' => $m->meetingID->__toString(), + 'meetingName' => $m->meetingName->__toString(), + 'createTime' => $m->createTime->__toString(), + 'attendeePw' => $m->attendeePW->__toString(), + 'moderatorPw' => $m->moderatorPW->__toString(), + 'hasBeenForciblyEnded' => $m->hasBeenForciblyEnded->__toString(), + 'running' => $m->running->__toString() + ); + } + return $result; + } + } + else { + return null; + } + + } + + public function getMeetingInfoUrl($infoParams) { + /* USAGE: + $infoParams = array( + 'meetingId' => '1234', -- REQUIRED - The unique id for the meeting + 'password' => 'mp' -- REQUIRED - The moderator password for the meeting + ); + */ + $this->_meetingId = $this->_requiredParam($infoParams['meetingId']); + $this->_password = $this->_requiredParam($infoParams['password']); + $infoUrl = $this->_bbbServerBaseUrl."api/getMeetingInfo?"; + $params = + 'meetingID='.urlencode($this->_meetingId). + '&password='.urlencode($this->_password); + return ($infoUrl.$params.'&checksum='.sha1("getMeetingInfo".$params.$this->_securitySalt)); + } + + public function getMeetingInfoWithXmlResponseArray($infoParams) { + /* USAGE: + $infoParams = array( + 'meetingId' => '1234', -- REQUIRED - The unique id for the meeting + 'password' => 'mp' -- REQUIRED - The moderator password for the meeting + ); + */ + $xml = $this->_processXmlResponse($this->getMeetingInfoUrl($infoParams)); + if($xml) { + // If we don't get a success code or messageKey, find out why: + if (($xml->returncode != 'SUCCESS') || ($xml->messageKey == null)) { + $result = array( + 'returncode' => $xml->returncode->__toString(), + 'messageKey' => $xml->messageKey->__toString(), + 'message' => $xml->message->__toString() + ); + return $result; + } else { + // In this case, we have success and meeting info: + $result = array( + 'returncode' => $xml->returncode->__toString(), + 'meetingName' => $xml->meetingName->__toString(), + 'meetingId' => $xml->meetingID->__toString(), + 'createTime' => $xml->createTime->__toString(), + 'voiceBridge' => $xml->voiceBridge->__toString(), + 'attendeePw' => $xml->attendeePW->__toString(), + 'moderatorPw' => $xml->moderatorPW->__toString(), + 'running' => $xml->running->__toString(), + 'recording' => $xml->recording->__toString(), + 'hasBeenForciblyEnded' => $xml->hasBeenForciblyEnded->__toString(), + 'startTime' => $xml->startTime->__toString(), + 'endTime' => $xml->endTime->__toString(), + 'participantCount' => $xml->participantCount->__toString(), + 'maxUsers' => $xml->maxUsers->__toString(), + 'moderatorCount' => $xml->moderatorCount->__toString(), + 'internalMeetingID' => $xml->internalMeetingID->__toString() + ); + + // Then interate through attendee results and return them as part of the array: + foreach ($xml->attendees->attendee as $a) { + $result[] = array( + 'userId' => $a->userID->__toString(), + 'fullName' => $a->fullName->__toString(), + 'role' => $a->role->__toString() + ); + } + return $result; + } + } + else { + return null; + } + + } + + /* __________________ BBB RECORDING METHODS _________________ */ + /* The methods in the following section support the following categories of the BBB API: + -- getRecordings + -- publishRecordings + -- deleteRecordings + */ + + public function getRecordingsUrl($recordingParams) { + /* USAGE: + $recordingParams = array( + 'meetingId' => '1234', -- OPTIONAL - comma separate if multiple ids + ); + */ + $recordingsUrl = $this->_bbbServerBaseUrl."api/getRecordings?"; + $params = 'meetingID='.urlencode($recordingParams['meetingId']); + return ($recordingsUrl.$params.'&checksum='.sha1("getRecordings".$params.$this->_securitySalt)); + + } + + public function getRecordingsWithXmlResponseArray($recordingParams) { + /* USAGE: + $recordingParams = array( + 'meetingId' => '1234', -- OPTIONAL - comma separate if multiple ids + ); + NOTE: 'duration' DOES work when creating a meeting, so if you set duration + when creating a meeting, it will kick users out after the duration. Should + probably be required in user code when 'recording' is set to true. + */ + $xml = $this->_processXmlResponse($this->getRecordingsUrl($recordingParams)); + if($xml) { + // If we don't get a success code or messageKey, find out why: + if (($xml->returncode != 'SUCCESS') || ($xml->messageKey == null)) { + $result = array( + 'returncode' => $xml->returncode->__toString(), + 'messageKey' => $xml->messageKey->__toString(), + 'message' => $xml->message->__toString() + ); + return $result; + } + else { + // In this case, we have success and recording info: + $result = array( + 'returncode' => $xml->returncode->__toString(), + 'messageKey' => $xml->messageKey->__toString(), + 'message' => $xml->message->__toString() + ); + $formats = []; + + foreach ($xml->recordings->recording as $r) { + foreach ($r->playback->format as $format) { + $formats[] = $format; + } + + $result[] = array( + 'recordId' => $r->recordID->__toString(), + 'meetingId' => $r->meetingID->__toString(), + 'name' => $r->name->__toString(), + 'published' => $r->published->__toString(), + 'startTime' => $r->startTime->__toString(), + 'endTime' => $r->endTime->__toString(), + 'playbackFormat' => $formats, + 'playbackFormatType' => $r->playback->format->type->__toString(), + 'playbackFormatUrl' => $r->playback->format->url->__toString(), + 'playbackFormatLength' => $r->playback->format->length->__toString(), + 'metadataTitle' => $r->metadata->title->__toString(), + 'metadataSubject' => $r->metadata->subject->__toString(), + 'metadataDescription' => $r->metadata->description->__toString(), + 'metadataCreator' => $r->metadata->creator->__toString(), + 'metadataContributor' => $r->metadata->contributor->__toString(), + 'metadataLanguage' => $r->metadata->language->__toString(), + // Add more here as needed for your app depending on your + // use of metadata when creating recordings. + ); + } + return $result; + } + } + else { + return null; + } + } + + /** + * @param $array recordingParams + * + * @return array|null + */ + public function getRecordings($recordingParams) + { + /* USAGE: + $recordingParams = array( + 'meetingId' => '1234', -- OPTIONAL - comma separate if multiple ids + ); + NOTE: 'duration' DOES work when creating a meeting, so if you set duration + when creating a meeting, it will kick users out after the duration. Should + probably be required in user code when 'recording' is set to true. + */ + $xml = $this->_processXmlResponse($this->getRecordingsUrl($recordingParams)); + if($xml) { + // If we don't get a success code or messageKey, find out why: + if (($xml->returncode != 'SUCCESS') || ($xml->messageKey == null)) { + $result = array( + 'returncode' => $xml->returncode->__toString(), + 'messageKey' => $xml->messageKey->__toString(), + 'message' => $xml->message->__toString() + ); + return $result; + } + else { + // In this case, we have success and recording info: + $result = array( + 'returncode' => $xml->returncode->__toString(), + 'messageKey' => $xml->messageKey->__toString(), + 'message' => $xml->message->__toString() + ); + $result['records'] = []; + if (!empty($xml->recordings->recording)) { + $formats = []; + + foreach ($xml->recordings->recording as $r) { + foreach ($r->playback->format as $format) { + $formats[] = $format; + } + $result['records'][] = array( + 'recordId' => $r->recordID->__toString(), + 'meetingId' => $r->meetingID->__toString(), + 'name' => $r->name->__toString(), + 'published' => $r->published->__toString(), + 'startTime' => $r->startTime->__toString(), + 'endTime' => $r->endTime->__toString(), + 'playbackFormat' => $formats, + 'playbackFormatType' => $r->playback->format->type->__toString(), + 'playbackFormatUrl' => $r->playback->format->url->__toString(), + 'playbackFormatLength' => $r->playback->format->length->__toString(), + 'metadataTitle' => $r->metadata->title->__toString(), + 'metadataSubject' => $r->metadata->subject->__toString(), + 'metadataDescription' => $r->metadata->description->__toString(), + 'metadataCreator' => $r->metadata->creator->__toString(), + 'metadataContributor' => $r->metadata->contributor->__toString(), + 'metadataLanguage' => $r->metadata->language->__toString(), + ); + } + } + + return $result; + } + } + + return null; + } + + public function getPublishRecordingsUrl($recordingParams) { + /* USAGE: + $recordingParams = array( + 'recordId' => '1234', -- REQUIRED - comma separate if multiple ids + 'publish' => 'true', -- REQUIRED - boolean: true/false + ); + */ + $recordingsUrl = $this->_bbbServerBaseUrl."api/publishRecordings?"; + $params = + 'recordID='.urlencode($recordingParams['recordId']). + '&publish='.urlencode($recordingParams['publish']); + return ($recordingsUrl.$params.'&checksum='.sha1("publishRecordings".$params.$this->_securitySalt)); + + } + + public function publishRecordingsWithXmlResponseArray($recordingParams) { + /* USAGE: + $recordingParams = array( + 'recordId' => '1234', -- REQUIRED - comma separate if multiple ids + 'publish' => 'true', -- REQUIRED - boolean: true/false + ); + */ + $xml = $this->_processXmlResponse($this->getPublishRecordingsUrl($recordingParams)); + if($xml) { + return array( + 'returncode' => $xml->returncode->__toString(), + 'published' => $xml->published->__toString() // -- Returns true/false. + ); + } + else { + return null; + } + + + } + + public function getDeleteRecordingsUrl($recordingParams) { + /* USAGE: + $recordingParams = array( + 'recordId' => '1234', -- REQUIRED - comma separate if multiple ids + ); + */ + $recordingsUrl = $this->_bbbServerBaseUrl."api/deleteRecordings?"; + $params = + 'recordID='.urlencode($recordingParams['recordId']); + return ($recordingsUrl.$params.'&checksum='.sha1("deleteRecordings".$params.$this->_securitySalt)); + } + + public function deleteRecordingsWithXmlResponseArray($recordingParams) { + /* USAGE: + $recordingParams = array( + 'recordId' => '1234', -- REQUIRED - comma separate if multiple ids + ); + */ + + $xml = $this->_processXmlResponse($this->getDeleteRecordingsUrl($recordingParams)); + if($xml) { + return array( + 'returncode' => $xml->returncode->__toString(), + 'deleted' => $xml->deleted->__toString() // -- Returns true/false. + ); + } + else { + return null; + } + + } + + /** USAGE: + * $recordingParams = array( + * 'recordId' => '1234', -- REQUIRED - comma separate if multiple ids + * ); + */ + public function generateRecording($recordingParams) + { + if (empty($recordingParams)) { + return false; + } + + $recordingsUrl = $this->_bbbServerBaseUrl.'../demo/regenerateRecord.jsp?'; + $params = 'recordID='.urlencode($recordingParams['recordId']); + $url = $recordingsUrl.$params.'&checksum='.sha1('regenerateRecord'.$params.$this->_securitySalt); + + $ch = curl_init() or die ( curl_error($ch) ); + $timeout = 10; + curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false); + curl_setopt( $ch, CURLOPT_URL, $url ); + curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 ); + curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, $timeout); + $data = curl_exec( $ch ); + curl_close( $ch ); + + return true; + } +} diff --git a/plugin/bbb/lib/bbb_plugin.class.php b/plugin/bbb/lib/bbb_plugin.class.php new file mode 100644 index 000000000..4141eb1e6 --- /dev/null +++ b/plugin/bbb/lib/bbb_plugin.class.php @@ -0,0 +1,407 @@ + 'big_blue_button_record_and_store', + 'type' => 'checkbox', + ], + [ + 'name' => 'bbb_enable_conference_in_groups', + 'type' => 'checkbox', + ], + [ + 'name' => 'bbb_force_record_generation', + 'type' => 'checkbox', + ], + [ + 'name' => 'big_blue_button_students_start_conference_in_groups', + 'type' => 'checkbox', + ], + ]; + + /** + * BBBPlugin constructor. + */ + protected function __construct() + { + $settings = [ + 'tool_enable' => 'boolean', + 'host' => 'text', + 'salt' => 'text', + 'enable_global_conference' => 'boolean', + 'enable_global_conference_per_user' => 'boolean', + 'enable_conference_in_course_groups' => 'boolean', + 'enable_global_conference_link' => 'boolean', + 'disable_download_conference_link' => 'boolean', + 'max_users_limit' => 'text', + 'global_conference_allow_roles' => [ + 'type' => 'select', + 'options' => [ + PLATFORM_ADMIN => get_lang('Administrator'), + COURSEMANAGER => get_lang('Teacher'), + STUDENT => get_lang('Student'), + STUDENT_BOSS => get_lang('StudentBoss'), + ], + 'attributes' => ['multiple' => 'multiple'], + ], + 'allow_regenerate_recording' => 'boolean', + // Default course settings, must be the same as $course_settings + 'big_blue_button_record_and_store' => 'checkbox', + 'bbb_enable_conference_in_groups' => 'checkbox', + 'bbb_force_record_generation' => 'checkbox', + 'disable_course_settings' => 'boolean', + 'meeting_duration' => 'text', + ]; + + if (1 === (int) api_get_current_access_url_id()) { + $settings['plugin_bbb_multiple_urls_cron_apply_to_all'] = 'checkbox'; + } + + parent::__construct( + '2.11', + 'Julio Montoya, Yannick Warnier, Angel Fernando Quiroz Campos, Jose Angel Ruiz, Ghazi Triki, Adnen Manssouri', + $settings + ); + + $this->isAdminPlugin = true; + } + + /** + * @return BBBPlugin|null + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * @param string $variable + * + * @return bool + */ + public function validateCourseSetting($variable) + { + if ($this->get('disable_course_settings') === 'true') { + return false; + } + + $result = true; + switch ($variable) { + case 'bbb_enable_conference_in_groups': + $result = $this->get('enable_conference_in_course_groups') === 'true'; + break; + case 'bbb_force_record_generation': + $result = $this->get('allow_regenerate_recording') === 'true'; + break; + case 'big_blue_button_record_and_store': + } + + return $result; + } + + /** + * + * @return array + */ + public function getCourseSettings() + { + $settings = []; + if ($this->get('disable_course_settings') !== 'true') { + $settings = parent::getCourseSettings(); + } + + return $settings; + } + + /** + * + * @return \Plugin + */ + public function performActionsAfterConfigure() + { + $result = $this->get('disable_course_settings') === 'true'; + if ($result) { + $valueConference = $this->get('bbb_enable_conference_in_groups') === 'true' ? 1 : 0; + self::update_course_field_in_all_courses('bbb_enable_conference_in_groups', $valueConference); + + $valueForceRecordGeneration = $this->get('bbb_force_record_generation') === 'true' ? 1 : 0; + self::update_course_field_in_all_courses('bbb_force_record_generation', $valueForceRecordGeneration); + + $valueForceRecordStore = $this->get('big_blue_button_record_and_store') === 'true' ? 1 : 0; + self::update_course_field_in_all_courses('big_blue_button_record_and_store', $valueForceRecordStore); + } + + return $this; + } + + /** + * Install + */ + public function install() + { + $sql = "CREATE TABLE IF NOT EXISTS plugin_bbb_meeting ( + id INT unsigned NOT NULL auto_increment PRIMARY KEY, + c_id INT unsigned NOT NULL DEFAULT 0, + group_id INT unsigned NOT NULL DEFAULT 0, + user_id INT unsigned NOT NULL DEFAULT 0, + meeting_name VARCHAR(255) NOT NULL DEFAULT '', + attendee_pw VARCHAR(255) NOT NULL DEFAULT '', + moderator_pw VARCHAR(255) NOT NULL DEFAULT '', + record INT NOT NULL DEFAULT 0, + status INT NOT NULL DEFAULT 0, + created_at VARCHAR(255) NOT NULL, + closed_at VARCHAR(255) NOT NULL, + calendar_id INT DEFAULT 0, + welcome_msg VARCHAR(255) NOT NULL DEFAULT '', + session_id INT unsigned DEFAULT 0, + remote_id CHAR(30), + internal_meeting_id VARCHAR(255) DEFAULT NULL, + visibility TINYINT NOT NULL DEFAULT 1, + voice_bridge INT NOT NULL DEFAULT 1, + access_url INT NOT NULL DEFAULT 1, + video_url TEXT NULL, + has_video_m4v TINYINT NOT NULL DEFAULT 0 + )"; + Database::query($sql); + + Database::query( + "CREATE TABLE IF NOT EXISTS plugin_bbb_room ( + id int NOT NULL AUTO_INCREMENT PRIMARY KEY, + meeting_id int NOT NULL, + participant_id int(11) NOT NULL, + in_at datetime, + out_at datetime, + close INT NOT NULL DEFAULT 0 + );" + ); + $fieldLabel = 'plugin_bbb_course_users_limit'; + $fieldType = ExtraField::FIELD_TYPE_INTEGER; + $fieldTitle = $this->get_lang('MaxUsersInConferenceRoom'); + $fieldDefault = '0'; + $extraField = new ExtraField('course'); + $fieldId = CourseManager::create_course_extra_field( + $fieldLabel, + $fieldType, + $fieldTitle, + $fieldDefault + ); + $extraField->find($fieldId); + $extraField->update( + [ + 'id' => $fieldId, + 'variable' => 'plugin_bbb_course_users_limit', + 'changeable' => 1, + 'visible_to_self' => 1, + 'visible_to_others' => 0, + ] + ); + $fieldLabel = 'plugin_bbb_session_users_limit'; + $extraField = new ExtraField('session'); + $fieldId = SessionManager::create_session_extra_field( + $fieldLabel, + $fieldType, + $fieldTitle, + $fieldDefault + ); + $extraField->find($fieldId); + $extraField->update( + [ + 'id' => $fieldId, + 'variable' => 'plugin_bbb_session_users_limit', + 'changeable' => 1, + 'visible_to_self' => 1, + 'visible_to_others' => 0, + ] + ); + + Database::query( + "CREATE TABLE IF NOT EXISTS plugin_bbb_meeting_format ( + id int unsigned not null PRIMARY KEY AUTO_INCREMENT, + meeting_id int unsigned not null, + format_type varchar(255) not null, + resource_url text not null + );" + ); + + // Copy icons into the main/img/icons folder + $iconName = 'bigbluebutton'; + $iconsList = [ + '64/'.$iconName.'.png', + '64/'.$iconName.'_na.png', + '32/'.$iconName.'.png', + '32/'.$iconName.'_na.png', + '22/'.$iconName.'.png', + '22/'.$iconName.'_na.png', + ]; + $sourceDir = api_get_path(SYS_PLUGIN_PATH).'bbb/resources/img/'; + $destinationDir = api_get_path(SYS_CODE_PATH).'img/icons/'; + foreach ($iconsList as $icon) { + $src = $sourceDir.$icon; + $dest = $destinationDir.$icon; + copy($src, $dest); + } + // Installing course settings + $this->install_course_fields_in_all_courses(true); + } + + /** + * Uninstall + */ + public function uninstall() + { + $t_settings = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT); + $t_options = Database::get_main_table(TABLE_MAIN_SETTINGS_OPTIONS); + $t_tool = Database::get_course_table(TABLE_TOOL_LIST); + + $variables = [ + 'bbb_salt', + 'bbb_host', + 'bbb_tool_enable', + 'enable_global_conference', + 'enable_global_conference_per_user', + 'enable_global_conference_link', + 'disable_download_conference_link', + 'enable_conference_in_course_groups', + 'bbb_plugin', + 'bbb_plugin_host', + 'bbb_plugin_salt', + 'max_users_limit', + 'global_conference_allow_roles' + ]; + + $urlId = api_get_current_access_url_id(); + + foreach ($variables as $variable) { + $sql = "DELETE FROM $t_settings WHERE variable = '$variable' AND access_url = $urlId"; + Database::query($sql); + } + + $em = Database::getManager(); + $sm = $em->getConnection()->getSchemaManager(); + if ($sm->tablesExist('plugin_bbb_meeting')) { + Database::query("DELETE FROM plugin_bbb_meeting WHERE access_url = $urlId"); + } + + // Only delete tables if it's uninstalled from main url. + if (1 == $urlId) { + $extraField = new ExtraField('course'); + $extraFieldInfo = $extraField->get_handler_field_info_by_field_variable( + 'plugin_bbb_course_users_limit' + ); + if (!empty($extraFieldInfo)) { + $extraField->delete($extraFieldInfo['id']); + } + $extraField = new ExtraField('session'); + $extraFieldInfo = $extraField->get_handler_field_info_by_field_variable( + 'plugin_bbb_session_users_limit' + ); + if (!empty($extraFieldInfo)) { + $extraField->delete($extraFieldInfo['id']); + } + + $sql = "DELETE FROM $t_options WHERE variable = 'bbb_plugin'"; + Database::query($sql); + + // hack to get rid of Database::query warning (please add c_id...) + $sql = "DELETE FROM $t_tool WHERE name = 'bbb' AND c_id != 0"; + Database::query($sql); + + if ($sm->tablesExist('plugin_bbb_meeting_format')) { + Database::query('DROP TABLE IF EXISTS plugin_bbb_meeting_format'); + } + if ($sm->tablesExist('plugin_bbb_room')) { + Database::query('DROP TABLE IF EXISTS plugin_bbb_room'); + } + if ($sm->tablesExist('plugin_bbb_meeting')) { + Database::query('DROP TABLE IF EXISTS plugin_bbb_meeting'); + } + + // Deleting course settings + $this->uninstall_course_fields_in_all_courses($this->course_settings); + + // Remove icons from the main/img/icons folder + $iconName = 'bigbluebutton'; + $iconsList = [ + '64/'.$iconName.'.png', + '64/'.$iconName.'_na.png', + '32/'.$iconName.'.png', + '32/'.$iconName.'_na.png', + '22/'.$iconName.'.png', + '22/'.$iconName.'_na.png', + ]; + $destinationDir = api_get_path(SYS_CODE_PATH).'img/icons/'; + foreach ($iconsList as $icon) { + $dest = $destinationDir.$icon; + if (is_file($dest)) { + @unlink($dest); + } + } + } + } + + /** + * Update + */ + public function update() + { + $sql = "SHOW COLUMNS FROM plugin_bbb_room WHERE Field = 'close'"; + $res = Database::query($sql); + + if (Database::num_rows($res) === 0) { + $sql = "ALTER TABLE plugin_bbb_room ADD close int unsigned NULL"; + $res = Database::query($sql); + if (!$res) { + echo Display::return_message($this->get_lang('ErrorUpdateFieldDB'), 'warning'); + } + + Database::update( + 'plugin_bbb_room', + ['close' => BBBPlugin::ROOM_CLOSE] + ); + } + } + + /** + * Set the course setting in all courses + * + * @param bool $variable Course setting to update + * @param bool $value New values of the course setting + */ + public function update_course_field_in_all_courses($variable, $value) + { + // Update existing courses to add the new course setting value + $table = Database::get_main_table(TABLE_MAIN_COURSE); + $sql = "SELECT id FROM $table ORDER BY id"; + $res = Database::query($sql); + $courseSettingTable = Database::get_course_table(TABLE_COURSE_SETTING); + while ($row = Database::fetch_assoc($res)) { + Database::update( + $courseSettingTable, + ['value' => $value], + ['variable = ? AND c_id = ?' => [$variable, $row['id']]] + ); + } + } +} diff --git a/plugin/bbb/lib/vm/AbstractVM.php b/plugin/bbb/lib/vm/AbstractVM.php new file mode 100644 index 000000000..4c9527f68 --- /dev/null +++ b/plugin/bbb/lib/vm/AbstractVM.php @@ -0,0 +1,50 @@ +name = $settings['name']; + $this->host = $settings['host']; + $this->user = $settings['user']; + $this->apiKey = $settings['api_key']; + $this->vmId = $settings['vm_id']; + $this->vmMinSize = $settings['vm_min_size_id']; + $this->vmMaxSize = $settings['vm_max_size_id']; + $this->vmClientId = $settings['vm_client_id']; + } + + /** + * @param string $message + */ + public function addMessage($message) + { + $this->messages[] = $message; + } + + /** + * @return string + */ + public function getMessageToString() + { + return implode(PHP_EOL, $this->messages); + } +} diff --git a/plugin/bbb/lib/vm/AmazonVM.php b/plugin/bbb/lib/vm/AmazonVM.php new file mode 100644 index 000000000..683cc15b5 --- /dev/null +++ b/plugin/bbb/lib/vm/AmazonVM.php @@ -0,0 +1,44 @@ +connect(); + } + + /** + * @inheritdoc + */ + public function connect() + { + // Set up your credentials. + $credentials = new Credentials($this->vmClientId, $this->apiKey); + // Use the default adapter, CurlHttpAdapter. + $this->connector = new DigitalOcean($credentials); + + // Or use BuzzHttpAdapter. + //$this->connector = new DigitalOcean($credentials, new BuzzHttpAdapter()); + } + + /** + * @return DigitalOcean + */ + public function getConnector() + { + return $this->connector; + } + + /** + * @param string $type min or max + */ + public function resizeTo($type = 'min') + { + try { + $droplets = $this->getConnector()->droplets(); + $sizes = $this->getConnector()->sizes(); + $availableSizes = $sizes->getAll(); + + if (isset($availableSizes->status) && $availableSizes->status == 'OK') { + + $minSizeIdExists = false; + $maxSizeIdExists = false; + + foreach ($availableSizes->sizes as $size) { + if ($size->id == $this->vmMaxSize) { + $maxSizeIdExists = true; + } + if ($size->id == $this->vmMinSizeSize) { + $minSizeIdExists = true; + } + } + if ($maxSizeIdExists && $minSizeIdExists) { + throw new \Exception('Sizes are not well configured'); + } + } else { + throw new \Exception('Sizes not available'); + } + + // Returns all active droplets that are currently running in your account. + //$allActive = $droplets->showAllActive(); + + $dropletInfo = $droplets->show($this->vmId); + + if ($dropletInfo->status == 'OK') { + switch ($type) { + case 'min': + if ($dropletInfo->droplet->size_id == $this->vmMinSize) { + // No resize + $this->addMessage( + 'Nothing to execute. The size was already reduced.' + ); + } else { + $this->resize($this->vmMinSize); + } + + break; + case 'max': + if ($dropletInfo->droplet->size_id == $this->vmMaxSize) { + // No resize + $this->addMessage( + 'Nothing to execute. The size was already boost.' + ); + } else { + $this->resize($this->vmMaxSize); + } + break; + } + } else { + throw new \Exception(" Id ".$this->vmId." doesn't exists."); + } + } catch (Exception $e) { + die($e->getMessage()); + } + } + + /** + * Turns off / resize / turns on + * @param int $sizeId + */ + public function resize($sizeId) + { + $droplets = $this->getConnector()->droplets(); + $dropletInfo = $droplets->show($this->vmId); + + $powerOff = $droplets->powerOff($this->vmId); + + $this->addMessage('Power off droplet #'.$this->vmId); + + $this->waitForEvent($powerOff->event_id); + + $this->addMessage('Current status: '.$dropletInfo->droplet->status); + + $resizeDroplet = $droplets->resize( + $this->vmId, + array('size_id' => intval($sizeId)) + ); + $this->addMessage('Resize droplet to size id: '.$sizeId); + $this->waitForEvent($resizeDroplet->event_id); + + $powerOn = $droplets->powerOn($this->vmId); + $this->waitForEvent($powerOn->event_id); + $this->addMessage('Power on droplet #'.$this->vmId); + + } + + /** + * Loops until an event answer 100 percentage + * @param int $eventId + */ + public function waitForEvent($eventId) + { + $events = $this->getConnector()->events(); + $status = false; + while ($status == false) { + $infoStatus = $events->show($eventId); + if ($infoStatus->status == 'OK' && $infoStatus->event->percentage == 100) { + $status = true; + } + } + } + + /** + * @inheritdoc + */ + public function runCron() + { + $this->resizeToMinLimit(); + echo $this->getMessageToString(); + } + + /** + * @inheritdoc + */ + public function resizeToMaxLimit() + { + $this->resizeTo('max'); + } + + /** + * @inheritdoc + */ + public function resizeToMinLimit() + { + $this->resizeTo('min'); + } +} diff --git a/plugin/bbb/lib/vm/VMInterface.php b/plugin/bbb/lib/vm/VMInterface.php new file mode 100644 index 000000000..8019a3668 --- /dev/null +++ b/plugin/bbb/lib/vm/VMInterface.php @@ -0,0 +1,29 @@ +get_lang('Videoconference'); +$roomTable = Database::get_main_table('plugin_bbb_room'); + +$htmlHeadXtra[] = api_get_js_simple(api_get_path(WEB_PLUGIN_PATH).'bbb/resources/utils.js'); + +$action = $_GET['action'] ?? ''; +$userId = api_get_user_id(); +$groupId = api_get_group_id(); +$sessionId = api_get_session_id(); +$courseInfo = api_get_course_info(); + +$bbb = new bbb('', '', $isGlobal, $isGlobalPerUser); + +$conferenceManager = $bbb->isConferenceManager(); +if ($bbb->isGlobalConference()) { + api_block_anonymous_users(); +} else { + api_protect_course_script(true); +} + +$allowStudentAsConferenceManager = false; +if (!empty($courseInfo) && !empty($groupId) && !api_is_allowed_to_edit()) { + $groupEnabled = api_get_course_plugin_setting( + 'bbb', + 'bbb_enable_conference_in_groups', + $courseInfo + ) === '1'; + if ($groupEnabled) { + $isSubscribed = GroupManager::is_user_in_group(api_get_user_id(), GroupManager::get_group_properties($groupId)); + if ($isSubscribed) { + $allowStudentAsConferenceManager = api_get_course_plugin_setting( + 'bbb', + 'big_blue_button_students_start_conference_in_groups', + $courseInfo + ) === '1'; + } + } +} + +$allowToEdit = $conferenceManager; +// Disable students edit permissions. +if ($allowStudentAsConferenceManager) { + $allowToEdit = false; +} + +$courseCode = $courseInfo['code'] ?? ''; + +$message = ''; +if ($conferenceManager && $allowToEdit) { + switch ($action) { + case 'add_to_calendar': + if ($bbb->isGlobalConference()) { + return false; + } + $courseInfo = api_get_course_info(); + $agenda = new Agenda('course'); + $id = (int) $_GET['id']; + $title = sprintf($plugin->get_lang('VideoConferenceXCourseX'), $id, $courseInfo['name']); + $content = Display::url($plugin->get_lang('GoToTheVideoConference'), $_GET['url']); + + $eventId = $agenda->addEvent( + $_REQUEST['start'], + null, + 'true', + $title, + $content, + ['everyone'] + ); + if (!empty($eventId)) { + $message = Display::return_message($plugin->get_lang('VideoConferenceAddedToTheCalendar'), 'success'); + } else { + $message = Display::return_message(get_lang('Error'), 'error'); + } + break; + case 'copy_record_to_link_tool': + $result = $bbb->copyRecordingToLinkTool($_GET['id']); + if ($result) { + $message = Display::return_message($plugin->get_lang('VideoConferenceAddedToTheLinkTool'), 'success'); + } else { + $message = Display::return_message(get_lang('Error'), 'error'); + } + break; + case 'regenerate_record': + if ($plugin->get('allow_regenerate_recording') !== 'true') { + api_not_allowed(true); + } + $recordId = isset($_GET['record_id']) ? $_GET['record_id'] : ''; + $result = $bbb->regenerateRecording($_GET['id'], $recordId); + if ($result) { + $message = Display::return_message(get_lang('Success'), 'success'); + } else { + $message = Display::return_message(get_lang('Error'), 'error'); + } + + Display::addFlash($message); + header('Location: '.$bbb->getListingUrl()); + exit; + break; + case 'delete_record': + $result = $bbb->deleteRecording($_GET['id']); + if ($result) { + $message = Display::return_message(get_lang('Deleted'), 'success'); + } else { + $message = Display::return_message(get_lang('Error'), 'error'); + } + + Display::addFlash($message); + header('Location: '.$bbb->getListingUrl()); + exit; + break; + case 'end': + $bbb->endMeeting($_GET['id']); + $message = Display::return_message( + $plugin->get_lang('MeetingClosed').'
'.$plugin->get_lang('MeetingClosedComment'), + 'success', + false + ); + + if (file_exists(__DIR__.'/config.vm.php')) { + require __DIR__.'/../../vendor/autoload.php'; + require __DIR__.'/lib/vm/AbstractVM.php'; + require __DIR__.'/lib/vm/VMInterface.php'; + require __DIR__.'/lib/vm/DigitalOceanVM.php'; + require __DIR__.'/lib/VM.php'; + $config = require __DIR__.'/config.vm.php'; + + $vm = new VM($config); + $vm->resizeToMinLimit(); + } + + Display::addFlash($message); + header('Location: '.$bbb->getListingUrl()); + exit; + break; + case 'publish': + $bbb->publishMeeting($_GET['id']); + Display::addFlash(Display::return_message(get_lang('Updated'))); + header('Location: '.$bbb->getListingUrl()); + exit; + break; + case 'unpublish': + $bbb->unpublishMeeting($_GET['id']); + Display::addFlash(Display::return_message(get_lang('Updated'))); + header('Location: '.$bbb->getListingUrl()); + exit; + break; + case 'logout': + if ($plugin->get('allow_regenerate_recording') === 'true') { + $setting = api_get_course_plugin_setting('bbb', 'bbb_force_record_generation', $courseInfo); + $allow = $setting == 1 ? true : false; + if ($allow) { + $result = $bbb->getMeetingByRemoteId($_GET['remote_id']); + if (!empty($result)) { + $result = $bbb->regenerateRecording($result['id']); + if ($result) { + Display::addFlash(Display::return_message(get_lang('Success'))); + } else { + Display::addFlash(Display::return_message(get_lang('Error'), 'error')); + } + } + } + } + + $remoteId = Database::escape_string($_GET['remote_id']); + $meetingData = Database::select( + '*', + Database::get_main_table('plugin_bbb_meeting'), + ['where' => ['remote_id = ? AND access_url = ?' => [$remoteId, api_get_current_access_url_id()]]], + 'first' + ); + + if (empty($meetingData) || !is_array($meetingData)) { + error_log("meeting does not exist - remote_id: $remoteId"); + } else { + $meetingId = $meetingData['id']; + + // If creator -> update + if ($meetingData['creator_id'] == api_get_user_id()) { + $pass = $bbb->getModMeetingPassword($courseCode); + + $meetingBBB = $bbb->getMeetingInfo( + [ + 'meetingId' => $remoteId, + 'password' => $pass, + ] + ); + + if ($meetingBBB === false) { + //checking with the remote_id didn't work, so just in case and + // to provide backwards support, check with the id + $params = [ + 'meetingId' => $meetingId, + // -- REQUIRED - The unique id for the meeting + 'password' => $pass, + // -- REQUIRED - The moderator password for the meeting + ]; + $meetingBBB = $bbb->getMeetingInfo($params); + } + + if (!empty($meetingBBB)) { + if (isset($meetingBBB['returncode'])) { + $status = (string) $meetingBBB['returncode']; + switch ($status) { + case 'FAILED': + $bbb->endMeeting($meetingId, $courseCode); + break; + case 'SUCCESS': + $i = 0; + while ($i < $meetingBBB['participantCount']) { + $participantId = $meetingBBB[$i]['userId']; + $roomData = Database::select( + '*', + $roomTable, + [ + 'where' => [ + 'meeting_id = ? AND participant_id = ? AND close = ?' => [ + $meetingId, + $participantId, + BBBPlugin::ROOM_OPEN, + ], + ], + 'order' => 'id DESC', + ], + 'first' + ); + + if (!empty($roomData)) { + $roomId = $roomData['id']; + if (!empty($roomId)) { + Database::update( + $roomTable, + ['out_at' => api_get_utc_datetime()], + ['id = ? ' => $roomId] + ); + } + } + $i++; + } + break; + } + } + } + } + + // Update out_at field of user + $roomData = Database::select( + '*', + $roomTable, + [ + 'where' => ['meeting_id = ? AND participant_id = ?' => [$meetingId, $userId]], + 'order' => 'id DESC', + ], + 'first' + ); + + if (!empty($roomData)) { + $roomId = $roomData['id']; + if (!empty($roomId)) { + Database::update( + $roomTable, + ['out_at' => api_get_utc_datetime(), 'close' => BBBPlugin::ROOM_CLOSE], + ['id = ? ' => $roomId] + ); + } + } + + $message = Display::return_message( + $plugin->get_lang('RoomClosed').'
'.$plugin->get_lang('RoomClosedComment'), + 'success', + false + ); + Display::addFlash($message); + } + + header('Location: '.$bbb->getListingUrl()); + exit; + break; + default: + break; + } +} else { + if ($action === 'logout') { + // Update out_at field of user + $remoteId = Database::escape_string($_GET['remote_id']); + $meetingData = Database::select( + '*', + Database::get_main_table('plugin_bbb_meeting'), + ['where' => ['remote_id = ? AND access_url = ?' => [$remoteId, api_get_current_access_url_id()]]], + 'first' + ); + + if (empty($meetingData) || !is_array($meetingData)) { + error_log("meeting does not exist - remote_id: $remoteId"); + } else { + $meetingId = $meetingData['id']; + $roomData = Database::select( + '*', + $roomTable, + [ + 'where' => [ + 'meeting_id = ? AND participant_id = ? AND close = ?' => [ + $meetingId, + $userId, + BBBPlugin::ROOM_OPEN, + ], + ], + 'order' => 'id DESC', + ] + ); + + $i = 0; + foreach ($roomData as $item) { + $roomId = $item['id']; + if (!empty($roomId)) { + if ($i == 0) { + Database::update( + $roomTable, + ['out_at' => api_get_utc_datetime(), 'close' => BBBPlugin::ROOM_CLOSE], + ['id = ? ' => $roomId] + ); + } else { + Database::update($roomTable, ['close' => BBBPlugin::ROOM_CLOSE], ['id = ? ' => $roomId]); + } + $i++; + } + } + + $message = Display::return_message( + $plugin->get_lang('RoomExit'), + 'success', + false + ); + Display::addFlash($message); + } + header('Location: '.$bbb->getListingUrl()); + exit; + } +} + +if (isset($_GET['page_id'])) { + $pageId = (int) $_GET['page_id']; +} + +$meetingsCount = $bbb->getCountMeetings( + api_get_course_int_id(), + api_get_session_id(), + api_get_group_id() +); + +$limit = 10; +$pageNumber = ceil($meetingsCount / $limit); + +if (!isset($pageId)) { + $pageId = 1; +} + +$start = ($pageId - 1) * $limit; + +$meetings = $bbb->getMeetings( + api_get_course_int_id(), + api_get_session_id(), + api_get_group_id(), + false, + [], + $start, + $limit, + "DESC" +); + +if (empty($meetings)) { + $pageId = 0; +} + +$usersOnline = $bbb->getUsersOnlineInCurrentRoom(); +$maxUsers = $bbb->getMaxUsersLimit(); +$status = $bbb->isServerRunning(); +$currentOpenConference = $bbb->getCurrentVideoConference(); +$videoConferenceName = $currentOpenConference + ? $currentOpenConference['meeting_name'] + : $bbb->generateVideoConferenceName(); +$meetingExists = $bbb->meetingExists($videoConferenceName); +$showJoinButton = false; + +// Only conference manager can see the join button +$userCanSeeJoinButton = $conferenceManager; +if ($bbb->isGlobalConference() && $bbb->isGlobalConferencePerUserEnabled()) { + // Any user can see the "join button" BT#12620 + $userCanSeeJoinButton = true; +} + +if (($meetingExists || $userCanSeeJoinButton) && ($maxUsers == 0 || $maxUsers > $usersOnline)) { + $showJoinButton = true; +} +$conferenceUrl = $bbb->getConferenceUrl(); +$courseInfo = api_get_course_info(); +$formToString = ''; + +if ($bbb->isGlobalConference() === false && + !empty($courseInfo) && + $plugin->get('enable_conference_in_course_groups') === 'true' +) { + $url = api_get_self().'?'.api_get_cidreq(true, false).'&gidReq='; + $htmlHeadXtra[] = ''; + + $form = new FormValidator(api_get_self().'?'.api_get_cidreq()); + if ($conferenceManager && false === $allowStudentAsConferenceManager) { + $groups = GroupManager::get_group_list(null, $courseInfo, null, $sessionId); + } else { + if (!empty($groupId)) { + $groupInfo = GroupManager::get_group_properties($groupId); + if ($groupInfo) { + $isSubscribed = GroupManager::is_user_in_group(api_get_user_id(), $groupInfo); + if (false === $isSubscribed) { + api_not_allowed(true); + } + } + } + + $groups = GroupManager::getAllGroupPerUserSubscription( + api_get_user_id(), + api_get_course_int_id(), + api_get_session_id() + ); + } + + if ($groups) { + $meetingsInGroup = $bbb->getAllMeetingsInCourse(api_get_course_int_id(), api_get_session_id(), 1); + $meetingsGroup = array_column($meetingsInGroup, 'status', 'group_id'); + $groupList[0] = get_lang('Select'); + foreach ($groups as $groupData) { + $itemGroupId = $groupData['iid']; + if (isset($meetingsGroup[$itemGroupId]) && $meetingsGroup[$itemGroupId] == 1) { + $groupData['name'] .= ' ('.get_lang('Active').')'; + } + $groupList[$itemGroupId] = $groupData['name']; + } + + $form->addSelect('group_id', get_lang('Groups'), $groupList, ['id' => 'group_select']); + $form->setDefaults(['group_id' => $groupId]); + $formToString = $form->returnForm(); + } +} + +$frmEnterConference = new FormValidator( + 'enter_conference', + 'get', + api_get_path(WEB_PLUGIN_PATH).'bbb/start.php', + '_blank' +); +$frmEnterConference->addText('name', get_lang('Name')); +$frmEnterConference->applyFilter('name', 'trim'); +$frmEnterConference->addButtonNext($plugin->get_lang('EnterConference')); + +$conferenceUrlQueryParams = []; + +parse_str( + parse_url($conferenceUrl, PHP_URL_QUERY), + $conferenceUrlQueryParams +); + +foreach ($conferenceUrlQueryParams as $key => $value) { + $frmEnterConference->addHidden($key, $value); +} + +if ($meetingExists) { + $meetingInfo = $bbb->getMeetingByName($videoConferenceName); + + if (1 === (int) $meetingInfo['status']) { + $frmEnterConference->freeze(['name']); + } +} + +$frmEnterConference->setDefaults(['name' => $videoConferenceName]); + +// Default URL +$enterConferenceLink = $frmEnterConference->returnForm(); + +$tpl = new Template($tool_name); + +$tpl->assign('allow_to_edit', $allowToEdit); +$tpl->assign('meetings', $meetings); +$tpl->assign('conference_url', $conferenceUrl); +$tpl->assign('users_online', $usersOnline); +$tpl->assign('conference_manager', $conferenceManager); +$tpl->assign('max_users_limit', $maxUsers); +$tpl->assign('bbb_status', $status); +$tpl->assign('show_join_button', $showJoinButton); +$tpl->assign('message', $message); +$tpl->assign('form', $formToString); +$tpl->assign('enter_conference_links', $enterConferenceLink); +$tpl->assign('page_number', $pageNumber); +$tpl->assign('page_id', $pageId); + +$content = $tpl->fetch('bbb/view/listing.tpl'); + +$actionLinks = ''; +if (api_is_platform_admin()) { + $actionLinks .= Display::toolbarButton( + $plugin->get_lang('AdminView'), + api_get_path(WEB_PLUGIN_PATH).'bbb/admin.php', + 'list', + 'primary' + ); + + $tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$actionLinks]) + ); +} + +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/bbb/plugin.php b/plugin/bbb/plugin.php new file mode 100644 index 000000000..0f88af8f3 --- /dev/null +++ b/plugin/bbb/plugin.php @@ -0,0 +1,6 @@ +get_info(); diff --git a/plugin/bbb/resources/img/128/bigbluebutton.png b/plugin/bbb/resources/img/128/bigbluebutton.png new file mode 100644 index 000000000..0a9a573bb Binary files /dev/null and b/plugin/bbb/resources/img/128/bigbluebutton.png differ diff --git a/plugin/bbb/resources/img/128/bigbluebutton_na.png b/plugin/bbb/resources/img/128/bigbluebutton_na.png new file mode 100644 index 000000000..9953b9950 Binary files /dev/null and b/plugin/bbb/resources/img/128/bigbluebutton_na.png differ diff --git a/plugin/bbb/resources/img/128/videoconference_flash.png b/plugin/bbb/resources/img/128/videoconference_flash.png new file mode 100644 index 000000000..e6d9f4e7c Binary files /dev/null and b/plugin/bbb/resources/img/128/videoconference_flash.png differ diff --git a/plugin/bbb/resources/img/128/videoconference_html5.png b/plugin/bbb/resources/img/128/videoconference_html5.png new file mode 100644 index 000000000..e3cdeffe4 Binary files /dev/null and b/plugin/bbb/resources/img/128/videoconference_html5.png differ diff --git a/plugin/bbb/resources/img/22/bigbluebutton.png b/plugin/bbb/resources/img/22/bigbluebutton.png new file mode 100644 index 000000000..3b2fdf86b Binary files /dev/null and b/plugin/bbb/resources/img/22/bigbluebutton.png differ diff --git a/plugin/bbb/resources/img/22/bigbluebutton_na.png b/plugin/bbb/resources/img/22/bigbluebutton_na.png new file mode 100644 index 000000000..eb75e7661 Binary files /dev/null and b/plugin/bbb/resources/img/22/bigbluebutton_na.png differ diff --git a/plugin/bbb/resources/img/32/bigbluebutton.png b/plugin/bbb/resources/img/32/bigbluebutton.png new file mode 100644 index 000000000..1cb49d6c4 Binary files /dev/null and b/plugin/bbb/resources/img/32/bigbluebutton.png differ diff --git a/plugin/bbb/resources/img/32/bigbluebutton_na.png b/plugin/bbb/resources/img/32/bigbluebutton_na.png new file mode 100644 index 000000000..332d0736e Binary files /dev/null and b/plugin/bbb/resources/img/32/bigbluebutton_na.png differ diff --git a/plugin/bbb/resources/img/64/bigbluebutton.png b/plugin/bbb/resources/img/64/bigbluebutton.png new file mode 100644 index 000000000..f14e70fe9 Binary files /dev/null and b/plugin/bbb/resources/img/64/bigbluebutton.png differ diff --git a/plugin/bbb/resources/img/64/bigbluebutton_na.png b/plugin/bbb/resources/img/64/bigbluebutton_na.png new file mode 100644 index 000000000..871ba8ce0 Binary files /dev/null and b/plugin/bbb/resources/img/64/bigbluebutton_na.png differ diff --git a/plugin/bbb/resources/img/64/videoconference_flash.png b/plugin/bbb/resources/img/64/videoconference_flash.png new file mode 100644 index 000000000..753144fc6 Binary files /dev/null and b/plugin/bbb/resources/img/64/videoconference_flash.png differ diff --git a/plugin/bbb/resources/img/64/videoconference_html5.png b/plugin/bbb/resources/img/64/videoconference_html5.png new file mode 100644 index 000000000..4b1dde01f Binary files /dev/null and b/plugin/bbb/resources/img/64/videoconference_html5.png differ diff --git a/plugin/bbb/resources/img/svg/bigbluebutton.svg b/plugin/bbb/resources/img/svg/bigbluebutton.svg new file mode 100644 index 000000000..ebbb5902d --- /dev/null +++ b/plugin/bbb/resources/img/svg/bigbluebutton.svg @@ -0,0 +1,284 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugin/bbb/resources/img/svg/bigbluebutton_na.svg b/plugin/bbb/resources/img/svg/bigbluebutton_na.svg new file mode 100644 index 000000000..305e18356 --- /dev/null +++ b/plugin/bbb/resources/img/svg/bigbluebutton_na.svg @@ -0,0 +1,336 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugin/bbb/resources/img/svg/videoconference_flash.svg b/plugin/bbb/resources/img/svg/videoconference_flash.svg new file mode 100644 index 000000000..e544a70c4 --- /dev/null +++ b/plugin/bbb/resources/img/svg/videoconference_flash.svg @@ -0,0 +1,282 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugin/bbb/resources/img/svg/videoconference_html5.svg b/plugin/bbb/resources/img/svg/videoconference_html5.svg new file mode 100644 index 000000000..7b84c93cc --- /dev/null +++ b/plugin/bbb/resources/img/svg/videoconference_html5.svg @@ -0,0 +1,327 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugin/bbb/resources/utils.js b/plugin/bbb/resources/utils.js new file mode 100644 index 000000000..42ae3c1ab --- /dev/null +++ b/plugin/bbb/resources/utils.js @@ -0,0 +1,27 @@ +$(function () { + $('.check-meeting-video').on('click', function (e) { + e.preventDefault(); + + var $self = $(this), + meetingId = $self.data('id') || 0; + + if (!meetingId) { + return; + } + + var $loader = $('', { + 'aria-hidden': 'true' + }).addClass('fa fa-spinner fa-spin fa-fw'); + + $self.replaceWith($loader); + + $.get(_p.web_plugin + 'bbb/ajax.php', { + a: 'check_m4v', + meeting: meetingId + }, function (response) { + $loader.replaceWith(response.link); + + window.open(response.url); + }); + }); +}); diff --git a/plugin/bbb/start.php b/plugin/bbb/start.php new file mode 100644 index 000000000..8cc970bff --- /dev/null +++ b/plugin/bbb/start.php @@ -0,0 +1,112 @@ + 'Videoconference', +]; +Event::registerLog($logInfo); + +$tool_name = get_lang('Videoconference'); +$tpl = new Template($tool_name); + +$vmIsEnabled = false; +$host = ''; +$salt = ''; +$bbb = new bbb('', '', $isGlobal, $isGlobalPerUser); + +$conferenceManager = $bbb->isConferenceManager(); +if ($bbb->isGlobalConference()) { + api_block_anonymous_users(); +} else { + api_protect_course_script(true); +} + +$message = null; +if ($bbb->pluginEnabled) { + if ($bbb->isServerConfigured()) { + if ($bbb->isServerRunning()) { + if (isset($_GET['launch']) && $_GET['launch'] == 1) { + if (file_exists(__DIR__.'/config.vm.php')) { + $config = require __DIR__.'/config.vm.php'; + $vmIsEnabled = true; + $host = ''; + $salt = ''; + + require __DIR__.'/lib/vm/AbstractVM.php'; + require __DIR__.'/lib/vm/VMInterface.php'; + require __DIR__.'/lib/vm/DigitalOceanVM.php'; + require __DIR__.'/lib/VM.php'; + + $vm = new VM($config); + + if ($vm->isEnabled()) { + try { + $vm->resizeToMaxLimit(); + } catch (\Exception $e) { + echo $e->getMessage(); + exit; + } + } + } + + $meetingParams = []; + $meetingParams['meeting_name'] = $bbb->generateVideoConferenceName($_GET['name'] ?? null); + $url = null; + if ($bbb->meetingExists($meetingParams['meeting_name'])) { + $joinUrl = $bbb->joinMeeting($meetingParams['meeting_name']); + if ($joinUrl) { + $url = $joinUrl; + } + } else { + if ($bbb->isConferenceManager()) { + $url = $bbb->createMeeting($meetingParams); + } + } + + $meetingInfo = $bbb->findMeetingByName($meetingParams['meeting_name']); + if (!empty($meetingInfo) && $url) { + $bbb->saveParticipant($meetingInfo['id'], api_get_user_id()); + $bbb->redirectToBBB($url); + } else { + Display::addFlash( + Display::return_message($bbb->plugin->get_lang('ThereIsNoVideoConferenceActive')) + ); + $url = $bbb->getListingUrl(); + header('Location: '.$url); + exit; + } + } else { + $url = $bbb->getListingUrl(); + header('Location: '.$url); + exit; + } + } else { + $message = Display::return_message(get_lang('ServerIsNotRunning'), 'warning'); + } + } else { + $message = Display::return_message(get_lang('ServerIsNotConfigured'), 'warning'); + } +} else { + $message = Display::return_message(get_lang('ServerIsNotConfigured'), 'warning'); +} + +$tpl->assign('message', $message); +$tpl->display_one_col_template(); diff --git a/plugin/bbb/uninstall.php b/plugin/bbb/uninstall.php new file mode 100644 index 000000000..4bf2dfdfb --- /dev/null +++ b/plugin/bbb/uninstall.php @@ -0,0 +1,12 @@ +uninstall(); diff --git a/plugin/bbb/update.php b/plugin/bbb/update.php new file mode 100644 index 000000000..df3eea673 --- /dev/null +++ b/plugin/bbb/update.php @@ -0,0 +1,14 @@ +update(); diff --git a/plugin/bbb/view/admin.tpl b/plugin/bbb/view/admin.tpl new file mode 100644 index 000000000..6a1f4cb28 --- /dev/null +++ b/plugin/bbb/view/admin.tpl @@ -0,0 +1,58 @@ +{{ settings_form }} + +{{ 'RecordList'|get_plugin_lang('BBBPlugin') }} + +{{ search_form }} + + + + + + + + + + + + + + + + {% for meeting in meetings %} + + {% if meeting.visibility == 0 %} + + {% else %} + + {% endif %} + + + + + + + + + + {% endfor %} + +
{{ 'DateStart'|get_lang }}{{ 'DateEnd'|get_lang }}{{ 'Status'|get_lang }}{{ 'Records'|get_plugin_lang('BBBPlugin') }}{{ 'Course'|get_lang }}{{ 'Session'|get_lang }}{{ 'Participants'|get_lang }}{{ 'CountUsers'|get_lang }}{{ 'Actions'|get_lang }}
{{ meeting.created_at }}{{ meeting.created_at }}{{ meeting.closed_at }} + {% if meeting.status == 1 %} + {{ 'MeetingOpened'|get_plugin_lang('BBBPlugin') }} + {% else %} + {{ 'MeetingClosed'|get_plugin_lang('BBBPlugin') }} + {% endif %} + + {% if meeting.record == 1 %} + {# Record list #} + {{ meeting.show_links }} + {% else %} + {{ 'NoRecording'|get_plugin_lang('BBBPlugin') }} + {% endif %} + {{ meeting.course ?: '-' }}{{ meeting.session ?: '-' }} + {{ meeting.participants ? meeting.participants|join('
') : '-' }} + 		+ {{ meeting.participants ? meeting.participants | length : 0 }} + + {{ meeting.action_links }} +
diff --git a/plugin/bbb/view/listing.tpl b/plugin/bbb/view/listing.tpl new file mode 100644 index 000000000..489288598 --- /dev/null +++ b/plugin/bbb/view/listing.tpl @@ -0,0 +1,146 @@ + +
+{% if bbb_status == true %} +
+ {{ form }} + {% if show_join_button == true %} + {{ enter_conference_links }} +
+ {{ 'UrlMeetingToShare'| get_plugin_lang('BBBPlugin') }} +
+
+
+ + +
+
+
+ +

+ + {{ 'XUsersOnLine'| get_plugin_lang('BBBPlugin') | format(users_online) }} + +

+ + {% if max_users_limit > 0 %} + {% if conference_manager == true %} +

{{ 'MaxXUsersWarning' | get_plugin_lang('BBBPlugin') | format(max_users_limit) }}

+ {% elseif users_online >= max_users_limit/2 %} +

{{ 'MaxXUsersWarning' | get_plugin_lang('BBBPlugin') | format(max_users_limit) }}

+ {% endif %} + {% endif %} +
+
+ {% elseif max_users_limit > 0 %} + {% if conference_manager == true %} +

{{ 'MaxXUsersReachedManager' | get_plugin_lang('BBBPlugin') | format(max_users_limit) }}

+ {% elseif users_online > 0 %} +

{{ 'MaxXUsersReached' | get_plugin_lang('BBBPlugin') | format(max_users_limit) }}

+ {% endif %} + {% endif %} +
+ +
+
+

{{ 'RecordList'| get_plugin_lang('BBBPlugin') }}

+
+ + + + + + + {% if allow_to_edit %} + + {% endif %} + + {% for meeting in meetings %} + + + + {% if meeting.visibility == 0 %} + + {% else %} + + {% endif %} + + + {% if allow_to_edit %} + + {% endif %} + + + {% endfor %} +
{{ 'Name'|get_lang }}{{ 'CreatedAt'| get_plugin_lang('BBBPlugin') }}{{ 'Status'| get_lang }}{{ 'Records'| get_plugin_lang('BBBPlugin') }}{{ 'Actions'| get_lang }}
{{ meeting.metting_name }}{{ meeting.created_at }}{{ meeting.created_at }} + {% if meeting.status == 1 %} + {{ 'MeetingOpened'|get_plugin_lang('BBBPlugin') }} + {% else %} + {{ 'MeetingClosed'|get_plugin_lang('BBBPlugin') }} + {% endif %} + + {% if meeting.show_links.record %} + {# Record list #} + {% for link in meeting.show_links %} + {% if link is not iterable %} + {{ link }} + {% endif %} + {% endfor %} + {% else %} + {{ 'NoRecording'|get_plugin_lang('BBBPlugin') }} + {% endif %} + + + {% if meeting.status == 1 %} + + {{ 'CloseMeeting'|get_plugin_lang('BBBPlugin') }} + + {% endif %} + {{ meeting.action_links }} +
+
+ +{% else %} +
+ {{ 'ServerIsNotRunning' | get_plugin_lang('BBBPlugin') | return_message('warning') }} +
+{% endif %} + diff --git a/plugin/before_login/README.md b/plugin/before_login/README.md new file mode 100644 index 000000000..6c3609867 --- /dev/null +++ b/plugin/before_login/README.md @@ -0,0 +1,14 @@ +Before login plugin +=== + +This plugins shows a page before showing the login page. It is a bit rough and requires theming work to make anything appealing. + +This is useful if you want to ask a question before a user has the opportunity to login. + +Example: +You're old enough to enter this site? If you accept the "option 1" then you can enter to the campus (the login will appear). + +If you select "option 2" then you're redirected to another page. + +To enable, install the plugin then add it to the content_top or main_top region. +Theme it by creating custom.template.tpl from template.tpl in the plugin/before_login/ directory. \ No newline at end of file diff --git a/plugin/before_login/index.php b/plugin/before_login/index.php new file mode 100644 index 000000000..d171a7547 --- /dev/null +++ b/plugin/before_login/index.php @@ -0,0 +1,76 @@ +defaultRenderer(); + $renderer->setFormTemplate('{content}
'); + $renderer->setCustomElementTemplate('{element}'); + + $form->addElement('html', $option1); + $form->addElement('checkbox', 'left', null, get_lang('Yes')); + $form->addElement('button', 'submit', get_lang('Confirm'), ['class' => 'btn btn-primary']); + $formHtml = $form->returnForm(); + if ($form->validate()) { + $result = $form->getSubmitValues(); + if (isset($result['left']) && $result['left']) { + $_SESSION['before_login_accepted'] = 1; + header('Location: '.$urlOption1); + exit; + } + } + + $form2 = new FormValidator('form'); + + if (!empty($option2) && !empty($urlOption2)) { + $renderer = &$form2->defaultRenderer(); + $renderer->setHeaderTemplate(''); + $renderer->setFormTemplate('{content}
'); + $renderer->setCustomElementTemplate('{element}'); + + $form2->addElement('html', $option2); + $form2->addElement('checkbox', 'right', null, get_lang('Yes')); + $form2->addElement('button', 'submit', get_lang('Send')); + $formHtml2 = $form2->returnForm(); + + if ($form2->validate()) { + $result = $form2->getSubmitValues(); + if (isset($result['right']) && $result['right']) { + header('Location: '.$urlOption2); + exit; + } + } + } + + $_template['form_option1'] = $formHtml; + $_template['form_option2'] = $formHtml2; +} diff --git a/plugin/before_login/plugin.php b/plugin/before_login/plugin.php new file mode 100644 index 000000000..f93f91898 --- /dev/null +++ b/plugin/before_login/plugin.php @@ -0,0 +1,53 @@ +Plugins). + * + * @package chamilo.plugin + * + * @author Julio Montoya + */ + +/* Plugin config */ + +// The plugin title. +$plugin_info['title'] = 'Show HTML before login'; +// The comments that go with the plugin. +$plugin_info['comment'] = "Show a content before loading the login page."; +// The plugin version. +$plugin_info['version'] = '1.0'; +// The plugin author. +$plugin_info['author'] = 'Julio Montoya'; + +// The plugin configuration. +$form = new FormValidator('form'); +$form->addElement('select', 'language', get_lang('Language'), api_get_languages_to_array()); + +$form->addElement('header', 'Option 1'); +$form->addElement('textarea', 'option1', get_lang('Description'), ['rows' => 10, 'class' => 'span6']); +$form->addElement('text', 'option1_url', get_lang('RedirectTo')); + +$form->addElement('header', 'Option 2'); +$form->addElement('textarea', 'option2', get_lang('Description'), ['rows' => 10, 'class' => 'span6']); +$form->addElement('text', 'option2_url', get_lang('RedirectTo')); +$form->addElement('button', 'submit_button', get_lang('Save')); + +// Get default value for form + +$defaults = []; +$defaults['language'] = api_get_plugin_setting('before_login', 'language'); +$defaults['option1'] = api_get_plugin_setting('before_login', 'option1'); +$defaults['option2'] = api_get_plugin_setting('before_login', 'option2'); + +$defaults['option1_url'] = api_get_plugin_setting('before_login', 'option1_url'); +$defaults['option2_url'] = api_get_plugin_setting('before_login', 'option2_url'); + +$plugin_info['templates'] = ['template.tpl']; +if (file_exists(__DIR__.'/custom.template.tpl')) { + $plugin_info['templates'] = ['custom.template.tpl']; +} +$form->setDefaults($defaults); + +// Display form +$plugin_info['settings_form'] = $form; diff --git a/plugin/before_login/template.tpl b/plugin/before_login/template.tpl new file mode 100644 index 000000000..77fa85e4b --- /dev/null +++ b/plugin/before_login/template.tpl @@ -0,0 +1,14 @@ +{% if before_login.form_option1 %} +
+
+
+ {{ before_login.form_option1 }} +
+
+ {{ before_login.form_option2 }} +
+
+
+{% else %} + +{% endif %} \ No newline at end of file diff --git a/plugin/buycourses/CHANGELOG.md b/plugin/buycourses/CHANGELOG.md new file mode 100644 index 000000000..6deee5944 --- /dev/null +++ b/plugin/buycourses/CHANGELOG.md @@ -0,0 +1,134 @@ +v7.4 - 2022-04-28 +==== +Add subscriptions support. + +If the plugin has already been installed, the update.php script must be executed (load plugin/buycourses/update.php in your browser) to update the database structure by adding the plugin_buycourses_subscription, plugin_buycourses_subscription_rel_sale, plugin_buycourses_subscription_period and plugin_buycourses_coupon_rel_subscription_sale. + +v7.3 - 2022-04-28 +==== +Add Cecabank payments support. + +If the plugin has already been installed, the update.php script must be executed (load plugin/buycourses/update.php in your browser) to update the structure of the tables in the database. + +v7.2 - 2021-11-22 +==== +Add Stripe payments support. + +If the plugin has already been installed, the update.php script must be executed (load plugin/buycourses/update.php in your browser) to update the structure of the tables in the database. + +v7.1 - 2021-10-26 +==== +Fix install issue with DB field type. + +v7.0 - 2021-08-12 +==== +Added support for discount coupons. +Added a better table view for the sales report. +Multiple fixes to navigation-related issues. + +WARNING: Updating this plugin (or Chamilo) without going through the specific update procedure for this plugin will break your sales pages. + +The file [your-host]/plugin/buycourses/update.php *MUST* be executed to update the structure of the tables +in the database. + +v6.0 - 2020-11-29 +==== +Added support for purchase instructions e-mail customization (although this +does not support multiple languages at the moment). +This requires changes to the DB tables: +```sql +ALTER TABLE plugin_buycourses_global_config ADD COLUMN info_email_extra TEXT; +``` + +v5.0 - 2019-02-06 +==== + +This version includes two additional modules (taxes and invoices), +which can be enabled from the configuration. + +The file update.php must be executed to update the structure of the tables + in the database. + + +v4.0 - 2017-04-25 +==== + +This version includes the Culqi payment gateway v1.0 (now expired) and introduces +an additional option to show the Buy Courses tab to anonymous users. + +To enable these features, if you have already installed this plugin on your +portal prior to this version, you will need to add the corresponding settings +to your settings_current table. No documentation is available at this time on +how to do that, so please check up the code. Sorry about that. + + +v3.0 - 2015-09-25 +==== + +This version has been fixed and improved for Chamilo LMS 1.10.x. + +- A new user interface for platform admins and users. +- Avoid data redundancy by adding courses/sessions to catalog +- The catalog of sessions can be configured to offer some courses or sessions +in a currency other than the others courses or sessions +- The sales have a status: Pending, Completed, Canceled +- The Peding Orders pages has been replaced by a Sales Report. +Allowing filter the sales by its status +- The plugin Registration page was removed. Instead the Chamilo LMS +registrarion page is used. +- Added the ability to record beneficiaries with the sale of courses/sessions + +##Changes in database structure + +The database structure has been changed totally. The previous database +structure was formed for the tables: + +- `plugin_buy_course` The registered courses in the platform +- `plugin_buy_course_country` The list of countries with their currencies +- `plugin_buy_course_paypal` The PayPal account info +- `plugin_buy_course_sale` The sales of courses that were made +- `plugin_buy_course_temporal` The pending orders of courses that were made +- `plugin_buy_course_transfer` The bank accounts for transfers +- `plugin_buy_session` The registered courses in the platform +- `plugin_buy_session_course` The courses in sessions +- `plugin_buy_session_sale` The sales of session that were made +- `plugin_buy_session_temporary` The pending orders of session that were made + +To avoid the data redundancy, the `plugin_buy_course`, `plugin_buy_session` +and `plugin_buy_session_course` tables were replaced for the +`plugin_buycourses_item` table. And the `plugin_buy_course_sale`, +`plugin_buy_course_temporal`, `plugin_buy_session_sale` and +`plugin_buy_session_temporary` tables were replaced for the + `plugin_buycourses_item` table. + +The __new database__ structure is formed for the tables: + +- `plugin_buycourses_currency` The list of countries with their currencies +- `plugin_buycourses_item` The registered courses and sessions in the platform +- `plugin_buycourses_item_re_beneficiary` The beneficiaries users with the sale of courses +- `plugin_buycourses_paypal_account` The PayPal account info +- `plugin_buycourses_sale` The sales of courses and sessions that were made +- `plugin_buycourses_transfer` The bank accounts for transfers + +--- + +v2.0 - 2014-10-14 +================= +This version adds support for sales of sessions access. +A session can be purchased as soon as it is given a price, granted the current +date is either previous to the session start date, between the start and end, +or no date has been defined for the session. +Students are subscribed automatically once they have paid. There is no +intermediary step. +This version does not work (yet) with the session period defined by user +(a special feature introduced in Chamilo 1.9.10). + +Upgrade procedure +----------------- +If you are working with this plugin since earlier versions, you will have to +look at the installer to *fix* your plugin tables (add a few fields). + +v1.0 - 2014-06-30 (or something) +================= +This is the first release of the plugin, with only the PayPal payment method +in working state and only for courses. diff --git a/plugin/buycourses/README.md b/plugin/buycourses/README.md new file mode 100644 index 000000000..0aca81db4 --- /dev/null +++ b/plugin/buycourses/README.md @@ -0,0 +1,37 @@ +Buy Courses (course sales) plugin +================================= +This plugin transforms your Chamilo installation in an online shop by adding a catalogue + of courses and sessions that you have previously configured for sales. + +If the user is not registered or logged in, he/she will be requested to register/login +before he/she can resume buying items. + +Do not enable this plugin in any "Region". This is a known issue, but it works without +region assignation. + +Once the course or session is chosen, the plugin displays the available payment methods +and lets the user proceed with the purchase. +Currently, the plugin allows users to pay through: + - PayPal (requires a merchant account on PayPal at configuration time) + - Bank payments (requires manual confirmation of payments' reception) + - RedSys payments (Spanish payment gateway) (requires the download of an external file) + - Stripe payments (requieres a merchant account oin Stripe at configuration time) + - Cecabank payments (Spanish payment gateway) + +The user receives an e-mail confirming the purchase and she/he can immediately +access to the course or session. + +We recommend using sessions as this gives you more time-related availability options +(in the session configuration). + +Updates +========= + +You must load the update.php script for installations that were in +production before updating the code, as it will update the database structure to +enable new features. + +Please note that updating Chamilo does *NOT* automatically update the plugins +structure. + +You can find a history of changes in the [CHANGELOG.md file](../../plugin/buycourses/CHANGELOG.md) diff --git a/plugin/buycourses/admin.php b/plugin/buycourses/admin.php new file mode 100644 index 000000000..f1a1f640f --- /dev/null +++ b/plugin/buycourses/admin.php @@ -0,0 +1,3 @@ +getConnection(); +$platform = $connection->getDatabasePlatform(); +$sm = $connection->getSchemaManager(); + +// Create tables +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_PAYPAL)) { + $paypalTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_PAYPAL); + $paypalTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $paypalTable->addColumn('username', Types::STRING); + $paypalTable->addColumn('password', Types::STRING); + $paypalTable->addColumn('signature', Types::STRING); + $paypalTable->addColumn('sandbox', Types::BOOLEAN); + $paypalTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_TRANSFER)) { + $transferTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_TRANSFER); + $transferTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $transferTable->addColumn('name', Types::STRING); + $transferTable->addColumn('account', Types::STRING); + $transferTable->addColumn('swift', Types::STRING); + $transferTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_TPV_REDSYS)) { + $tpvRedsysTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_TPV_REDSYS); + $tpvRedsysTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $tpvRedsysTable->addColumn('merchantcode', Types::STRING); + $tpvRedsysTable->addColumn('terminal', Types::STRING); + $tpvRedsysTable->addColumn('currency', Types::STRING); + $tpvRedsysTable->addColumn('kc', Types::STRING); + $tpvRedsysTable->addColumn('url_redsys', Types::STRING); + $tpvRedsysTable->addColumn('url_redsys_sandbox', Types::STRING); + $tpvRedsysTable->addColumn('sandbox', Types::BOOLEAN); + $tpvRedsysTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_CURRENCY)) { + $currencyTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_CURRENCY); + $currencyTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $currencyTable->addColumn( + 'country_code', + Types::STRING, + ['length' => 2] + ); + $currencyTable->addColumn( + 'country_name', + Types::STRING, + ['length' => 255] + ); + $currencyTable->addColumn( + 'iso_code', + Types::STRING, + ['length' => 3] + ); + $currencyTable->addColumn('status', Types::BOOLEAN); + $currencyTable->addUniqueIndex(['country_code']); + $currencyTable->addIndex(['iso_code']); + $currencyTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_ITEM)) { + $itemTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_ITEM); + $itemTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $itemTable->addColumn('product_type', Types::INTEGER); + $itemTable->addColumn( + 'product_id', + Types::INTEGER, + ['unsigned' => true] + ); + $itemTable->addColumn( + 'price', + Types::DECIMAL, + ['scale' => 2] + ); + $itemTable->addColumn( + 'currency_id', + Types::INTEGER, + ['unsigned' => true] + ); + $itemTable->addColumn( + 'tax_perc', + Types::INTEGER, + ['unsigned' => true, 'notnull' => false] + ); + $itemTable->setPrimaryKey(['id']); + $itemTable->addForeignKeyConstraint( + $currencyTable, + ['currency_id'], + ['id'], + ['onDelete' => 'CASCADE'] + ); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_ITEM_BENEFICIARY)) { + $itemBeneficiary = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_ITEM_BENEFICIARY); + $itemBeneficiary->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $itemBeneficiary->addColumn( + 'item_id', + Types::INTEGER, + ['unsigned' => true] + ); + $itemBeneficiary->addColumn( + 'user_id', + Types::INTEGER, + ['unsigned' => true] + ); + $itemBeneficiary->addColumn( + 'commissions', + Types::INTEGER, + ['unsigned' => true] + ); + $itemBeneficiary->setPrimaryKey(['id']); + $itemBeneficiary->addForeignKeyConstraint( + $itemTable, + ['item_id'], + ['id'], + ['onDelete' => 'CASCADE'] + ); +} +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_COMMISSION)) { + $commissions = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_COMMISSION); + $commissions->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $commissions->addColumn( + 'commission', + Types::INTEGER, + ['unsigned' => true] + ); + $commissions->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_PAYPAL_PAYOUTS)) { + $saleCommissions = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_PAYPAL_PAYOUTS); + $saleCommissions->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $saleCommissions->addColumn('date', Types::DATETIME_MUTABLE); + $saleCommissions->addColumn('payout_date', Types::DATETIME_MUTABLE); + $saleCommissions->addColumn( + 'sale_id', + Types::INTEGER, + ['unsigned' => true] + ); + $saleCommissions->addColumn( + 'user_id', + Types::INTEGER, + ['unsigned' => true] + ); + $saleCommissions->addColumn( + 'commission', + Types::DECIMAL, + ['scale' => 2] + ); + $saleCommissions->addColumn( + 'status', + Types::INTEGER, + ['unsigned' => true] + ); + $saleCommissions->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_SALE)) { + $saleTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_SALE); + $saleTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $saleTable->addColumn('reference', Types::STRING); + $saleTable->addColumn('date', Types::DATETIME_MUTABLE); + $saleTable->addColumn( + 'user_id', + Types::INTEGER, + ['unsigned' => true] + ); + $saleTable->addColumn('product_type', Types::INTEGER); + $saleTable->addColumn('product_name', Types::STRING); + $saleTable->addColumn( + 'product_id', + Types::INTEGER, + ['unsigned' => true] + ); + $saleTable->addColumn( + 'price', + Types::DECIMAL, + ['scale' => 2] + ); + $saleTable->addColumn( + 'price_without_tax', + Types::DECIMAL, + ['scale' => 2, 'notnull' => false] + ); + $saleTable->addColumn( + 'tax_perc', + Types::INTEGER, + ['unsigned' => true, 'notnull' => false] + ); + $saleTable->addColumn( + 'tax_amount', + Types::DECIMAL, + ['scale' => 2, 'notnull' => false] + ); + $saleTable->addColumn( + 'currency_id', + Types::INTEGER, + ['unsigned' => true] + ); + $saleTable->addColumn('status', Types::INTEGER); + $saleTable->addColumn('payment_type', Types::INTEGER); + $saleTable->addColumn('invoice', Types::INTEGER); + $saleTable->addColumn( + 'price_without_discount', + Types::DECIMAL, + ['scale' => 2, 'notnull' => false] + ); + $saleTable->addColumn( + 'discount_amount', + Types::DECIMAL, + ['scale' => 2, 'notnull' => false] + ); + $saleTable->setPrimaryKey(['id']); + $saleTable->addForeignKeyConstraint( + $currencyTable, + ['currency_id'], + ['id'], + ['onDelete' => 'CASCADE'] + ); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_SERVICES)) { + $servicesTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_SERVICES); + $servicesTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $servicesTable->addColumn('name', Types::STRING); + $servicesTable->addColumn('description', Types::TEXT); + $servicesTable->addColumn( + 'price', + Types::DECIMAL, + ['scale' => 2] + ); + $servicesTable->addColumn('duration_days', Types::INTEGER); + $servicesTable->addColumn('applies_to', Types::INTEGER); + $servicesTable->addColumn('owner_id', Types::INTEGER); + $servicesTable->addColumn('visibility', Types::INTEGER); + $servicesTable->addColumn('video_url', Types::STRING); + $servicesTable->addColumn('image', Types::STRING); + $servicesTable->addColumn('service_information', Types::TEXT); + $servicesTable->addColumn('tax_perc', Types::INTEGER); + $servicesTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_SERVICES_SALE)) { + $servicesNodeTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_SERVICES_SALE); + $servicesNodeTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $servicesNodeTable->addColumn( + 'service_id', + Types::INTEGER, + ['unsigned' => true] + ); + $servicesNodeTable->addColumn('reference', Types::STRING); + $servicesNodeTable->addColumn('currency_id', Types::INTEGER); + $servicesNodeTable->addColumn( + 'price', + Types::DECIMAL, + ['scale' => 2] + ); + $servicesNodeTable->addColumn( + 'price_without_tax', + Types::DECIMAL, + ['scale' => 2, 'notnull' => false] + ); + $servicesNodeTable->addColumn( + 'tax_perc', + Types::INTEGER, + ['unsigned' => true, 'notnull' => false] + ); + $servicesNodeTable->addColumn( + 'tax_amount', + Types::DECIMAL, + ['scale' => 2, 'notnull' => false] + ); + $servicesNodeTable->addColumn('node_type', Types::INTEGER); + $servicesNodeTable->addColumn('node_id', Types::INTEGER); + $servicesNodeTable->addColumn('buyer_id', Types::INTEGER); + $servicesNodeTable->addColumn('buy_date', Types::DATETIME_MUTABLE); + $servicesNodeTable->addColumn( + 'date_start', + Types::DATETIME_MUTABLE, + ['notnull' => false] + ); + $servicesNodeTable->addColumn( + 'date_end', + Types::DATETIME_MUTABLE + ); + $servicesNodeTable->addColumn('status', Types::INTEGER); + $servicesNodeTable->addColumn('payment_type', Types::INTEGER); + $servicesNodeTable->addColumn('invoice', Types::INTEGER); + $servicesNodeTable->addColumn( + 'price_without_discount', + Types::DECIMAL, + ['scale' => 2, 'notnull' => false] + ); + $servicesNodeTable->addColumn( + 'discount_amount', + Types::DECIMAL, + ['scale' => 2, 'notnull' => false] + ); + $servicesNodeTable->setPrimaryKey(['id']); + $servicesNodeTable->addForeignKeyConstraint( + $servicesTable, + ['service_id'], + ['id'], + ['onDelete' => 'CASCADE'] + ); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_CULQI)) { + $culqiTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_CULQI); + $culqiTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $culqiTable->addColumn('commerce_code', Types::STRING); + $culqiTable->addColumn('api_key', Types::STRING); + $culqiTable->addColumn('integration', Types::INTEGER); + $culqiTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_GLOBAL_CONFIG)) { + $globalTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_GLOBAL_CONFIG); + $globalTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $globalTable->addColumn('terms_and_conditions', Types::TEXT); + $globalTable->addColumn('global_tax_perc', Types::INTEGER); + $globalTable->addColumn('tax_applies_to', Types::INTEGER); + $globalTable->addColumn('tax_name', Types::STRING); + $globalTable->addColumn('seller_name', Types::STRING); + $globalTable->addColumn('seller_id', Types::STRING); + $globalTable->addColumn('seller_address', Types::STRING); + $globalTable->addColumn('seller_email', Types::STRING); + $globalTable->addColumn('next_number_invoice', Types::INTEGER); + $globalTable->addColumn('invoice_series', Types::STRING); + $globalTable->addColumn('sale_email', Types::STRING); + $globalTable->addColumn('info_email_extra', Types::TEXT); + $globalTable->setPrimaryKey(['id']); +} else { + $globalTable = $pluginSchema->getTable(BuyCoursesPlugin::TABLE_GLOBAL_CONFIG); + + if (!$globalTable->hasColumn('info_email_extra')) { + $globalTable->addColumn('info_email_extra', Types::TEXT); + } +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_INVOICE)) { + $invoiceTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_INVOICE); + $invoiceTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $invoiceTable->addColumn('sale_id', Types::INTEGER); + $invoiceTable->addColumn('is_service', Types::INTEGER); + $invoiceTable->addColumn( + 'num_invoice', + Types::INTEGER, + ['unsigned' => true, 'notnull' => false] + ); + $invoiceTable->addColumn( + 'year', + Types::INTEGER, + ['unsigned' => true, 'notnull' => false] + ); + $invoiceTable->addColumn('serie', Types::STRING); + $invoiceTable->addColumn('date_invoice', Types::DATETIME_MUTABLE); + $invoiceTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_COUPON)) { + $couponTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_COUPON); + $couponTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $couponTable->addColumn('code', Types::STRING); + $couponTable->addColumn('discount_type', Types::INTEGER); + $couponTable->addColumn('discount_amount', Types::INTEGER); + $couponTable->addColumn('valid_start', Types::DATETIME_MUTABLE); + $couponTable->addColumn('valid_end', Types::DATETIME_MUTABLE); + $couponTable->addColumn('delivered', Types::INTEGER); + $couponTable->addColumn('active', Types::BOOLEAN); + $couponTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_COUPON_ITEM)) { + $couponItemTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_COUPON_ITEM); + $couponItemTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $couponItemTable->addColumn('coupon_id', Types::INTEGER); + $couponItemTable->addColumn('product_type', Types::INTEGER); + $couponItemTable->addColumn('product_id', Types::INTEGER); + $couponItemTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_COUPON_SERVICE)) { + $couponService = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_COUPON_SERVICE); + $couponService->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $couponService->addColumn('coupon_id', Types::INTEGER); + $couponService->addColumn('service_id', Types::INTEGER); + $couponService->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_SUBSCRIPTION)) { + $subscriptionTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_SUBSCRIPTION); + $subscriptionTable->addColumn( + 'product_type', + Types::INTEGER, + ['unsigned' => true] + ); + $subscriptionTable->addColumn( + 'product_id', + Types::INTEGER, + ['unsigned' => true] + ); + $subscriptionTable->addColumn( + 'duration', + Types::INTEGER, + ['unsigned' => true] + ); + $subscriptionTable->addColumn('currency_id', Types::INTEGER); + $subscriptionTable->addColumn('price', Types::DECIMAL); + $subscriptionTable->addColumn('tax_perc', Types::INTEGER); + $subscriptionTable->setPrimaryKey(['product_type', 'product_id', 'duration']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_SUBSCRIPTION_SALE)) { + $subscriptionSaleTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_SUBSCRIPTION_SALE); + $subscriptionSaleTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $subscriptionSaleTable->addColumn('currency_id', Types::INTEGER); + $subscriptionSaleTable->addColumn('reference', Types::STRING); + $subscriptionSaleTable->addColumn('date', Types::DATETIME_MUTABLE); + $subscriptionSaleTable->addColumn('user_id', Types::INTEGER); + $subscriptionSaleTable->addColumn('product_type', Types::INTEGER); + $subscriptionSaleTable->addColumn('product_name', Types::STRING); + $subscriptionSaleTable->addColumn('product_id', Types::INTEGER); + $subscriptionSaleTable->addColumn('price', Types::DECIMAL); + $subscriptionSaleTable->addColumn('price_without_tax', Types::DECIMAL, ['notnull' => false]); + $subscriptionSaleTable->addColumn('tax_perc', Types::INTEGER, ['notnull' => false]); + $subscriptionSaleTable->addColumn('tax_amount', Types::DECIMAL, ['notnull' => false]); + $subscriptionSaleTable->addColumn('status', Types::INTEGER); + $subscriptionSaleTable->addColumn('payment_type', Types::INTEGER); + $subscriptionSaleTable->addColumn('invoice', Types::INTEGER); + $subscriptionSaleTable->addColumn('price_without_discount', Types::DECIMAL); + $subscriptionSaleTable->addColumn('discount_amount', Types::DECIMAL); + $subscriptionSaleTable->addColumn('subscription_end', Types::DATETIME_MUTABLE); + $subscriptionSaleTable->addColumn('expired', Types::BOOLEAN); + $subscriptionSaleTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_SUBSCRIPTION_PERIOD)) { + $subscriptionPeriodTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_SUBSCRIPTION_PERIOD); + $subscriptionPeriodTable->addColumn( + 'duration', + Types::INTEGER, + ['unsigned' => true] + ); + $subscriptionPeriodTable->addColumn('name', Types::STRING); + $subscriptionPeriodTable->setPrimaryKey(['duration']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_COUPON_SALE)) { + $couponSaleTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_COUPON_SALE); + $couponSaleTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $couponSaleTable->addColumn('coupon_id', Types::INTEGER); + $couponSaleTable->addColumn('sale_id', Types::INTEGER); + $couponSaleTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_COUPON_SERVICE_SALE)) { + $couponSaleTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_COUPON_SERVICE_SALE); + $couponSaleTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $couponSaleTable->addColumn('coupon_id', Types::INTEGER); + $couponSaleTable->addColumn('service_sale_id', Types::INTEGER); + $couponSaleTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_STRIPE)) { + $stripeTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_STRIPE); + $stripeTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $stripeTable->addColumn('account_id', Types::STRING); + $stripeTable->addColumn('secret_key', Types::STRING); + $stripeTable->addColumn('endpoint_secret', Types::STRING); + $stripeTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_TPV_CECABANK)) { + $tpvCecabankTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_TPV_CECABANK); + $tpvCecabankTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $tpvCecabankTable->addColumn('crypto_key', Types::STRING); + $tpvCecabankTable->addColumn('merchant_id', Types::STRING); + $tpvCecabankTable->addColumn('acquirer_bin', Types::STRING); + $tpvCecabankTable->addColumn('terminal_id', Types::STRING); + $tpvCecabankTable->addColumn('cypher', Types::STRING); + $tpvCecabankTable->addColumn('exponent', Types::STRING); + $tpvCecabankTable->addColumn('supported_payment', Types::STRING); + $tpvCecabankTable->addColumn('url', Types::STRING); + $tpvCecabankTable->setPrimaryKey(['id']); +} + +if (false === $sm->tablesExist(BuyCoursesPlugin::TABLE_COUPON_SUBSCRIPTION_SALE)) { + $couponSubscriptionSaleTable = $pluginSchema->createTable(BuyCoursesPlugin::TABLE_COUPON_SUBSCRIPTION_SALE); + $couponSubscriptionSaleTable->addColumn( + 'id', + Types::INTEGER, + ['autoincrement' => true, 'unsigned' => true] + ); + $couponSubscriptionSaleTable->addColumn('coupon_id', Types::INTEGER); + $couponSubscriptionSaleTable->addColumn('sale_id', Types::INTEGER); + $couponSubscriptionSaleTable->setPrimaryKey(['id']); +} + +$queries = $pluginSchema->toSql($platform); + +foreach ($queries as $query) { + Database::query($query); +} + +// Insert data +$paypalTable = Database::get_main_table(BuyCoursesPlugin::TABLE_PAYPAL); +$currencyTable = Database::get_main_table(BuyCoursesPlugin::TABLE_CURRENCY); +$itemTable = Database::get_main_table(BuyCoursesPlugin::TABLE_ITEM); +$saleTable = Database::get_main_table(BuyCoursesPlugin::TABLE_SALE); +$commissionTable = Database::get_main_table(BuyCoursesPlugin::TABLE_COMMISSION); +$extraFieldTable = Database::get_main_table(TABLE_EXTRA_FIELD); +$culqiTable = Database::get_main_table(BuyCoursesPlugin::TABLE_CULQI); +$globalTable = Database::get_main_table(BuyCoursesPlugin::TABLE_GLOBAL_CONFIG); +$tpvRedsysTable = Database::get_main_table(BuyCoursesPlugin::TABLE_TPV_REDSYS); +$stripeTable = Database::get_main_table(BuyCoursesPlugin::TABLE_STRIPE); + +$paypalExtraField = Database::select( + "*", + $extraFieldTable, + [ + 'where' => ['variable = ?' => 'paypal'], + ], + 'first' +); + +if (!$paypalExtraField) { + Database::insert( + $extraFieldTable, + [ + 'extra_field_type' => 1, + 'field_type' => 1, + 'variable' => 'paypal', + 'display_text' => 'Paypal', + 'default_value' => '', + 'field_order' => 0, + 'visible_to_self' => 1, + 'changeable' => 1, + 'filter' => 0, + 'created_at' => api_get_utc_datetime(), + ] + ); +} + +Database::insert( + $paypalTable, + [ + 'username' => '', + 'password' => '', + 'signature' => '', + 'sandbox' => true, + ] +); + +Database::insert( + $tpvRedsysTable, + [ + 'url_redsys' => 'https://sis.redsys.es/sis/realizarPago', + 'url_redsys_sandbox' => 'https://sis-t.redsys.es:25443/sis/realizarPago', + ] +); + +Database::insert( + $culqiTable, + [ + 'commerce_code' => '', + 'api_key' => '', + 'integration' => 1, + ] +); + +Database::insert( + $globalTable, + [ + 'terms_and_conditions' => '', + ] +); + +Database::insert( + $commissionTable, + [ + 'commission' => 0, + ] +); + +Database::insert( + $stripeTable, + [ + 'account_id' => '', + 'secret_key' => '', + 'endpoint_secret' => '', + ] +); + +$currencies = [ + ['AD', 'Andorra', 'EUR', 'AND'], + ['AE', 'United Arab Emirates', 'AED', 'ARE'], + ['AF', 'Afghanistan', 'AFN', 'AFG'], + ['AG', 'Antigua and Barbuda', 'XCD', 'ATG'], + ['AI', 'Anguilla', 'XCD', 'AIA'], + ['AL', 'Albania', 'ALL', 'ALB'], + ['AM', 'Armenia', 'AMD', 'ARM'], + ['AO', 'Angola', 'AOA', 'AGO'], + ['AR', 'Argentina', 'ARS', 'ARG'], + ['AS', 'American Samoa', 'USD', 'ASM'], + ['AT', 'Austria', 'EUR', 'AUT'], + ['AU', 'Australia', 'AUD', 'AUS'], + ['AW', 'Aruba', 'AWG', 'ABW'], + ['AX', 'Åland', 'EUR', 'ALA'], + ['AZ', 'Azerbaijan', 'AZN', 'AZE'], + ['BA', 'Bosnia and Herzegovina', 'BAM', 'BIH'], + ['BB', 'Barbados', 'BBD', 'BRB'], + ['BD', 'Bangladesh', 'BDT', 'BGD'], + ['BE', 'Belgium', 'EUR', 'BEL'], + ['BF', 'Burkina Faso', 'XOF', 'BFA'], + ['BG', 'Bulgaria', 'BGN', 'BGR'], + ['BH', 'Bahrain', 'BHD', 'BHR'], + ['BI', 'Burundi', 'BIF', 'BDI'], + ['BJ', 'Benin', 'XOF', 'BEN'], + ['BL', 'Saint Barthélemy', 'EUR', 'BLM'], + ['BM', 'Bermuda', 'BMD', 'BMU'], + ['BN', 'Brunei', 'BND', 'BRN'], + ['BO', 'Bolivia', 'BOB', 'BOL'], + ['BQ', 'Bonaire', 'USD', 'BES'], + ['BR', 'Brazil', 'BRL', 'BRA'], + ['BS', 'Bahamas', 'BSD', 'BHS'], + ['BT', 'Bhutan', 'BTN', 'BTN'], + ['BV', 'Bouvet Island', 'NOK', 'BVT'], + ['BW', 'Botswana', 'BWP', 'BWA'], + ['BY', 'Belarus', 'BYR', 'BLR'], + ['BZ', 'Belize', 'BZD', 'BLZ'], + ['CA', 'Canada', 'CAD', 'CAN'], + ['CC', 'Cocos [Keeling] Islands', 'AUD', 'CCK'], + ['CD', 'Congo', 'CDF', 'COD'], + ['CF', 'Central African Republic', 'XAF', 'CAF'], + ['CG', 'Republic of the Congo', 'XAF', 'COG'], + ['CH', 'Switzerland', 'CHF', 'CHE'], + ['CI', 'Ivory Coast', 'XOF', 'CIV'], + ['CK', 'Cook Islands', 'NZD', 'COK'], + ['CL', 'Chile', 'CLP', 'CHL'], + ['CM', 'Cameroon', 'XAF', 'CMR'], + ['CN', 'China', 'CNY', 'CHN'], + ['CO', 'Colombia', 'COP', 'COL'], + ['CR', 'Costa Rica', 'CRC', 'CRI'], + ['CU', 'Cuba', 'CUP', 'CUB'], + ['CV', 'Cape Verde', 'CVE', 'CPV'], + ['CW', 'Curacao', 'ANG', 'CUW'], + ['CX', 'Christmas Island', 'AUD', 'CXR'], + ['CY', 'Cyprus', 'EUR', 'CYP'], + ['CZ', 'Czechia', 'CZK', 'CZE'], + ['DE', 'Germany', 'EUR', 'DEU'], + ['DJ', 'Djibouti', 'DJF', 'DJI'], + ['DK', 'Denmark', 'DKK', 'DNK'], + ['DM', 'Dominica', 'XCD', 'DMA'], + ['DO', 'Dominican Republic', 'DOP', 'DOM'], + ['DZ', 'Algeria', 'DZD', 'DZA'], + ['EC', 'Ecuador', 'USD', 'ECU'], + ['EE', 'Estonia', 'EUR', 'EST'], + ['EG', 'Egypt', 'EGP', 'EGY'], + ['EH', 'Western Sahara', 'MAD', 'ESH'], + ['ER', 'Eritrea', 'ERN', 'ERI'], + ['ES', 'Spain', 'EUR', 'ESP'], + ['ET', 'Ethiopia', 'ETB', 'ETH'], + ['FI', 'Finland', 'EUR', 'FIN'], + ['FJ', 'Fiji', 'FJD', 'FJI'], + ['FK', 'Falkland Islands', 'FKP', 'FLK'], + ['FM', 'Micronesia', 'USD', 'FSM'], + ['FO', 'Faroe Islands', 'DKK', 'FRO'], + ['FR', 'France', 'EUR', 'FRA'], + ['GA', 'Gabon', 'XAF', 'GAB'], + ['GB', 'United Kingdom', 'GBP', 'GBR'], + ['GD', 'Grenada', 'XCD', 'GRD'], + ['GE', 'Georgia', 'GEL', 'GEO'], + ['GF', 'French Guiana', 'EUR', 'GUF'], + ['GG', 'Guernsey', 'GBP', 'GGY'], + ['GH', 'Ghana', 'GHS', 'GHA'], + ['GI', 'Gibraltar', 'GIP', 'GIB'], + ['GL', 'Greenland', 'DKK', 'GRL'], + ['GM', 'Gambia', 'GMD', 'GMB'], + ['GN', 'Guinea', 'GNF', 'GIN'], + ['GP', 'Guadeloupe', 'EUR', 'GLP'], + ['GQ', 'Equatorial Guinea', 'XAF', 'GNQ'], + ['GR', 'Greece', 'EUR', 'GRC'], + ['GS', 'South Georgia and the South Sandwich Islands', 'GBP', 'SGS'], + ['GT', 'Guatemala', 'GTQ', 'GTM'], + ['GU', 'Guam', 'USD', 'GUM'], + ['GW', 'Guinea-Bissau', 'XOF', 'GNB'], + ['GY', 'Guyana', 'GYD', 'GUY'], + ['HK', 'Hong Kong', 'HKD', 'HKG'], + ['HM', 'Heard Island and McDonald Islands', 'AUD', 'HMD'], + ['HN', 'Honduras', 'HNL', 'HND'], + ['HR', 'Croatia', 'HRK', 'HRV'], + ['HT', 'Haiti', 'HTG', 'HTI'], + ['HU', 'Hungary', 'HUF', 'HUN'], + ['ID', 'Indonesia', 'IDR', 'IDN'], + ['IE', 'Ireland', 'EUR', 'IRL'], + ['IL', 'Israel', 'ILS', 'ISR'], + ['IM', 'Isle of Man', 'GBP', 'IMN'], + ['IN', 'India', 'INR', 'IND'], + ['IO', 'British Indian Ocean Territory', 'USD', 'IOT'], + ['IQ', 'Iraq', 'IQD', 'IRQ'], + ['IR', 'Iran', 'IRR', 'IRN'], + ['IS', 'Iceland', 'ISK', 'ISL'], + ['IT', 'Italy', 'EUR', 'ITA'], + ['JE', 'Jersey', 'GBP', 'JEY'], + ['JM', 'Jamaica', 'JMD', 'JAM'], + ['JO', 'Jordan', 'JOD', 'JOR'], + ['JP', 'Japan', 'JPY', 'JPN'], + ['KE', 'Kenya', 'KES', 'KEN'], + ['KG', 'Kyrgyzstan', 'KGS', 'KGZ'], + ['KH', 'Cambodia', 'KHR', 'KHM'], + ['KI', 'Kiribati', 'AUD', 'KIR'], + ['KM', 'Comoros', 'KMF', 'COM'], + ['KN', 'Saint Kitts and Nevis', 'XCD', 'KNA'], + ['KP', 'North Korea', 'KPW', 'PRK'], + ['KR', 'South Korea', 'KRW', 'KOR'], + ['KW', 'Kuwait', 'KWD', 'KWT'], + ['KY', 'Cayman Islands', 'KYD', 'CYM'], + ['KZ', 'Kazakhstan', 'KZT', 'KAZ'], + ['LA', 'Laos', 'LAK', 'LAO'], + ['LB', 'Lebanon', 'LBP', 'LBN'], + ['LC', 'Saint Lucia', 'XCD', 'LCA'], + ['LI', 'Liechtenstein', 'CHF', 'LIE'], + ['LK', 'Sri Lanka', 'LKR', 'LKA'], + ['LR', 'Liberia', 'LRD', 'LBR'], + ['LS', 'Lesotho', 'LSL', 'LSO'], + ['LT', 'Lithuania', 'LTL', 'LTU'], + ['LU', 'Luxembourg', 'EUR', 'LUX'], + ['LV', 'Latvia', 'LVL', 'LVA'], + ['LY', 'Libya', 'LYD', 'LBY'], + ['MA', 'Morocco', 'MAD', 'MAR'], + ['MC', 'Monaco', 'EUR', 'MCO'], + ['MD', 'Moldova', 'MDL', 'MDA'], + ['ME', 'Montenegro', 'EUR', 'MNE'], + ['MF', 'Saint Martin', 'EUR', 'MAF'], + ['MG', 'Madagascar', 'MGA', 'MDG'], + ['MH', 'Marshall Islands', 'USD', 'MHL'], + ['MK', 'Macedonia', 'MKD', 'MKD'], + ['ML', 'Mali', 'XOF', 'MLI'], + ['MM', 'Myanmar [Burma]', 'MMK', 'MMR'], + ['MN', 'Mongolia', 'MNT', 'MNG'], + ['MO', 'Macao', 'MOP', 'MAC'], + ['MP', 'Northern Mariana Islands', 'USD', 'MNP'], + ['MQ', 'Martinique', 'EUR', 'MTQ'], + ['MR', 'Mauritania', 'MRO', 'MRT'], + ['MS', 'Montserrat', 'XCD', 'MSR'], + ['MT', 'Malta', 'EUR', 'MLT'], + ['MU', 'Mauritius', 'MUR', 'MUS'], + ['MV', 'Maldives', 'MVR', 'MDV'], + ['MW', 'Malawi', 'MWK', 'MWI'], + ['MX', 'Mexico', 'MXN', 'MEX'], + ['MY', 'Malaysia', 'MYR', 'MYS'], + ['MZ', 'Mozambique', 'MZN', 'MOZ'], + ['NA', 'Namibia', 'NAD', 'NAM'], + ['NC', 'New Caledonia', 'XPF', 'NCL'], + ['NE', 'Niger', 'XOF', 'NER'], + ['NF', 'Norfolk Island', 'AUD', 'NFK'], + ['NG', 'Nigeria', 'NGN', 'NGA'], + ['NI', 'Nicaragua', 'NIO', 'NIC'], + ['NL', 'Netherlands', 'EUR', 'NLD'], + ['NO', 'Norway', 'NOK', 'NOR'], + ['NP', 'Nepal', 'NPR', 'NPL'], + ['NR', 'Nauru', 'AUD', 'NRU'], + ['NU', 'Niue', 'NZD', 'NIU'], + ['NZ', 'New Zealand', 'NZD', 'NZL'], + ['OM', 'Oman', 'OMR', 'OMN'], + ['PA', 'Panama', 'PAB', 'PAN'], + ['PE', 'Peru', 'PEN', 'PER'], + ['PF', 'French Polynesia', 'XPF', 'PYF'], + ['PG', 'Papua New Guinea', 'PGK', 'PNG'], + ['PH', 'Philippines', 'PHP', 'PHL'], + ['PK', 'Pakistan', 'PKR', 'PAK'], + ['PL', 'Poland', 'PLN', 'POL'], + ['PM', 'Saint Pierre and Miquelon', 'EUR', 'SPM'], + ['PN', 'Pitcairn Islands', 'NZD', 'PCN'], + ['PR', 'Puerto Rico', 'USD', 'PRI'], + ['PS', 'Palestine', 'ILS', 'PSE'], + ['PT', 'Portugal', 'EUR', 'PRT'], + ['PW', 'Palau', 'USD', 'PLW'], + ['PY', 'Paraguay', 'PYG', 'PRY'], + ['QA', 'Qatar', 'QAR', 'QAT'], + ['RE', 'Réunion', 'EUR', 'REU'], + ['RO', 'Romania', 'RON', 'ROU'], + ['RS', 'Serbia', 'RSD', 'SRB'], + ['RU', 'Russia', 'RUB', 'RUS'], + ['RW', 'Rwanda', 'RWF', 'RWA'], + ['SA', 'Saudi Arabia', 'SAR', 'SAU'], + ['SB', 'Solomon Islands', 'SBD', 'SLB'], + ['SC', 'Seychelles', 'SCR', 'SYC'], + ['SD', 'Sudan', 'SDG', 'SDN'], + ['SE', 'Sweden', 'SEK', 'SWE'], + ['SG', 'Singapore', 'SGD', 'SGP'], + ['SH', 'Saint Helena', 'SHP', 'SHN'], + ['SI', 'Slovenia', 'EUR', 'SVN'], + ['SJ', 'Svalbard and Jan Mayen', 'NOK', 'SJM'], + ['SK', 'Slovakia', 'EUR', 'SVK'], + ['SL', 'Sierra Leone', 'SLL', 'SLE'], + ['SM', 'San Marino', 'EUR', 'SMR'], + ['SN', 'Senegal', 'XOF', 'SEN'], + ['SO', 'Somalia', 'SOS', 'SOM'], + ['SR', 'Suriname', 'SRD', 'SUR'], + ['SS', 'South Sudan', 'SSP', 'SSD'], + ['ST', 'São Tomé and Príncipe', 'STD', 'STP'], + ['SV', 'El Salvador', 'USD', 'SLV'], + ['SX', 'Sint Maarten', 'ANG', 'SXM'], + ['SY', 'Syria', 'SYP', 'SYR'], + ['SZ', 'Swaziland', 'SZL', 'SWZ'], + ['TC', 'Turks and Caicos Islands', 'USD', 'TCA'], + ['TD', 'Chad', 'XAF', 'TCD'], + ['TF', 'French Southern Territories', 'EUR', 'ATF'], + ['TG', 'Togo', 'XOF', 'TGO'], + ['TH', 'Thailand', 'THB', 'THA'], + ['TJ', 'Tajikistan', 'TJS', 'TJK'], + ['TK', 'Tokelau', 'NZD', 'TKL'], + ['TL', 'East Timor', 'USD', 'TLS'], + ['TM', 'Turkmenistan', 'TMT', 'TKM'], + ['TN', 'Tunisia', 'TND', 'TUN'], + ['TO', 'Tonga', 'TOP', 'TON'], + ['TR', 'Turkey', 'TRY', 'TUR'], + ['TT', 'Trinidad and Tobago', 'TTD', 'TTO'], + ['TV', 'Tuvalu', 'AUD', 'TUV'], + ['TW', 'Taiwan', 'TWD', 'TWN'], + ['TZ', 'Tanzania', 'TZS', 'TZA'], + ['UA', 'Ukraine', 'UAH', 'UKR'], + ['UG', 'Uganda', 'UGX', 'UGA'], + ['UM', 'U.S. Minor Outlying Islands', 'USD', 'UMI'], + ['US', 'United States', 'USD', 'USA'], + ['UY', 'Uruguay', 'UYU', 'URY'], + ['UZ', 'Uzbekistan', 'UZS', 'UZB'], + ['VA', 'Vatican City', 'EUR', 'VAT'], + ['VC', 'Saint Vincent and the Grenadines', 'XCD', 'VCT'], + ['VE', 'Venezuela', 'VEF', 'VEN'], + ['VG', 'British Virgin Islands', 'USD', 'VGB'], + ['VI', 'U.S. Virgin Islands', 'USD', 'VIR'], + ['VN', 'Vietnam', 'VND', 'VNM'], + ['VU', 'Vanuatu', 'VUV', 'VUT'], + ['WF', 'Wallis and Futuna', 'XPF', 'WLF'], + ['WS', 'Samoa', 'WST', 'WSM'], + ['XK', 'Kosovo', 'EUR', 'XKX'], + ['YE', 'Yemen', 'YER', 'YEM'], + ['YT', 'Mayotte', 'EUR', 'MYT'], + ['ZA', 'South Africa', 'ZAR', 'ZAF'], + ['ZM', 'Zambia', 'ZMK', 'ZMB'], + ['ZW', 'Zimbabwe', 'ZWL', 'ZWE'], +]; + +foreach ($currencies as $currency) { + $value = Database::select( + "*", + $currencyTable, + [ + 'where' => ['country_code = ?' => $currency[0]], + ], + 'first' + ); + + if (!empty($value)) { + continue; + } + + Database::insert( + $currencyTable, + [ + 'country_code' => $currency[0], + 'country_name' => $currency[1], + 'iso_code' => $currency[2], + ] + ); +} + +$fieldlabel = 'buycourses_company'; +$fieldtype = '1'; +$fieldtitle = BuyCoursesPlugin::get_lang('Company'); +$fielddefault = ''; +$field_id = UserManager::create_extra_field($fieldlabel, $fieldtype, $fieldtitle, $fielddefault); + +$fieldlabel = 'buycourses_vat'; +$fieldtype = '1'; +$fieldtitle = BuyCoursesPlugin::get_lang('VAT'); +$fielddefault = ''; +$field_id = UserManager::create_extra_field($fieldlabel, $fieldtype, $fieldtitle, $fielddefault); + +$fieldlabel = 'buycourses_address'; +$fieldtype = '1'; +$fieldtitle = BuyCoursesPlugin::get_lang('Address'); +$fielddefault = ''; +$field_id = UserManager::create_extra_field($fieldlabel, $fieldtype, $fieldtitle, $fielddefault); diff --git a/plugin/buycourses/index.php b/plugin/buycourses/index.php new file mode 100644 index 000000000..fefacd452 --- /dev/null +++ b/plugin/buycourses/index.php @@ -0,0 +1,7 @@ +install(); diff --git a/plugin/buycourses/lang/brazilian.php b/plugin/buycourses/lang/brazilian.php new file mode 100644 index 000000000..19debc6ca --- /dev/null +++ b/plugin/buycourses/lang/brazilian.php @@ -0,0 +1,99 @@ +configurar pagamento - Defina a moeda com a qual você gostaria de vender seus cursos ou sessões"; +$strings['InstructionsStepThree'] = "Para configurar cursos para vender. Vá em: configurar cursos e preços."; +$strings['BuyCourses'] = "Comprar cursos"; +$strings['ConfigurationOfCoursesAndPrices'] = "Configurar cursos e preços "; +$strings['SalesReport'] = "Relatório de vendas"; +$strings['UserInformation'] = "Detalhes do comprador"; +$strings['PaymentMethods'] = "Métodos de pagamento"; +$strings['ConfirmOrder'] = "Confirmar pedido"; +$strings['PurchaseData'] = "Dados de Compra"; +$strings['bc_subject'] = "Confirmação de ordem do curso"; +$strings['PurchaseStatusX'] = "Estado de compra: %s"; +$strings['PendingReasonByTransfer'] = " Pendente Aguardando confirmação da transferência."; +$strings['CancelOrder'] = "Anular ordem"; +$strings['BankAccountInformation'] = "Detalhes da conta bancária"; +$strings['BankAccount'] = "Contas bancárias"; +$strings['OnceItIsConfirmedYouWillReceiveAnEmailWithTheBankInformationAndAnOrderReference'] = "Uma vez confirmada, você receberá um e-mail com os dados bancários e uma referência de ordem."; +$strings['SubscriptionToCourseXSuccessful'] = "Sua inscrição para \"%s\" foi concluída com sucesso."; +$strings['OrderCanceled'] = "Ordem cancelada"; +$strings['OrderStatus'] = "Status do pedido"; +$strings['SearchByStatus'] = "Pesquisar por estado"; +$strings['OrderReference'] = "Código de encomenda"; +$strings['OrderDate'] = "Data do pedido"; +$strings['ProductType'] = "Tipo de produto"; +$strings['SubscribeUser'] = "Inscrever utilizador"; +$strings['DeleteOrder'] = "Excluir a ordem"; +$strings['ErrorContactPlatformAdmin'] = "Por favor entre em contato com o administrador da plataforma de erro desconhecido.."; +$strings['PendingReasonByAddress'] = ". Pendente Você não digitou um endereço de entrega confirmado."; +$strings['PendingReasonByAuthorization'] = " Pendentes fundos Nós ainda não capturados.."; +$strings['PendingReasonByEcheck'] = " Pendente O pagamento foi feito por um eCheck que ainda não foi eliminada."; +$strings['PendingReasonByIntl'] = " Pendente Nós não temos um mecanismo de retirada de fundos.."; +$strings['PendingReasonByMulticurrency'] = " Pendente Nós não equilibrar na moeda enviado."; +$strings['PendingReasonByOrder'] = " Pendente Ordem feita Nós ainda não capturado fundos..."; +$strings['PendingReasonByPaymentReview'] = " Pendente O pagamento está sendo revisto pelo PayPal para o risco."; +$strings['PendingReasonByRegulatoryReview'] = " Pendente O pagamento está sendo revisado para conformidade com regulamentações governamentais.."; +$strings['PendingReasonByUnilateral'] = " Pendente O e-mail ainda não está registrado o confirmou.."; +$strings['PendingReasonByUpgrade'] = " Pendente O pagamento foi feito por cartão de crédito.."; +$strings['PendingReasonByVerify'] = " Pendente Desculpe Nós ainda não são verificados no PayPal..."; +$strings['PendingReasonByOther'] = " Pendente Por favor, entre em contato com o administrador da plataforma.."; +$strings['PayPalPaymentOKPleaseConfirm'] = "PayPal relata a transação está pronto para ser executado. Para confirmar que você está OK para prosseguir, clique no botão de confirmação abaixo. Uma vez clicado, você será registrado para o curso e os fundos serão transferido da sua conta PayPal para a nossa loja. Você sempre pode acessar seus cursos através da aba 'Meus cursos' Obrigado por seu costume.!"; +$strings['Sandbox'] = "Ambiente de teste"; +$strings['PayPalConfig'] = "Configuração PayPal:"; +$strings['TransfersConfig'] = "Configurar transferências bancárias:"; +$strings['PluginInstruction'] = "Você pode ativar ou desativar a opção de pagar via PayPal ou transferência bancária na seção de configuração do plugin."; +$strings['ClickHere'] = " Clique aqui para obter mais detalhes"; +$strings['CurrencyType'] = "Tipo de moeda"; +$strings['InfoCurrency'] = "Define a moeda para o pagamento de seus cursos."; +$strings['ApiUsername'] = "Nome de usuário API"; +$strings['ApiPassword'] = "Senha API"; +$strings['ApiSignature'] = "Assinatura API"; +$strings['InfoApiCredentials'] = "Para gerar as suas credenciais de API para integrar Chamilo com a sua conta PayPal, você deve seguir os seguintes passos"; +$strings['InfoApiStepOne'] = "Vá para a sua conta do PayPal, Resumo , então preferências do vendedor na Ferramentas de Vendas menu (se o fizer não ter este item de menu, você pode precisar de obter a autorização para vender o material através do PayPal em primeiro lugar)."; +$strings['InfoApiStepTwo'] = "No parágrafo Acesso API , clique em Atualizar "; +$strings['InfoApiStepThree'] = "Na opção 2 (credenciais de solicitação de API para criar o seu próprio nome de usuário e senha API), clique no botão Exibir API Assinatura link , e copiar as credenciais apresentadas à direita no formulário do plugin BuyCourses."; +$strings['ErrorOccurred'] = " Ocorreu um erro Código: %s. Mensagem: %s. Por favor, entre em contato com o Admin da plataforma."; +$strings['VisibleInCatalog'] = "Visível no catálogo"; +$strings['Beneficiaries'] = "Beneficiários"; +$strings['AvailableCourse'] = "Campo disponível"; +$strings['ShowOnCourseCatalog'] = "Mostrar no catálogo de cursos"; +$strings['ByStatus'] = "Por estado"; +$strings['ByUser'] = "Por usuário"; +$strings['ByEmail'] = "Por email"; +$strings['PaymentMethod'] = "Método de pagamento"; +$strings['SWIFT'] = "Código SWIFT"; +$strings['SWIFT_help'] = "Formato padrão de Códigos de Identificação Bancária (BIC) e serve como um identificador exclusivo de um banco ou instituição financeira"; +$strings['ExportReport'] = "Exportar Relatório de Vendas"; +$strings['OrderTime'] = "Hora do pedido"; +$strings['SelectDateRange'] = "Selecione uma data de início e uma data de término para o relatório"; diff --git a/plugin/buycourses/lang/dutch.php b/plugin/buycourses/lang/dutch.php new file mode 100644 index 000000000..d265f6c10 --- /dev/null +++ b/plugin/buycourses/lang/dutch.php @@ -0,0 +1,135 @@ + %s . Deze percentage zal invermindering gebracht worden van de totale prijs van het product. Het verschil in het bedrag zal aan de volgende commissies toegepast worden."; +$strings['CoursesInSessionsDoesntDisplayHere'] = "De cursussen die binnen een training zitten worden niet weergegeven in de lijst van de cursussen als afzonderlijke producten."; +$strings['WantToSellCourses'] = "Wilt u leren en wat geld verdienen met uw eigen cursussen? Deze lijst kan worden gevuld met de verkoop van uw cursussen via dit platform. Neem contact op met ons."; +$strings['SelectOptionToProceed'] = "Selecteer de optie om verder te gaan"; +$strings['VerifyTotalAmountToProceedPayout'] = "Controleer het totale bedrag voor over te gaan tot de betaling van commissies. Dit bedrag heeft geen extra kosten voor PayPal rekening houder. De cursussen verkopen die niet meetellen met een Paypal-account voor de begunstigden niet in aanmerking genomen."; +$strings['TotalAcounts'] = "Totaal van de rekeningen:"; +$strings['TotalPayout'] = "Totaal te betalen:"; +$strings['PayoutDate'] = "Betaaldatum:"; +$strings['CautionThisProcessCantBeCanceled'] = "Let op:Dit proces kan een paar minuten duren en kan niet worden geannuleerd."; +$strings['ProcessingPayoutsDontCloseThisWindow'] = "Verder gaan met betalingen. Dit venster niet sluiten totdat dit proces is afgerond."; +$strings['PayoutSuccess'] = "Betalingen met succes verwerkt"; +$strings['Buyer'] = "Koper"; +$strings['BankTransfer'] = "Bankoverschrijving"; +$strings['SaleInfo'] = "Verkoop Informatie"; +$strings['SaleStatusPending'] = "Verkoop in behandeling"; +$strings['SaleStatusCanceled'] = "Verkoop geannuleerd"; +$strings['SaleStatusCompleted'] = "verkoop afgerond"; +$strings['PayoutStatusPending'] = "Betaling in behandeling"; +$strings['PayoutStatusCanceled'] = "Betaling geannuleerd"; +$strings['PayoutStatusCompleted'] = "Betaling afgerond"; +$strings['PayoutsTotalPending'] = "Onafgehandelde betalingen:"; +$strings['PayoutsTotalCanceled'] = "Geannuleerde betalingen:"; +$strings['PayoutsTotalCompleted'] = "Afgeronde betalingen:"; +$strings['TotalAmount'] = "Totaalbedrag:"; +$strings['CourseListOnSale'] = "Lijst van cursussen in verkoop"; +$strings['AvailableCourses'] = "Beschikbare Cursussen"; +$strings['Price'] = "Prijs"; +$strings['SearchFilter'] = "Zoekmachine"; +$strings['MinimumPrice'] = "Minimuum prijs"; +$strings['MaximumPrice'] = "Maximuumm prijs"; +$strings['AvailableCoursesConfiguration'] = "Beschikbare cursussen overzicht"; +$strings['PaymentsConfiguration'] = "Betalingsoverzicht"; +$strings['TheUserIsAlreadyRegisteredInTheCourse'] = "Je bent geregistreerd voor de cursus."; +$strings['SeeDescription'] = "Omschrijving"; +$strings['Buy'] = "Koop / inschrijven"; +$strings['WaitingToReceiveThePayment'] = "In afwachting van uw betaling"; +$strings['TheUserIsAlreadyRegisteredInTheSession'] = "Je bent geregistreerd voor de sessie"; +$strings['ItemNotSaved'] = "Item niet opgeslagen"; +$strings['TitlePlugin'] = "Alles wat je nodig hebt om online cursussen te onderwijzen en te verkopen"; +$strings['PluginPresentation'] = "The BuyCourses Plugin gives you the means to sell your courses or sessions and teach online, through only a few simple steps and settings. What are you waiting for? Start selling courses through Chamilo LMS!"; +$strings['Instructions'] = "Instructies"; +$strings['InstructionsStepOne'] = "Maak een cursus of een sessie op het platform."; +$strings['InstructionsStepTwo'] = "In de betaling , stelt de valuta waarmee u wilt uw cursussen of sessies te verkopen."; +$strings['InstructionsStepThree'] = "Overzicht van cursussen om te verkopen in de Cursussen en prijzen Instellingen."; +$strings['BuyCourses'] = "Cursussen Kopen"; +$strings['ConfigurationOfCoursesAndPrices'] = "Cursussen en Prijzen overzicht"; +$strings['SalesReport'] = "Verkoopcijfers"; +$strings['UserInformation'] = "Gegevens van de koper"; +$strings['PaymentMethods'] = "Betaal methodes"; +$strings['ConfirmOrder'] = "Bevestig bestelling"; +$strings['PurchaseData'] = "Aankoopgegevens"; +$strings['bc_subject'] = "Bevestiging cursus order"; +$strings['PurchaseStatusX'] = "Aankoop status: %s"; +$strings['PendingReasonByTransfer'] = " In afwachting . In afwachting van de overdracht bevestiging"; +$strings['CancelOrder'] = "Annuleer order"; +$strings['BankAccountInformation'] = "Bankgegevens"; +$strings['BankAccount'] = "Bankrekening"; +$strings['OnceItIsConfirmedYouWillReceiveAnEmailWithTheBankInformationAndAnOrderReference'] = "Eenmaal bevestigd, ontvangt u een e-mail met de bankgegevens en een orderreferentie."; +$strings['SubscriptionToCourseXSuccessful'] = "Uw aankoop op \"%s\" werd met succes afgerond."; +$strings['OrderCanceled'] = "Order geannuleerd"; +$strings['OrderStatus'] = "Bestelstatus"; +$strings['PayoutStatus'] = "Betalingsstatus"; +$strings['SearchByStatus'] = "Zoeken op status"; +$strings['OrderReference'] = "Bestelreferentie"; +$strings['OrderDate'] = "Besteldatum"; +$strings['OrderPrice'] = "Bestel prijs"; +$strings['ProductType'] = "Artikel type"; +$strings['SubscribeUser'] = "Onderteken gebruiker"; +$strings['DeleteOrder'] = "Verwijder bestelling"; +$strings['ErrorContactPlatformAdmin'] = "Onbekende fout. Neem contact op met het platform administrator."; +$strings['PendingReasonByAddress'] = "in afwachting. Je hebt een bevestigde verzendadres niet in te voeren."; +$strings['PendingReasonByAuthorization'] = "in afwachting. We hebben nog geen betalingen."; +$strings['PendingReasonByEcheck'] = "in afwachting. De betaling is verricht door een eCheck die nog niet is vrijgemaakt"; +$strings['PendingReasonByIntl'] = "in afwachting.We hebben geen terugtrekking mechanisme voor betalingen."; +$strings['PendingReasonByMulticurrency'] = "in afwachting. We hebben niet in evenwicht te brengen in de valuta verzonden."; +$strings['PendingReasonByOrder'] = "in afwachting. Bestelling. We hebben nog geen betalingen."; +$strings['PendingReasonByPaymentReview'] = "in afwachting. De betaling wordt beoordeeld door PayPal voor risico."; +$strings['PendingReasonByRegulatoryReview'] = "in afwachting. De betaling wordt beoordeeld voor de naleving van regelgeving van de overheid."; +$strings['PendingReasonByUnilateral'] = "in afwachting. Het e-mailadres is nog niet geregistreerd of bevestigd."; +$strings['PendingReasonByUpgrade'] = "in afwachting. De betaling werd gedaan via credit card."; +$strings['PendingReasonByVerify'] = "in afwachting. Sorry. We zijn nog niet in Paypal geverifieerd."; +$strings['PendingReasonByOther'] = "in afwachting. Neem contact op met het platform admin."; +$strings['PayPalPaymentOKPleaseConfirm'] = "PayPal rapporteert de transactie nu worden gestart. Om te erkennen dat u op OK om verder te gaan, klikt u op de knop bevestiging hieronder. Eenmaal geklikt, wordt u ingeschreven voor de cursus en het geld zal naar onze winkel worden overgedragen van uw PayPal-rekening. U kunt altijd toegang tot uw cursussen via het tabblad 'Mijn cursussen'. Dank u voor uw aankoop"; +$strings['Sandbox'] = "Test omgeving"; +$strings['PayPalAccount'] = "Paypal rekening"; +$strings['NoPayPalAccountDetected'] = "Geen Paypal account gedetecteerd"; +$strings['PayPalConfig'] = "PayPal bevestiging:"; +$strings['TransfersConfig'] = "Bank overschrijving bevestiging:"; +$strings['PluginInstruction'] = "U kunt de optie in- of uitschakelen om te betalen via PayPal of overschrijving instellen in de configuratie sectie van de plugin."; +$strings['ClickHere'] = "Click here voor meer details"; +$strings['CurrencyType'] = "Valuta type"; +$strings['InfoCurrency'] = "Stel in de valuta voor de betaling van uw cursussen."; +$strings['ApiUsername'] = "API Gebruikersnaam"; +$strings['ApiPassword'] = "API Paswoord"; +$strings['ApiSignature'] = "API Handtekening"; +$strings['InfoApiCredentials'] = "To generate your API credentials to integrate Chamilo with your PayPal account, you must follow the following steps"; +$strings['InfoApiStepOne'] = "Ga naar je PayPal-account, Overzicht en verkoper voorkeuren in het Verkoop Tools menu (als je niet dit menu-item hebt, om spullen te verkopen moet u eerst via PayPal om de toestemming te krijgen )."; +$strings['InfoApiStepTwo'] = "In paragraaf API-toegang , klikt u op Bijwerken "; +$strings['InfoApiStepThree'] = "In optie 2 (API Request referenties aan uw eigen API gebruikersnaam en wachtwoord), klikt u op de Bekijk API Handtekening , en kopieer de getoonde rechtsaf de Cursusshop plugin vorm referenties"; +$strings['ErrorOccurred'] = " Er is een fout opgetreden . Code:% s. Bericht:% s. Neem contact op met naar platform admin"; +$strings['VisibleInCatalog'] = "Zichtbaar in catalogus"; +$strings['Beneficiaries'] = "begunstigden"; +$strings['AvailableCourse'] = "beschikbare cursus"; +$strings['ShowOnCourseCatalog'] = "Toon op de cursusoverzicht"; +$strings['ByStatus'] = "Door de status"; +$strings['ByUser'] = "Door de gebruiker"; +$strings['PaymentMethod'] = "Betaal methodes"; +$strings['SWIFT'] = "SWIFT code"; +$strings['SWIFT_help'] = "Standaardformaat van Bank Identifier Codes (BIC) en dient als een unieke identificatiecode voor een bank of financiële instelling"; diff --git a/plugin/buycourses/lang/english.php b/plugin/buycourses/lang/english.php new file mode 100644 index 000000000..deb6f0ae3 --- /dev/null +++ b/plugin/buycourses/lang/english.php @@ -0,0 +1,321 @@ + %s . This percentage will be discounted from the total product price. The difference will be the amount to apply the following commissions."; +$strings['CoursesInSessionsDoesntDisplayHere'] = "The courses which are inside a training session don't appear in the list of courses to configure as individual products."; +$strings['WantToSellCourses'] = "Do you want to teach and earn some money with your own courses? This list could be filled with your earnings selling courses through this platform. Get in touch with us."; +$strings['SelectOptionToProceed'] = "Select option to proceed"; +$strings['VerifyTotalAmountToProceedPayout'] = "Please check the total amount to proceed with the payment of commissions. This amount doesn't take extra costs for PayPal into account. The courses sales that do not count with a Paypal account for the beneficiaries will not be considered."; +$strings['TotalAcounts'] = "Total of accounts:"; +$strings['TotalPayout'] = "Total to be paid:"; +$strings['PayoutDate'] = "Payment date:"; +$strings['CautionThisProcessCantBeCanceled'] = "Caution: this process can take a few minutes and cannot be cancelled."; +$strings['ProcessingPayoutsDontCloseThisWindow'] = "Proceeding with payments. Don't close this window until this process is finalized."; +$strings['PayoutSuccess'] = "Payments processed successfully"; +$strings['Buyer'] = "Buyer"; +$strings['BankTransfer'] = "Bank transfer"; +$strings['SaleInfo'] = "Sale information"; +$strings['SaleStatusPending'] = "Sale pending"; +$strings['SaleStatusCanceled'] = "Sale canceled"; +$strings['SaleStatusCompleted'] = "Sale completed"; +$strings['PayoutStatusPending'] = "Payment pending"; +$strings['PayoutStatusCanceled'] = "Payment cancelled"; +$strings['PayoutStatusCompleted'] = "Payment completed"; +$strings['PayoutsTotalPending'] = "Pending payments:"; +$strings['PayoutsTotalCanceled'] = "Cancelled payments:"; +$strings['PayoutsTotalCompleted'] = "Completed payments:"; +$strings['Total'] = "Total"; +$strings['TotalAmount'] = "Total amount:"; +$strings['CourseListOnSale'] = "List of courses on sale"; +$strings['AvailableCourses'] = "Available Courses"; +$strings['Price'] = "Price"; +$strings['SearchFilter'] = "Search filter"; +$strings['MinimumPrice'] = "Minimum price"; +$strings['MaximumPrice'] = "Maximum price"; +$strings['AvailableCoursesConfiguration'] = "Available courses configuration"; +$strings['PaymentsConfiguration'] = "Payments configuration"; +$strings['TheUserIsAlreadyRegisteredInTheCourse'] = "You are already registered in the course."; +$strings['SeeDescription'] = "Description"; +$strings['Buy'] = "Buy"; +$strings['WaitingToReceiveThePayment'] = "Currently pending payment"; +$strings['TheUserIsAlreadyRegisteredInTheSession'] = "You are already registered in the session"; +$strings['ItemNotSaved'] = "Item not saved"; +$strings['TitlePlugin'] = "Everything you need to teach and sell courses online"; +$strings['PluginPresentation'] = "The BuyCourses Plugin gives you the means to sell your courses or sessions and teach online, through only a few simple steps and settings. What are you waiting for? Start selling courses through Chamilo LMS!"; +$strings['Instructions'] = "Instructions"; +$strings['InstructionsStepOne'] = "Create a course or session on the platform."; +$strings['InstructionsStepTwo'] = "In the payment settings, set the currency with which you would like to sell your courses or sessions."; +$strings['InstructionsStepThree'] = "Configure courses to sell in the Courses and prices settings."; +$strings['BuyCourses'] = "Buy courses"; +$strings['ConfigurationOfCoursesAndPrices'] = "Courses and prices configuration"; +$strings['SalesReport'] = "Sales report"; +$strings['UserInformation'] = "Buyer's details"; +$strings['PaymentMethods'] = "Payment methods"; +$strings['ConfirmOrder'] = "Confirm order"; +$strings['PurchaseData'] = "Purchase data"; +$strings['bc_subject'] = "Confirmation of course order"; +$strings['PurchaseStatusX'] = "Purchase status: %s"; +$strings['PendingReasonByTransfer'] = "Pending. Awaiting for transfer confirmation"; +$strings['CancelOrder'] = "Cancel order"; +$strings['BankAccountInformation'] = "Bank account details"; +$strings['BankAccount'] = "Bank account"; +$strings['OnceItIsConfirmedYouWillReceiveAnEmailWithTheBankInformationAndAnOrderReference'] = "Once confirmed, you will receive an e-mail with the bank details and an order reference."; +$strings['SubscriptionToCourseXSuccessful'] = "Completed process. Your subscription to \"%s\" was completed successfully."; +$strings['OrderCanceled'] = "Order canceled"; +$strings['OrderStatus'] = "Order status"; +$strings['PayoutStatus'] = "Payment status"; +$strings['SearchByStatus'] = "Search by status"; +$strings['OrderReference'] = "Order reference"; +$strings['OrderDate'] = "Order date"; +$strings['OrderPrice'] = "Order price"; +$strings['ProductType'] = "Product type"; +$strings['SubscribeUser'] = "Subscribe user"; +$strings['DeleteOrder'] = "Delete order"; +$strings['ErrorContactPlatformAdmin'] = "Unknown error. Please contact the platform administrator."; +$strings['PendingReasonByAddress'] = "Pending. You did not enter a confirmed shipping address."; +$strings['PendingReasonByAuthorization'] = "Pending. We have not yet captured funds."; +$strings['PendingReasonByEcheck'] = "Pending. The payment was made by an eCheck that has not yet cleared"; +$strings['PendingReasonByIntl'] = "Pending. We have no a withdrawal mechanism for funds."; +$strings['PendingReasonByMulticurrency'] = "Pending. We have not balance in the currency sent."; +$strings['PendingReasonByOrder'] = "Pending. Order made. We have not yet captured funds."; +$strings['PendingReasonByPaymentReview'] = "Pending. The payment is being reviewed by PayPal for risk."; +$strings['PendingReasonByRegulatoryReview'] = "Pending. The payment is being reviewed for compliance with government regulations."; +$strings['PendingReasonByUnilateral'] = "Pending. The email address is not yet registered o confirmed."; +$strings['PendingReasonByUpgrade'] = "Pending. The payment was made via credit card."; +$strings['PendingReasonByVerify'] = "Pending. Sorry. We are not yet verified in PayPal."; +$strings['PendingReasonByOther'] = "Pending. Please contact with the platform admin."; +$strings['PayPalPaymentOKPleaseConfirm'] = "PayPal reports the transaction is ready to be executed. To acknowledge that you are OK to proceed, please click the confirmation button below. Once clicked, you will be registered to the course and the funds will be transferred from your PayPal account to our shop. You can always access your courses through the 'My courses' tab. Thank you for your custom!"; +$strings['Sandbox'] = "Test environment"; +$strings['PayPalAccount'] = "Paypal account"; +$strings['NoPayPalAccountDetected'] = "No Paypal account detected"; +$strings['PayPalConfig'] = "PayPal configuration:"; +$strings['TransfersConfig'] = "Bank transfers configuration:"; +$strings['PluginInstruction'] = "You can enable or disable the option to pay via PayPal, Culqi or bank transfer settings in the configuration section of the plugin."; +$strings['ClickHere'] = "Click here for more details"; +$strings['CurrencyType'] = "Currency type"; +$strings['InfoCurrency'] = "Sets the currency for the payment of your courses."; +$strings['ApiUsername'] = "API Username"; +$strings['ApiPassword'] = "API Password"; +$strings['ApiSignature'] = "API Signature"; +$strings['InfoApiCredentials'] = "To generate your API credentials to integrate Chamilo with your PayPal account, you must follow the following steps"; +$strings['InfoApiStepOne'] = "Go to your PayPal account, Summary, then Seller preferences in the Selling Tools menu (if you do not have this menu entry, you might need to get the authorization to sell stuff through PayPal first)."; +$strings['InfoApiStepTwo'] = "In paragraph API access, click Update"; +$strings['InfoApiStepThree'] = "In Option 2 (Request API credentials to create your own API username and password), click the View API Signature link, and copy the credentials shown right into the BuyCourses plugin form"; +$strings['ErrorOccurred'] = "An error ocurred. Code: %s. Message: %s. Please contact to platform admin"; +$strings['VisibleInCatalog'] = "Visible in catalog"; +$strings['Beneficiaries'] = "Beneficiaries"; +$strings['AvailableCourse'] = "Available course"; +$strings['ShowOnCourseCatalog'] = "Show on course catalog"; +$strings['ByStatus'] = "By status"; +$strings['ByUser'] = "By user"; +$strings['ByEmail'] = "By email"; +$strings['PaymentMethod'] = "Payment method"; +$strings['SWIFT'] = "SWIFT code"; +$strings['SWIFT_help'] = "Standard format of Bank Identifier Codes (BIC) and serves as a unique identifier for a bank or financial institution"; +$strings['PleaseSelectThePaymentMethodBeforeConfirmYourOrder'] = "Please select your favorite payment method before confirming your order"; +$strings['NoPaymentOptionAvailable'] = 'No payment option available. Please report to the administrator.'; +$strings['XIsOnlyPaymentMethodAvailable'] = '%s is the only payment method available for this purchase.'; +$strings['hide_free_text'] = "Hide 'Free' text"; +$strings['culqi_enable'] = "Enable culqi"; +$strings['include_services'] = "Include services"; +$strings['CurrencyIsNotConfigured'] = "Please, configure a currency before continuing."; +$strings['Services'] = "Services"; +$strings['Service'] = "Service"; +$strings['NewService'] = "New service"; +$strings['ServiceName'] = "Service name"; +$strings['AppliesTo'] = "Applies to"; +$strings['ServiceInformation'] = "Service information"; +$strings['ListOfServicesOnSale'] = "List of services on sale"; +$strings['GlobalConfig'] = "Global configuration"; +$strings['WriteHereTheTermsAndConditionsOfYourECommerce'] = "Write here the terms and conditions of your e-commerce"; +$strings['EditService'] = "Edit service"; +$strings['DeleteThisService'] = "Delete this service"; +$strings['IConfirmIReadAndAcceptTermsAndCondition'] = "I confirm I read and accept the terms and conditions"; +$strings['PleaseSelectTheCorrectInfoToApplyTheService'] = "Please select the correct info to apply the service"; +$strings['SaleStatusCancelled'] = "Sale cancelled"; +$strings['ServiceSaleInfo'] = "Service sale info"; +$strings['ServiceId'] = "Service Id"; +$strings['BoughtBy'] = "Bought by"; +$strings['PurchaserUser'] = "Purchaser user"; +$strings['Pending'] = "Pending"; +$strings['Names'] = "Names"; +$strings['SellerName'] = "Seller name"; +$strings['SellerId'] = "Seller id"; +$strings['SellerAddress'] = "Seller address"; +$strings['SellerEmail'] = "Seller e-mail"; +$strings['NextNumberInvoice'] = "Next invoice number"; +$strings['NextNumberInvoiceDescription'] = "Number of the following invoice"; +$strings['InvoiceSeries'] = "Invoice series"; +$strings['InvoiceSeriesDescription'] = "Optional parameter: Example invoice Id <series><year>/<number>"; +$strings['InvoiceView'] = "View invoice"; +$strings['NoInvoiceEnable'] = "No invoicing block enable"; +$strings['Company'] = "Company"; +$strings['VAT'] = "VAT"; +$strings['Address'] = "Address"; +$strings['InvoiceNumber'] = "Invoice number"; +$strings['InvoiceDate'] = "Invoice date"; +$strings['Invoice'] = "Invoice"; +$strings['SaleEmail'] = "Sales e-mail"; +$strings['PurchaseDetailsIntro'] = "Purchase details"; +$strings['PurchaseDetailsEnd'] = "Regards"; +$strings['ProductName'] = "Product name"; +$strings['BankAccountIntro'] = "Bank Account Info"; +$strings['AdditionalInfoRequired'] = 'More information needed'; +$strings['SubscriptionToServiceXSuccessful'] = "Subscription to service %s completed."; +$strings['ClickHereToFinish'] = "Click here to finish"; +$strings['OrderCancelled'] = "Order cancelled"; +$strings['use_currency_symbol'] = "Use currency symbol"; +$strings['ExportReport'] = "Export Sales Report"; +$strings['OrderTime'] = "Order time"; +$strings['SelectDateRange'] = "Select a start date and end date for the report"; +$strings['ServiceAdded'] = "Service added"; +$strings['ServiceEdited'] = "Service updated"; +$strings['ListOfServicesOnSale'] = "List of services for sale"; +$strings['AdditionalInfo'] = "Additional information"; +$strings['culqi_enable'] = "Enable Culqi"; +$strings['CulqiConfig'] = "Culqi configuration:"; +$strings['InfoCulqiCredentials'] = "To obtain your credentials, you will need to create an account on Culqi and enter the development mode, copy the merchant code in your dashboard, then enter the API Keys section and copy the corresponding key to paste it here."; +$strings['CommerceCode'] = "Merchant code"; +$strings['NoTermsAndConditionsProvided'] = "No defined terms and conditions"; +$strings['GlobalConfig'] = "Global configuration:"; +$strings['MyServices'] = "My services"; +$strings['SalePrice'] = "Sale price"; +$strings['YouNeedToBeRegisteredInAtLeastOneCourse'] = "You need to be registered in at least one course"; +$strings['YouNeedToBeRegisteredInAtLeastOneSession'] = "You need to be registered in at least one session"; +$strings['IfYouWantToGetTheCertificateAndOrSkillsAsociatedToThisCourseYouNeedToBuyTheCertificateServiceYouCanGoToServiceCatalogClickingHere'] = "To obtain the certificate and/or the skills associated to this course, you need to buy the Certificate service. Go to the services catalogue to buy it by clicking here"; +$strings['ServiceDeleted'] = 'Service deleted'; +$strings['YourCoursesNeedAtLeastOneLearningPath'] = 'The courses to which you are subscribed need at least one learning path that contains a final certificate item'; +$strings['GlobalTaxPerc'] = "Global tax rate"; +$strings['GlobalTaxPercDescription'] = "Default tax rate that will be used unless there is a specific tax rate for the course, session or service."; +$strings['TaxPerc'] = "Tax rate"; +$strings['TaxPercDescription'] = "If left blank, the global tax rate will be used."; +$strings['ByDefault'] = "by default (global value)"; +$strings['OnlyCourses'] = "Only courses"; +$strings['OnlySessions'] = "Only sessions"; +$strings['OnlyServices'] = "Only services"; +$strings['TaxAppliesTo'] = "Tax applied to"; +$strings['AllCoursesSessionsAndServices'] = "All (courses, sessions and services)"; +$strings['TaxNameCustom'] = "Tax name"; +$strings['TaxNameExamples'] = "VAT, IVA, IGV, TVA, IV ..."; +$strings['ErrorUpdateFieldDB'] = "Error updating the database fields"; +$strings['tpv_redsys_enable'] = "Enable RedSys POS"; +$strings['tpv_redsys_enable_help'] = "In order to use the RedSys POS payment method, it is necessary to download the \"REST INTEGRATION - PHP API \" files at the following link web de RedSys and locate the file apiRedSys.php in the plugin/buycourses/resources directory."; +$strings['NotFindRedsysFile'] = "The apiRedsys.php file cannot be found in plugin/buycourses/resources directory"; +$strings['TpvPayment'] = "POS payment"; +$strings['TpvRedsysConfig'] = "Redsys POS configuration"; +$strings['DS_MERCHANT_MERCHANTCODE'] = "Trade number (FUC)"; +$strings['DS_MERCHANT_TERMINAL'] = "Terminal number"; +$strings['DS_MERCHANT_CURRENCY'] = "Terminal currency"; +$strings['kc'] = "Secret encryption key"; +$strings['url_redsys'] = "Redsys connection URL"; +$strings['url_redsys_sandbox'] = "Redsys connection URL (Sandbox)"; +$strings['InfoTpvRedsysApiCredentials'] = "You must complete the following form fields with the information provided by the Redsys POS Technical Support:"; +$strings['InfoEmailExtra'] = "Extra info in payment e-mail"; +$strings['Coupon'] = "Coupon"; +$strings['DiscountAmount'] = "Discount amount"; +$strings['RedeemCoupon'] = "Redeem"; +$strings['NeedToAddCouponCode'] = "A coupon code has not been entered"; +$strings['CouponNotValid'] = "This coupon is not valid"; +$strings['CouponRedeemed'] = "Coupon redeemed"; +$strings['CouponDiscount'] = "Discount"; +$strings['CouponStatus'] = "Coupon status"; +$strings['CouponPercentage'] = "Percentage"; +$strings['CouponAmount'] = "Amount"; +$strings['CouponList'] = "Coupon list"; +$strings['CouponCode'] = "Coupon code"; +$strings['CouponDiscountType'] = "Discount type"; +$strings['CouponDateStart'] = "Valid from"; +$strings['CouponDateEnd'] = "Expires on"; +$strings['CouponDelivered'] = "Delivered"; +$strings['CouponDisable'] = "Disable"; +$strings['CouponEnable'] = "Enable"; +$strings['CouponCodeUsed'] = "Coupon code already used"; +$strings['CouponNoExists'] = "Coupon no exists"; +$strings['CouponErrorInsert'] = "Error inserting new coupon"; +$strings['CouponActive'] = "Active"; +$strings['CouponDisabled'] = "Disabled"; +$strings['CouponUpdate'] = "Coupon updated"; +$strings['CouponsConfiguration'] = "Coupons configuration"; +$strings['CouponAdd'] = "New coupon"; +$strings['ConfigureCoupon'] = "Configure coupon"; +$strings['DiscountCoupon'] = "Discount coupons"; +$strings['CouponsCode'] = "Code"; +$strings['DoYouHaveACoupon'] = "Do you have a coupon?"; +$strings['stripe_enable'] = "Enable Stripe"; +$strings['StripeConfig'] = "Stripe configuration:"; +$strings['InfoStripeCredentials'] = "To obtain the credentials you must first create an account in Stripe, copy the account id from your profile, go to the API Keys configuration section and copy the secret key, finally you must go to the Developers button (top right), register a new Endpoint in the Webhooks section, pointing to https://{site}/plugin/buycourses/src/stripe_response.php for the checkout.session.completed event type and copy the secret of the Endpoint."; +$strings['StripeAccountId'] = "Account id:"; +$strings['StripeSecret'] = "Secret key:"; +$strings['StripeEndpointSecret'] = "Endpoint secret:"; +$strings['PendingReasonByStripe'] = "Pending. Awaiting for payment confirmation ..."; +$strings['cecabank_enable'] = "Enable Cecabank POS"; +$strings['TpvCecabank'] = "POS payment (Cecabank)"; +$strings['CecaSecret'] = "Secret"; +$strings['CecaUrl'] = "Url"; +$strings['CecaMerchanId'] = "Merchant"; +$strings['CecaAcquirerId'] = "Adquirer"; +$strings['CecaTerminalId'] = "Terminal"; +$strings['CecaCypher'] = "Cypher"; +$strings['CecaCurrency'] = "Currency"; +$strings['CecaExponent'] = "Exponent"; +$strings['CecaSupportedPayment'] = "Payment supported"; +$strings['CecabankConfig'] = "Cecabank configuration"; +$strings['Country'] = "Country"; +$strings['PaymentType'] = "Payment type"; +$strings['CountryRelPaymentConfig'] = "Payment type configuration for the country"; +$strings['CountryRelPaymentMessage'] = "To process an order, the type of payment per country must be defined, otherwise the order will not be allowed to go through."; +$strings['CountryEmpty'] = "To process an order, you need to define the Country field in the user profile."; +$strings['Duration'] = "Duration"; +$strings['SubscriptionAdd'] = "Add subscription"; +$strings['SubscriptionList'] = "Subscription list"; +$strings['SubscriptionListOnSale'] = "Subscriptions on sale"; +$strings['SelectSubscription'] = "Select duration"; +$strings['SubscriptionNotValid'] = "Subscription not valid"; +$strings['SubscriptionSalesReport'] = "Sales report"; +$strings['BuySubscriptions'] = "Buy subscriptions"; +$strings['ConfigurationOfSubscriptionsAndPrices'] = "Subscriptions and prices configuration"; +$strings['FrequencyConfig'] = "Duration config"; +$strings['Subscriptions'] = "Subscriptions"; +$strings['HasSubscriptions'] = "Has subscriptions"; +$strings['FrequencyRemoved'] = "Period removed"; +$strings['SubscriptionPeriodOnUse'] = "Subscription period in use"; +$strings['FrequencyNotExits'] = "Period does not exist"; +$strings['FrequencyIncorrect'] = "Period incorrect"; +$strings['SubscriptionFrequencyValueDays'] = "Value on days"; +$strings['FrequencyNotUpdated'] = "Period not updated"; +$strings['FrequencyNotSaved'] = "Period not saved"; +$strings['NeedToAddDuration'] = "Need to add duration"; +$strings['SubscriptionNotValid'] = "Subscription not valid"; +$strings['SelecSubscription'] = "Select a subscription"; +$strings['ConfigureSubscriptionsFrequencies'] = "Configure subscriptions periods"; +$strings['FrequencyAdd'] = "Add periods"; +$strings['SubscriptionAlreadyExists'] = "Subscription already exists"; +$strings['SubscriptionPeriodDuration'] = "Subscription duration (in days)"; +$strings['Product'] = "Product name"; +$strings['YouProductIsActivatedYouCanNowAccessIt'] = "Your product is now activated and you can now have access to it."; +$strings['hide_shopping_cart_from_course_catalogue'] = "Hide shopping cart from the course catalogue and leave the subscribe button"; diff --git a/plugin/buycourses/lang/french.php b/plugin/buycourses/lang/french.php new file mode 100644 index 000000000..a8eebb865 --- /dev/null +++ b/plugin/buycourses/lang/french.php @@ -0,0 +1,250 @@ + %s . Ce pourcentage sera soustrait du prix total du produit. La différence sera répartie selon les commissions définies ci-dessous."; +$strings['CoursesInSessionsDoesntDisplayHere'] = "Les cours qui se trouvent dans une session n'apparaissent pas dans la liste de cours individuels."; +$strings['WantToSellCourses'] = "Envie d'enseigner et de gagner un peu d'argent avec vos propres cours? Cette liste pourraît être pleine de ventes de vos cours. Contactez-nous."; +$strings['SelectOptionToProceed'] = "Sélectionnez une option pour continuer"; +$strings['VerifyTotalAmountToProceedPayout'] = "Veuillez vérifier le montant total avant de continuer le paiement des commissions. Ce montant ne prend pas en compte le coût additionnel éventuellement perçu par PayPal. Les ventes de cours pour lesquelles les bénéficiaires n'ont pas de compte PayPal configuré ne seront pas prises en compte."; +$strings['TotalAcounts'] = "Total des comptes:"; +$strings['TotalPayout'] = "Total à payer:"; +$strings['PayoutDate'] = "Date de paiement:"; +$strings['CautionThisProcessCantBeCanceled'] = "Attention: ce processus peut prendre quelques minutes et ne peut pas être interrompu."; +$strings['ProcessingPayoutsDontCloseThisWindow'] = "Exécution des paiements. Ne fermez pas cette fenêtre avant que le processus ne soit finalisé."; +$strings['PayoutSuccess'] = "Paiements effectués avec succès"; +$strings['Buyer'] = "Acheteur"; +$strings['BankTransfer'] = "Transfert bancaire"; +$strings['SaleInfo'] = "Information vente"; +$strings['SaleStatusPending'] = "Vente non confirmée"; +$strings['SaleStatusCanceled'] = "Vente annulée"; +$strings['SaleStatusCompleted'] = "Vente finalisée"; +$strings['PayoutStatusPending'] = "Paiement en attente"; +$strings['PayoutStatusCanceled'] = "Paiement annulé"; +$strings['PayoutStatusCompleted'] = "Paiement complété"; +$strings['PayoutsTotalPending'] = "Paiements en attente:"; +$strings['PayoutsTotalCanceled'] = "Paiements annulés:"; +$strings['PayoutsTotalCompleted'] = "Paiements complétés:"; +$strings['TotalAmount'] = "Montant total:"; +$strings['CourseListOnSale'] = "Liste de cours en vente"; +$strings['AvailableCourses'] = "Cours disponibles"; +$strings['Price'] = "Prix"; +$strings['SearchFilter'] = "Filtre de recherche"; +$strings['MinimumPrice'] = "Prix minimum"; +$strings['MaximumPrice'] = "Prix maximum"; +$strings['AvailableCoursesConfiguration'] = "Configuration des cours disponibles"; +$strings['PaymentsConfiguration'] = "Configuration des paiements"; +$strings['TheUserIsAlreadyRegisteredInTheCourse'] = "L'utilisateur est déjà inscrit au cours"; +$strings['SeeDescription'] = "Voir description"; +$strings['Buy'] = "Acheter"; +$strings['WaitingToReceiveThePayment'] = "En attente de réception du paiement"; +$strings['TheUserIsAlreadyRegisteredInTheSession'] = "Vous êtes déjà inscrit à cette session"; +$strings['ItemNotSaved'] = "Article non sauvé"; +$strings['TitlePlugin'] = "Tout le nécessaire pour enseigner et vendre des cours en ligne"; +$strings['PluginPresentation'] = "Le plugin BuyCourses vous donne les moyens nécessaires pour vendre vos cours ou vos sessions existants et d'enseigner en ligne, en quelques étapes très simples. Qu'attendez-vous? Commencez à vendre des cours grâce à Chamilo dès maintenant!"; +$strings['Instructions'] = "Instructions d'utilisation"; +$strings['InstructionsStepOne'] = "Créer un cours ou une session de formation sur la plateforme."; +$strings['InstructionsStepTwo'] = "Dans la section configuration de paiements, configurer le type de devise dans lequel vous souhaitez vendre vos cours et sessions"; +$strings['InstructionsStepThree'] = "Configurer les cours à vendre dans la section Configuration de cours et prix"; +$strings['BuyCourses'] = "Acheter des cours"; +$strings['ConfigurationOfCoursesAndPrices'] = "Configuration des cours et prix"; +$strings['SalesReport'] = "Rapport des ventes"; +$strings['UserInformation'] = "Fiche acheteur"; +$strings['PaymentMethods'] = "Méthodes de paiement"; +$strings['ConfirmOrder'] = "Confirmer commande"; +$strings['PurchaseData'] = "Détails d'achat"; +$strings['bc_subject'] = "Confirmation de commande de cours"; +$strings['PurchaseStatusX'] = "État de la vente: %s"; +$strings['PendingReasonByTransfer'] = "En attente. Transfert pas encore confirmé"; +$strings['CancelOrder'] = "Annuler la commande"; +$strings['BankAccountInformation'] = "Détails du compte bancaire"; +$strings['BankAccount'] = "Compte bancaire"; +$strings['OnceItIsConfirmedYouWillReceiveAnEmailWithTheBankInformationAndAnOrderReference'] = "Une fois confirmée, vous recevrez un e-mail avec les données bancaires et la référence de la commande"; +$strings['SubscriptionToCourseXSuccessful'] = "Votre inscription au \"%s\" est terminée."; +$strings['OrderCanceled'] = "Commande annulée"; +$strings['OrderStatus'] = "Statut de commande"; +$strings['PayoutStatus'] = "État du paiement"; +$strings['SearchByStatus'] = "Recherche par statut"; +$strings['OrderReference'] = "Référence de la commande"; +$strings['OrderDate'] = "Date de commande"; +$strings['OrderPrice'] = "Commande Prix"; +$strings['ProductType'] = "Type de produit"; +$strings['SubscribeUser'] = "Inscrire utilisateur"; +$strings['DeleteOrder'] = "Éliminer la commande"; +$strings['ErrorContactPlatformAdmin'] = "Une erreur inconnue s'est produite. Veuillez contacter l'administrateur de la plateforme."; +$strings['PendingReasonByAddress'] = "En attente. Il manque une adresse de livraison."; +$strings['PendingReasonByAuthorization'] = "En attente. Nous n'avons pas confirmé la réception des fonds."; +$strings['PendingReasonByEcheck'] = "En attente. Le paiement a été fait via un chèque qui n'a pas encore été libéré"; +$strings['PendingReasonByIntl'] = "En attente. Aucun moyen de toucher les fonds."; +$strings['PendingReasonByMulticurrency'] = "En attente. Nous n'avons pas de compte dans la devise indiquée."; +$strings['PendingReasonByOrder'] = "En attente. Commande enregistrée. Les fonds n'ont pas encore été libérés."; +$strings['PendingReasonByPaymentReview'] = "En attente. Le paiement est en révision anti-fraude chez PayPal."; +$strings['PendingReasonByRegulatoryReview'] = "En attente. Le paiement est actuellement revu pour correspondre aux règles mises en vigueur par le gouvernement."; +$strings['PendingReasonByUnilateral'] = "En attente. L'adresse e-mail n'est pas encore confirmée ou enregistrée."; +$strings['PendingReasonByUpgrade'] = "En attente. Le paiement a été fait par carte de crédit."; +$strings['PendingReasonByVerify'] = "En attente. Désolé, nous n'avons pas encore vérifié sur PayPal."; +$strings['PendingReasonByOther'] = "En attente. Veuillez contacter l'administrateur."; +$strings['PayPalPaymentOKPleaseConfirm'] = "PayPal nous indique que la transaction est prête à être exécutée. Par mesure de sécurité, nous vous demandons de bien vouloir confirmer une dernière fois la transaction en cliquant sur le bouton de confirmation ci-dessous. Une fois cliqué, vous serez immédiatement enregistré au cours, et les fonds correspondants seront soustraits de votre compte PayPal. Vous pouvez accéder à vos cours à tout moment à partir de l'onglet 'Mes cours'. Merci de votre fidélité!"; +$strings['Sandbox'] = "Environnement de test"; +$strings['PayPalAccount'] = "Compte Paypal"; +$strings['NoPayPalAccountDetected'] = "Pas de compte paypal détecté"; +$strings['PayPalConfig'] = "Configuration PayPal:"; +$strings['TransfersConfig'] = "Configuration des transfers bancaires:"; +$strings['PluginInstruction'] = "Vous pouvez activer ou désactiver l'option de paiements via PayPal, Culqi ou de transferts bancaires dans la section de configuration des plugins."; +$strings['ClickHere'] = "Cliquez ici pour plus d'infos"; +$strings['CurrencyType'] = "Type de devise"; +$strings['InfoCurrency'] = "Permet de configurer la devise pour l'achat des cours."; +$strings['ApiUsername'] = "Nom d'utilisateur de l'API"; +$strings['ApiPassword'] = "Mot de passe de l'API"; +$strings['ApiSignature'] = "Signature de l'API"; +$strings['InfoApiCredentials'] = "Pour générer vos données API pour intégrer votre compte PayPal à Chamilo, il vous faudra suivre les étapes suivantes"; +$strings['InfoApiStepOne'] = "Aller dans l'option profil de PayPal, et ensuite dans Outils de vente"; +$strings['InfoApiStepTwo'] = "Dans la section API d'accès, cliquer sur l'option Mettre à jour"; +$strings['InfoApiStepThree'] = "Dans l'option 2 de Configuration des données et permissions API, cliquer sur Voir signature API. Copier ces donées dans le formulaire de configuration de ce plugin"; +$strings['ErrorOccurred'] = "Une erreur est survenue. Code: %s. Message: %s. Veuillez contacter l'administrateur de la plateforme"; +$strings['VisibleInCatalog'] = "Visible dans le catalogue"; +$strings['Beneficiaries'] = "Bénéficiaires"; +$strings['AvailableCourse'] = "Cours disponibles"; +$strings['ShowOnCourseCatalog'] = "Afficher dans le catalogue de cours"; +$strings['ByStatus'] = "Par statut"; +$strings['ByUser'] = "Par utilisateur"; +$strings['ByEmail'] = "Par email"; +$strings['PaymentMethod'] = "Méthodes de paiement"; +$strings['SWIFT'] = "Code SWIFT"; +$strings['SWIFT_help'] = "Format standard des codes d'identification de banque (BIC) et sert un identifiant unique pour une banque ou une institution financière."; +$strings['PleaseSelectThePaymentMethodBeforeConfirmYourOrder'] = 'Veuillez sélectionner votre méthode de paiement préférée avant de confirmer'; +$strings['NoPaymentOptionAvailable'] = 'Aucune méthode de paiement disponible. Merci de bien vouloir rapporter ce problème à l\'administrateur.'; +$strings['XIsOnlyPaymentMethodAvailable'] = '%s est la seule méthode de paiement disponible pour cet achat.'; +$strings['public_main_menu_tab'] = "Montrer l'onglet dans le menu principal aux utilisateurs anonyme également"; +$strings['culqi_enable'] = "Activé culqi"; +$strings['include_services'] = "Inclure les services"; +$strings['hide_free_text'] = "Cacher le texte 'Free' ou 'Gratuit'"; +$strings['Services'] = "Services"; +$strings['ServiceName'] = "Nom du service"; +$strings['AppliesTo'] = "S'applique à"; +$strings['ListOfServicesOnSale'] = "Liste de services en vente"; +$strings['GlobalConfig'] = "Configuration globale"; +$strings['WriteHereTheTermsAndConditionsOfYourECommerce'] = "Écrire les conditions de ventes de votre e-commerce"; +$strings['NewService'] = "Nouveau service"; +$strings['Service'] = "Service"; +$strings['ServiceInformation'] = "Information sur le service"; +$strings['EditService'] = "Edition du service"; +$strings['DeleteThisService'] = "Supprimer ce service"; +$strings['IConfirmIReadAndAcceptTermsAndCondition'] = "Je confirme que j'ai lu et que j'accepte les termes et conditions"; +$strings['PleaseSelectTheCorrectInfoToApplyTheService'] = "Veuillez choisir l'information à appliquer au service"; +$strings['SaleStatusCancelled'] = "Vente annulée"; +$strings['ServiceSaleInfo'] = "Information de vente"; +$strings['ServiceId'] = "Id du service"; +$strings['BoughtBy'] = "Acheté par"; +$strings['PurchaserUser'] = "Utilisateur acheteur"; +$strings['Pending'] = "En attente"; +$strings['Names'] = "Nom"; +$strings['ExportReport'] = "Export du rapport des ventes"; +$strings['OrderTime'] = "Heure de commande"; +$strings['SelectDateRange'] = "Sélectionnez une date de début et une date de fin pour le rapport"; +$strings['InfoEmailExtra'] = "Informations additionnelles dans l'e-mail de paiement"; +$strings['Coupon'] = "Coupon"; +$strings['DiscountAmount'] = "Ristourne totale"; +$strings['RedeemCoupon'] = "Échanger"; +$strings['NeedToAddCouponCode'] = "Aucun code de coupon n'a été introduit"; +$strings['CouponNotValid'] = "Ce coupon n'est pas valable"; +$strings['CouponRedeemed'] = "Coupon échangé"; +$strings['CouponDiscount'] = "Ristourne"; +$strings['CouponStatus'] = "Statut du coupon"; +$strings['CouponPercentage'] = "Pourcentage"; +$strings['CouponAmount'] = "Montant"; +$strings['CouponList'] = "Liste des coupons"; +$strings['CouponCode'] = "Code du coupon"; +$strings['CouponDiscountType'] = "Type de ristourne"; +$strings['CouponDateStart'] = "Valable apd"; +$strings['CouponDateEnd'] = "Expire le"; +$strings['CouponDelivered'] = "Livré"; +$strings['CouponDisable'] = "Désactivé"; +$strings['CouponEnable'] = "Activé"; +$strings['CouponCodeUsed'] = "Code de coupon déjà utilisé"; +$strings['CouponNoExists'] = "Ce coupon n'existe pas"; +$strings['CouponErrorInsert'] = "Erreur lors de l'insertion du coupon"; +$strings['CouponActive'] = "Actif"; +$strings['CouponDisabled'] = "Désactivé"; +$strings['CouponUpdate'] = "Coupon mis à jour"; +$strings['CouponsConfiguration'] = "Configuration coupons"; +$strings['CouponAdd'] = "Nouveau coupon"; +$strings['ConfigureCoupon'] = "Configurer le coupon"; +$strings['DiscountCoupon'] = "Coupons de ristourne"; +$strings['CouponsCode'] = "Code"; +$strings['DoYouHaveACoupon'] = "Vous avez un coupon?"; +$strings['stripe_enable'] = "Activer Stripe"; +$strings['StripeConfig'] = "Configuration de Stripe:"; +$strings['InfoStripeCredentials'] = "Pour obtenir les données de connexion, vous devez d'abord réer un compte Stripe (ce qui prend un certain temps), puis copier l'ID du compte depuis votre profil et le renseigner ici. Puis aller dans la configuration des clefs API et copier la clef secrète. Enfin, suivre le bouton 'Développeurs' (haut droite), enregistrer un nouveau Endpoint dans la section Webhooks, le pointer vers l'URL https://{site}/plugin/buycourses/src/stripe_response.php et l'associer à l'événement checkout.session.completed et copier le secret du Endpoint ici."; +$strings['StripeAccountId'] = "ID du compte:"; +$strings['StripeSecret'] = "Clef secrète:"; +$strings['StripeEndpointSecret'] = "Clef secrète du Endpoint:"; +$strings['PendingReasonByStripe'] = "Un instant.... En attente de confirmation du paiement..."; +$strings['cecabank_enable'] = "Activer Cecabank POS"; +$strings['TpvCecabank'] = "Paiement POS (Cecabank)"; +$strings['CecaSecret'] = "Clef secrète"; +$strings['CecaUrl'] = "URL"; +$strings['CecaMerchanId'] = "Marchand"; +$strings['CecaAcquirerId'] = "Acquéreur"; +$strings['CecaTerminalId'] = "Terminal"; +$strings['CecaCypher'] = "Chiffrage"; +$strings['CecaCurrency'] = "Devise"; +$strings['CecaExponent'] = "Exposant"; +$strings['CecaSupportedPayment'] = "Paiement supporté"; +$strings['CecabankConfig'] = "Configuration de Cecabank"; +$strings['Country'] = "Pays"; +$strings['PaymentType'] = "Type de paiement"; +$strings['CountryRelPaymentConfig'] = "Configuration du type de paiement par pays"; +$strings['CountryRelPaymentMessage'] = "Pour faire une commande, il est nécessaire de définir le type de paiement par pays. Sinon, il est impossible de clôturer la commande"; +$strings['CountryEmpty'] = "Pour passer commande, il est nécessaire de définir le champ Pays dans le profil utilisateur."; +$strings['Duration'] = "Durée"; +$strings['SubscriptionAdd'] = "Ajouter souscription"; +$strings['SubscriptionList'] = "Liste des souscriptions"; +$strings['SubscriptionListOnSale'] = "Souscriptions en promo"; +$strings['SelectSubscription'] = "Sélectionner la durée"; +$strings['SubscriptionNotValid'] = "Souscription non valable"; +$strings['SubscriptionSalesReport'] = "Rapport de ventes"; +$strings['BuySubscriptions'] = "Souscrire"; +$strings['ConfigurationOfSubscriptionsAndPrices'] = "Configuration des souscriptions et prix"; +$strings['FrequencyConfig'] = "Configuration périodes"; +$strings['Subscriptions'] = "Souscriptions"; +$strings['HasSubscriptions'] = "A des souscriptions"; +$strings['FrequencyRemoved'] = "Période supprimée"; +$strings['SubscriptionPeriodOnUse'] = "Période de souscription utilisée"; +$strings['FrequencyNotExits'] = "Cette période n'existe pas"; +$strings['FrequencyIncorrect'] = "Période incorrecte"; +$strings['SubscriptionFrequencyValueDays'] = "Valeur en jours"; +$strings['FrequencyNotUpdated'] = "Période non mise à jour"; +$strings['FrequencyNotSaved'] = "Période non sauvegardée"; +$strings['NeedToAddDuration'] = "Une durée est nécessaire"; +$strings['SubscriptionNotValid'] = "Souscription non valable"; +$strings['SelecSubscription'] = "Sélectionnez une souscription"; +$strings['ConfigureSubscriptionsFrequencies'] = "Configurez des périodes de souscription"; +$strings['FrequencyAdd'] = "Ajouter période"; +$strings['SubscriptionAlreadyExists'] = "La souscription existe déjà"; +$strings['SubscriptionPeriodDuration'] = "Durée de souscription (en jours)"; +$strings['Product'] = "Produit"; +$strings['SalePrice'] = "Prix"; +$strings['YouProductIsActivatedYouCanNowAccessIt'] = "Votre abonnement a été activé, vous avez maintenant accès au module choisi."; +$strings['hide_shopping_cart_from_course_catalogue'] = "Cacher le chariot de vente dans le catalogue de cours et laisse le bouton s'inscrire"; diff --git a/plugin/buycourses/lang/spanish.php b/plugin/buycourses/lang/spanish.php new file mode 100644 index 000000000..cfc31902c --- /dev/null +++ b/plugin/buycourses/lang/spanish.php @@ -0,0 +1,321 @@ + %s , este porcentaje será descontado del total del precio del producto cuya diferencia será el monto base para aplicar estas comisiones."; +$strings['CoursesInSessionsDoesntDisplayHere'] = "Los cursos que se encuentren dentro de una sesión de formación no aparecerán en la lista de cursos a configurar como productos individuales."; +$strings['WantToSellCourses'] = "¿Quieres enseñar y ganar dinero con tus propios cursos?, Esta lista puede estar llena de tus ganancias vendiendo cursos a través de esta plataforma!. Informate con nosotros! "; +$strings['SelectOptionToProceed'] = "Selecciona una opción para proceder"; +$strings['VerifyTotalAmountToProceedPayout'] = "Por favor verificar el monto total para proceder con el pago de comisiones, este monto no considera cargos extras por paypal, las ventas de cursos que no cuenten con una cuenta de Paypal para el o los beneficiarios no serán consideradas."; +$strings['TotalAcounts'] = "Total de cuentas:"; +$strings['TotalPayout'] = "Total a pagar:"; +$strings['PayoutDate'] = "Fecha del Pago:"; +$strings['CautionThisProcessCantBeCanceled'] = "Precaución: este proceso puede tomar unos minutos y no puede ser cancelado."; +$strings['ProcessingPayoutsDontCloseThisWindow'] = "Procesando los pagos, no cierre esta ventana hasta que haya finalizado"; +$strings['PayoutSuccess'] = "Los pagos se han realizado con éxito"; +$strings['Buyer'] = "Comprador"; +$strings['BankTransfer'] = "Transferencia Bancaria"; +$strings['SaleInfo'] = "Información de la venta"; +$strings['SaleStatusPending'] = "Venta pendiente"; +$strings['SaleStatusCanceled'] = "Venta cancelada"; +$strings['SaleStatusCompleted'] = "Venta completada"; +$strings['PayoutStatusPending'] = "Pago pendiente"; +$strings['PayoutStatusCanceled'] = "Pago cancelado"; +$strings['PayoutStatusCompleted'] = "Pago completado"; +$strings['PayoutsTotalPending'] = "Pagos pendientes:"; +$strings['PayoutsTotalCanceled'] = "Pagos cancelados:"; +$strings['PayoutsTotalCompleted'] = "Pagos completados:"; +$strings['Total'] = "Total"; +$strings['TotalAmount'] = "Monto total:"; +$strings['CourseListOnSale'] = "Lista de cursos a la venta"; +$strings['AvailableCourses'] = "Cursos disponibles"; +$strings['Price'] = "Precio"; +$strings['SearchFilter'] = "Filtro de búsqueda"; +$strings['MinimumPrice'] = "Precio mínimo"; +$strings['MaximumPrice'] = "Precio máximo"; +$strings['AvailableCoursesConfiguration'] = "Configuración de cursos disponibles"; +$strings['PaymentsConfiguration'] = "Configuración de Pagos"; +$strings['TheUserIsAlreadyRegisteredInTheCourse'] = "Usted ya está registrado en el curso."; +$strings['SeeDescription'] = "Ver descripción"; +$strings['Buy'] = "Comprar"; +$strings['WaitingToReceiveThePayment'] = "Se encuentra a la espera de recibir el pago"; +$strings['TheUserIsAlreadyRegisteredInTheSession'] = "Usted ya está registrado en la sesión"; +$strings['ItemNotSaved'] = "Elemento no guardado"; +$strings['TitlePlugin'] = "Todo lo que necesita para enseñar y vender cursos en línea"; +$strings['PluginPresentation'] = "El Plugin BuyCourses le da los recursos para vender sus cursos o sus sesiones ya creados y enseñar en línea, todo en unos simples pasos y configuraciones. ¿Qué espera? Empiece a vender cursos a través de Chamilo ahora!"; +$strings['Instructions'] = "Instrucciones de uso"; +$strings['InstructionsStepOne'] = "Crea un curso o una sesión de formación en la plataforma."; +$strings['InstructionsStepTwo'] = "En la sección configuración de pagos, configure el tipo de moneda con el que venderá sus cursos o sesiones."; +$strings['InstructionsStepThree'] = "Configure los cursos a vender en la sección Configuración de cursos y precios"; +$strings['BuyCourses'] = "Comprar cursos"; +$strings['ConfigurationOfCoursesAndPrices'] = "Configuración de cursos y precios"; +$strings['SalesReport'] = "Reporte de ventas"; +$strings['UserInformation'] = "Ficha del comprador"; +$strings['PaymentMethods'] = "Métodos de pago"; +$strings['ConfirmOrder'] = "Confirmar Orden"; +$strings['PurchaseData'] = "Datos de la compra"; +$strings['bc_subject'] = "Confirmación pedido de cursos"; +$strings['PurchaseStatusX'] = "Estado de la compra: %s"; +$strings['PendingReasonByTransfer'] = "Pendiente. Esperando la confirmación de la transferencia"; +$strings['CancelOrder'] = "Cancelar Orden"; +$strings['BankAccountInformation'] = "Información de la Cuenta Bancaria"; +$strings['BankAccount'] = "Cuenta Bancaria"; +$strings['OnceItIsConfirmedYouWillReceiveAnEmailWithTheBankInformationAndAnOrderReference'] = "Una vez confirmado, recibira un e-mail con los datos bancarios y una referencia del pedido."; +$strings['SubscriptionToCourseXSuccessful'] = "

Proceso completado. Tu subscripción a \"%s\" se realizó correctamente.

"; +$strings['OrderCanceled'] = "Pedido cancelado"; +$strings['OrderStatus'] = "Estado del pedido"; +$strings['PayoutStatus'] = "Estado del pago"; +$strings['SearchByStatus'] = "Buscar por estado"; +$strings['OrderReference'] = "Referencia del pedido"; +$strings['OrderDate'] = "Fecha del pedido"; +$strings['OrderPrice'] = "Precio del pedido"; +$strings['ProductType'] = "Tipo de producto"; +$strings['SubscribeUser'] = "Inscribir usuario"; +$strings['DeleteOrder'] = "Eliminar pedido"; +$strings['ErrorContactPlatformAdmin'] = "Se ha producido un error desconocido. Por favor, póngase en contacto con el administrador de la plataforma."; +$strings['PendingReasonByAddress'] = "Pendiente. No has ingresado una dirección de correo confirmada."; +$strings['PendingReasonByAuthorization'] = "Pendiente. No hemos recibido los fondos."; +$strings['PendingReasonByEcheck'] = "Pendiente. El pago fue hecho a través de un eCheck que aún no está declarado"; +$strings['PendingReasonByIntl'] = "Pendiente. No tenemos un mecanismo de retiro de fondos."; +$strings['PendingReasonByMulticurrency'] = "Pending. No podemos realizar el cambio de moneda."; +$strings['PendingReasonByOrder'] = "Pendiente. Pedido realizado. No hemos recibido los fondos."; +$strings['PendingReasonByPaymentReview'] = "Pendiente. El pago está siendo revisado por PayPal por riesgo."; +$strings['PendingReasonByRegulatoryReview'] = "Pendiente. El pago está siendo revisado por cumplimiento con regulaciones gubernamentales."; +$strings['PendingReasonByUnilateral'] = "Pendiente. La dirección de correo electrónico aún no está registrada o confirmada."; +$strings['PendingReasonByUpgrade'] = "Pendiente. El pago fue realizado a través de una tarjeta de crédito."; +$strings['PendingReasonByVerify'] = "Pendiente. Lo sentimos. Todavía no estamos verificados en PayPal."; +$strings['PendingReasonByOther'] = "Pendiente. Por favor contacta al administrador de la plataforma."; +$strings['PayPalPaymentOKPleaseConfirm'] = "PayPal nos indicó que todo estaba listo para ejecutar el pago. Por seguridad, le pedimos confirme una última vez su pedido dando clic en el botón de confirmación a bajo. Una vez le haya dado clic, será registrado al curso y el monto correspondiente será retirado de su cuenta PayPal. Siempre puede acceder a sus cursos a partir de la pestaña 'Mis cursos'. Gracias por su compra!"; +$strings['Sandbox'] = "Entorno de Pruebas"; +$strings['PayPalAccount'] = "Cuenta de Paypal"; +$strings['NoPayPalAccountDetected'] = "No se ingresó una cuenta de Paypal"; +$strings['PayPalConfig'] = "Configuración PayPal:"; +$strings['TransfersConfig'] = "Configuración de transferencias:"; +$strings['PluginInstruction'] = "Puede activar o desactivar la opción de pagos vía PayPal, Culqi o configuración de transferencias bancarias, en la sección del configuración del plugin."; +$strings['ClickHere'] = "Clic aquí para más detalles"; +$strings['CurrencyType'] = "Tipo de moneda"; +$strings['InfoCurrency'] = "Permite configurar el tipo de moneda (de pago) para sus cursos."; +$strings['ApiUsername'] = "Nombre de usuario de API"; +$strings['ApiPassword'] = "Contraseña de API"; +$strings['ApiSignature'] = "Firma"; +$strings['InfoApiCredentials'] = "Para generar tu credenciales API para integrar su cuenta PayPal con Chamilo LMS, deberá seguir los siguientes pasos"; +$strings['InfoApiStepOne'] = "Ir a la opción de Perfil de PayPal, luego en Mis herramientas de venta"; +$strings['InfoApiStepTwo'] = "En el apartado Acceso API, dar clic en la opción Actualizar"; +$strings['InfoApiStepThree'] = "En la opción 2, de Configuración de credenciales y permisos de API, dar clic en Ver firma de API. Copiar los datos de las credenciales en el formulario de configuración de este plugin"; +$strings['ErrorOccurred'] = "Ocurrio un error. Codigo: %s. Mensaje: %s. Por favor, contacta al administrador de la plataforma."; +$strings['VisibleInCatalog'] = "Visible en el catálogo"; +$strings['Beneficiaries'] = "Beneficiarios"; +$strings['AvailableCourse'] = "Curso disponible"; +$strings['ShowOnCourseCatalog'] = "Mostrar en el catálogo de cursos"; +$strings['ByStatus'] = "Por estado"; +$strings['ByUser'] = "Por usuario"; +$strings['ByEmail'] = "Por email"; +$strings['PaymentMethod'] = "Método de pago"; +$strings['SWIFT'] = "Código SWIFT"; +$strings['SWIFT_help'] = "Formato estándar de los Códigos de Identificación Bancaria (BIC) que sirve como identificador único para un banco o institución financiera."; +$strings['PleaseSelectThePaymentMethodBeforeConfirmYourOrder'] = "Seleccione su método de pago preferido antes de confirmar su pedido"; +$strings['NoPaymentOptionAvailable'] = 'No hay opción de pago disponible. Por favor reporte este problema al administrador.'; +$strings['XIsOnlyPaymentMethodAvailable'] = '%s es la única opción de pago disponible para esta compra.'; +$strings['hide_free_text'] = "Esconder texto 'Gratis'"; +$strings['culqi_enable'] = "Activar culqi"; +$strings['include_services'] = "Incluir Servicios"; +$strings['CurrencyIsNotConfigured'] = "Configure una moneda antes de seguir."; +$strings['Services'] = "Servicios"; +$strings['Service'] = "Servicio"; +$strings['NewService'] = "Nuevo servicio"; +$strings['ServiceName'] = "Nombre de servicio"; +$strings['AppliesTo'] = "Aplicado a"; +$strings['ServiceInformation'] = "Información del servicio"; +$strings['ListOfServicesOnSale'] = "Lista de servicios en venta"; +$strings['GlobalConfig'] = "Configuración global"; +$strings['WriteHereTheTermsAndConditionsOfYourECommerce'] = "Escriba aquí los términos y condiciones de su portal e-commerce"; +$strings['EditService'] = "Editar servicio"; +$strings['DeleteThisService'] = "Borrar servicio"; +$strings['IConfirmIReadAndAcceptTermsAndCondition'] = "He leído y acepto los términos y condiciones"; +$strings['PleaseSelectTheCorrectInfoToApplyTheService'] = "Porfavor Seleccione la información correcta para aplicar el servicio"; +$strings['SaleStatusCancelled'] = "Venta anulada"; +$strings['ServiceSaleInfo'] = "Información del servicio"; +$strings['ServiceId'] = "Id de servicio"; +$strings['BoughtBy'] = "Comprado por"; +$strings['PurchaserUser'] = "Usuario comprador"; +$strings['Pending'] = "Pendiente"; +$strings['Names'] = "Nombres"; +$strings['SellerName'] = "Nombre vendedor"; +$strings['SellerId'] = "Identificador vendedor"; +$strings['SellerAddress'] = "Dirección vendedor"; +$strings['SellerEmail'] = "E-mail vendedor"; +$strings['NextNumberInvoice'] = "Número siguiente factura"; +$strings['NextNumberInvoiceDescription'] = "Número de la siguiente factura asignado de forma manual"; +$strings['InvoiceSeries'] = "Serie factura"; +$strings['InvoiceSeriesDescription'] = "Parámetro opcional: Ejemplo de numeración factura <serie><año>/<número>"; +$strings['InvoiceView'] = "Ver factura"; +$strings['NoInvoiceEnable'] = "No está habilitado el bloque de facturación"; +$strings['Company'] = "Empresa"; +$strings['VAT'] = "CIF"; +$strings['Address'] = "Dirección"; +$strings['InvoiceNumber'] = "Num. factura"; +$strings['InvoiceDate'] = "Fecha de emisión"; +$strings['Invoice'] = "Factura"; +$strings['SaleEmail'] = "E-mail de ventas"; +$strings['PurchaseDetailsIntro'] = "Detalles de la comprar"; +$strings['PurchaseDetailsEnd'] = "Atentamente"; +$strings['ProductName'] = "Nombre producto"; +$strings['BankAccountIntro'] = "Información cuentas bancarias"; +$strings['AdditionalInfoRequired'] = 'Se requiere que se elija la información adicional antes de proceder'; +$strings['SubscriptionToServiceXSuccessful'] = "La subscripción al servicio %s ha sido satisfactoria"; +$strings['ClickHereToFinish'] = "De clic aquí para terminar"; +$strings['OrderCancelled'] = "Pedido anulado"; +$strings['use_currency_symbol'] = "Usar símbolo de la moneda"; +$strings['ExportReport'] = "Exportar reporte de ventas"; +$strings['OrderTime'] = "Fecha del pedido"; +$strings['SelectDateRange'] = "Seleccione una fecha de inicio y una fecha de fin para el reporte"; +$strings['ServiceAdded'] = "Servicio agregado"; +$strings['ServiceEdited'] = "Servicio editado"; +$strings['ListOfServicesOnSale'] = "Lista de servicios a la venta"; +$strings['AdditionalInfo'] = "Información adicional"; +$strings['culqi_enable'] = "Habilitar Culqi"; +$strings['CulqiConfig'] = "Configuración de CULQI:"; +$strings['InfoCulqiCredentials'] = "Para obtener las credenciales es necesario crearse una cuenta en Culqi e ingresar en modo desarrollo, copiar el código de comercio que se encuentra en su panel de control, luego ingresar al apartado de API Keys y generar la Key correspondiente para copiarla aquí"; +$strings['CommerceCode'] = "Codigo de comercio"; +$strings['NoTermsAndConditionsProvided'] = "Terminos y condiciones no establecidos"; +$strings['GlobalConfig'] = "Configuración global:"; +$strings['MyServices'] = "Mis servicios"; +$strings['SalePrice'] = "Precio de venta"; +$strings['YouNeedToBeRegisteredInAtLeastOneCourse'] = "Necesitas estar registrado en al menos un curso"; +$strings['YouNeedToBeRegisteredInAtLeastOneSession'] = "Necesitas estar registrado en al menos una sesión"; +$strings['IfYouWantToGetTheCertificateAndOrSkillsAsociatedToThisCourseYouNeedToBuyTheCertificateServiceYouCanGoToServiceCatalogClickingHere'] = "Si quieres obtener el certificado y/o las competencias asociadas a este curso, necesitas comprar el servicio de Certificado , puedes ir al catálogo de servicios para comprarlo haciendo click AQUÍ"; +$strings['ServiceDeleted'] = 'Servicio eliminado'; +$strings['YourCoursesNeedAtLeastOneLearningPath'] = 'Los cursos en los que estás registrado necesitan tener al menos una lección que contenga un item de cerficado final'; +$strings['GlobalTaxPerc'] = "Porcentaje del impuesto global"; +$strings['GlobalTaxPercDescription'] = "Porcentaje por defecto que se usará, excepto si existe un impuesto específico en el curso, sesión o servicio."; +$strings['TaxPerc'] = "Porcentaje del impuesto"; +$strings['TaxPercDescription'] = "Si se deja vacío se usará valor global por defecto."; +$strings['ByDefault'] = "por defecto (valor global)"; +$strings['OnlyCourses'] = "Solo Cursos"; +$strings['OnlySessions'] = "Solo Sesiones"; +$strings['OnlyServices'] = "Solo Servicios"; +$strings['TaxAppliesTo'] = "Impuestos aplicados a"; +$strings['AllCoursesSessionsAndServices'] = "Todos (Cursos, sesiones y servicios)"; +$strings['TaxNameCustom'] = "Nombre del impuesto"; +$strings['TaxNameExamples'] = "VAT, IVA, IGV, TVA, IV ..."; +$strings['ErrorUpdateFieldDB'] = "Error al actualizar los campos de la base de datos"; +$strings['tpv_redsys_enable'] = "Habilitar TPV RedSys"; +$strings['tpv_redsys_enable_help'] = "Para poder utilizar la modalidad de pago del TPV de RedSys es necesario descargar los ficheros de \"INTEGRACIÓN REST - API PHP\" en el siguiente enlace web de RedSys y ubicar el fichero el fichero apiRedSys.php en el directorio plugin/buycourses/resources."; +$strings['NotFindRedsysFile'] = "No se encuentra en el directorio plugin/buycourses/resources el fichero apiRedsys.php"; +$strings['TpvPayment'] = "Pago con tarjeta"; +$strings['TpvRedsysConfig'] = "Configuración TPV Redsys"; +$strings['DS_MERCHANT_MERCHANTCODE'] = "Número de comercio (FUC)"; +$strings['DS_MERCHANT_TERMINAL'] = "Número de terminal"; +$strings['DS_MERCHANT_CURRENCY'] = "Moneda del terminal"; +$strings['kc'] = "Clave secreta de encriptación"; +$strings['url_redsys'] = "URL conexión Redsys"; +$strings['url_redsys_sandbox'] = "URL conexión Redsys (Pruebas)"; +$strings['InfoTpvRedsysApiCredentials'] = "Deberá completar los siguientes campos del formulario con la información que les facilite el Soporte Técnico del TPV Redsys:"; +$strings['InfoEmailExtra'] = "Información extra en e-mail"; +$strings['Coupon'] = "Cupón"; +$strings['DiscountAmount'] = "Descuento total"; +$strings['RedeemCoupon'] = "Canjear"; +$strings['NeedToAddCouponCode'] = "No se ha introducido un código de cupón"; +$strings['CouponNotValid'] = "El cupón no es valido"; +$strings['CouponRedeemed'] = "Cupón canjeado"; +$strings['CouponDiscount'] = "Descuento"; +$strings['CouponStatus'] = "Estado cupón"; +$strings['CouponPercentage'] = "Porcentaje"; +$strings['CouponAmount'] = "Valor"; +$strings['CouponList'] = "Lista de cupones"; +$strings['CouponCode'] = "Código del cupón"; +$strings['CouponDiscountType'] = "Tipo de descuento"; +$strings['CouponDateStart'] = "Valido desde"; +$strings['CouponDateEnd'] = "Caduca el"; +$strings['CouponDelivered'] = "Canjeados"; +$strings['CouponDisable'] = "Desactivar"; +$strings['CouponEnable'] = "Activar"; +$strings['CouponCodeUsed'] = "Código de cupón ya usado"; +$strings['CouponNoExists'] = "El cupón no existe"; +$strings['CouponErrorInsert'] = "Error añadiendo nuevo cupón"; +$strings['CouponActive'] = "Activo"; +$strings['CouponDisabled'] = "Desactivado"; +$strings['CouponUpdate'] = "Cupón actualizado"; +$strings['CouponsConfiguration'] = "Configuración de cupones"; +$strings['CouponAdd'] = "Nuevo cupón"; +$strings['ConfigureCoupon'] = "Configurar cupón"; +$strings['DiscountCoupons'] = "Cupones descuento"; +$strings['CouponsCode'] = "Código"; +$strings['DoYouHaveACoupon'] = "¿Tienes un cupón?"; +$strings['stripe_enable'] = "Activar Stripe"; +$strings['StripeConfig'] = "Configuración de Stripe:"; +$strings['InfoStripeCredentials'] = "Para obtener las credenciales debes crear una cuenta en Stripe, copiar el id de cuenta de tu perfil, ir a la sección de configuración de las claves API y copiar la secret key, por último deberá registrar un nuevo Endpoint en la sección de webhooks a https://{site}/plugin/buycourses/src/stripe_response.php para el tipo de evento checkout.session.completed y copiar el secret del Endpoint."; +$strings['StripeAccountId'] = "Id de la cuenta:"; +$strings['StripeSecret'] = "Secret key:"; +$strings['StripeEndpointSecret'] = "Endpoint secret:"; +$strings['PendingReasonByStripe'] = "Pendiente. Esperando confirmación del pago ..."; +$strings['cecabank_enable'] = "Habilitar TPV Cecabank"; +$strings['TpvCecabank'] = "Pago con tarjeta (Cecabank)"; +$strings['CecaSecret'] = "Secret"; +$strings['CecaUrl'] = "Url"; +$strings['CecaMerchanId'] = "Merchant"; +$strings['CecaAcquirerId'] = "Adquirer"; +$strings['CecaTerminalId'] = "Terminal"; +$strings['CecaCypher'] = "Cypher"; +$strings['CecaCurrency'] = "Moneda"; +$strings['CecaExponent'] = "Exponent"; +$strings['CecaSupportedPayment'] = "Pago soportado"; +$strings['CecabankConfig'] = "Configuración Cecabank"; +$strings['Country'] = "País"; +$strings['PaymentType'] = "Tipo de pago"; +$strings['CountryRelPaymentConfig'] = "Configuración del tipo de pago por país"; +$strings['CountryRelPaymentMessage'] = "Para realizar un pedido es necesario definir el tipo de pago por país, en caso contrario no se permite la realización del pedido"; +$strings['CountryEmpty'] = "Para realizar un pedido es necesario definir en el perfil del usuario el campo país"; +$strings['Duration'] = "Duración"; +$strings['SubscriptionAdd'] = "Añadir suscripción"; +$strings['SubscriptionList'] = "Lista de suscripciones"; +$strings['SubscriptionListOnSale'] = "Lista de suscripciones a la venta"; +$strings['SelectSubscription'] = "Seleciona duración"; +$strings['SubscriptionNotValid'] = "Suscripción no valida"; +$strings['SubscriptionSalesReport'] = "Reporte de ventas"; +$strings['BuySubscriptions'] = "Compra suscripciones"; +$strings['ConfigurationOfSubscriptionsAndPrices'] = "Configuración de suscripciones y precios"; +$strings['FrequencyConfig'] = "Configuración periodos"; +$strings['Subscriptions'] = "Suscripciones"; +$strings['HasSubscriptions'] = "Tiene suscripciones"; +$strings['FrequencyRemoved'] = "Periodo eliminado"; +$strings['SubscriptionPeriodOnUse'] = "Periodo de suscription en uso"; +$strings['FrequencyNotExits'] = "El periodo no existe"; +$strings['FrequencyIncorrect'] = "Periodo incorrecto"; +$strings['SubscriptionFrequencyValueDays'] = "Valor de la suscripción en días"; +$strings['FrequencyNotUpdated'] = "Periodo no actualizado"; +$strings['FrequencyNotSaved'] = "Periodo no guardado"; +$strings['NeedToAddDuration'] = "Hay que especificar una duración"; +$strings['SubscriptionNotValid'] = "Suscripción no valida"; +$strings['SelecSubscription'] = "Seleccione una suscripción"; +$strings['ConfigureSubscriptionsFrequencies'] = "Configurar los períodos de suscripciones"; +$strings['FrequencyAdd'] = "Agregar período"; +$strings['SubscriptionAlreadyExists'] = "La suscripción ya existe"; +$strings['SubscriptionPeriodDuration'] = "Duración de suscripción (en días)"; +$strings['Product'] = "Producto"; +$strings['YouProductIsActivatedYouCanNowAccessIt'] = "Tu producto esta activado y puedes ahora acceder a este."; +$strings['hide_shopping_cart_from_course_catalogue'] = "Esconder el carito de compra del catalogo de curso y dejar el boton de subscripcion a curso"; diff --git a/plugin/buycourses/plugin.php b/plugin/buycourses/plugin.php new file mode 100644 index 000000000..f77cd31ed --- /dev/null +++ b/plugin/buycourses/plugin.php @@ -0,0 +1,13 @@ +Plugins). + * + * @package chamilo.plugin.buycourses + */ +/** + * Plugin details (must be present). + */ +require_once __DIR__.'/config.php'; +$plugin_info = BuyCoursesPlugin::create()->get_info(); diff --git a/plugin/buycourses/resources/css/style.css b/plugin/buycourses/resources/css/style.css new file mode 100644 index 000000000..40b07a1c5 --- /dev/null +++ b/plugin/buycourses/resources/css/style.css @@ -0,0 +1,421 @@ +.buy-courses-tabs { + margin-bottom: 15px; +} + +.buy-courses-page-header { + padding-bottom: 9px; + margin: 40px 0 20px; + border-bottom: 1px solid #eee; +} + +.buy-courses-block-button { + display: block; + width: 100%; + height: 50px; + line-height: 35px; + font-size: 16px; +} + +.buy-courses-cross-out { + text-decoration: line-through; +} + +.buy-courses-title-color { + color: #5DC3E1; + padding-bottom: 10px; +} + +.buy-courses-description-service { + text-align: justify; + font-size: 18px; + line-height: 1.42857; +} + +/* PROCESS BUY */ +.buy-info .price, .service-buy .price { + font-size: 24px; + line-height: 32px; + font-weight: bold; + padding-bottom: 10px; + padding-top: 10px; + letter-spacing: -0.020em; +} + +.buy-info .price-details-tax, .service-buy .price-details-tax { + font-size: 18px; + line-height: 24px; + font-weight: bold; + padding-bottom: 0px; + padding-top: 10px; + letter-spacing: -0.020em; +} + +.buy-info .buy-item .title { + margin-top: 5px; + font-weight: bold; + line-height: 24px; + font-size: 18px; +} + +.buy-info .buy-item .description, .buy-info .buy-item .coaches { + margin-bottom: 20px; + color: #666666; +} + +.buy-info .buy-item .list-description { + color: #666666; +} + +.buy-info .buy-item .date { + margin-bottom: 10px; + color: #666666; +} + +.buy-info .coupon-question, .service-buy .coupon { + font-size: 16px; + line-height: 6px; + font-weight: bold; + padding-bottom: 10px; + padding-top: 24px; + letter-spacing: -0.020em; +} + +.buy-info .coupon, .service-buy .coupon { + line-height: 32px; + font-weight: bold; + padding-bottom: 10px; + padding-top: 10px; + letter-spacing: -0.1em; +} + +.buy-summary { + margin-top: 10px; + border-top: 1px solid #CCCCCC; +} + +.panel-box-buy { + box-shadow: 0 15px 30px rgba(0, 0, 0, .1); + padding: 20px; +} + +.buy-summary .alert-info { + color: #31708f; + background-color: #e8f2f8; + border-color: #bce8f1; +} + +.btn.btn-default.btn-sm { + white-space: unset; +} + +tr.sale-row { + font-size: 12px; +} +tr.sale-columns { + font-size: 10px; + text-transform: uppercase; + background-color: #e6e6e6; +} +tr.sale-columns th{ + vertical-align: middle !important; + text-align: center; +} +@-moz-keyframes wobblebar-loader { + 0% { + left: 4px; + } + 3% { + left: 204px; + } + 6% { + left: 4px; + } + 9% { + left: 204px; + } + 12% { + left: 4px; + } + 15% { + left: 204px; + } + 18% { + left: 32px; + } + 27% { + left: 32px; + } + 30% { + left: 204px; + } + 33% { + left: 4px; + } + 36% { + left: 204px; + } + 39% { + left: 4px; + } + 42% { + left: 204px; + } + 45% { + left: 4px; + } + 48% { + left: 204px; + } + 51% { + left: 152px; + } + 63% { + left: 152px; + } + 66% { + left: 4px; + } + 69% { + left: 204px; + } + 72% { + left: 4px; + } + 75% { + left: 204px; + } + 78% { + left: 4px; + } + 81% { + left: 204px; + } + 84% { + left: 72px; + } + 94% { + left: 72px; + } + 97% { + left: 204px; + } +} + +@-webkit-keyframes wobblebar-loader { + 0% { + left: 4px; + } + 3% { + left: 204px; + } + 6% { + left: 4px; + } + 9% { + left: 204px; + } + 12% { + left: 4px; + } + 15% { + left: 204px; + } + 18% { + left: 32px; + } + 27% { + left: 32px; + } + 30% { + left: 204px; + } + 33% { + left: 4px; + } + 36% { + left: 204px; + } + 39% { + left: 4px; + } + 42% { + left: 204px; + } + 45% { + left: 4px; + } + 48% { + left: 204px; + } + 51% { + left: 152px; + } + 63% { + left: 152px; + } + 66% { + left: 4px; + } + 69% { + left: 204px; + } + 72% { + left: 4px; + } + 75% { + left: 204px; + } + 78% { + left: 4px; + } + 81% { + left: 204px; + } + 84% { + left: 72px; + } + 94% { + left: 72px; + } + 97% { + left: 204px; + } +} + +@keyframes wobblebar-loader { + 0% { + left: 4px; + } + 3% { + left: 204px; + } + 6% { + left: 4px; + } + 9% { + left: 204px; + } + 12% { + left: 4px; + } + 15% { + left: 204px; + } + 18% { + left: 32px; + } + 27% { + left: 32px; + } + 30% { + left: 204px; + } + 33% { + left: 4px; + } + 36% { + left: 204px; + } + 39% { + left: 4px; + } + 42% { + left: 204px; + } + 45% { + left: 4px; + } + 48% { + left: 204px; + } + 51% { + left: 152px; + } + 63% { + left: 152px; + } + 66% { + left: 4px; + } + 69% { + left: 204px; + } + 72% { + left: 4px; + } + 75% { + left: 204px; + } + 78% { + left: 4px; + } + 81% { + left: 204px; + } + 84% { + left: 72px; + } + 94% { + left: 72px; + } + 97% { + left: 204px; + } +} + +/* Landscape phones and down */ +@media (max-width: 480px) { + .panel-box-buy { + padding: 0; + } + + .buy-summary .pull-right { + float: left !important; + } + + .buy-summary .btn-success { + width: 100%; + } +} + +/* :not(:required) hides this rule from IE9 and below */ +.wobblebar-loader:not(:required) { + background: #2E6DA4; + -moz-border-radius: 10.66667px; + -webkit-border-radius: 10.66667px; + border-radius: 10.66667px; + display: inline-block; + overflow: hidden; + text-indent: -9999px; + width: 228px; + height: 21.33333px; + position: relative; +} + +.wobblebar-loader:not(:required)::after { + -moz-animation: wobblebar-loader 15000ms infinite ease; + -webkit-animation: wobblebar-loader 15000ms infinite ease; + animation: wobblebar-loader 15000ms infinite ease; + background: white; + display: block; + -moz-border-radius: 7.11111px; + -webkit-border-radius: 7.11111px; + border-radius: 7.11111px; + content: ''; + position: absolute; + top: 3.55556px; + left: 4px; + width: 21.33333px; + height: 14.22222px; +} + +div.items-course-info h4.title { + font-weight: bold; + height: 2.8em; +} + +@media (min-width: 991px) { + .col-sm-6 .items-course .items-course-image figure { + max-height: 135px; + } +} \ No newline at end of file diff --git a/plugin/buycourses/resources/img/128/backlogs.png b/plugin/buycourses/resources/img/128/backlogs.png new file mode 100644 index 000000000..522a1cfa0 Binary files /dev/null and b/plugin/buycourses/resources/img/128/backlogs.png differ diff --git a/plugin/buycourses/resources/img/128/buycourses.png b/plugin/buycourses/resources/img/128/buycourses.png new file mode 100644 index 000000000..cba3a6492 Binary files /dev/null and b/plugin/buycourses/resources/img/128/buycourses.png differ diff --git a/plugin/buycourses/resources/img/128/buysubscriptions.png b/plugin/buycourses/resources/img/128/buysubscriptions.png new file mode 100644 index 000000000..97a4eed52 Binary files /dev/null and b/plugin/buycourses/resources/img/128/buysubscriptions.png differ diff --git a/plugin/buycourses/resources/img/128/discount.png b/plugin/buycourses/resources/img/128/discount.png new file mode 100644 index 000000000..9c1f011f7 Binary files /dev/null and b/plugin/buycourses/resources/img/128/discount.png differ diff --git a/plugin/buycourses/resources/img/128/paymentsettings.png b/plugin/buycourses/resources/img/128/paymentsettings.png new file mode 100644 index 000000000..24516f22f Binary files /dev/null and b/plugin/buycourses/resources/img/128/paymentsettings.png differ diff --git a/plugin/buycourses/resources/img/128/settings.png b/plugin/buycourses/resources/img/128/settings.png new file mode 100644 index 000000000..ae508a49a Binary files /dev/null and b/plugin/buycourses/resources/img/128/settings.png differ diff --git a/plugin/buycourses/resources/img/128/subscriptionssettings.png b/plugin/buycourses/resources/img/128/subscriptionssettings.png new file mode 100644 index 000000000..9c5050713 Binary files /dev/null and b/plugin/buycourses/resources/img/128/subscriptionssettings.png differ diff --git a/plugin/buycourses/resources/img/32/backlogs.png b/plugin/buycourses/resources/img/32/backlogs.png new file mode 100644 index 000000000..7054fc702 Binary files /dev/null and b/plugin/buycourses/resources/img/32/backlogs.png differ diff --git a/plugin/buycourses/resources/img/32/buycourses.png b/plugin/buycourses/resources/img/32/buycourses.png new file mode 100644 index 000000000..eac4dfa95 Binary files /dev/null and b/plugin/buycourses/resources/img/32/buycourses.png differ diff --git a/plugin/buycourses/resources/img/32/buysubscription.png b/plugin/buycourses/resources/img/32/buysubscription.png new file mode 100644 index 000000000..359169ef6 Binary files /dev/null and b/plugin/buycourses/resources/img/32/buysubscription.png differ diff --git a/plugin/buycourses/resources/img/32/buysubscriptions.png b/plugin/buycourses/resources/img/32/buysubscriptions.png new file mode 100644 index 000000000..359169ef6 Binary files /dev/null and b/plugin/buycourses/resources/img/32/buysubscriptions.png differ diff --git a/plugin/buycourses/resources/img/32/discount.png b/plugin/buycourses/resources/img/32/discount.png new file mode 100644 index 000000000..ec27b0093 Binary files /dev/null and b/plugin/buycourses/resources/img/32/discount.png differ diff --git a/plugin/buycourses/resources/img/32/paymentsettings.png b/plugin/buycourses/resources/img/32/paymentsettings.png new file mode 100644 index 000000000..7f0e022e0 Binary files /dev/null and b/plugin/buycourses/resources/img/32/paymentsettings.png differ diff --git a/plugin/buycourses/resources/img/32/settings.png b/plugin/buycourses/resources/img/32/settings.png new file mode 100644 index 000000000..00ded5c27 Binary files /dev/null and b/plugin/buycourses/resources/img/32/settings.png differ diff --git a/plugin/buycourses/resources/img/32/subscriptionsettings.png b/plugin/buycourses/resources/img/32/subscriptionsettings.png new file mode 100644 index 000000000..21f37ff01 Binary files /dev/null and b/plugin/buycourses/resources/img/32/subscriptionsettings.png differ diff --git a/plugin/buycourses/resources/img/32/subscriptionssettings.png b/plugin/buycourses/resources/img/32/subscriptionssettings.png new file mode 100644 index 000000000..21f37ff01 Binary files /dev/null and b/plugin/buycourses/resources/img/32/subscriptionssettings.png differ diff --git a/plugin/buycourses/resources/img/42/backlogs.png b/plugin/buycourses/resources/img/42/backlogs.png new file mode 100644 index 000000000..c7e3cdeeb Binary files /dev/null and b/plugin/buycourses/resources/img/42/backlogs.png differ diff --git a/plugin/buycourses/resources/img/42/buycourses.png b/plugin/buycourses/resources/img/42/buycourses.png new file mode 100644 index 000000000..80cfb5e07 Binary files /dev/null and b/plugin/buycourses/resources/img/42/buycourses.png differ diff --git a/plugin/buycourses/resources/img/42/buysubscriptions.png b/plugin/buycourses/resources/img/42/buysubscriptions.png new file mode 100644 index 000000000..359169ef6 Binary files /dev/null and b/plugin/buycourses/resources/img/42/buysubscriptions.png differ diff --git a/plugin/buycourses/resources/img/42/discount.png b/plugin/buycourses/resources/img/42/discount.png new file mode 100644 index 000000000..9846e3eff Binary files /dev/null and b/plugin/buycourses/resources/img/42/discount.png differ diff --git a/plugin/buycourses/resources/img/42/paymentsettings.png b/plugin/buycourses/resources/img/42/paymentsettings.png new file mode 100644 index 000000000..1048f830a Binary files /dev/null and b/plugin/buycourses/resources/img/42/paymentsettings.png differ diff --git a/plugin/buycourses/resources/img/42/settings.png b/plugin/buycourses/resources/img/42/settings.png new file mode 100644 index 000000000..975dc44df Binary files /dev/null and b/plugin/buycourses/resources/img/42/settings.png differ diff --git a/plugin/buycourses/resources/img/42/subscriptionssettings.png b/plugin/buycourses/resources/img/42/subscriptionssettings.png new file mode 100644 index 000000000..21f37ff01 Binary files /dev/null and b/plugin/buycourses/resources/img/42/subscriptionssettings.png differ diff --git a/plugin/buycourses/resources/img/64/backlogs.png b/plugin/buycourses/resources/img/64/backlogs.png new file mode 100644 index 000000000..f0c83f66c Binary files /dev/null and b/plugin/buycourses/resources/img/64/backlogs.png differ diff --git a/plugin/buycourses/resources/img/64/buycourses.png b/plugin/buycourses/resources/img/64/buycourses.png new file mode 100644 index 000000000..2f42065bd Binary files /dev/null and b/plugin/buycourses/resources/img/64/buycourses.png differ diff --git a/plugin/buycourses/resources/img/64/buysubscriptions.png b/plugin/buycourses/resources/img/64/buysubscriptions.png new file mode 100644 index 000000000..be1bed82d Binary files /dev/null and b/plugin/buycourses/resources/img/64/buysubscriptions.png differ diff --git a/plugin/buycourses/resources/img/64/discount.png b/plugin/buycourses/resources/img/64/discount.png new file mode 100644 index 000000000..80de02b68 Binary files /dev/null and b/plugin/buycourses/resources/img/64/discount.png differ diff --git a/plugin/buycourses/resources/img/64/paymentsettings.png b/plugin/buycourses/resources/img/64/paymentsettings.png new file mode 100644 index 000000000..cbb1bcdd0 Binary files /dev/null and b/plugin/buycourses/resources/img/64/paymentsettings.png differ diff --git a/plugin/buycourses/resources/img/64/settings.png b/plugin/buycourses/resources/img/64/settings.png new file mode 100644 index 000000000..6f2afb97d Binary files /dev/null and b/plugin/buycourses/resources/img/64/settings.png differ diff --git a/plugin/buycourses/resources/img/64/subscriptionssettings.png b/plugin/buycourses/resources/img/64/subscriptionssettings.png new file mode 100644 index 000000000..2e2d327e7 Binary files /dev/null and b/plugin/buycourses/resources/img/64/subscriptionssettings.png differ diff --git a/plugin/buycourses/resources/js/commissions.js b/plugin/buycourses/resources/js/commissions.js new file mode 100644 index 000000000..757a6c1ee --- /dev/null +++ b/plugin/buycourses/resources/js/commissions.js @@ -0,0 +1,145 @@ +/* + * To change this license header, choose License Headers in Project Properties. + * To change this template file, choose Tools | Templates + * and open the template in the editor. + */ + +function showSliders(maxPercentage, type, defaultValues) { + + defaultValues = defaultValues || "0"; + + var sliderCounter = 1; + var percentage = 0; + var minPercentage = 0; + + $("#selectBox option:selected").each(function() { + + var count = $("#selectBox option:selected").length; + + percentage = maxPercentage / count; + percentage = parseInt(percentage); + + verifyMaxPercentage = percentage * count; + if (verifyMaxPercentage !== maxPercentage && sliderCounter === 1) { + percentage = percentage + (maxPercentage - verifyMaxPercentage); + } + + beneficiaryId = $(this).val(); + beneficiaryName = $(this).text(); + + var verify; + + var slidersValue = defaultValues.toString().split(','); + + if (type === 'default') { + + percentage = slidersValue[sliderCounter - 1]; + percentage = parseInt(percentage); + $("#panelSliders").append("" + beneficiaryName + " - [ " + percentage + " % ]
"); + + } else if (type === 'renew') { + + $("#panelSliders").append("" + beneficiaryName + " - [ " + percentage + " % ]
"); + + } + + verifyPaypalAccountByBeneficiary(beneficiaryId); + + sliderCounter++; + stepSlide = count - 1; + + if (stepSlide === 0) { + (type === 'default') ? minPercentage = 0 : minPercentage = 100; + (type === 'default') ? stepSlide = 100 : stepSlide = 1; + } + + + $( "#panelSliders .panelSliders" ).slider({ + value: percentage, + min: minPercentage, + max: maxPercentage, + step: stepSlide, + animate: true, + slide: function( event, ui ) { + + $(this).prev(".value").text(ui.value); + + var total = 0; + var sliders = $( "#panelSliders .panelSliders" ); + + sliders.not(this).each(function() { + value = $(this).slider("option", "value"); + total += value; + }); + + total += ui.value; + var delta = 100 - total; + + sliders.not(this).each(function() { + + var t = $(this); + value = t.slider("option", "value"); + + var newValue = value + (delta/stepSlide); + + if (newValue < 0 || ui.value == 100) + newValue = 0; + if (newValue > 100) + newValue = 100; + + t.prev('.value').text(newValue); + t.slider('value', newValue); + + }); + + $("[name=\'commissions\']").val(getSlidersValues()); + } + }); + }); + + $("[name=\'commissions\']").val(getSlidersValues()); + showCorrectSliderHandler(); +}; + +function getSlidersValues() { + var commissions = ""; + + $( "#panelSliders .panelSliders" ).each(function() { + commissions += $(this).prev(".value").text() + ','; + }); + + commissions = commissions.substring(0, commissions.length-1); + + return commissions; +} + +function showCorrectSliderHandler() { + var correctHandler = []; + + $("#panelSliders > span").each(function () { + if ($(this).hasClass('value')) { + correctHandler.push($(this).text()); + } + }); + + var counter = 0; + + $("#panelSliders .panelSliders > span").each(function () { + if ($(this).hasClass('ui-slider-handle')) { + $(this).css('left', correctHandler[counter]+'%'); + counter++; + } + }); +} + +function verifyPaypalAccountByBeneficiary(userId) { + + return $.ajax({ + data: 'id='+userId, + url: 'buycourses.ajax.php?a=verifyPaypal', + type: 'POST', + success: function(response) { + $("#"+userId).append(' '+response); + } + }); +} diff --git a/plugin/buycourses/resources/js/modals.js b/plugin/buycourses/resources/js/modals.js new file mode 100644 index 000000000..90e677d1d --- /dev/null +++ b/plugin/buycourses/resources/js/modals.js @@ -0,0 +1 @@ +!function(a,b){"use strict";"function"==typeof define&&define.amd?define(["jquery"],b):"object"==typeof exports?module.exports=b(require("jquery")):a.bootbox=b(a.jQuery)}(this,function a(b,c){"use strict";function d(a){var b=q[o.locale];return b?b[a]:q.en[a]}function e(a,c,d){a.stopPropagation(),a.preventDefault();var e=b.isFunction(d)&&d.call(c,a)===!1;e||c.modal("hide")}function f(a){var b,c=0;for(b in a)c++;return c}function g(a,c){var d=0;b.each(a,function(a,b){c(a,b,d++)})}function h(a){var c,d;if("object"!=typeof a)throw new Error("Please supply an object of options");if(!a.message)throw new Error("Please specify a message");return a=b.extend({},o,a),a.buttons||(a.buttons={}),c=a.buttons,d=f(c),g(c,function(a,e,f){if(b.isFunction(e)&&(e=c[a]={callback:e}),"object"!==b.type(e))throw new Error("button with key "+a+" must be an object");e.label||(e.label=a),e.className||(e.className=2>=d&&f===d-1?"btn-primary":"btn-default")}),a}function i(a,b){var c=a.length,d={};if(1>c||c>2)throw new Error("Invalid argument length");return 2===c||"string"==typeof a[0]?(d[b[0]]=a[0],d[b[1]]=a[1]):d=a[0],d}function j(a,c,d){return b.extend(!0,{},a,i(c,d))}function k(a,b,c,d){var e={className:"bootbox-"+a,buttons:l.apply(null,b)};return m(j(e,d,c),b)}function l(){for(var a={},b=0,c=arguments.length;c>b;b++){var e=arguments[b],f=e.toLowerCase(),g=e.toUpperCase();a[f]={label:d(g)}}return a}function m(a,b){var d={};return g(b,function(a,b){d[b]=!0}),g(a.buttons,function(a){if(d[a]===c)throw new Error("button key "+a+" is not allowed (options are "+b.join("\n")+")")}),a}var n={dialog:"",header:"

",footer:"
",closeButton:"",form:"
",inputs:{text:"",textarea:"",email:"",select:"",checkbox:"
",date:"",time:"",number:"",password:""}},o={locale:"en",backdrop:"static",animate:!0,className:null,closeButton:!0,show:!0,container:"body"},p={};p.alert=function(){var a;if(a=k("alert",["ok"],["message","callback"],arguments),a.callback&&!b.isFunction(a.callback))throw new Error("alert requires callback property to be a function when provided");return a.buttons.ok.callback=a.onEscape=function(){return b.isFunction(a.callback)?a.callback.call(this):!0},p.dialog(a)},p.confirm=function(){var a;if(a=k("confirm",["cancel","confirm"],["message","callback"],arguments),a.buttons.cancel.callback=a.onEscape=function(){return a.callback.call(this,!1)},a.buttons.confirm.callback=function(){return a.callback.call(this,!0)},!b.isFunction(a.callback))throw new Error("confirm requires a callback");return p.dialog(a)},p.prompt=function(){var a,d,e,f,h,i,k;if(f=b(n.form),d={className:"bootbox-prompt",buttons:l("cancel","confirm"),value:"",inputType:"text"},a=m(j(d,arguments,["title","callback"]),["cancel","confirm"]),i=a.show===c?!0:a.show,a.message=f,a.buttons.cancel.callback=a.onEscape=function(){return a.callback.call(this,null)},a.buttons.confirm.callback=function(){var c;switch(a.inputType){case"text":case"textarea":case"email":case"select":case"date":case"time":case"number":case"password":c=h.val();break;case"checkbox":var d=h.find("input:checked");c=[],g(d,function(a,d){c.push(b(d).val())})}return a.callback.call(this,c)},a.show=!1,!a.title)throw new Error("prompt requires a title");if(!b.isFunction(a.callback))throw new Error("prompt requires a callback");if(!n.inputs[a.inputType])throw new Error("invalid prompt type");switch(h=b(n.inputs[a.inputType]),a.inputType){case"text":case"textarea":case"email":case"date":case"time":case"number":case"password":h.val(a.value);break;case"select":var o={};if(k=a.inputOptions||[],!b.isArray(k))throw new Error("Please pass an array of input options");if(!k.length)throw new Error("prompt with select requires options");g(k,function(a,d){var e=h;if(d.value===c||d.text===c)throw new Error("given options in wrong format");d.group&&(o[d.group]||(o[d.group]=b("").attr("label",d.group)),e=o[d.group]),e.append("")}),g(o,function(a,b){h.append(b)}),h.val(a.value);break;case"checkbox":var q=b.isArray(a.value)?a.value:[a.value];if(k=a.inputOptions||[],!k.length)throw new Error("prompt with checkbox requires options");if(!k[0].value||!k[0].text)throw new Error("given options in wrong format");h=b("
"),g(k,function(c,d){var e=b(n.inputs[a.inputType]);e.find("input").attr("value",d.value),e.find("label").append(d.text),g(q,function(a,b){b===d.value&&e.find("input").prop("checked",!0)}),h.append(e)})}return a.placeholder&&h.attr("placeholder",a.placeholder),a.pattern&&h.attr("pattern",a.pattern),a.maxlength&&h.attr("maxlength",a.maxlength),f.append(h),f.on("submit",function(a){a.preventDefault(),a.stopPropagation(),e.find(".btn-primary").click()}),e=p.dialog(a),e.off("shown.bs.modal"),e.on("shown.bs.modal",function(){h.focus()}),i===!0&&e.modal("show"),e},p.dialog=function(a){a=h(a);var d=b(n.dialog),f=d.find(".modal-dialog"),i=d.find(".modal-body"),j=a.buttons,k="",l={onEscape:a.onEscape};if(b.fn.modal===c)throw new Error("$.fn.modal is not defined; please double check you have included the Bootstrap JavaScript library. See http://getbootstrap.com/javascript/ for more details.");if(g(j,function(a,b){k+="",l[a]=b.callback}),i.find(".bootbox-body").html(a.message),a.animate===!0&&d.addClass("fade"),a.className&&d.addClass(a.className),"large"===a.size?f.addClass("modal-lg"):"small"===a.size&&f.addClass("modal-sm"),a.title&&i.before(n.header),a.closeButton){var m=b(n.closeButton);a.title?d.find(".modal-header").prepend(m):m.css("margin-top","-10px").prependTo(i)}return a.title&&d.find(".modal-title").html(a.title),k.length&&(i.after(n.footer),d.find(".modal-footer").html(k)),d.on("hidden.bs.modal",function(a){a.target===this&&d.remove()}),d.on("shown.bs.modal",function(){d.find(".btn-primary:first").focus()}),"static"!==a.backdrop&&d.on("click.dismiss.bs.modal",function(a){d.children(".modal-backdrop").length&&(a.currentTarget=d.children(".modal-backdrop").get(0)),a.target===a.currentTarget&&d.trigger("escape.close.bb")}),d.on("escape.close.bb",function(a){l.onEscape&&e(a,d,l.onEscape)}),d.on("click",".modal-footer button",function(a){var c=b(this).data("bb-handler");e(a,d,l[c])}),d.on("click",".bootbox-close-button",function(a){e(a,d,l.onEscape)}),d.on("keyup",function(a){27===a.which&&d.trigger("escape.close.bb")}),b(a.container).append(d),d.modal({backdrop:a.backdrop?"static":!1,keyboard:!1,show:!1}),a.show&&d.modal("show"),d},p.setDefaults=function(){var a={};2===arguments.length?a[arguments[0]]=arguments[1]:a=arguments[0],b.extend(o,a)},p.hideAll=function(){return b(".bootbox").modal("hide"),p};var q={bg_BG:{OK:"Ок",CANCEL:"Отказ",CONFIRM:"Потвърждавам"},br:{OK:"OK",CANCEL:"Cancelar",CONFIRM:"Sim"},cs:{OK:"OK",CANCEL:"Zrušit",CONFIRM:"Potvrdit"},da:{OK:"OK",CANCEL:"Annuller",CONFIRM:"Accepter"},de:{OK:"OK",CANCEL:"Abbrechen",CONFIRM:"Akzeptieren"},el:{OK:"Εντάξει",CANCEL:"Ακύρωση",CONFIRM:"Επιβεβαίωση"},en:{OK:"OK",CANCEL:"Cancel",CONFIRM:"OK"},es:{OK:"OK",CANCEL:"Cancelar",CONFIRM:"Aceptar"},et:{OK:"OK",CANCEL:"Katkesta",CONFIRM:"OK"},fa:{OK:"قبول",CANCEL:"لغو",CONFIRM:"تایید"},fi:{OK:"OK",CANCEL:"Peruuta",CONFIRM:"OK"},fr:{OK:"OK",CANCEL:"Annuler",CONFIRM:"D'accord"},he:{OK:"אישור",CANCEL:"ביטול",CONFIRM:"אישור"},hu:{OK:"OK",CANCEL:"Mégsem",CONFIRM:"Megerősít"},hr:{OK:"OK",CANCEL:"Odustani",CONFIRM:"Potvrdi"},id:{OK:"OK",CANCEL:"Batal",CONFIRM:"OK"},it:{OK:"OK",CANCEL:"Annulla",CONFIRM:"Conferma"},ja:{OK:"OK",CANCEL:"キャンセル",CONFIRM:"確認"},lt:{OK:"Gerai",CANCEL:"Atšaukti",CONFIRM:"Patvirtinti"},lv:{OK:"Labi",CANCEL:"Atcelt",CONFIRM:"Apstiprināt"},nl:{OK:"OK",CANCEL:"Annuleren",CONFIRM:"Accepteren"},no:{OK:"OK",CANCEL:"Avbryt",CONFIRM:"OK"},pl:{OK:"OK",CANCEL:"Anuluj",CONFIRM:"Potwierdź"},pt:{OK:"OK",CANCEL:"Cancelar",CONFIRM:"Confirmar"},ru:{OK:"OK",CANCEL:"Отмена",CONFIRM:"Применить"},sq:{OK:"OK",CANCEL:"Anulo",CONFIRM:"Prano"},sv:{OK:"OK",CANCEL:"Avbryt",CONFIRM:"OK"},th:{OK:"ตกลง",CANCEL:"ยกเลิก",CONFIRM:"ยืนยัน"},tr:{OK:"Tamam",CANCEL:"İptal",CONFIRM:"Onayla"},zh_CN:{OK:"OK",CANCEL:"取消",CONFIRM:"确认"},zh_TW:{OK:"OK",CANCEL:"取消",CONFIRM:"確認"}};return p.addLocale=function(a,c){return b.each(["OK","CANCEL","CONFIRM"],function(a,b){if(!c[b])throw new Error("Please supply a translation for '"+b+"'")}),q[a]={OK:c.OK,CANCEL:c.CANCEL,CONFIRM:c.CONFIRM},p},p.removeLocale=function(a){return delete q[a],p},p.setLocale=function(a){return p.setDefaults("locale",a)},p.init=function(c){return a(c||b)},p}); \ No newline at end of file diff --git a/plugin/buycourses/src/buy_course_plugin.class.php b/plugin/buycourses/src/buy_course_plugin.class.php new file mode 100644 index 000000000..fca64a42d --- /dev/null +++ b/plugin/buycourses/src/buy_course_plugin.class.php @@ -0,0 +1,6146 @@ + + * @author Imanol Losada + * @author Alex Aragón + * @author Angel Fernando Quiroz Campos + * @author José Loguercio Silva + * @author Julio Montoya + */ +class BuyCoursesPlugin extends Plugin +{ + public const TABLE_PAYPAL = 'plugin_buycourses_paypal_account'; + public const TABLE_CURRENCY = 'plugin_buycourses_currency'; + public const TABLE_ITEM = 'plugin_buycourses_item'; + public const TABLE_ITEM_BENEFICIARY = 'plugin_buycourses_item_rel_beneficiary'; + public const TABLE_SALE = 'plugin_buycourses_sale'; + public const TABLE_TRANSFER = 'plugin_buycourses_transfer'; + public const TABLE_COMMISSION = 'plugin_buycourses_commission'; + public const TABLE_PAYPAL_PAYOUTS = 'plugin_buycourses_paypal_payouts'; + public const TABLE_SERVICES = 'plugin_buycourses_services'; + public const TABLE_SERVICES_SALE = 'plugin_buycourses_service_sale'; + public const TABLE_CULQI = 'plugin_buycourses_culqi'; + public const TABLE_GLOBAL_CONFIG = 'plugin_buycourses_global_config'; + public const TABLE_INVOICE = 'plugin_buycourses_invoices'; + public const TABLE_TPV_REDSYS = 'plugin_buycourses_tpvredsys_account'; + public const TABLE_COUPON = 'plugin_buycourses_coupon'; + public const TABLE_COUPON_ITEM = 'plugin_buycourses_coupon_rel_item'; + public const TABLE_COUPON_SERVICE = 'plugin_buycourses_coupon_rel_service'; + public const TABLE_SUBSCRIPTION = 'plugin_buycourses_subscription'; + public const TABLE_SUBSCRIPTION_SALE = 'plugin_buycourses_subscription_rel_sale'; + public const TABLE_SUBSCRIPTION_PERIOD = 'plugin_buycourses_subscription_period'; + public const TABLE_COUPON_SALE = 'plugin_buycourses_coupon_rel_sale'; + public const TABLE_COUPON_SERVICE_SALE = 'plugin_buycourses_coupon_rel_service_sale'; + public const TABLE_COUPON_SUBSCRIPTION_SALE = 'plugin_buycourses_coupon_rel_subscription_sale'; + public const TABLE_STRIPE = 'plugin_buycourses_stripe_account'; + public const TABLE_TPV_CECABANK = 'plugin_buycourses_cecabank_account'; + public const PRODUCT_TYPE_COURSE = 1; + public const PRODUCT_TYPE_SESSION = 2; + public const PRODUCT_TYPE_SERVICE = 3; + public const PAYMENT_TYPE_PAYPAL = 1; + public const PAYMENT_TYPE_TRANSFER = 2; + public const PAYMENT_TYPE_CULQI = 3; + public const PAYMENT_TYPE_TPV_REDSYS = 4; + public const PAYMENT_TYPE_STRIPE = 5; + public const PAYMENT_TYPE_TPV_CECABANK = 6; + public const PAYOUT_STATUS_CANCELED = 2; + public const PAYOUT_STATUS_PENDING = 0; + public const PAYOUT_STATUS_COMPLETED = 1; + public const SALE_STATUS_CANCELED = -1; + public const SALE_STATUS_PENDING = 0; + public const SALE_STATUS_COMPLETED = 1; + public const SERVICE_STATUS_PENDING = 0; + public const SERVICE_STATUS_COMPLETED = 1; + public const SERVICE_STATUS_CANCELLED = -1; + public const SERVICE_TYPE_USER = 1; + public const SERVICE_TYPE_COURSE = 2; + public const SERVICE_TYPE_SESSION = 3; + public const SERVICE_TYPE_LP_FINAL_ITEM = 4; + public const CULQI_INTEGRATION_TYPE = 'INTEG'; + public const CULQI_PRODUCTION_TYPE = 'PRODUC'; + public const TAX_APPLIES_TO_ALL = 1; + public const TAX_APPLIES_TO_ONLY_COURSE = 2; + public const TAX_APPLIES_TO_ONLY_SESSION = 3; + public const TAX_APPLIES_TO_ONLY_SERVICES = 4; + public const PAGINATION_PAGE_SIZE = 6; + public const COUPON_DISCOUNT_TYPE_PERCENTAGE = 1; + public const COUPON_DISCOUNT_TYPE_AMOUNT = 2; + public const COUPON_STATUS_ACTIVE = 1; + public const COUPON_STATUS_DISABLE = 0; + + public $isAdminPlugin = false; + + /** + * BuyCoursesPlugin constructor. + */ + public function __construct() + { + parent::__construct( + '7.1', + " + Jose Angel Ruiz - NoSoloRed (original author)
+ Francis Gonzales and Yannick Warnier - BeezNest (integration)
+ Alex Aragón - BeezNest (Design icons and css styles)
+ Imanol Losada - BeezNest (introduction of sessions purchase)
+ Angel Fernando Quiroz Campos - BeezNest (cleanup and new reports)
+ José Loguercio Silva - BeezNest (Payouts and buy Services)
+ Julio Montoya + ", + [ + 'show_main_menu_tab' => 'boolean', + 'public_main_menu_tab' => 'boolean', + 'include_sessions' => 'boolean', + 'include_services' => 'boolean', + 'paypal_enable' => 'boolean', + 'transfer_enable' => 'boolean', + 'culqi_enable' => 'boolean', + 'commissions_enable' => 'boolean', + 'unregistered_users_enable' => 'boolean', + 'hide_free_text' => 'boolean', + 'hide_shopping_cart_from_course_catalogue' => 'boolean', + 'invoicing_enable' => 'boolean', + 'tax_enable' => 'boolean', + 'use_currency_symbol' => 'boolean', + 'tpv_redsys_enable' => 'boolean', + 'stripe_enable' => 'boolean', + 'cecabank_enable' => 'boolean', + ] + ); + } + + /** + * @return BuyCoursesPlugin + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * Check if plugin is enabled. + * + * @param bool $checkEnabled Check if, additionnally to being installed, the plugin is enabled + */ + public function isEnabled(bool $checkEnabled = false): bool + { + return $this->get('paypal_enable') || $this->get('transfer_enable') || $this->get('culqi_enable') || $this->get('stripe_enable') || $this->get('cecabank_enable'); + } + + /** + * This method creates the tables required to this plugin. + */ + public function install() + { + $tablesToBeCompared = [ + self::TABLE_PAYPAL, + self::TABLE_TRANSFER, + self::TABLE_CULQI, + self::TABLE_ITEM_BENEFICIARY, + self::TABLE_ITEM, + self::TABLE_SALE, + self::TABLE_CURRENCY, + self::TABLE_COMMISSION, + self::TABLE_PAYPAL_PAYOUTS, + self::TABLE_SERVICES, + self::TABLE_SERVICES_SALE, + self::TABLE_GLOBAL_CONFIG, + self::TABLE_INVOICE, + self::TABLE_TPV_REDSYS, + self::TABLE_COUPON, + self::TABLE_COUPON_ITEM, + self::TABLE_COUPON_SERVICE, + self::TABLE_SUBSCRIPTION, + self::TABLE_SUBSCRIPTION_SALE, + self::TABLE_SUBSCRIPTION_PERIOD, + self::TABLE_COUPON_SALE, + self::TABLE_COUPON_SERVICE_SALE, + self::TABLE_COUPON_SUBSCRIPTION_SALE, + self::TABLE_STRIPE, + self::TABLE_TPV_CECABANK, + ]; + $em = Database::getManager(); + $cn = $em->getConnection(); + $sm = $cn->getSchemaManager(); + $tables = $sm->tablesExist($tablesToBeCompared); + + if ($tables) { + return false; + } + + require_once api_get_path(SYS_PLUGIN_PATH).'buycourses/database.php'; + } + + /** + * This method drops the plugin tables. + */ + public function uninstall() + { + $tablesToBeDeleted = [ + self::TABLE_PAYPAL, + self::TABLE_TRANSFER, + self::TABLE_CULQI, + self::TABLE_ITEM_BENEFICIARY, + self::TABLE_ITEM, + self::TABLE_SALE, + self::TABLE_CURRENCY, + self::TABLE_COMMISSION, + self::TABLE_PAYPAL_PAYOUTS, + self::TABLE_SERVICES_SALE, + self::TABLE_SERVICES, + self::TABLE_GLOBAL_CONFIG, + self::TABLE_INVOICE, + self::TABLE_TPV_REDSYS, + self::TABLE_COUPON, + self::TABLE_COUPON_ITEM, + self::TABLE_COUPON_SERVICE, + self::TABLE_SUBSCRIPTION, + self::TABLE_SUBSCRIPTION_SALE, + self::TABLE_SUBSCRIPTION_PERIOD, + self::TABLE_COUPON_SALE, + self::TABLE_COUPON_SERVICE_SALE, + self::TABLE_COUPON_SUBSCRIPTION_SALE, + self::TABLE_STRIPE, + ]; + + foreach ($tablesToBeDeleted as $tableToBeDeleted) { + $table = Database::get_main_table($tableToBeDeleted); + $sql = "DROP TABLE IF EXISTS $table"; + Database::query($sql); + } + $this->manageTab(false); + } + + public function update() + { + $table = self::TABLE_GLOBAL_CONFIG; + $sql = "SHOW COLUMNS FROM $table WHERE Field = 'global_tax_perc'"; + $res = Database::query($sql); + + if (Database::num_rows($res) === 0) { + $sql = "ALTER TABLE $table ADD ( + sale_email varchar(255) NOT NULL, + global_tax_perc int unsigned NOT NULL, + tax_applies_to int unsigned NOT NULL, + tax_name varchar(255) NOT NULL, + seller_name varchar(255) NOT NULL, + seller_id varchar(255) NOT NULL, + seller_address varchar(255) NOT NULL, + seller_email varchar(255) NOT NULL, + next_number_invoice int unsigned NOT NULL, + invoice_series varchar(255) NOT NULL + )"; + $res = Database::query($sql); + if (!$res) { + echo Display::return_message($this->get_lang('ErrorUpdateFieldDB'), 'warning'); + } + } + + $sql = "SHOW COLUMNS FROM $table WHERE Field = 'info_email_extra'"; + $res = Database::query($sql); + + if (Database::num_rows($res) === 0) { + $sql = "ALTER TABLE $table ADD (info_email_extra TEXT NOT NULL)"; + $res = Database::query($sql); + if (!$res) { + echo Display::return_message($this->get_lang('ErrorUpdateFieldDB'), 'warning'); + } + } + + $table = self::TABLE_ITEM; + $sql = "SHOW COLUMNS FROM $table WHERE Field = 'tax_perc'"; + $res = Database::query($sql); + + if (Database::num_rows($res) === 0) { + $sql = "ALTER TABLE $table ADD tax_perc int unsigned NULL"; + $res = Database::query($sql); + if (!$res) { + echo Display::return_message($this->get_lang('ErrorUpdateFieldDB'), 'warning'); + } + } + + $table = self::TABLE_SERVICES; + $sql = "SHOW COLUMNS FROM $table WHERE Field = 'tax_perc'"; + $res = Database::query($sql); + + if (Database::num_rows($res) === 0) { + $sql = "ALTER TABLE $table ADD tax_perc int unsigned NULL"; + $res = Database::query($sql); + if (!$res) { + echo Display::return_message($this->get_lang('ErrorUpdateFieldDB'), 'warning'); + } + } + + $table = self::TABLE_SALE; + $sql = "SHOW COLUMNS FROM $table WHERE Field = 'tax_perc'"; + $res = Database::query($sql); + + if (Database::num_rows($res) === 0) { + $sql = "ALTER TABLE $table ADD ( + price_without_tax decimal(10,2) NULL, + tax_perc int unsigned NULL, + tax_amount decimal(10,2) NULL, + invoice int unsigned NULL + )"; + $res = Database::query($sql); + if (!$res) { + echo Display::return_message($this->get_lang('ErrorUpdateFieldDB'), 'warning'); + } + } + + $sql = "SHOW COLUMNS FROM $table WHERE Field = 'price_without_discount'"; + $res = Database::query($sql); + + if (Database::num_rows($res) === 0) { + $sql = "ALTER TABLE $table ADD ( + price_without_discount decimal(10,2) NULL, + discount_amount decimal(10,2) NULL + )"; + $res = Database::query($sql); + if (!$res) { + echo Display::return_message($this->get_lang('ErrorUpdateFieldDB'), 'warning'); + } + } + + $table = self::TABLE_SERVICES_SALE; + $sql = "SHOW COLUMNS FROM $table WHERE Field = 'tax_perc'"; + $res = Database::query($sql); + + if (Database::num_rows($res) === 0) { + $sql = "ALTER TABLE $table ADD ( + price_without_tax decimal(10,2) NULL, + tax_perc int unsigned NULL, + tax_amount decimal(10,2) NULL, + invoice int unsigned NULL + )"; + $res = Database::query($sql); + if (!$res) { + echo Display::return_message($this->get_lang('ErrorUpdateFieldDB'), 'warning'); + } + } + + $sql = "SHOW COLUMNS FROM $table WHERE Field = 'price_without_discount'"; + $res = Database::query($sql); + + if (Database::num_rows($res) === 0) { + $sql = "ALTER TABLE $table ADD ( + price_without_discount decimal(10,2) NULL, + discount_amount decimal(10,2) NULL + )"; + $res = Database::query($sql); + if (!$res) { + echo Display::return_message($this->get_lang('ErrorUpdateFieldDB'), 'warning'); + } + } + + $table = self::TABLE_INVOICE; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int unsigned NOT NULL AUTO_INCREMENT, + sale_id int unsigned NOT NULL, + is_service int unsigned NOT NULL, + num_invoice int unsigned NOT NULL, + year int(4) unsigned NOT NULL, + serie varchar(255) NOT NULL, + date_invoice datetime NOT NULL, + PRIMARY KEY (id) + )"; + Database::query($sql); + + $table = self::TABLE_TPV_REDSYS; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int unsigned NOT NULL AUTO_INCREMENT, + merchantcode varchar(255) NOT NULL, + terminal varchar(255) NOT NULL, + currency varchar(255) NOT NULL, + kc varchar(255) NOT NULL, + url_redsys varchar(255) NOT NULL, + url_redsys_sandbox varchar(255) NOT NULL, + sandbox int unsigned NULL, + PRIMARY KEY (id) + )"; + Database::query($sql); + + $sql = "SELECT * FROM $table"; + $res = Database::query($sql); + if (Database::num_rows($res) == 0) { + Database::insert($table, [ + 'url_redsys' => 'https://sis.redsys.es/sis/realizarPago', + 'url_redsys_sandbox' => 'https://sis-t.redsys.es:25443/sis/realizarPago', + ]); + } + + $table = self::TABLE_COUPON; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int unsigned NOT NULL AUTO_INCREMENT, + code varchar(255) NOT NULL, + discount_type int unsigned NOT NULL, + discount_amount decimal(10, 2) NOT NULL, + valid_start datetime NOT NULL, + valid_end datetime NOT NULL, + delivered varchar(255) NOT NULL, + active tinyint NOT NULL, + PRIMARY KEY (id) + )"; + Database::query($sql); + + $table = self::TABLE_COUPON_ITEM; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int unsigned NOT NULL AUTO_INCREMENT, + coupon_id int unsigned NOT NULL, + product_type int unsigned NOT NULL, + product_id int unsigned NOT NULL, + PRIMARY KEY (id) + )"; + Database::query($sql); + + $table = self::TABLE_COUPON_SERVICE; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int unsigned NOT NULL AUTO_INCREMENT, + coupon_id int unsigned NOT NULL, + service_id int unsigned NOT NULL, + PRIMARY KEY (id) + )"; + Database::query($sql); + + $table = self::TABLE_SUBSCRIPTION; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + product_type int unsigned NOT NULL, + product_id int unsigned NOT NULL, + duration int unsigned NOT NULL, + currency_id int unsigned NOT NULL, + price decimal(10, 2) NOT NULL, + tax_perc int unsigned, + PRIMARY KEY (product_type, product_id, duration) + )"; + Database::query($sql); + + $table = self::TABLE_SUBSCRIPTION_SALE; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int unsigned NOT NULL AUTO_INCREMENT, + currency_id int unsigned NOT NULL, + reference varchar(255) NOT NULL, + date datetime NOT NULL, + user_id int unsigned NOT NULL, + product_type int NOT NULL, + product_name varchar(255) NOT NULL, + product_id int unsigned NOT NULL, + price decimal(10,2) NOT NULL, + price_without_tax decimal(10,2) NULL, + tax_perc int unsigned NULL, + tax_amount decimal(10,2) NULL, + status int NOT NULL, + payment_type int NOT NULL, + invoice int NOT NULL, + price_without_discount decimal(10,2), + discount_amount decimal(10,2), + subscription_end datetime NOT NULL, + expired tinyint NULL, + PRIMARY KEY (id) + )"; + Database::query($sql); + + $table = self::TABLE_SUBSCRIPTION_PERIOD; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + duration int unsigned NOT NULL, + name varchar(50) NOT NULL, + PRIMARY KEY (duration) + )"; + Database::query($sql); + + $table = self::TABLE_COUPON_SALE; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int unsigned NOT NULL AUTO_INCREMENT, + coupon_id int unsigned NOT NULL, + sale_id int unsigned NOT NULL, + PRIMARY KEY (id) + )"; + Database::query($sql); + + $table = self::TABLE_COUPON_SERVICE_SALE; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int unsigned NOT NULL AUTO_INCREMENT, + coupon_id int unsigned NOT NULL, + service_sale_id int unsigned NOT NULL, + PRIMARY KEY (id) + )"; + Database::query($sql); + + $table = self::TABLE_COUPON_SUBSCRIPTION_SALE; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int unsigned NOT NULL AUTO_INCREMENT, + coupon_id int unsigned NOT NULL, + sale_id int unsigned NOT NULL, + PRIMARY KEY (id) + )"; + Database::query($sql); + + $table = self::TABLE_STRIPE; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int unsigned NOT NULL AUTO_INCREMENT, + account_id varchar(255) NOT NULL, + secret_key varchar(255) NOT NULL, + endpoint_secret varchar(255) NOT NULL, + PRIMARY KEY (id) + )"; + Database::query($sql); + + $sql = "SELECT * FROM $table"; + $res = Database::query($sql); + if (Database::num_rows($res) == 0) { + Database::insert($table, [ + 'account_id' => '', + 'secret_key' => '', + 'endpoint_secret' => '', + ]); + } + + $table = self::TABLE_TPV_CECABANK; + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int unsigned NOT NULL AUTO_INCREMENT, + crypto_key varchar(255) NOT NULL, + merchant_id varchar(255) NOT NULL, + acquirer_bin varchar(255) NOT NULL, + terminal_id varchar(255) NOT NULL, + cypher varchar(255) NOT NULL, + exponent varchar(255) NOT NULL, + supported_payment varchar(255) NOT NULL, + url varchar(255) NOT NULL, + PRIMARY KEY (id) + )"; + Database::query($sql); + + Display::addFlash( + Display::return_message( + $this->get_lang('Updated'), + 'info', + false + ) + ); + + $fieldlabel = 'buycourses_company'; + $fieldtype = '1'; + $fieldtitle = $this->get_lang('Company'); + $fielddefault = ''; + UserManager::create_extra_field($fieldlabel, $fieldtype, $fieldtitle, $fielddefault); + + $fieldlabel = 'buycourses_vat'; + $fieldtype = '1'; + $fieldtitle = $this->get_lang('VAT'); + $fielddefault = ''; + UserManager::create_extra_field($fieldlabel, $fieldtype, $fieldtitle, $fielddefault); + + $fieldlabel = 'buycourses_address'; + $fieldtype = '1'; + $fieldtitle = $this->get_lang('Address'); + $fielddefault = ''; + UserManager::create_extra_field($fieldlabel, $fieldtype, $fieldtitle, $fielddefault); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses'); + exit; + } + + /** + * This function verify if the plugin is enable and return the price info for a course or session in the new grid + * catalog for 1.11.x , the main purpose is to show if a course or session is in sale it shows in the main platform + * course catalog so the old buycourses plugin catalog can be deprecated. + * + * @param int $productId course or session id + * @param int $productType course or session type + * + * @return mixed bool|string html + */ + public function buyCoursesForGridCatalogValidator(int $productId, int $productType) + { + $return = []; + $paypal = $this->get('paypal_enable') === 'true'; + $transfer = $this->get('transfer_enable') === 'true'; + $stripe = $this->get('stripe_enable') === 'true'; + $culqi = $this->get('culqi_enable') === 'true'; + $cecabank = $this->get('cecabank_enable') === 'true'; + $tpv_redsys = $this->get('tpv_redsys_enable') === 'true'; + $hideFree = $this->get('hide_free_text') === 'true'; + + if ($paypal || $transfer || $stripe || $culqi || $cecabank || $tpv_redsys) { + $item = $this->getItemByProduct($productId, $productType); + $html = '
'; + if ($item) { + $html .= ' + '.$item['total_price_formatted'].' + '; + $return['verificator'] = true; + } else { + if ($hideFree == false) { + $html .= ' + '.$this->get_lang('Free').' + '; + } + $return['verificator'] = false; + } + $html .= '
'; + $return['html'] = $html; + + return $return; + } + + return false; + } + + /** + * Return the buyCourses plugin button to buy the course. + * + * @return string $html + */ + public function returnBuyCourseButton(int $productId, int $productType) + { + $productId = $productId; + $productType = $productType; + $url = api_get_path(WEB_PLUGIN_PATH).'buycourses/src/process.php?i='.$productId.'&t='.$productType; + $buyButton = Display::returnFontAwesomeIcon('shopping-cart'); + if ($this->get('hide_shopping_cart_from_course_catalogue') === 'true') { + $buyButton = Display::returnFontAwesomeIcon('check').PHP_EOL.get_lang('Subscribe'); + } + $html = ''. + $buyButton.''; + + return $html; + } + + /** + * Get the currency for sales. + * + * @return array The selected currency. Otherwise return false + */ + public function getSelectedCurrency() + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_CURRENCY), + [ + 'where' => ['status = ?' => true], + ], + 'first' + ); + } + + /** + * Get a list of currencies. + * + * @return array The currencies. Otherwise return false + */ + public function getCurrencies() + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_CURRENCY) + ); + } + + /** + * Save the selected currency. + * + * @param int $selectedId The currency Id + */ + public function saveCurrency(int $selectedId) + { + $currencyTable = Database::get_main_table( + self::TABLE_CURRENCY + ); + + Database::update( + $currencyTable, + ['status' => 0] + ); + Database::update( + $currencyTable, + ['status' => 1], + ['id = ?' => $selectedId] + ); + } + + /** + * Save the PayPal configuration params. + * + * @return int Rows affected. Otherwise return false + */ + public function savePaypalParams(array $params) + { + return Database::update( + Database::get_main_table(self::TABLE_PAYPAL), + [ + 'username' => $params['username'], + 'password' => $params['password'], + 'signature' => $params['signature'], + 'sandbox' => isset($params['sandbox']), + ], + ['id = ?' => 1] + ); + } + + /** + * Gets the stored PayPal params. + * + * @return array + */ + public function getPaypalParams() + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_PAYPAL), + ['id = ?' => 1], + 'first' + ); + } + + /** + * Gets the stored TPV Redsys params. + * + * @return array + */ + public function getTpvRedsysParams() + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_TPV_REDSYS), + ['id = ?' => 1], + 'first' + ); + } + + /** + * Save the tpv Redsys configuration params. + * + * @return int Rows affected. Otherwise return false + */ + public function saveTpvRedsysParams(array $params) + { + return Database::update( + Database::get_main_table(self::TABLE_TPV_REDSYS), + [ + 'merchantcode' => $params['merchantcode'], + 'terminal' => $params['terminal'], + 'currency' => $params['currency'], + 'kc' => $params['kc'], + 'url_redsys' => $params['url_redsys'], + 'url_redsys_sandbox' => $params['url_redsys_sandbox'], + 'sandbox' => isset($params['sandbox']), + ], + ['id = ?' => 1] + ); + } + + /** + * Save Stripe configuration params. + * + * @return int Rows affected. Otherwise return false + */ + public function saveStripeParameters(array $params) + { + return Database::update( + Database::get_main_table(self::TABLE_STRIPE), + [ + 'account_id' => $params['account_id'], + 'secret_key' => $params['secret_key'], + 'endpoint_secret' => $params['endpoint_secret'], + ], + ['id = ?' => 1] + ); + } + + /** + * Gets the stored Stripe params. + * + * @return array + */ + public function getStripeParams() + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_STRIPE), + ['id = ?' => 1], + 'first' + ); + } + + /** + * Save a transfer account information. + * + * @param array $params The transfer account + * + * @return int Rows affected. Otherwise, return false + */ + public function saveTransferAccount(array $params) + { + return Database::insert( + Database::get_main_table(self::TABLE_TRANSFER), + [ + 'name' => $params['tname'], + 'account' => $params['taccount'], + 'swift' => $params['tswift'], + ] + ); + } + + /** + * Save email message information in transfer. + * + * @param array $params The transfer message + * + * @return int Rows affected. Otherwise return false + */ + public function saveTransferInfoEmail(array $params) + { + return Database::update( + Database::get_main_table(self::TABLE_GLOBAL_CONFIG), + ['info_email_extra' => $params['tinfo_email_extra']], + ['id = ?' => 1] + ); + } + + /** + * Gets message information for transfer email. + * + * @return array + */ + public function getTransferInfoExtra() + { + return Database::select( + 'info_email_extra AS tinfo_email_extra', + Database::get_main_table(self::TABLE_GLOBAL_CONFIG), + ['id = ?' => 1], + 'first' + ); + } + + /** + * Get a list of transfer accounts. + * + * @return array + */ + public function getTransferAccounts() + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_TRANSFER) + ); + } + + /** + * Remove a transfer account. + * + * @param int $id The transfer account ID + * + * @return int Rows affected. Otherwise return false + */ + public function deleteTransferAccount(int $id) + { + return Database::delete( + Database::get_main_table(self::TABLE_TRANSFER), + ['id = ?' => $id] + ); + } + + /** + * Get registered item data. + * + * @param int $itemId The item ID + * + * @return array + */ + public function getItem(int $itemId) + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_ITEM), + [ + 'where' => ['id = ?' => $itemId], + ], + 'first' + ); + } + + /** + * Get the item data. + * + * @param int $productId The item ID + * @param int $itemType The item type + * + * @return array + */ + public function getItemByProduct(int $productId, int $itemType, array $coupon = null) + { + $buyItemTable = Database::get_main_table(self::TABLE_ITEM); + $buyCurrencyTable = Database::get_main_table(self::TABLE_CURRENCY); + + $fakeItemFrom = " + $buyItemTable i + INNER JOIN $buyCurrencyTable c + ON i.currency_id = c.id + "; + + $product = Database::select( + ['i.*', 'c.iso_code'], + $fakeItemFrom, + [ + 'where' => [ + 'i.product_id = ? AND i.product_type = ?' => [ + $productId, + $itemType, + ], + ], + ], + 'first' + ); + + if (empty($product)) { + return false; + } + + $this->setPriceSettings($product, self::TAX_APPLIES_TO_ONLY_COURSE, $coupon); + + return $product; + } + + /** + * Get registered item data. + * + * @param int $itemId The product ID + * @param int $productType The product type + * + * @return array + */ + public function getSubscriptionItem(int $itemId, int $productType) + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_SUBSCRIPTION), + [ + 'where' => ['product_id = ? AND product_type = ?' => [ + $itemId, + $productType, + ], + ], + ], + 'first' + ); + } + + /** + * Get the item data. + * + * @param int $productId The item ID + * @param int $itemType The item type + * @param array $coupon Array with at least 'discount_type' and 'discount_amount' elements + * + * @return array + */ + public function getSubscriptionItemByProduct(int $productId, int $itemType, array $coupon = null) + { + $buySubscriptionItemTable = Database::get_main_table(self::TABLE_SUBSCRIPTION); + $buyCurrencyTable = Database::get_main_table(self::TABLE_CURRENCY); + + $fakeItemFrom = " + $buySubscriptionItemTable s + INNER JOIN $buyCurrencyTable c + ON s.currency_id = c.id + "; + + $item = Database::select( + ['s.*', 'c.iso_code'], + $fakeItemFrom, + [ + 'where' => [ + 's.product_id = ? AND s.product_type = ?' => [ + $productId, + $itemType, + ], + ], + ], + 'first' + ); + + if (empty($item)) { + return false; + } + + $this->setPriceSettings($item, self::TAX_APPLIES_TO_ONLY_COURSE, $coupon); + + return $item; + } + + /** + * Get the item data. + * + * @param int $productId The item ID + * @param int $itemType The item type + * + * @return array + */ + public function getSubscriptionsItemsByProduct(int $productId, int $itemType) + { + $buySubscriptionItemTable = Database::get_main_table(self::TABLE_SUBSCRIPTION); + $buyCurrencyTable = Database::get_main_table(self::TABLE_CURRENCY); + + $fakeItemFrom = " + $buySubscriptionItemTable s + INNER JOIN $buyCurrencyTable c + ON s.currency_id = c.id + "; + + $items = Database::select( + ['s.*', 'c.iso_code'], + $fakeItemFrom, + [ + 'where' => [ + 's.product_id = ? AND s.product_type = ?' => [ + $productId, + $itemType, + ], + ], + ] + ); + + for ($i = 0; $i < count($items); $i++) { + $this->setPriceSettings($items[$i], self::TAX_APPLIES_TO_ONLY_COURSE); + } + + if (empty($items)) { + return false; + } + + return $items; + } + + /** + * Get registered item data by duration. + * + * @param int $duration The subscription duration + * + * @return array + */ + public function getSubscriptionsItemsByDuration(int $duration) + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_SUBSCRIPTION), + [ + 'where' => [ + 'duration = ?' => [$duration], + ], + ] + ); + } + + /** + * List courses details from the configuration page. + * + * @return array + */ + public function getCourseList(int $first, int $maxResults) + { + return $this->getCourses($first, $maxResults); + } + + /** + * Lists current user session details, including each session course details. + * + * It can return the number of rows when $typeResult is 'count'. + * + * @param string $name Optional. The name filter. + * @param int $min Optional. The minimum price filter. + * @param int $max Optional. The maximum price filter. + * @param string $typeResult Optional. 'all', 'first' or 'count'. + * + * @return array|int + */ + public function getCatalogSessionList(int $start, int $end, string $name = null, int $min = 0, int $max = 0, string $typeResult = 'all', $sessionCategory = 0) + { + $sessions = $this->filterSessionList($start, $end, $name, $min, $max, $typeResult, $sessionCategory); + + if ($typeResult === 'count') { + return $sessions; + } + + $sessionCatalog = []; + // loop through all sessions + foreach ($sessions as $session) { + $sessionCourses = $session->getCourses(); + + if (empty($sessionCourses)) { + continue; + } + + $item = $this->getItemByProduct( + $session->getId(), + self::PRODUCT_TYPE_SESSION + ); + + if (empty($item)) { + continue; + } + + $sessionData = $this->getSessionInfo($session->getId()); + $sessionData['coach'] = $session->getGeneralCoach()->getCompleteName(); + $sessionData['enrolled'] = $this->getUserStatusForSession( + api_get_user_id(), + $session + ); + $sessionData['courses'] = []; + + foreach ($sessionCourses as $sessionCourse) { + $course = $sessionCourse->getCourse(); + + $sessionCourseData = [ + 'title' => $course->getTitle(), + 'coaches' => [], + ]; + + $userCourseSubscriptions = $session->getUserCourseSubscriptionsByStatus( + $course, + Chamilo\CoreBundle\Entity\Session::COACH + ); + + foreach ($userCourseSubscriptions as $userCourseSubscription) { + $user = $userCourseSubscription->getUser(); + $sessionCourseData['coaches'][] = $user->getCompleteName(); + } + $sessionData['courses'][] = $sessionCourseData; + } + + $sessionCatalog[] = $sessionData; + } + + return $sessionCatalog; + } + + /** + * Lists current user course details. + * + * @param string $name Optional. The name filter + * @param int $min Optional. The minimum price filter + * @param int $max Optional. The maximum price filter + * + * @return array|int + */ + public function getCatalogCourseList(int $first, int $pageSize, string $name = null, int $min = 0, int $max = 0, string $typeResult = 'all') + { + $courses = $this->filterCourseList($first, $pageSize, $name, $min, $max, $typeResult); + + if ($typeResult === 'count') { + return $courses; + } + + if (empty($courses)) { + return []; + } + + $courseCatalog = []; + foreach ($courses as $course) { + $item = $this->getItemByProduct( + $course->getId(), + self::PRODUCT_TYPE_COURSE + ); + + if (empty($item)) { + continue; + } + + $courseItem = [ + 'id' => $course->getId(), + 'title' => $course->getTitle(), + 'code' => $course->getCode(), + 'course_img' => null, + 'item' => $item, + 'teachers' => [], + 'enrolled' => $this->getUserStatusForCourse(api_get_user_id(), $course), + ]; + + foreach ($course->getTeachers() as $courseUser) { + $teacher = $courseUser->getUser(); + $courseItem['teachers'][] = $teacher->getCompleteName(); + } + + // Check images + $possiblePath = api_get_path(SYS_COURSE_PATH); + $possiblePath .= $course->getDirectory(); + $possiblePath .= '/course-pic.png'; + + if (file_exists($possiblePath)) { + $courseItem['course_img'] = api_get_path(WEB_COURSE_PATH).$course->getDirectory().'/course-pic.png'; + } + $courseCatalog[] = $courseItem; + } + + return $courseCatalog; + } + + /** + * Lists current user subscription session details, including each session course details. + * + * It can return the number of rows when $typeResult is 'count'. + * + * @param int $start Pagination start. + * @param int $end Pagination end. + * @param string $name Optional. The name filter. + * @param string $typeResult Optional. 'all', 'first' or 'count'. + * @param int $sessionCategory Optional. Session category id + * + * @return array|int + */ + public function getCatalogSubscriptionSessionList(int $start, int $end, string $name = null, string $typeResult = 'all', int $sessionCategory = 0) + { + $sessions = $this->filterSubscriptionSessionList($start, $end, $name, $typeResult, $sessionCategory); + + if ($typeResult === 'count') { + return $sessions; + } + + $sessionCatalog = []; + // loop through all sessions + foreach ($sessions as $session) { + $sessionCourses = $session->getCourses(); + + if (empty($sessionCourses)) { + continue; + } + + $item = $this->getSubscriptionItemByProduct( + $session->getId(), + self::PRODUCT_TYPE_SESSION + ); + + if (empty($item)) { + continue; + } + + $sessionData = $this->getSubscriptionSessionInfo($session->getId()); + $sessionData['coach'] = $session->getGeneralCoach()->getCompleteName(); + $sessionData['enrolled'] = $this->getUserStatusForSubscriptionSession( + api_get_user_id(), + $session + ); + $sessionData['courses'] = []; + + foreach ($sessionCourses as $sessionCourse) { + $course = $sessionCourse->getCourse(); + + $sessionCourseData = [ + 'title' => $course->getTitle(), + 'coaches' => [], + ]; + + $userCourseSubscriptions = $session->getUserCourseSubscriptionsByStatus( + $course, + Chamilo\CoreBundle\Entity\Session::COACH + ); + + foreach ($userCourseSubscriptions as $userCourseSubscription) { + $user = $userCourseSubscription->getUser(); + $sessionCourseData['coaches'][] = $user->getCompleteName(); + } + $sessionData['courses'][] = $sessionCourseData; + } + + $sessionCatalog[] = $sessionData; + } + + return $sessionCatalog; + } + + /** + * Lists current user subscription course details. + * + * @param string $typeResult Optional. 'all', 'first' or 'count'. + * + * @return array|int + */ + public function getCatalogSubscriptionCourseList(int $first, int $pageSize, string $name = null, string $typeResult = 'all') + { + $courses = $this->filterSubscriptionCourseList($first, $pageSize, $name, $typeResult); + + if ($typeResult === 'count') { + return $courses; + } + + if (empty($courses)) { + return []; + } + + $courseCatalog = []; + foreach ($courses as $course) { + $item = $this->getSubscriptionItemByProduct( + $course->getId(), + self::PRODUCT_TYPE_COURSE + ); + + if (empty($item)) { + continue; + } + + $courseItem = [ + 'id' => $course->getId(), + 'title' => $course->getTitle(), + 'code' => $course->getCode(), + 'course_img' => null, + 'item' => $item, + 'teachers' => [], + 'enrolled' => $this->getUserStatusForSubscriptionCourse(api_get_user_id(), $course), + ]; + + foreach ($course->getTeachers() as $courseUser) { + $teacher = $courseUser->getUser(); + $courseItem['teachers'][] = $teacher->getCompleteName(); + } + + // Check images + $possiblePath = api_get_path(SYS_COURSE_PATH); + $possiblePath .= $course->getDirectory(); + $possiblePath .= '/course-pic.png'; + + if (file_exists($possiblePath)) { + $courseItem['course_img'] = api_get_path(WEB_COURSE_PATH).$course->getDirectory().'/course-pic.png'; + } + $courseCatalog[] = $courseItem; + } + + return $courseCatalog; + } + + public function getPriceWithCurrencyFromIsoCode(float $price, string $isoCode): string + { + $useSymbol = $this->get('use_currency_symbol') === 'true'; + + $result = $isoCode.' '.$price; + if ($useSymbol) { + if ($isoCode === 'BRL') { + $symbol = 'R$'; + } else { + $symbol = Symfony\Component\Intl\Intl::getCurrencyBundle()->getCurrencySymbol($isoCode); + } + $result = $symbol.' '.$price; + } + + return $result; + } + + /** + * Get course info. + * + * @return array + */ + public function getCourseInfo(int $courseId, array $coupon = null) + { + $entityManager = Database::getManager(); + $course = $entityManager->find('ChamiloCoreBundle:Course', $courseId); + + if (empty($course)) { + return []; + } + + $item = $this->getItemByProduct( + $course->getId(), + self::PRODUCT_TYPE_COURSE, + $coupon + ); + + if (empty($item)) { + return []; + } + + $courseDescription = $entityManager->getRepository('ChamiloCourseBundle:CCourseDescription') + ->findOneBy( + [ + 'cId' => $course->getId(), + 'sessionId' => 0, + ], + [ + 'descriptionType' => 'ASC', + ] + ); + + $globalParameters = $this->getGlobalParameters(); + $courseInfo = [ + 'id' => $course->getId(), + 'title' => $course->getTitle(), + 'description' => $courseDescription ? $courseDescription->getContent() : null, + 'code' => $course->getCode(), + 'visual_code' => $course->getVisualCode(), + 'teachers' => [], + 'item' => $item, + 'tax_name' => $globalParameters['tax_name'], + 'tax_enable' => $this->checkTaxEnabledInProduct(self::TAX_APPLIES_TO_ONLY_COURSE), + 'course_img' => null, + ]; + + $courseTeachers = $course->getTeachers(); + + foreach ($courseTeachers as $teachers) { + $user = $teachers->getUser(); + $teacher['id'] = $user->getId(); + $teacher['name'] = $user->getCompleteName(); + $courseInfo['teachers'][] = $teacher; + } + + $possiblePath = api_get_path(SYS_COURSE_PATH); + $possiblePath .= $course->getDirectory(); + $possiblePath .= '/course-pic.png'; + + if (file_exists($possiblePath)) { + $courseInfo['course_img'] = api_get_path(WEB_COURSE_PATH).$course->getDirectory().'/course-pic.png'; + } + + return $courseInfo; + } + + /** + * Get session info. + * + * @return array + */ + public function getSessionInfo(int $sessionId, array $coupon = null) + { + $entityManager = Database::getManager(); + $session = $entityManager->find('ChamiloCoreBundle:Session', $sessionId); + + if (empty($session)) { + return []; + } + + $item = $this->getItemByProduct( + $session->getId(), + self::PRODUCT_TYPE_SESSION, + $coupon + ); + + if (empty($item)) { + return []; + } + + $sessionDates = SessionManager::parseSessionDates( + [ + 'display_start_date' => $session->getDisplayStartDate(), + 'display_end_date' => $session->getDisplayEndDate(), + 'access_start_date' => $session->getAccessStartDate(), + 'access_end_date' => $session->getAccessEndDate(), + 'coach_access_start_date' => $session->getCoachAccessStartDate(), + 'coach_access_end_date' => $session->getCoachAccessEndDate(), + ] + ); + + $globalParameters = $this->getGlobalParameters(); + $sessionInfo = [ + 'id' => $session->getId(), + 'name' => $session->getName(), + 'description' => $session->getDescription(), + 'dates' => $sessionDates, + 'courses' => [], + 'tax_name' => $globalParameters['tax_name'], + 'tax_enable' => $this->checkTaxEnabledInProduct(self::TAX_APPLIES_TO_ONLY_SESSION), + 'image' => null, + 'nbrCourses' => $session->getNbrCourses(), + 'nbrUsers' => $session->getNbrUsers(), + 'item' => $item, + 'duration' => $session->getDuration(), + ]; + + $fieldValue = new ExtraFieldValue('session'); + $sessionImage = $fieldValue->get_values_by_handler_and_field_variable( + $session->getId(), + 'image' + ); + + if (!empty($sessionImage)) { + $sessionInfo['image'] = api_get_path(WEB_UPLOAD_PATH).$sessionImage['value']; + } + + $sessionCourses = $session->getCourses(); + foreach ($sessionCourses as $sessionCourse) { + $course = $sessionCourse->getCourse(); + $sessionCourseData = [ + 'title' => $course->getTitle(), + 'coaches' => [], + ]; + + $userCourseSubscriptions = $session->getUserCourseSubscriptionsByStatus( + $course, + Chamilo\CoreBundle\Entity\Session::COACH + ); + + foreach ($userCourseSubscriptions as $userCourseSubscription) { + $user = $userCourseSubscription->getUser(); + $coaches['id'] = $user->getUserId(); + $coaches['name'] = $user->getCompleteName(); + $sessionCourseData['coaches'][] = $coaches; + } + + $sessionInfo['courses'][] = $sessionCourseData; + } + + return $sessionInfo; + } + + /** + * Get course info. + * + * @return array + */ + public function getSubscriptionCourseInfo(int $courseId, array $coupon = null) + { + $entityManager = Database::getManager(); + $course = $entityManager->find('ChamiloCoreBundle:Course', $courseId); + + if (empty($course)) { + return []; + } + + $item = $this->getSubscriptionItemByProduct( + $course->getId(), + self::PRODUCT_TYPE_COURSE, + $coupon + ); + + if (empty($item)) { + return []; + } + + $courseDescription = $entityManager->getRepository('ChamiloCourseBundle:CCourseDescription') + ->findOneBy( + [ + 'cId' => $course->getId(), + 'sessionId' => 0, + ], + [ + 'descriptionType' => 'ASC', + ] + ); + + $globalParameters = $this->getGlobalParameters(); + $courseInfo = [ + 'id' => $course->getId(), + 'title' => $course->getTitle(), + 'description' => $courseDescription ? $courseDescription->getContent() : null, + 'code' => $course->getCode(), + 'visual_code' => $course->getVisualCode(), + 'teachers' => [], + 'item' => $item, + 'tax_name' => $globalParameters['tax_name'], + 'tax_enable' => $this->checkTaxEnabledInProduct(self::TAX_APPLIES_TO_ONLY_COURSE), + 'course_img' => null, + ]; + + $courseTeachers = $course->getTeachers(); + + foreach ($courseTeachers as $teachers) { + $user = $teachers->getUser(); + $teacher['id'] = $user->getId(); + $teacher['name'] = $user->getCompleteName(); + $courseInfo['teachers'][] = $teacher; + } + + $possiblePath = api_get_path(SYS_COURSE_PATH); + $possiblePath .= $course->getDirectory(); + $possiblePath .= '/course-pic.png'; + + if (file_exists($possiblePath)) { + $courseInfo['course_img'] = api_get_path(WEB_COURSE_PATH).$course->getDirectory().'/course-pic.png'; + } + + return $courseInfo; + } + + /** + * Get session info. + * + * @param array $sessionId The session ID + * + * @return array + */ + public function getSubscriptionSessionInfo(int $sessionId, array $coupon = null) + { + $entityManager = Database::getManager(); + $session = $entityManager->find('ChamiloCoreBundle:Session', $sessionId); + + if (empty($session)) { + return []; + } + + $item = $this->getSubscriptionItemByProduct( + $session->getId(), + self::PRODUCT_TYPE_SESSION, + $coupon + ); + + if (empty($item)) { + return []; + } + + $sessionDates = SessionManager::parseSessionDates( + [ + 'display_start_date' => $session->getDisplayStartDate(), + 'display_end_date' => $session->getDisplayEndDate(), + 'access_start_date' => $session->getAccessStartDate(), + 'access_end_date' => $session->getAccessEndDate(), + 'coach_access_start_date' => $session->getCoachAccessStartDate(), + 'coach_access_end_date' => $session->getCoachAccessEndDate(), + ] + ); + + $globalParameters = $this->getGlobalParameters(); + $sessionInfo = [ + 'id' => $session->getId(), + 'name' => $session->getName(), + 'description' => $session->getDescription(), + 'dates' => $sessionDates, + 'courses' => [], + 'tax_name' => $globalParameters['tax_name'], + 'tax_enable' => $this->checkTaxEnabledInProduct(self::TAX_APPLIES_TO_ONLY_SESSION), + 'image' => null, + 'nbrCourses' => $session->getNbrCourses(), + 'nbrUsers' => $session->getNbrUsers(), + 'item' => $item, + 'duration' => $session->getDuration(), + ]; + + $fieldValue = new ExtraFieldValue('session'); + $sessionImage = $fieldValue->get_values_by_handler_and_field_variable( + $session->getId(), + 'image' + ); + + if (!empty($sessionImage)) { + $sessionInfo['image'] = api_get_path(WEB_UPLOAD_PATH).$sessionImage['value']; + } + + $sessionCourses = $session->getCourses(); + foreach ($sessionCourses as $sessionCourse) { + $course = $sessionCourse->getCourse(); + $sessionCourseData = [ + 'title' => $course->getTitle(), + 'coaches' => [], + ]; + + $userCourseSubscriptions = $session->getUserCourseSubscriptionsByStatus( + $course, + Chamilo\CoreBundle\Entity\Session::COACH + ); + + foreach ($userCourseSubscriptions as $userCourseSubscription) { + $user = $userCourseSubscription->getUser(); + $coaches['id'] = $user->getUserId(); + $coaches['name'] = $user->getCompleteName(); + $sessionCourseData['coaches'][] = $coaches; + } + + $sessionInfo['courses'][] = $sessionCourseData; + } + + return $sessionInfo; + } + + /** + * Register a sale. + * + * @param int $itemId The product ID + * @param int $paymentType The payment type + * @param string $couponId The coupon ID + * + * @return bool + */ + public function registerSale(int $itemId, int $paymentType, string $couponId = null) + { + if (!in_array( + $paymentType, + [ + self::PAYMENT_TYPE_PAYPAL, + self::PAYMENT_TYPE_TRANSFER, + self::PAYMENT_TYPE_CULQI, + self::PAYMENT_TYPE_TPV_REDSYS, + self::PAYMENT_TYPE_STRIPE, + self::PAYMENT_TYPE_TPV_CECABANK, + ] + ) + ) { + return false; + } + + $entityManager = Database::getManager(); + $item = $this->getItem($itemId); + + if (empty($item)) { + return false; + } + + $productName = ''; + if ($item['product_type'] == self::PRODUCT_TYPE_COURSE) { + $course = $entityManager->find('ChamiloCoreBundle:Course', $item['product_id']); + + if (empty($course)) { + return false; + } + + $productName = $course->getTitle(); + } elseif ($item['product_type'] == self::PRODUCT_TYPE_SESSION) { + $session = $entityManager->find('ChamiloCoreBundle:Session', $item['product_id']); + + if (empty($session)) { + return false; + } + + $productName = $session->getName(); + } + + if ($couponId != null) { + $coupon = $this->getCoupon($couponId, $item['product_type'], $item['product_id']); + } + + $couponDiscount = 0; + $priceWithoutDiscount = 0; + if ($coupon != null) { + if ($coupon['discount_type'] == self::COUPON_DISCOUNT_TYPE_AMOUNT) { + $couponDiscount = $coupon['discount_amount']; + } elseif ($coupon['discount_type'] == self::COUPON_DISCOUNT_TYPE_PERCENTAGE) { + $couponDiscount = ($item['price'] * $coupon['discount_amount']) / 100; + } + $priceWithoutDiscount = $item['price']; + } + $item['price'] = $item['price'] - $couponDiscount; + $price = $item['price']; + $priceWithoutTax = null; + $taxPerc = null; + $taxAmount = 0; + $taxEnable = $this->get('tax_enable') === 'true'; + $globalParameters = $this->getGlobalParameters(); + $taxAppliesTo = $globalParameters['tax_applies_to']; + + if ($taxEnable && + ( + $taxAppliesTo == self::TAX_APPLIES_TO_ALL || + ($taxAppliesTo == self::TAX_APPLIES_TO_ONLY_COURSE && $item['product_type'] == self::PRODUCT_TYPE_COURSE) || + ($taxAppliesTo == self::TAX_APPLIES_TO_ONLY_SESSION && $item['product_type'] == self::PRODUCT_TYPE_SESSION) + ) + ) { + $priceWithoutTax = $item['price']; + $globalTaxPerc = $globalParameters['global_tax_perc']; + $precision = 2; + $taxPerc = is_null($item['tax_perc']) ? $globalTaxPerc : $item['tax_perc']; + $taxAmount = round($priceWithoutTax * $taxPerc / 100, $precision); + $price = $priceWithoutTax + $taxAmount; + } + + $values = [ + 'reference' => $this->generateReference( + api_get_user_id(), + $item['product_type'], + $item['product_id'] + ), + 'currency_id' => $item['currency_id'], + 'date' => api_get_utc_datetime(), + 'user_id' => api_get_user_id(), + 'product_type' => $item['product_type'], + 'product_name' => $productName, + 'product_id' => $item['product_id'], + 'price' => $price, + 'price_without_tax' => $priceWithoutTax, + 'tax_perc' => $taxPerc, + 'tax_amount' => $taxAmount, + 'status' => self::SALE_STATUS_PENDING, + 'payment_type' => $paymentType, + 'price_without_discount' => $priceWithoutDiscount, + 'discount_amount' => $couponDiscount, + ]; + + return Database::insert(self::TABLE_SALE, $values); + } + + /** + * Update the sale reference. + * + * @return bool + */ + public function updateSaleReference(int $saleId, string $saleReference) + { + $saleTable = Database::get_main_table(self::TABLE_SALE); + + return Database::update( + $saleTable, + ['reference' => $saleReference], + ['id = ?' => $saleId] + ); + } + + /** + * Get sale data by ID. + * + * @return array + */ + public function getSale(int $saleId) + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_SALE), + [ + 'where' => ['id = ?' => (int) $saleId], + ], + 'first' + ); + } + + /** + * Get sale data by reference. + * + * @return array + */ + public function getSaleFromReference(string $reference) + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_SALE), + [ + 'where' => ['reference = ?' => $reference], + ], + 'first' + ); + } + + /** + * Get a list of sales by the payment type. + * + * @param int $paymentType The payment type to filter (default : Paypal) + * + * @return array The sale list. Otherwise return false + */ + public function getSaleListByPaymentType(int $paymentType = self::PAYMENT_TYPE_PAYPAL) + { + $saleTable = Database::get_main_table(self::TABLE_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + + return Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 's.*'], + "$saleTable s $innerJoins", + [ + 'where' => [ + 's.payment_type = ? AND s.status = ?' => [ + $paymentType, + self::SALE_STATUS_COMPLETED, + ], + ], + 'order' => 'id DESC', + ] + ); + } + + /** + * Get data of sales. + * + * @param int $saleId The sale id + * @param int $isService Check if a service + * + * @return array The sale data + */ + public function getDataSaleInvoice(int $saleId, int $isService) + { + if ($isService) { + $sale = $this->getServiceSale($saleId); + $sale['reference'] = $sale['reference']; + $sale['product_name'] = $sale['service']['name']; + $sale['payment_type'] = $sale['payment_type']; + $sale['user_id'] = $sale['buyer']['id']; + $sale['date'] = $sale['buy_date']; + } else { + $sale = $this->getSale($saleId); + } + + return $sale; + } + + /** + * Get data of invoice. + * + * @param int $saleId The sale id + * @param int $isService Check if a service + * + * @return array The invoice data + */ + public function getDataInvoice(int $saleId, int $isService) + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_INVOICE), + [ + 'where' => [ + 'sale_id = ? AND ' => (int) $saleId, + 'is_service = ?' => (int) $isService, + ], + ], + 'first' + ); + } + + /** + * Get invoice numbering. + * + * @param int $saleId The sale id + * @param int $isService Check if a service + * + * @return string + */ + public function getNumInvoice(int $saleId, int $isService) + { + $dataInvoice = $this->getDataInvoice($saleId, $isService); + if (empty($dataInvoice)) { + return '-'; + } + + return $dataInvoice['serie'].$dataInvoice['year'].'/'.$dataInvoice['num_invoice']; + } + + /** + * Get currency data by ID. + * + * @param int $currencyId The currency ID + * + * @return array + */ + public function getCurrency(int $currencyId) + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_CURRENCY), + [ + 'where' => ['id = ?' => $currencyId], + ], + 'first' + ); + } + + /** + * Complete sale process. Update sale status to completed. + * + * @return bool + */ + public function completeSale(int $saleId) + { + $sale = $this->getSale($saleId); + + if ($sale['status'] == self::SALE_STATUS_COMPLETED) { + return true; + } + + $saleIsCompleted = false; + switch ($sale['product_type']) { + case self::PRODUCT_TYPE_COURSE: + $course = api_get_course_info_by_id($sale['product_id']); + $saleIsCompleted = CourseManager::subscribeUser($sale['user_id'], $course['code']); + break; + case self::PRODUCT_TYPE_SESSION: + SessionManager::subscribeUsersToSession( + $sale['product_id'], + [$sale['user_id']], + api_get_session_visibility($sale['product_id']), + false + ); + + $saleIsCompleted = true; + break; + } + + if ($saleIsCompleted) { + $this->updateSaleStatus($sale['id'], self::SALE_STATUS_COMPLETED); + if ($this->get('invoicing_enable') === 'true') { + $this->setInvoice($sale['id']); + } + } + + return $saleIsCompleted; + } + + /** + * Update sale status to canceled. + * + * @param int $saleId The sale ID + */ + public function cancelSale(int $saleId) + { + $this->updateSaleStatus($saleId, self::SALE_STATUS_CANCELED); + } + + /** + * Get payment types. + */ + public function getPaymentTypes(bool $onlyActive = false): array + { + $types = [ + self::PAYMENT_TYPE_PAYPAL => 'PayPal', + self::PAYMENT_TYPE_TRANSFER => $this->get_lang('BankTransfer'), + self::PAYMENT_TYPE_CULQI => 'Culqi', + self::PAYMENT_TYPE_TPV_REDSYS => $this->get_lang('TpvPayment'), + self::PAYMENT_TYPE_STRIPE => 'Stripe', + self::PAYMENT_TYPE_TPV_CECABANK => $this->get_lang('TpvCecabank'), + ]; + + if (!$onlyActive) { + return $types; + } + + if ($this->get('paypal_enable') !== 'true') { + unset($types[BuyCoursesPlugin::PAYMENT_TYPE_PAYPAL]); + } + + if ($this->get('transfer_enable') !== 'true') { + unset($types[BuyCoursesPlugin::PAYMENT_TYPE_TRANSFER]); + } + + if ($this->get('culqi_enable') !== 'true') { + unset($types[BuyCoursesPlugin::PAYMENT_TYPE_CULQI]); + } + + if ($this->get('tpv_redsys_enable') !== 'true' + || !file_exists(api_get_path(SYS_PLUGIN_PATH).'buycourses/resources/apiRedsys.php') + ) { + unset($types[BuyCoursesPlugin::PAYMENT_TYPE_TPV_REDSYS]); + } + + if ($this->get('stripe_enable') !== 'true') { + unset($types[BuyCoursesPlugin::PAYMENT_TYPE_STRIPE]); + } + + if ($this->get('cecabank_enable') !== 'true') { + unset($types[BuyCoursesPlugin::PAYMENT_TYPE_TPV_CECABANK]); + } + + return $types; + } + + /** + * Register a invoice. + * + * @param int $saleId The sale ID + * @param int $isService The service type to filter (default : 0) + */ + public function setInvoice(int $saleId, int $isService = 0) + { + $invoiceTable = Database::get_main_table(self::TABLE_INVOICE); + $year = date('Y'); + + $globalParameters = $this->getGlobalParameters(); + $numInvoice = $globalParameters['next_number_invoice']; + $serie = $globalParameters['invoice_series']; + + if (empty($numInvoice)) { + $item = Database::select( + ['MAX(num_invoice) AS num_invoice'], + $invoiceTable, + [ + 'where' => ['year = ?' => $year], + ], + 'first' + ); + + $numInvoice = 1; + if ($item !== false) { + $numInvoice = (int) ($item['num_invoice'] + 1); + } + } else { + Database::update( + Database::get_main_table(self::TABLE_GLOBAL_CONFIG), + ['next_number_invoice' => 0], + ['id = ?' => 1] + ); + } + + Database::insert( + $invoiceTable, + [ + 'sale_id' => $saleId, + 'is_service' => $isService, + 'num_invoice' => $numInvoice, + 'year' => $year, + 'serie' => $serie, + 'date_invoice' => api_get_utc_datetime(), + ] + ); + + // Record invoice in the sales table + $table = Database::get_main_table(self::TABLE_SALE); + if (!empty($isService)) { + $table = Database::get_main_table(self::TABLE_SERVICES_SALE); + } + + Database::update( + $table, + ['invoice' => 1], + ['id = ?' => $saleId] + ); + } + + /** + * Get Tax's types. + * + * @return array + */ + public function getTaxAppliesTo() + { + return [ + self::TAX_APPLIES_TO_ALL => $this->get_lang('AllCoursesSessionsAndServices'), + self::TAX_APPLIES_TO_ONLY_COURSE => $this->get_lang('OnlyCourses'), + self::TAX_APPLIES_TO_ONLY_SESSION => $this->get_lang('OnlySessions'), + self::TAX_APPLIES_TO_ONLY_SERVICES => $this->get_lang('OnlyServices'), + ]; + } + + /** + * Get a list of sales by the status. + * + * @param int $status The status to filter + * + * @return array The sale list. Otherwise return false + */ + public function getSaleListByStatus(int $status = self::SALE_STATUS_PENDING) + { + $saleTable = Database::get_main_table(self::TABLE_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + + return Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 'u.email', 's.*'], + "$saleTable s $innerJoins", + [ + 'where' => ['s.status = ?' => $status], + 'order' => 'id DESC', + ] + ); + } + + /** + * Get the list statuses for sales. + * + * @throws Exception + * + * @return array + */ + public function getSaleListReport(string $dateStart = null, string $dateEnd = null) + { + $saleTable = Database::get_main_table(self::TABLE_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + $list = Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 'u.email', 's.*'], + "$saleTable s $innerJoins", + [ + 'order' => 'id DESC', + ] + ); + $listExportTemp = []; + $listExport = []; + $textStatus = null; + $paymentTypes = $this->getPaymentTypes(); + $productTypes = $this->getProductTypes(); + foreach ($list as $item) { + $statusSaleOrder = $item['status']; + switch ($statusSaleOrder) { + case 0: + $textStatus = $this->get_lang('SaleStatusPending'); + break; + case 1: + $textStatus = $this->get_lang('SaleStatusCompleted'); + break; + case -1: + $textStatus = $this->get_lang('SaleStatusCanceled'); + break; + } + $dateFilter = new DateTime($item['date']); + $listExportTemp[] = [ + 'id' => $item['id'], + 'reference' => $item['reference'], + 'status' => $textStatus, + 'status_filter' => $item['status'], + 'date' => $dateFilter->format('Y-m-d'), + 'order_time' => $dateFilter->format('H:i:s'), + 'price' => $item['iso_code'].' '.$item['price'], + 'product_type' => $productTypes[$item['product_type']], + 'product_name' => $item['product_name'], + 'payment_type' => $paymentTypes[$item['payment_type']], + 'complete_user_name' => api_get_person_name($item['firstname'], $item['lastname']), + 'email' => $item['email'], + ]; + } + $listExport[] = [ + get_lang('Number'), + $this->get_lang('OrderStatus'), + $this->get_lang('OrderDate'), + $this->get_lang('OrderTime'), + $this->get_lang('PaymentMethod'), + $this->get_lang('SalePrice'), + $this->get_lang('ProductType'), + $this->get_lang('ProductName'), + $this->get_lang('UserName'), + get_lang('Email'), + ]; + //Validation Export + $dateStart = strtotime($dateStart); + $dateEnd = strtotime($dateEnd); + foreach ($listExportTemp as $item) { + $dateFilter = strtotime($item['date']); + if (($dateFilter >= $dateStart) && ($dateFilter <= $dateEnd)) { + $listExport[] = [ + 'id' => $item['id'], + 'status' => $item['status'], + 'date' => $item['date'], + 'order_time' => $item['order_time'], + 'payment_type' => $item['payment_type'], + 'price' => $item['price'], + 'product_type' => $item['product_type'], + 'product_name' => $item['product_name'], + 'complete_user_name' => $item['complete_user_name'], + 'email' => $item['email'], + ]; + } + } + + return $listExport; + } + + /** + * Get the statuses for sales. + * + * @return array + */ + public function getSaleStatuses() + { + return [ + self::SALE_STATUS_CANCELED => $this->get_lang('SaleStatusCanceled'), + self::SALE_STATUS_PENDING => $this->get_lang('SaleStatusPending'), + self::SALE_STATUS_COMPLETED => $this->get_lang('SaleStatusCompleted'), + ]; + } + + /** + * Get the statuses for Payouts. + * + * @return array + */ + public function getPayoutStatuses() + { + return [ + self::PAYOUT_STATUS_CANCELED => $this->get_lang('PayoutStatusCanceled'), + self::PAYOUT_STATUS_PENDING => $this->get_lang('PayoutStatusPending'), + self::PAYOUT_STATUS_COMPLETED => $this->get_lang('PayoutStatusCompleted'), + ]; + } + + /** + * Get the list of product types. + * + * @return array + */ + public function getProductTypes() + { + return [ + self::PRODUCT_TYPE_COURSE => get_lang('Course'), + self::PRODUCT_TYPE_SESSION => get_lang('Session'), + ]; + } + + /** + * Get the list of service types. + * + * @return array + */ + public function getServiceTypes() + { + return [ + self::SERVICE_TYPE_USER => get_lang('User'), + self::SERVICE_TYPE_COURSE => get_lang('Course'), + self::SERVICE_TYPE_SESSION => get_lang('Session'), + self::SERVICE_TYPE_LP_FINAL_ITEM => get_lang('TemplateTitleCertificate'), + ]; + } + + /** + * Get the list of coupon status. + * + * @return array + */ + public function getCouponStatuses() + { + return [ + self::COUPON_STATUS_ACTIVE => $this->get_lang('CouponActive'), + self::COUPON_STATUS_DISABLE => $this->get_lang('CouponDisabled'), + ]; + } + + /** + * Get the list of coupon discount types. + * + * @return array + */ + public function getCouponDiscountTypes() + { + return [ + self::COUPON_DISCOUNT_TYPE_PERCENTAGE => $this->get_lang('CouponPercentage'), + self::COUPON_DISCOUNT_TYPE_AMOUNT => $this->get_lang('CouponAmount'), + ]; + } + + /** + * Generates a random text (used for order references). + * + * @param int $length Optional. Length of characters (defaults to 6) + * @param bool $lowercase Optional. Include lowercase characters + * @param bool $uppercase Optional. Include uppercase characters + * @param bool $numbers Optional. Include numbers + */ + public static function randomText( + int $length = 6, + bool $lowercase = true, + bool $uppercase = true, + bool $numbers = true + ): string { + $salt = $lowercase ? 'abchefghknpqrstuvwxyz' : ''; + $salt .= $uppercase ? 'ACDEFHKNPRSTUVWXYZ' : ''; + $salt .= $numbers ? (strlen($salt) ? '2345679' : '0123456789') : ''; + + if (strlen($salt) == 0) { + return ''; + } + + $str = ''; + + srand((float) microtime() * 1000000); + + for ($i = 0; $i < $length; $i++) { + $numbers = rand(0, strlen($salt) - 1); + $str .= substr($salt, $numbers, 1); + } + + return $str; + } + + /** + * Generates an order reference. + * + * @param int $userId The user ID + * @param int $productType The course/session type + * @param int $productId The course/session ID + */ + public function generateReference(int $userId, int $productType, int $productId): string + { + return vsprintf( + '%d-%d-%d-%s', + [$userId, $productType, $productId, self::randomText()] + ); + } + + /** + * Get a list of sales by the user. + * + * @param string $term The search term + * + * @return array The sale list. Otherwise return false + */ + public function getSaleListByUser(string $term) + { + $term = trim($term); + + if (empty($term)) { + return []; + } + + $saleTable = Database::get_main_table(self::TABLE_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + + return Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 'u.email', 's.*'], + "$saleTable s $innerJoins", + [ + 'where' => [ + 'u.username LIKE %?% OR ' => $term, + 'u.lastname LIKE %?% OR ' => $term, + 'u.firstname LIKE %?%' => $term, + ], + 'order' => 'id DESC', + ] + ); + } + + /** + * Get a list of sales by the user id. + * + * @param int $id The user id + * + * @return array The sale list. Otherwise return false + */ + public function getSaleListByUserId(int $id) + { + if (empty($id)) { + return []; + } + + $saleTable = Database::get_main_table(self::TABLE_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + + return Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 's.*'], + "$saleTable s $innerJoins", + [ + 'where' => [ + 'u.id = ? AND s.status = ?' => [(int) $id, self::SALE_STATUS_COMPLETED], + ], + 'order' => 'id DESC', + ] + ); + } + + /** + * Get a list of sales by date range. + * + * @return array The sale list. Otherwise return false + */ + public function getSaleListByDate(string $dateStart, string $dateEnd) + { + $dateStart = trim($dateStart); + $dateEnd = trim($dateEnd); + if (empty($dateStart)) { + return []; + } + if (empty($dateEnd)) { + return []; + } + $saleTable = Database::get_main_table(self::TABLE_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + + return Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 'u.email', 's.*'], + "$saleTable s $innerJoins", + [ + 'where' => [ + 's.date BETWEEN ? AND ' => $dateStart, + ' ? ' => $dateEnd, + ], + 'order' => 'id DESC', + ] + ); + } + + /** + * Get a list of sales by the user Email. + * + * @param string $term The search term + * + * @return array The sale list. Otherwise return false + */ + public function getSaleListByEmail(string $term) + { + $term = trim($term); + if (empty($term)) { + return []; + } + $saleTable = Database::get_main_table(self::TABLE_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + + return Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 'u.email', 's.*'], + "$saleTable s $innerJoins", + [ + 'where' => [ + 'u.email LIKE %?% ' => $term, + ], + 'order' => 'id DESC', + ] + ); + } + + /** + * Convert the course info to array with necessary course data for save item. + * + * @param array $defaultCurrency Optional. Currency data + * + * @return array + */ + public function getCourseForConfiguration(Course $course, array $defaultCurrency = null) + { + $courseItem = [ + 'item_id' => null, + 'course_id' => $course->getId(), + 'course_visual_code' => $course->getVisualCode(), + 'course_code' => $course->getCode(), + 'course_title' => $course->getTitle(), + 'course_directory' => $course->getDirectory(), + 'course_visibility' => $course->getVisibility(), + 'visible' => false, + 'currency' => empty($defaultCurrency) ? null : $defaultCurrency['iso_code'], + 'price' => 0.00, + 'tax_perc' => null, + ]; + + $item = $this->getItemByProduct($course->getId(), self::PRODUCT_TYPE_COURSE); + + if ($item !== false) { + $courseItem['item_id'] = $item['id']; + $courseItem['visible'] = true; + $courseItem['currency'] = $item['iso_code']; + $courseItem['price'] = $item['price']; + $courseItem['tax_perc'] = $item['tax_perc']; + } + + return $courseItem; + } + + /** + * Convert the session info to array with necessary session data for save item. + * + * @param Session $session The session data + * @param array $defaultCurrency Optional. Currency data + * + * @return array + */ + public function getSessionForConfiguration(Session $session, array $defaultCurrency = null) + { + $buyItemTable = Database::get_main_table(self::TABLE_ITEM); + $buyCurrencyTable = Database::get_main_table(self::TABLE_CURRENCY); + + $fakeItemFrom = " + $buyItemTable i + INNER JOIN $buyCurrencyTable c ON i.currency_id = c.id + "; + + $sessionItem = [ + 'item_id' => null, + 'session_id' => $session->getId(), + 'session_name' => $session->getName(), + 'session_visibility' => $session->getVisibility(), + 'session_display_start_date' => null, + 'session_display_end_date' => null, + 'visible' => false, + 'currency' => empty($defaultCurrency) ? null : $defaultCurrency['iso_code'], + 'price' => 0.00, + 'tax_perc' => null, + ]; + + $displayStartDate = $session->getDisplayStartDate(); + + if (!empty($displayStartDate)) { + $sessionItem['session_display_start_date'] = api_format_date( + $session->getDisplayStartDate()->format('Y-m-d h:i:s') + ); + } + + $displayEndDate = $session->getDisplayEndDate(); + + if (!empty($displayEndDate)) { + $sessionItem['session_display_end_date'] = api_format_date( + $session->getDisplayEndDate()->format('Y-m-d h:i:s'), + DATE_TIME_FORMAT_LONG_24H + ); + } + + $item = Database::select( + ['i.*', 'c.iso_code'], + $fakeItemFrom, + [ + 'where' => [ + 'i.product_id = ? AND ' => $session->getId(), + 'i.product_type = ?' => self::PRODUCT_TYPE_SESSION, + ], + ], + 'first' + ); + + if ($item !== false) { + $sessionItem['item_id'] = $item['id']; + $sessionItem['visible'] = true; + $sessionItem['currency'] = $item['iso_code']; + $sessionItem['price'] = $item['price']; + $sessionItem['tax_perc'] = $item['tax_perc']; + } + + return $sessionItem; + } + + /** + * Get all beneficiaries for a item. + * + * @param int $itemId The item ID + * + * @return array The beneficiaries. Otherwise return false + */ + public function getItemBeneficiaries(int $itemId) + { + $beneficiaryTable = Database::get_main_table(self::TABLE_ITEM_BENEFICIARY); + + return Database::select( + '*', + $beneficiaryTable, + [ + 'where' => [ + 'item_id = ?' => $itemId, + ], + ] + ); + } + + /** + * Delete a item with its beneficiaries. + * + * @param int $itemId The item ID + * + * @return int The number of affected rows. Otherwise return false + */ + public function deleteItem(int $itemId) + { + $itemTable = Database::get_main_table(self::TABLE_ITEM); + $affectedRows = Database::delete( + $itemTable, + ['id = ?' => $itemId] + ); + + if (!$affectedRows) { + return false; + } + + return $this->deleteItemBeneficiaries($itemId); + } + + /** + * Register a item. + * + * @param array $itemData The item data + * + * @return int The item ID. Otherwise return false + */ + public function registerItem(array $itemData) + { + $itemTable = Database::get_main_table(self::TABLE_ITEM); + + return Database::insert($itemTable, $itemData); + } + + /** + * Update the item data by product. + * + * @param array $itemData The item data to be updated + * @param int $productId The product ID + * @param int $productType The type of product + * + * @return int The number of affected rows. Otherwise return false + */ + public function updateItem(array $itemData, int $productId, int $productType) + { + $itemTable = Database::get_main_table(self::TABLE_ITEM); + + return Database::update( + $itemTable, + $itemData, + [ + 'product_id = ? AND ' => $productId, + 'product_type' => $productType, + ] + ); + } + + /** + * Remove all beneficiaries for a item. + * + * @param int $itemId The user ID + * + * @return int The number of affected rows. Otherwise return false + */ + public function deleteItemBeneficiaries(int $itemId) + { + $beneficiaryTable = Database::get_main_table(self::TABLE_ITEM_BENEFICIARY); + + return Database::delete( + $beneficiaryTable, + ['item_id = ?' => $itemId] + ); + } + + /** + * Register the beneficiaries users with the sale of item. + * + * @param int $itemId The item ID + * @param array $userIds The beneficiary user ID and Teachers commissions if enabled + */ + public function registerItemBeneficiaries(int $itemId, array $userIds) + { + $beneficiaryTable = Database::get_main_table(self::TABLE_ITEM_BENEFICIARY); + + $this->deleteItemBeneficiaries($itemId); + + foreach ($userIds as $userId => $commissions) { + Database::insert( + $beneficiaryTable, + [ + 'item_id' => $itemId, + 'user_id' => (int) $userId, + 'commissions' => (int) $commissions, + ] + ); + } + } + + /** + * Check if a course is valid for sale. + * + * @param Course $course The course + * + * @return bool + */ + public function isValidCourse(Course $course) + { + $courses = $this->getCourses(); + + foreach ($courses as $_c) { + if ($_c->getCode() === $course->getCode()) { + return true; + } + } + + return false; + } + + /** + * Gets the beneficiaries with commissions and current paypal accounts by sale. + * + * @param int $saleId The sale ID + * + * @return array + */ + public function getBeneficiariesBySale(int $saleId) + { + $sale = $this->getSale($saleId); + $item = $this->getItemByProduct($sale['product_id'], $sale['product_type']); + $itemBeneficiaries = $this->getItemBeneficiaries($item['id']); + + return $itemBeneficiaries; + } + + /** + * gets all payouts. + * + * @param int $status - default 0 - pending + * @param int $payoutId - for get an individual payout if want all then false + * + * @return array + */ + public function getPayouts( + int $status = self::PAYOUT_STATUS_PENDING, + int $payoutId = 0, + int $userId = 0 + ) { + $condition = ($payoutId) ? 'AND p.id = '.($payoutId) : ''; + $condition2 = ($userId) ? ' AND p.user_id = '.($userId) : ''; + $typeResult = ($condition) ? 'first' : 'all'; + $payoutsTable = Database::get_main_table(self::TABLE_PAYPAL_PAYOUTS); + $saleTable = Database::get_main_table(self::TABLE_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $extraFieldTable = Database::get_main_table(TABLE_EXTRA_FIELD); + $extraFieldValues = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES); + + $paypalExtraField = Database::select( + "*", + $extraFieldTable, + [ + 'where' => ['variable = ?' => 'paypal'], + ], + 'first' + ); + + if (!$paypalExtraField) { + return false; + } + + $innerJoins = " + INNER JOIN $userTable u ON p.user_id = u.id + INNER JOIN $saleTable s ON s.id = p.sale_id + INNER JOIN $currencyTable c ON s.currency_id = c.id + LEFT JOIN $extraFieldValues efv ON p.user_id = efv.item_id + AND field_id = ".((int) $paypalExtraField['id'])." + "; + + $payouts = Database::select( + "p.* , u.firstname, u.lastname, efv.value as paypal_account, s.reference as sale_reference, s.price as item_price, c.iso_code", + "$payoutsTable p $innerJoins", + [ + 'where' => ['p.status = ? '.$condition.' '.$condition2 => $status], + ], + $typeResult + ); + + return $payouts; + } + + /** + * Verify if the beneficiary have a paypal account. + * + * @return true if the user have a paypal account, false if not + */ + public function verifyPaypalAccountByBeneficiary(int $userId) + { + $extraFieldTable = Database::get_main_table(TABLE_EXTRA_FIELD); + $extraFieldValues = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES); + + $paypalExtraField = Database::select( + '*', + $extraFieldTable, + [ + 'where' => ['variable = ?' => 'paypal'], + ], + 'first' + ); + + if (!$paypalExtraField) { + return false; + } + + $paypalFieldId = $paypalExtraField['id']; + $paypalAccount = Database::select( + 'value', + $extraFieldValues, + [ + 'where' => ['field_id = ? AND item_id = ?' => [(int) $paypalFieldId, $userId]], + ], + 'first' + ); + + if (!$paypalAccount) { + return false; + } + + if ($paypalAccount['value'] === '') { + return false; + } + + return true; + } + + /** + * Register the users payouts. + * + * @return array + */ + public function storePayouts(int $saleId) + { + $payoutsTable = Database::get_main_table(self::TABLE_PAYPAL_PAYOUTS); + $platformCommission = $this->getPlatformCommission(); + + $sale = $this->getSale($saleId); + $commission = (int) $platformCommission['commission']; + $teachersCommission = number_format( + (floatval($sale['price']) * $commission) / 100, + 2 + ); + + $beneficiaries = $this->getBeneficiariesBySale($saleId); + foreach ($beneficiaries as $beneficiary) { + $beneficiaryCommission = (int) $beneficiary['commissions']; + Database::insert( + $payoutsTable, + [ + 'date' => $sale['date'], + 'payout_date' => api_get_utc_datetime(), + 'sale_id' => $saleId, + 'user_id' => $beneficiary['user_id'], + 'commission' => number_format( + (floatval($teachersCommission) * $beneficiaryCommission) / 100, + 2 + ), + 'status' => self::PAYOUT_STATUS_PENDING, + ] + ); + } + } + + /** + * Register the users payouts. + * + * @param int $saleId The subscription sale ID + * + * @return array + */ + public function storeSubscriptionPayouts(int $saleId) + { + $payoutsTable = Database::get_main_table(self::TABLE_PAYPAL_PAYOUTS); + $platformCommission = $this->getPlatformCommission(); + + $sale = $this->getSubscriptionSale($saleId); + $commission = (int) $platformCommission['commission']; + $teachersCommission = number_format( + (floatval($sale['price']) * $commission) / 100, + 2 + ); + + $beneficiaries = $this->getBeneficiariesBySale($saleId); + foreach ($beneficiaries as $beneficiary) { + $beneficiaryCommission = (int) $beneficiary['commissions']; + Database::insert( + $payoutsTable, + [ + 'date' => $sale['date'], + 'payout_date' => api_get_utc_datetime(), + 'sale_id' => $saleId, + 'user_id' => $beneficiary['user_id'], + 'commission' => number_format( + (floatval($teachersCommission) * $beneficiaryCommission) / 100, + 2 + ), + 'status' => self::PAYOUT_STATUS_PENDING, + ] + ); + } + } + + /** + * Register the users payouts. + * + * @param int $payoutId The payout ID + * @param int $status The status to set (-1 to cancel, 0 to pending, 1 to completed) + * + * @return array + */ + public function setStatusPayouts(int $payoutId, int $status) + { + $payoutsTable = Database::get_main_table(self::TABLE_PAYPAL_PAYOUTS); + + Database::update( + $payoutsTable, + ['status' => (int) $status], + ['id = ?' => (int) $payoutId] + ); + } + + /** + * Gets the stored platform commission params. + * + * @return array + */ + public function getPlatformCommission() + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_COMMISSION), + ['id = ?' => 1], + 'first' + ); + } + + /** + * Update the platform commission. + * + * @param array $params platform commission + * + * @return int The number of affected rows. Otherwise return false + */ + public function updateCommission(array $params) + { + $commissionTable = Database::get_main_table(self::TABLE_COMMISSION); + + return Database::update( + $commissionTable, + ['commission' => (int) $params['commission']] + ); + } + + /** + * Register additional service. + * + * @param array $service params + * + * @return mixed response + */ + public function storeService(array $service) + { + $servicesTable = Database::get_main_table(self::TABLE_SERVICES); + + $return = Database::insert( + $servicesTable, + [ + 'name' => Security::remove_XSS($service['name']), + 'description' => Security::remove_XSS($service['description']), + 'price' => $service['price'], + 'tax_perc' => $service['tax_perc'] != '' ? (int) $service['tax_perc'] : null, + 'duration_days' => (int) $service['duration_days'], + 'applies_to' => (int) $service['applies_to'], + 'owner_id' => (int) $service['owner_id'], + 'visibility' => (int) $service['visibility'], + 'image' => '', + 'video_url' => $service['video_url'], + 'service_information' => $service['service_information'], + ] + ); + + if ($return && !empty($service['picture_crop_image_base_64']) && + !empty($service['picture_crop_result']) + ) { + $img = str_replace('data:image/png;base64,', '', $service['picture_crop_image_base_64']); + $img = str_replace(' ', '+', $img); + $data = base64_decode($img); + $file = api_get_path(SYS_PLUGIN_PATH).'buycourses/uploads/services/images/simg-'.$return.'.png'; + file_put_contents($file, $data); + + Database::update( + $servicesTable, + ['image' => 'simg-'.$return.'.png'], + ['id = ?' => $return] + ); + } + + return $return; + } + + /** + * update a service. + * + * @return mixed response + */ + public function updateService(array $service, int $id) + { + $servicesTable = Database::get_main_table(self::TABLE_SERVICES); + if (!empty($service['picture_crop_image_base_64'])) { + $img = str_replace('data:image/png;base64,', '', $service['picture_crop_image_base_64']); + $img = str_replace(' ', '+', $img); + $data = base64_decode($img); + $file = api_get_path(SYS_PLUGIN_PATH).'buycourses/uploads/services/images/simg-'.$id.'.png'; + file_put_contents($file, $data); + } + + return Database::update( + $servicesTable, + [ + 'name' => Security::remove_XSS($service['name']), + 'description' => Security::remove_XSS($service['description']), + 'price' => $service['price'], + 'tax_perc' => $service['tax_perc'] != '' ? (int) $service['tax_perc'] : null, + 'duration_days' => (int) $service['duration_days'], + 'applies_to' => (int) $service['applies_to'], + 'owner_id' => (int) $service['owner_id'], + 'visibility' => (int) $service['visibility'], + 'image' => 'simg-'.$id.'.png', + 'video_url' => $service['video_url'], + 'service_information' => $service['service_information'], + ], + ['id = ?' => $id] + ); + } + + /** + * Remove a service. + * + * @param int $id The transfer account ID + * + * @return int Rows affected. Otherwise return false + */ + public function deleteService(int $id) + { + Database::delete( + Database::get_main_table(self::TABLE_SERVICES_SALE), + ['service_id = ?' => $id] + ); + + return Database::delete( + Database::get_main_table(self::TABLE_SERVICES), + ['id = ?' => $id] + ); + } + + /** + * @param array|null $coupon Array with at least 'discount_type' and 'discount_amount' elements + */ + public function setPriceSettings(array &$product, int $productType, array $coupon = null): bool + { + if (empty($product)) { + return false; + } + + $taxPerc = null; + $product['has_coupon'] = $coupon != null ? true : false; + $couponDiscount = 0; + if ($coupon != null) { + if ($coupon['discount_type'] == self::COUPON_DISCOUNT_TYPE_AMOUNT) { + $couponDiscount = $coupon['discount_amount']; + } elseif ($coupon['discount_type'] == self::COUPON_DISCOUNT_TYPE_PERCENTAGE) { + $couponDiscount = ($product['price'] * $coupon['discount_amount']) / 100; + } + $product['price_without_discount'] = $product['price']; + } + $product['discount_amount'] = $couponDiscount; + $product['price'] = $product['price'] - $couponDiscount; + $priceWithoutTax = $product['price']; + $product['total_price'] = $product['price']; + $product['tax_amount'] = 0; + + if ($this->checkTaxEnabledInProduct($productType)) { + if (is_null($product['tax_perc'])) { + $globalParameters = $this->getGlobalParameters(); + $globalTaxPerc = $globalParameters['global_tax_perc']; + $taxPerc = $globalTaxPerc; + } else { + $taxPerc = $product['tax_perc']; + } + //$taxPerc = is_null($product['tax_perc']) ? $globalTaxPerc : $product['tax_perc']; + + $taxAmount = round($priceWithoutTax * $taxPerc / 100, 2); + $product['tax_amount'] = $taxAmount; + $priceWithTax = $priceWithoutTax + $taxAmount; + $product['total_price'] = $priceWithTax; + } + + $product['tax_perc_show'] = $taxPerc; + $product['price_formatted'] = $this->getPriceWithCurrencyFromIsoCode( + $product['price'], + $product['iso_code'] + ); + + $product['tax_amount_formatted'] = number_format($product['tax_amount'], 2); + + $product['total_price_formatted'] = $this->getPriceWithCurrencyFromIsoCode( + $product['total_price'], + $product['iso_code'] + ); + + if ($coupon != null) { + $product['discount_amount_formatted'] = $this->getPriceWithCurrencyFromIsoCode( + $product['discount_amount'], + $product['iso_code'] + ); + + $product['price_without_discount_formatted'] = $this->getPriceWithCurrencyFromIsoCode( + $product['price_without_discount'], + $product['iso_code'] + ); + } + + return true; + } + + /** + * @param array $coupon + * + * @return array + */ + public function getService(int $id, array $coupon = null) + { + if (empty($id)) { + return []; + } + + $servicesTable = Database::get_main_table(self::TABLE_SERVICES); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $conditions = ['WHERE' => ['s.id = ?' => $id]]; + $showData = 'first'; + $innerJoins = "INNER JOIN $userTable u ON s.owner_id = u.id"; + $currency = $this->getSelectedCurrency(); + $isoCode = $currency['iso_code']; + $service = Database::select( + "s.*, '$isoCode' as currency, u.firstname, u.lastname", + "$servicesTable s $innerJoins", + $conditions, + $showData + ); + + $service['iso_code'] = $isoCode; + $globalParameters = $this->getGlobalParameters(); + + $this->setPriceSettings($service, self::TAX_APPLIES_TO_ONLY_SERVICES, $coupon); + + $service['tax_name'] = $globalParameters['tax_name']; + $service['tax_enable'] = $this->checkTaxEnabledInProduct(self::TAX_APPLIES_TO_ONLY_SERVICES); + $service['owner_name'] = api_get_person_name($service['firstname'], $service['lastname']); + $service['image'] = !empty($service['image']) ? api_get_path(WEB_PLUGIN_PATH).'buycourses/uploads/services/images/'.$service['image'] : null; + + return $service; + } + + /** + * List additional services. + * + * @return array + */ + public function getAllServices() + { + $servicesTable = Database::get_main_table(self::TABLE_SERVICES); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + + $innerJoins = "INNER JOIN $userTable u ON s.owner_id = u.id"; + $return = Database::select( + 's.id', + "$servicesTable s $innerJoins", + [], + 'all' + ); + + $services = []; + foreach ($return as $index => $service) { + $services[$index] = $this->getService($service['id']); + } + + return $services; + } + + /** + * List additional services. + * + * @return array|int + */ + public function getServices(int $start, int $end, string $typeResult = 'all') + { + $servicesTable = Database::get_main_table(self::TABLE_SERVICES); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + + $conditions = ['limit' => "$start, $end"]; + $innerJoins = "INNER JOIN $userTable u ON s.owner_id = u.id"; + $return = Database::select( + 's.id', + "$servicesTable s $innerJoins", + $conditions, + $typeResult + ); + + if ($typeResult === 'count') { + return $return; + } + + $services = []; + foreach ($return as $index => $service) { + $services[$index] = $this->getService($service['id']); + } + + return $services; + } + + /** + * Get the statuses for sales. + * + * @return array + */ + public function getServiceSaleStatuses() + { + return [ + self::SERVICE_STATUS_CANCELLED => $this->get_lang('SaleStatusCancelled'), + self::SERVICE_STATUS_PENDING => $this->get_lang('SaleStatusPending'), + self::SERVICE_STATUS_COMPLETED => $this->get_lang('SaleStatusCompleted'), + ]; + } + + /** + * List services sales. + * + * @param int $buyerId buyer id + * @param int $status status + * @param int $nodeType The node Type ( User = 1 , Course = 2 , Session = 3 ) + * @param int $nodeId the nodeId + * + * @return array + */ + public function getServiceSales( + int $buyerId = 0, + int $status = 0, + int $nodeType = 0, + int $nodeId = 0 + ) { + $conditions = null; + $groupBy = ''; + + $servicesTable = Database::get_main_table(self::TABLE_SERVICES); + $servicesSaleTable = Database::get_main_table(self::TABLE_SERVICES_SALE); + + $defaultOrder = 'id ASC'; + + if (!empty($buyerId)) { + $conditions = ['WHERE' => ['ss.buyer_id = ?' => $buyerId], 'ORDER' => $defaultOrder]; + } + + if (is_numeric($status)) { + $conditions = ['WHERE' => ['ss.status = ?' => $status], 'ORDER' => $defaultOrder]; + } + + if ($buyerId) { + $conditions = ['WHERE' => ['ss.buyer_id = ?' => [$buyerId]], 'ORDER' => $defaultOrder]; + } + + if ($nodeType && $nodeId) { + $conditions = [ + 'WHERE' => ['ss.node_type = ? AND ss.node_id = ?' => [$nodeType, $nodeId]], + 'ORDER' => $defaultOrder, + ]; + } + + if ($nodeType && $nodeId && $buyerId && is_numeric($status)) { + $conditions = [ + 'WHERE' => [ + 'ss.node_type = ? AND ss.node_id = ? AND ss.buyer_id = ? AND ss.status = ?' => [ + $nodeType, + $nodeId, + $buyerId, + $status, + ], + ], + 'ORDER' => $defaultOrder, + ]; + } + + $innerJoins = "INNER JOIN $servicesTable s ON ss.service_id = s.id $groupBy"; + $return = Database::select( + 'DISTINCT ss.id ', + "$servicesSaleTable ss $innerJoins", + $conditions + //, "all", null, true + ); + + $list = []; + foreach ($return as $service) { + $list[] = $this->getServiceSale($service['id']); + } + + return $list; + } + + /** + * @param int $id service sale id + * + * @return array + */ + public function getServiceSale(int $id) + { + $servicesTable = Database::get_main_table(self::TABLE_SERVICES); + $servicesSaleTable = Database::get_main_table(self::TABLE_SERVICES_SALE); + + if (empty($id)) { + return []; + } + + $conditions = ['WHERE' => ['ss.id = ?' => $id]]; + $innerJoins = "INNER JOIN $servicesTable s ON ss.service_id = s.id "; + $currency = $this->getSelectedCurrency(); + $isoCode = $currency['iso_code']; + + $servicesSale = Database::select( + 'ss.*, s.name, s.description, s.price as service_price, s.duration_days, s.applies_to, s.owner_id, s.visibility, s.image', + "$servicesSaleTable ss $innerJoins", + $conditions, + 'first' + ); + $owner = api_get_user_info($servicesSale['owner_id']); + $buyer = api_get_user_info($servicesSale['buyer_id']); + + $servicesSale['service']['id'] = $servicesSale['service_id']; + $servicesSale['service']['name'] = $servicesSale['name']; + $servicesSale['service']['description'] = $servicesSale['description']; + $servicesSale['service']['price'] = $servicesSale['service_price']; + $servicesSale['service']['currency'] = $isoCode; + + $servicesSale['service']['total_price'] = $this->getPriceWithCurrencyFromIsoCode( + $servicesSale['price'], + $isoCode + ); + + $servicesSale['service']['duration_days'] = $servicesSale['duration_days']; + $servicesSale['service']['applies_to'] = $servicesSale['applies_to']; + $servicesSale['service']['owner']['id'] = $servicesSale['owner_id']; + $servicesSale['service']['owner']['name'] = api_get_person_name($owner['firstname'], $owner['lastname']); + $servicesSale['service']['visibility'] = $servicesSale['visibility']; + $servicesSale['service']['image'] = $servicesSale['image']; + $servicesSale['item'] = $this->getService($servicesSale['service_id']); + $servicesSale['buyer']['id'] = $buyer['user_id']; + $servicesSale['buyer']['name'] = api_get_person_name($buyer['firstname'], $buyer['lastname']); + $servicesSale['buyer']['username'] = $buyer['username']; + + return $servicesSale; + } + + /** + * Update service sale status to cancelled. + * + * @param int $serviceSaleId The sale ID + * + * @return bool + */ + public function cancelServiceSale(int $serviceSaleId) + { + $this->updateServiceSaleStatus( + $serviceSaleId, + self::SERVICE_STATUS_CANCELLED + ); + + return true; + } + + /** + * Complete service sale process. Update service sale status to completed. + * + * @param int $serviceSaleId The service sale ID + * + * @return bool + */ + public function completeServiceSale(int $serviceSaleId) + { + $serviceSale = $this->getServiceSale($serviceSaleId); + if ($serviceSale['status'] == self::SERVICE_STATUS_COMPLETED) { + return true; + } + + $this->updateServiceSaleStatus( + $serviceSaleId, + self::SERVICE_STATUS_COMPLETED + ); + + if ($this->get('invoicing_enable') === 'true') { + $this->setInvoice($serviceSaleId, 1); + } + + return true; + } + + /** + * Lists current service details. + * + * @return array|int + */ + public function getCatalogServiceList( + int $start, + int $end, + string $name = null, + int $min = 0, + int $max = 0, + $appliesTo = '', + string $typeResult = 'all' + ) { + $servicesTable = Database::get_main_table(self::TABLE_SERVICES); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + + $whereConditions = [ + 's.visibility <> ? ' => 0, + ]; + + if (!empty($name)) { + $whereConditions['AND s.name LIKE %?%'] = $name; + } + + if (!empty($min)) { + $whereConditions['AND s.price >= ?'] = $min; + } + + if (!empty($max)) { + $whereConditions['AND s.price <= ?'] = $max; + } + + if (!$appliesTo == '') { + $whereConditions['AND s.applies_to = ?'] = $appliesTo; + } + + $innerJoins = "INNER JOIN $userTable u ON s.owner_id = u.id"; + $return = Database::select( + 's.*', + "$servicesTable s $innerJoins", + ['WHERE' => $whereConditions, 'limit' => "$start, $end"], + $typeResult + ); + + if ($typeResult === 'count') { + return $return; + } + + $services = []; + foreach ($return as $index => $service) { + $services[$index] = $this->getService($service['id']); + } + + return $services; + } + + /** + * Register a Service sale. + * + * @param int $serviceId The service ID + * @param int $paymentType The payment type + * @param int $infoSelect The ID for Service Type + * + * @return bool + */ + public function registerServiceSale(int $serviceId, int $paymentType, int $infoSelect, int $couponId = null) + { + if (!in_array( + $paymentType, + [self::PAYMENT_TYPE_PAYPAL, self::PAYMENT_TYPE_TRANSFER, self::PAYMENT_TYPE_CULQI] + ) + ) { + return false; + } + + $userId = api_get_user_id(); + $service = $this->getService($serviceId); + + if (empty($service)) { + return false; + } + + if ($couponId != null) { + $coupon = $this->getCouponService($couponId, $serviceId); + } + + $couponDiscount = 0; + $priceWithoutDiscount = 0; + if ($coupon != null) { + if ($coupon['discount_type'] == self::COUPON_DISCOUNT_TYPE_AMOUNT) { + $couponDiscount = $coupon['discount_amount']; + } elseif ($coupon['discount_type'] == self::COUPON_DISCOUNT_TYPE_PERCENTAGE) { + $couponDiscount = ($service['price'] * $coupon['discount_amount']) / 100; + } + $priceWithoutDiscount = $service['price']; + } + $service['price'] = $service['price'] - $couponDiscount; + $currency = $this->getSelectedCurrency(); + $price = $service['price']; + $priceWithoutTax = null; + $taxPerc = null; + $taxEnable = $this->get('tax_enable') === 'true'; + $globalParameters = $this->getGlobalParameters(); + $taxAppliesTo = $globalParameters['tax_applies_to']; + $taxAmount = 0; + + if ($taxEnable && + ($taxAppliesTo == self::TAX_APPLIES_TO_ALL || $taxAppliesTo == self::TAX_APPLIES_TO_ONLY_SERVICES) + ) { + $priceWithoutTax = $service['price']; + $globalTaxPerc = $globalParameters['global_tax_perc']; + $precision = 2; + $taxPerc = is_null($service['tax_perc']) ? $globalTaxPerc : $service['tax_perc']; + $taxAmount = round($priceWithoutTax * $taxPerc / 100, $precision); + $price = $priceWithoutTax + $taxAmount; + } + + $values = [ + 'service_id' => $serviceId, + 'reference' => $this->generateReference( + $userId, + $service['applies_to'], + $infoSelect + ), + 'currency_id' => $currency['id'], + 'price' => $price, + 'price_without_tax' => $priceWithoutTax, + 'tax_perc' => $taxPerc, + 'tax_amount' => $taxAmount, + 'node_type' => $service['applies_to'], + 'node_id' => $infoSelect, + 'buyer_id' => $userId, + 'buy_date' => api_get_utc_datetime(), + 'date_start' => api_get_utc_datetime(), + 'date_end' => date_format( + date_add( + date_create(api_get_utc_datetime()), + date_interval_create_from_date_string($service['duration_days'].' days') + ), + 'Y-m-d H:i:s' + ), + 'status' => self::SERVICE_STATUS_PENDING, + 'payment_type' => $paymentType, + 'price_without_discount' => $priceWithoutDiscount, + 'discount_amount' => $couponDiscount, + ]; + + $returnedServiceSaleId = Database::insert(self::TABLE_SERVICES_SALE, $values); + + return $returnedServiceSaleId; + } + + /** + * Save Culqi configuration params. + * + * @return int Rows affected. Otherwise return false + */ + public function saveCulqiParameters(array $params) + { + return Database::update( + Database::get_main_table(self::TABLE_CULQI), + [ + 'commerce_code' => $params['commerce_code'], + 'api_key' => $params['api_key'], + 'integration' => $params['integration'], + ], + ['id = ?' => 1] + ); + } + + /** + * Gets the stored Culqi params. + * + * @return array + */ + public function getCulqiParams() + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_CULQI), + ['id = ?' => 1], + 'first' + ); + } + + /** + * Save Cecabank configuration params. + * + * @return array + */ + public function saveCecabankParameters(array $params) + { + return Database::update( + Database::get_main_table(self::TABLE_TPV_CECABANK), + [ + 'crypto_key' => $params['crypto_key'], + 'merchant_id' => $params['merchart_id'], + 'acquirer_bin' => $params['acquirer_bin'], + 'terminal_id' => $params['terminal_id'], + 'cypher' => $params['cypher'], + 'exponent' => $params['exponent'], + 'supported_payment' => $params['supported_payment'], + 'url' => $params['url'], + ], + ['id = ?' => 1] + ); + } + + /** + * Gets the stored Cecabank params. + * + * @return array + */ + public function getCecabankParams() + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_TPV_CECABANK), + ['id = ?' => 1], + 'first' + ); + } + + /** + * Save Global Parameters. + * + * @return int Rows affected. Otherwise return false + */ + public function saveGlobalParameters(array $params) + { + $sqlParams = [ + 'terms_and_conditions' => $params['terms_and_conditions'], + 'sale_email' => $params['sale_email'], + ]; + + if ($this->get('tax_enable') === 'true') { + $sqlParams['global_tax_perc'] = $params['global_tax_perc']; + $sqlParams['tax_applies_to'] = $params['tax_applies_to']; + $sqlParams['tax_name'] = $params['tax_name']; + } + + if ($this->get('invoicing_enable') === 'true') { + $sqlParams['seller_name'] = $params['seller_name']; + $sqlParams['seller_id'] = $params['seller_id']; + $sqlParams['seller_address'] = $params['seller_address']; + $sqlParams['seller_email'] = $params['seller_email']; + $sqlParams['next_number_invoice'] = $params['next_number_invoice']; + $sqlParams['invoice_series'] = $params['invoice_series']; + } + + return Database::update( + Database::get_main_table(self::TABLE_GLOBAL_CONFIG), + $sqlParams, + ['id = ?' => 1] + ); + } + + /** + * get Global Parameters. + * + * @return array + */ + public function getGlobalParameters() + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_GLOBAL_CONFIG), + ['id = ?' => 1], + 'first' + ); + } + + /** + * @return bool + */ + public function checkTaxEnabledInProduct(int $productType) + { + if (empty($this->get('tax_enable') === 'true')) { + return false; + } + + $globalParameters = $this->getGlobalParameters(); + $taxAppliesTo = $globalParameters['tax_applies_to']; + if ($taxAppliesTo == self::TAX_APPLIES_TO_ALL) { + return true; + } + + if ($taxAppliesTo == $productType) { + return true; + } + + return false; + } + + /** + * Get the path. + * + * @param string $var path variable + * + * @return string path + */ + public function getPath($var) + { + $pluginPath = api_get_path(WEB_PLUGIN_PATH).'buycourses/'; + $paths = [ + 'SERVICE_IMAGES' => $pluginPath.'uploads/services/images/', + 'SRC' => $pluginPath.'src/', + 'VIEW' => $pluginPath.'view/', + 'UPLOADS' => $pluginPath.'uploads/', + 'LANGUAGES' => $pluginPath.'lang/', + 'RESOURCES' => $pluginPath.'resources/', + 'RESOURCES_IMG' => $pluginPath.'resources/img/', + 'RESOURCES_CSS' => $pluginPath.'resources/css/', + 'RESOURCES_JS' => $pluginPath.'resources/js/', + ]; + + return $paths[$var]; + } + + /** + * @return array + */ + public function getBuyCoursePluginPrice(Session $session) + { + // start buycourse validation + // display the course price and buy button if the buycourses plugin is enabled and this course is configured + $isThisCourseInSale = $this->buyCoursesForGridCatalogValidator($session->getId(), self::PRODUCT_TYPE_SESSION); + $return = []; + + if ($isThisCourseInSale) { + // set the Price label + $return['html'] = $isThisCourseInSale['html']; + // set the Buy button instead register. + if ($isThisCourseInSale['verificator']) { + $return['buy_button'] = $this->returnBuyCourseButton($session->getId(), self::PRODUCT_TYPE_SESSION); + } + } + // end buycourse validation + return $return; + } + + /** + * Register a coupon sale. + * + * @param int $saleId The sale ID + * @param int $couponId The coupon ID + * + * @return int + */ + public function registerCouponSale(int $saleId, int $couponId) + { + $sale = $this->getSale($saleId); + + if (empty($sale)) { + return false; + } + + $values = [ + 'coupon_id' => $couponId, + 'sale_id' => $saleId, + ]; + + return Database::insert(self::TABLE_COUPON_SALE, $values); + } + + /** + * Register a coupon service sale. + * + * @param int $saleId The sale ID + * @param int $couponId The coupon ID + * + * @return int + */ + public function registerCouponServiceSale(int $saleId, int $couponId) + { + $sale = $this->getSale($saleId); + + if (empty($sale)) { + return false; + } + + $values = [ + 'coupon_id' => $couponId, + 'service_sale_id' => $saleId, + ]; + + return Database::insert(self::TABLE_COUPON_SERVICE_SALE, $values); + } + + /** + * Register a coupon sale. + * + * @param int $saleId The sale ID + * @param int $couponId The coupon ID + * + * @return int + */ + public function registerCouponSubscriptionSale(int $saleId, int $couponId) + { + $sale = $this->getSubscriptionSale($saleId); + + if (empty($sale)) { + return false; + } + + $values = [ + 'coupon_id' => (int) $couponId, + 'sale_id' => (int) $saleId, + ]; + + return Database::insert(self::TABLE_COUPON_SUBSCRIPTION_SALE, $values); + } + + /** + * Add a new coupon. + */ + public function addNewCoupon(array $coupon): bool + { + $couponId = $this->registerCoupon($coupon); + if ($couponId) { + if (isset($coupon['courses'])) { + foreach ($coupon['courses'] as $course) { + $this->registerCouponItem($couponId, self::PRODUCT_TYPE_COURSE, $course); + } + } + + if (isset($coupon['sessions'])) { + foreach ($coupon['sessions'] as $session) { + $this->registerCouponItem($couponId, self::PRODUCT_TYPE_SESSION, $session); + } + } + + if (isset($coupon['services'])) { + foreach ($coupon['services'] as $service) { + $this->registerCouponService($couponId, $service); + } + } + + return true; + } else { + Display::addFlash( + Display::return_message( + $this->get_lang('CouponErrorInsert'), + 'error', + false + ) + ); + + return false; + } + } + + /** + * Add a new coupon. + * + * @return bool + */ + public function updateCouponData(array $coupon) + { + $this->updateCoupon($coupon); + $this->deleteCouponItemsByCoupon(self::PRODUCT_TYPE_COURSE, $coupon['id']); + $this->deleteCouponItemsByCoupon(self::PRODUCT_TYPE_SESSION, $coupon['id']); + $this->deleteCouponServicesByCoupon($coupon['id']); + + if (isset($coupon['courses'])) { + foreach ($coupon['courses'] as $course) { + $this->registerCouponItem($coupon['id'], self::PRODUCT_TYPE_COURSE, $course); + } + } + + if (isset($coupon['sessions'])) { + foreach ($coupon['sessions'] as $session) { + $this->registerCouponItem($coupon['id'], self::PRODUCT_TYPE_SESSION, $session); + } + } + + if (isset($coupon['services'])) { + foreach ($coupon['services'] as $service) { + $this->registerCouponService($coupon['id'], $service); + } + } + + return true; + } + + /** + * Update coupons delivered. + * + * @param int $couponId The coupon ID + * + * @return bool + */ + public function updateCouponDelivered(int $couponId) + { + $couponTable = Database::get_main_table(self::TABLE_COUPON); + + $sql = "UPDATE $couponTable + SET delivered = delivered+1 + WHERE id = $couponId"; + + Database::query($sql); + } + + /** + * Get coupon info. + * + * @param int $couponId The coupon ID + * + * @return array The coupon data + */ + public function getCouponInfo(int $couponId) + { + $coupon = $this->getDataCoupon($couponId); + + $couponRelCourses = $this->getItemsCoupons($couponId, self::PRODUCT_TYPE_COURSE); + $couponRelSessions = $this->getItemsCoupons($couponId, self::PRODUCT_TYPE_SESSION); + $couponRelServices = $this->getServicesCoupons($couponId); + + $coupon['courses'] = $couponRelCourses; + $coupon['sessions'] = $couponRelSessions; + $coupon['services'] = $couponRelServices; + + return $coupon; + } + + /** + * Get a list of coupons. + * + * @param int $status The coupons activation status + * + * @return array Coupons data + */ + public function getCouponsListByStatus(int $status) + { + $coupons = $this->getDataCoupons($status); + + return $coupons; + } + + /** + * Get the coupon data. + * + * @return array The coupon data + */ + public function getCoupon(int $couponId, int $productType, int $productId) + { + $coupon = $this->getDataCoupon($couponId, $productType, $productId); + + return $coupon; + } + + /** + * Get data of the coupon code. + * + * @param string $couponCode The coupon code + * @param int $productId The product ID + * @param int $productType The product type + * + * @return array The coupon data + */ + public function getCouponByCode(string $couponCode, int $productType = null, int $productId = null) + { + $coupon = $this->getDataCouponByCode($couponCode, $productType, $productId); + + return $coupon; + } + + /** + * Get data of the coupon code for a service. + * + * @param int $couponId The coupon ID + * @param int $serviceId The product ID + * + * @return array The coupon data + */ + public function getCouponService(int $couponId, int $serviceId) + { + $coupon = $this->getDataCouponService($couponId, $serviceId); + + return $coupon; + } + + /** + * Get data of the coupon code for a service. + * + * @param string $couponCode The coupon code code + * @param int $serviceId The product id + * + * @return array The coupon data + */ + public function getCouponServiceByCode(string $couponCode, int $serviceId) + { + $coupon = $this->getDataCouponServiceByCode($couponCode, $serviceId); + + return $coupon; + } + + /** + * Get the coupon code of a item sale. + * + * @param int $saleId The sale ID + * + * @return string The coupon code + */ + public function getSaleCouponCode(int $saleId) + { + $couponTable = Database::get_main_table(self::TABLE_COUPON); + $couponSaleTable = Database::get_main_table(self::TABLE_COUPON_SALE); + + $couponFrom = " + $couponTable c + INNER JOIN $couponSaleTable s + on c.id = s.coupon_id + "; + + $couponCode = Database::select( + ['c.code'], + $couponFrom, + [ + 'where' => [ + 's.sale_id = ? ' => $saleId, + ], + ], + 'first' + ); + + return $couponCode['code']; + } + + /** + * Get the coupon code of a service sale. + * + * @param int $serviceSaleId The service sale ID + * + * @return string The coupon code + */ + public function getServiceSaleCouponCode(int $serviceSaleId) + { + $couponTable = Database::get_main_table(self::TABLE_COUPON); + $couponServiceSaleTable = Database::get_main_table(self::TABLE_COUPON_SERVICE_SALE); + + $couponFrom = " + $couponTable c + INNER JOIN $couponServiceSaleTable s + on c.id = s.coupon_id + "; + + $couponCode = Database::select( + ['c.code'], + $couponFrom, + [ + 'where' => [ + 's.service_sale_id = ? ' => $serviceSaleId, + ], + ], + 'first' + ); + + return $couponCode['code']; + } + + /** + * @return array + */ + public function getCecabankSignature(string $saleReference, float $price) + { + $urlOk = api_get_path(WEB_PLUGIN_PATH).'buycourses/src/cecabank_success.php'; + $urlKo = api_get_path(WEB_PLUGIN_PATH).'buycourses/src/cecabank_cancel.php'; + + $cecabankParams = $this->getCecabankParams(); + $signature = $cecabankParams['crypto_key'] + .$cecabankParams['merchant_id'] + .$cecabankParams['acquirer_bin'] + .$cecabankParams['terminal_id'] + .$saleReference + .$price * 100 + .'978' + .$cecabankParams['exponent'] + .$cecabankParams['cypher'] + .$urlOk + .$urlKo; + + $sha256 = hash('sha256', $signature); + $signature = strtolower($sha256); + + return $signature; + } + + /** + * Register a subscription sale. + * + * @param int $productId The product ID + * @param int $productType The product type + * @param int $paymentType The payment type + * @param int $duration The subscription duration + * @param int $couponId The coupon ID + * + * @return int + */ + public function registerSubscriptionSale( + int $productId, + int $productType, + int $paymentType, + int $duration, + int $couponId = null + ) { + if (!in_array( + $paymentType, + [ + self::PAYMENT_TYPE_PAYPAL, + self::PAYMENT_TYPE_TRANSFER, + self::PAYMENT_TYPE_CULQI, + self::PAYMENT_TYPE_TPV_REDSYS, + self::PAYMENT_TYPE_STRIPE, + self::PAYMENT_TYPE_TPV_CECABANK, + ] + ) + ) { + return false; + } + + $entityManager = Database::getManager(); + $item = $this->getSubscriptionItem($productId, $productType); + + if (empty($item)) { + return false; + } + + $productName = ''; + if ($item['product_type'] == self::PRODUCT_TYPE_COURSE) { + $course = $entityManager->find('ChamiloCoreBundle:Course', $item['product_id']); + + if (empty($course)) { + return false; + } + + $productName = $course->getTitle(); + } elseif ($item['product_type'] == self::PRODUCT_TYPE_SESSION) { + $session = $entityManager->find('ChamiloCoreBundle:Session', $item['product_id']); + + if (empty($session)) { + return false; + } + + $productName = $session->getName(); + } + + if ($couponId != null) { + $coupon = $this->getCoupon($couponId, $item['product_type'], $item['product_id']); + } + + $couponDiscount = 0; + $priceWithoutDiscount = 0; + if ($coupon != null) { + if ($coupon['discount_type'] == self::COUPON_DISCOUNT_TYPE_AMOUNT) { + $couponDiscount = $coupon['discount_amount']; + } elseif ($coupon['discount_type'] == self::COUPON_DISCOUNT_TYPE_PERCENTAGE) { + $couponDiscount = ($item['price'] * $coupon['discount_amount']) / 100; + } + $priceWithoutDiscount = $item['price']; + } + $item['price'] = $item['price'] - $couponDiscount; + $price = $item['price']; + $priceWithoutTax = null; + $taxPerc = null; + $taxAmount = 0; + $taxEnable = $this->get('tax_enable') === 'true'; + $globalParameters = $this->getGlobalParameters(); + $taxAppliesTo = $globalParameters['tax_applies_to']; + + if ($taxEnable && + ( + $taxAppliesTo == self::TAX_APPLIES_TO_ALL || + ($taxAppliesTo == self::TAX_APPLIES_TO_ONLY_COURSE && $item['product_type'] == self::PRODUCT_TYPE_COURSE) || + ($taxAppliesTo == self::TAX_APPLIES_TO_ONLY_SESSION && $item['product_type'] == self::PRODUCT_TYPE_SESSION) + ) + ) { + $priceWithoutTax = $item['price']; + $globalTaxPerc = $globalParameters['global_tax_perc']; + $precision = 2; + $taxPerc = is_null($item['tax_perc']) ? $globalTaxPerc : $item['tax_perc']; + $taxAmount = round($priceWithoutTax * $taxPerc / 100, $precision); + $price = $priceWithoutTax + $taxAmount; + } + + $subscriptionEnd = date('y:m:d', strtotime('+'.$duration.' days')); + + $values = [ + 'reference' => $this->generateReference( + api_get_user_id(), + $item['product_type'], + $item['product_id'] + ), + 'currency_id' => $item['currency_id'], + 'date' => api_get_utc_datetime(), + 'user_id' => api_get_user_id(), + 'product_type' => $item['product_type'], + 'product_name' => $productName, + 'product_id' => $item['product_id'], + 'price' => $price, + 'price_without_tax' => $priceWithoutTax, + 'tax_perc' => $taxPerc, + 'tax_amount' => $taxAmount, + 'status' => self::SALE_STATUS_PENDING, + 'payment_type' => $paymentType, + 'price_without_discount' => $priceWithoutDiscount, + 'discount_amount' => $couponDiscount, + 'subscription_end' => $subscriptionEnd, + ]; + + return Database::insert(self::TABLE_SUBSCRIPTION_SALE, $values); + } + + /** + * Add a new subscription. + * + * @return bool + */ + public function addNewSubscription(array $subscription) + { + $result = false; + + if (isset($subscription['frequencies'])) { + foreach ($subscription['frequencies'] as $frequency) { + $subscriptionDb = $this->getSubscription($subscription['product_type'], $subscription['product_id'], $frequency['duration']); + + if (!isset($subscriptionDb) || empty($subscription)) { + Display::addFlash( + Display::return_message( + $this->get_lang('SubscriptionAlreadyExists').' ('.$frequency['duration'].')', + 'error', + false + ) + ); + + return false; + } else { + $subscriptionId = $this->registerSubscription($subscription, $frequency); + if ($subscriptionId) { + $result = true; + } else { + Display::addFlash( + Display::return_message( + $this->get_lang('SubscriptionErrorInsert'), + 'error', + false + ) + ); + + return false; + } + } + } + } else { + Display::addFlash( + Display::return_message( + $this->get_lang('FrequenciesNotSetError'), + 'error', + false + ) + ); + + return false; + } + + return $result; + } + + /** + * Add a new subscription. + * + * @return bool + */ + public function updateSubscriptions(int $productType, int $productId, int $taxPerc) + { + $this->updateSubscription($productType, $productId, $taxPerc); + } + + /** + * Delete a subscription. + * + * @return int + */ + public function deleteSubscription(int $productType, int $productId, int $duration) + { + return Database::delete( + Database::get_main_table(self::TABLE_SUBSCRIPTION), + [ + 'product_type = ? AND ' => (int) $productType, + 'product_id = ? AND ' => (int) $productId, + 'duration = ? ' => (int) $duration, + ] + ); + } + + /** + * Get a list of subscriptions by product ID and type. + * + * @param string $productId The product ID + * @param int $productType The product type + * + * @return array Subscriptions data + */ + public function getSubscriptions($productType, $productId) + { + $subscriptions = $this->getDataSubscriptions($productType, $productId); + + return $subscriptions; + } + + /** + * Get data of the subscription. + * + * @return array The subscription data + */ + public function getSubscription(int $productType, int $productId, int $duration, array $coupon = null) + { + $subscription = $this->getDataSubscription($productType, $productId, $duration); + + $currency = $this->getSelectedCurrency(); + $isoCode = $currency['iso_code']; + + $subscription['iso_code'] = $isoCode; + + $this->setPriceSettings($subscription, self::TAX_APPLIES_TO_ONLY_COURSE, $coupon); + + return $subscription; + } + + /** + * Get subscription sale data by ID. + * + * @param int $saleId The sale ID + * + * @return array + */ + public function getSubscriptionSale(int $saleId) + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE), + [ + 'where' => ['id = ?' => $saleId], + ], + 'first' + ); + } + + /** + * Complete subscription sale process. Update sale status to completed. + * + * @param int $saleId The subscription sale ID + * + * @return bool + */ + public function completeSubscriptionSale(int $saleId) + { + $sale = $this->getSubscriptionSale($saleId); + + if ($sale['status'] == self::SALE_STATUS_COMPLETED) { + return true; + } + + $saleIsCompleted = false; + switch ($sale['product_type']) { + case self::PRODUCT_TYPE_COURSE: + $course = api_get_course_info_by_id($sale['product_id']); + $saleIsCompleted = CourseManager::subscribeUser($sale['user_id'], $course['code']); + break; + case self::PRODUCT_TYPE_SESSION: + SessionManager::subscribeUsersToSession( + $sale['product_id'], + [$sale['user_id']], + api_get_session_visibility($sale['product_id']), + false + ); + + $saleIsCompleted = true; + break; + } + + if ($saleIsCompleted) { + $this->updateSubscriptionSaleStatus($sale['id'], self::SALE_STATUS_COMPLETED); + if ($this->get('invoicing_enable') === 'true') { + $this->setInvoice($sale['id']); + } + } + + return $saleIsCompleted; + } + + /** + * Update subscription sale status to canceled. + * + * @param int $saleId The subscription sale ID + */ + public function cancelSubscriptionSale(int $saleId) + { + $this->updateSubscriptionSaleStatus($saleId, self::SALE_STATUS_CANCELED); + } + + /** + * Get a list of subscription sales by the status. + * + * @param int $status The status to filter + * + * @return array The sale list. Otherwise return false + */ + public function getSubscriptionSaleListByStatus(int $status = self::SALE_STATUS_PENDING) + { + $saleTable = Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + + return Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 'u.email', 's.*'], + "$saleTable s $innerJoins", + [ + 'where' => ['s.status = ?' => $status], + 'order' => 'id DESC', + ] + ); + } + + /** + * Get the list statuses for subscriptions sales. + * + * @param string $dateStart + * @param string $dateEnd + * + * @throws Exception + * + * @return array + */ + public function getSubscriptionSaleListReport(string $dateStart = null, string $dateEnd = null) + { + $saleTable = Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + $list = Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 'u.email', 's.*'], + "$saleTable s $innerJoins", + [ + 'order' => 'id DESC', + ] + ); + $listExportTemp = []; + $listExport = []; + $textStatus = null; + $paymentTypes = $this->getPaymentTypes(); + $productTypes = $this->getProductTypes(); + foreach ($list as $item) { + $statusSaleOrder = $item['status']; + switch ($statusSaleOrder) { + case 0: + $textStatus = $this->get_lang('SaleStatusPending'); + break; + case 1: + $textStatus = $this->get_lang('SaleStatusCompleted'); + break; + case -1: + $textStatus = $this->get_lang('SaleStatusCanceled'); + break; + } + $dateFilter = new DateTime($item['date']); + $listExportTemp[] = [ + 'id' => $item['id'], + 'reference' => $item['reference'], + 'status' => $textStatus, + 'status_filter' => $item['status'], + 'date' => $dateFilter->format('Y-m-d'), + 'order_time' => $dateFilter->format('H:i:s'), + 'price' => $item['iso_code'].' '.$item['price'], + 'product_type' => $productTypes[$item['product_type']], + 'product_name' => $item['product_name'], + 'payment_type' => $paymentTypes[$item['payment_type']], + 'complete_user_name' => api_get_person_name($item['firstname'], $item['lastname']), + 'email' => $item['email'], + ]; + } + $listExport[] = [ + get_lang('Number'), + $this->get_lang('OrderStatus'), + $this->get_lang('OrderDate'), + $this->get_lang('OrderTime'), + $this->get_lang('PaymentMethod'), + $this->get_lang('SalePrice'), + $this->get_lang('ProductType'), + $this->get_lang('ProductName'), + $this->get_lang('UserName'), + get_lang('Email'), + ]; + //Validation Export + $dateStart = strtotime($dateStart); + $dateEnd = strtotime($dateEnd); + foreach ($listExportTemp as $item) { + $dateFilter = strtotime($item['date']); + if (($dateFilter >= $dateStart) && ($dateFilter <= $dateEnd)) { + $listExport[] = [ + 'id' => $item['id'], + 'status' => $item['status'], + 'date' => $item['date'], + 'order_time' => $item['order_time'], + 'payment_type' => $item['payment_type'], + 'price' => $item['price'], + 'product_type' => $item['product_type'], + 'product_name' => $item['product_name'], + 'complete_user_name' => $item['complete_user_name'], + 'email' => $item['email'], + ]; + } + } + + return $listExport; + } + + /** + * Get a list of subscription sales by the user. + * + * @param string $term The search term + * + * @return array The sale list. Otherwise return false + */ + public function getSubscriptionSaleListByUser(string $term) + { + $term = trim($term); + + if (empty($term)) { + return []; + } + + $saleTable = Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + + return Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 'u.email', 's.*'], + "$saleTable s $innerJoins", + [ + 'where' => [ + 'u.username LIKE %?% OR ' => $term, + 'u.lastname LIKE %?% OR ' => $term, + 'u.firstname LIKE %?%' => $term, + ], + 'order' => 'id DESC', + ] + ); + } + + /** + * Get a list of subscription sales by the user id. + * + * @param int $id The user id + * + * @return array The sale list. Otherwise return false + */ + public function getSubscriptionSaleListByUserId(int $id) + { + if (empty($id)) { + return []; + } + + $saleTable = Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + + return Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 's.*'], + "$saleTable s $innerJoins", + [ + 'where' => [ + 'u.id = ? AND s.status = ?' => [$id, self::SALE_STATUS_COMPLETED], + ], + 'order' => 'id DESC', + ] + ); + } + + /** + * Get a list of subscription sales by date range. + * + * @return array The sale list. Otherwise return false + */ + public function getSubscriptionSaleListByDate(string $dateStart, string $dateEnd) + { + $dateStart = trim($dateStart); + $dateEnd = trim($dateEnd); + if (empty($dateStart)) { + return []; + } + if (empty($dateEnd)) { + return []; + } + $saleTable = Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + + return Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 'u.email', 's.*'], + "$saleTable s $innerJoins", + [ + 'where' => [ + 's.date BETWEEN ? AND ' => $dateStart, + ' ? ' => $dateEnd, + ], + 'order' => 'id DESC', + ] + ); + } + + /** + * Get a list of subscription sales by the user Email. + * + * @param string $term The search term + * + * @return array The sale list. Otherwise return false + */ + public function getSubscriptionSaleListByEmail(string $term) + { + $term = trim($term); + if (empty($term)) { + return []; + } + $saleTable = Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE); + $currencyTable = Database::get_main_table(self::TABLE_CURRENCY); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $innerJoins = " + INNER JOIN $currencyTable c ON s.currency_id = c.id + INNER JOIN $userTable u ON s.user_id = u.id + "; + + return Database::select( + ['c.iso_code', 'u.firstname', 'u.lastname', 'u.email', 's.*'], + "$saleTable s $innerJoins", + [ + 'where' => [ + 'u.email LIKE %?% ' => $term, + ], + 'order' => 'id DESC', + ] + ); + } + + /** + * Get subscription sale data by ID. + * + * @param string $date The date + * + * @return array + */ + public function getSubscriptionsDue(string $date) + { + return Database::select( + 'id, user_id, product_id, product_type', + Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE), + [ + 'where' => ['subscription_end < ? AND status <> ? AND (expired is NULL OR expired <> ?)' => [ + $date, + self::SALE_STATUS_COMPLETED, + 1, + ], + ], + ], + 'first' + ); + } + + /** + * Get subscription sale data by ID. + * + * @param int $userId The user ID + * @param int $productId The product ID + * @param int $productType The product type + * + * @return array + */ + public function checkItemSubscriptionActive(int $userId, int $productId, int $productType) + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE), + [ + 'where' => ['subscription_end >= ? AND userId = ? AND productId = ? AND productType = ? AND status <> ?' => [ + api_get_utc_datetime(), + $userId, + $productId, + $productType, + self::SALE_STATUS_COMPLETED, + ], + ], + ], + 'first' + ); + } + + /** + * Get subscription sale data by ID. + * + * @return array + */ + public function updateSubscriptionSaleExpirationStatus(int $id) + { + $saleTable = Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE); + + return Database::update( + $saleTable, + ['expired' => 1], + ['id = ?' => $id] + ); + } + + /** + * Get the list of frequencies discount types. + * + * @return array + */ + public function getFrequencies() + { + $data = Database::select( + '*', + Database::get_main_table(self::TABLE_SUBSCRIPTION_PERIOD), + [] + ); + + $frequenciesList = $this->getFrequenciesList(); + $frequencies = []; + + foreach ($data as $key => $items) { + $frequencies[$items['duration']] = $items['name']; + } + + return $frequencies; + } + + /** + * Get the list of frequencies discount types. + * + * @return array + */ + public function getFrequenciesList() + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_SUBSCRIPTION_PERIOD), + [] + ); + } + + /** + * Get the a frequency. + * + * @param int $duration The duration of the frequency value + * + * @return array + */ + public function selectFrequency(int $duration) + { + return Database::select( + '*', + Database::get_main_table(self::TABLE_SUBSCRIPTION_PERIOD), + [ + 'where' => [ + 'duration = ?' => [ + (int) $duration, + ], + ], + ], + 'first' + ); + } + + /** + * Add a new subscription frequency. + * + * @return array + */ + public function addFrequency(int $duration, string $name) + { + $values = [ + 'duration' => $duration, + 'name' => $name, + ]; + + return Database::insert(self::TABLE_SUBSCRIPTION_PERIOD, $values); + } + + /** + * Update a subscription frequency. + * + * @return array + */ + public function updateFrequency(int $duration, string $name) + { + $periodTable = Database::get_main_table(self::TABLE_SUBSCRIPTION_PERIOD); + + return Database::update( + $periodTable, + ['name' => $name], + ['duration = ?' => $duration] + ); + } + + /** + * Delete a subscription frequency. + * + * @return array + */ + public function deleteFrequency(int $duration) + { + return Database::delete( + Database::get_main_table(self::TABLE_SUBSCRIPTION_PERIOD), + [ + 'duration = ?' => $duration, + ] + ); + } + + /** + * @return string + */ + public function getSubscriptionSuccessMessage(array $saleInfo) + { + switch ($saleInfo['product_type']) { + case self::PRODUCT_TYPE_COURSE: + $courseInfo = api_get_course_info_by_id($saleInfo['product_id']); + $url = api_get_course_url($courseInfo['code']); + break; + case self::PRODUCT_TYPE_SESSION: + $sessionId = (int) $saleInfo['product_id']; + $url = api_get_path(WEB_CODE_PATH).'session/index.php?session_id='.$sessionId; + break; + default: + $url = '#'; + } + + return Display::return_message( + sprintf( + $this->get_lang('SubscriptionToCourseXSuccessful'), + $url, + $saleInfo['product_name'] + ), + 'success', + false + ); + } + + /** + * @return string + */ + public static function returnPagination( + string $baseUrl, + string $currentPage, + string $pagesCount, + string $totalItems, + array $extraQueryParams = [] + ) { + $queryParams = HttpRequest::createFromGlobals()->query->all(); + + unset($queryParams['page']); + + $url = $baseUrl.'?'.http_build_query( + array_merge($queryParams, $extraQueryParams) + ); + + return Display::getPagination($url, $currentPage, $pagesCount, $totalItems); + } + + /** + * Returns the javascript to set the sales report table for courses. + */ + public static function getSalesReportScript(array $sales = [], bool $invoicingEnable = false) + { + $cols = " + '".preg_replace("/'/", "\\'", get_plugin_lang('OrderReference', 'BuyCoursesPlugin'))."', + '".preg_replace("/'/", "\\'", get_plugin_lang('OrderStatus', 'BuyCoursesPlugin'))."', + '".preg_replace("/'/", "\\'", get_plugin_lang('OrderDate', 'BuyCoursesPlugin'))."', + '".preg_replace("/'/", "\\'", get_plugin_lang('PaymentMethod', 'BuyCoursesPlugin'))."', + '".preg_replace("/'/", "\\'", get_plugin_lang('Price', 'BuyCoursesPlugin'))."', + '".preg_replace("/'/", "\\'", get_plugin_lang('CouponDiscount', 'BuyCoursesPlugin'))."', + '".preg_replace("/'/", "\\'", get_plugin_lang('Coupon', 'BuyCoursesPlugin'))."', + '".preg_replace("/'/", "\\'", get_plugin_lang('ProductType', 'BuyCoursesPlugin'))."', + '".preg_replace("/'/", "\\'", get_plugin_lang('Name', 'BuyCoursesPlugin'))."', + '".preg_replace("/'/", "\\'", get_lang('UserName'))."', + '".preg_replace("/'/", "\\'", get_lang('Email'))."',"; + $model = " + {name:'reference', index:'reference', height:'auto', width:70, sorttype:'string', align:'center'}, + {name:'status', index:'status', height:'auto', width:70, sorttype:'string', align:'center'}, + {name:'date', index:'date', height:'auto', width:70, sorttype:'date', align:'center'}, + {name:'payment_type', index:'payment_type', height:'auto', width:70, sorttype:'string', align:'center'}, + {name:'total_price', index:'total_price', height:'auto', width:70, sorttype:'string', align:'center'}, + {name:'coupon_discount', index:'coupon_discount', height:'auto', width:40, sorttype:'string', align: 'center'}, + {name:'coupon', index:'coupon', height:'auto', width:60, sorttype:'string', align:'center'}, + {name:'product_type', index:'product_type', height:'auto', width:40, sorttype:'string'}, + {name:'product_name', index:'product_name', height:'auto', /*width:60,*/ sorttype:'string'}, + {name:'complete_user_name', index:'complete_user_name', height:'auto', width:70, sorttype:'string'}, + {name:'email', index:'email', height:'auto', /*width:60,*/ sorttype:'string'}, "; + if ($invoicingEnable) { + $model .= "{name:'invoice', index:'invoice', height:'auto', width:70, sorttype:'string'},"; + $cols .= "'".get_plugin_lang('Invoice', 'BuyCoursesPlugin')."',"; + } + $cols .= "'".get_lang('Options')."',"; + $model .= " + {name:'options', index:'options', height:'auto', width:60, sortable:false},"; + $data = ''; + foreach ($sales as $item) { + $option = ''; + if (!isset($item['complete_user_name'])) { + $item['complete_user_name'] = api_get_person_name($item['firstname'], $item['lastname']); + } + if ($item['invoice'] == 1) { + if ($invoicingEnable) { + $item['invoice'] = "". + Display::return_icon('default.png', get_plugin_lang('InvoiceView', 'BuyCoursesPlugin'), '', ICON_SIZE_MEDIUM). + "
".$item['num_invoice']. + ""; + } + } else { + $item['invoice'] = null; + } + if ($item['status'] == BuyCoursesPlugin::SALE_STATUS_CANCELED) { + $item['status'] = get_plugin_lang('SaleStatusCanceled', 'BuyCoursesPlugin'); + } elseif ($item['status'] == BuyCoursesPlugin::SALE_STATUS_PENDING) { + $item['status'] = get_plugin_lang('SaleStatusPending', 'BuyCoursesPlugin'); + $option = "
". + "". + Display::return_icon('user_subscribe_session.png', get_plugin_lang('SubscribeUser', 'BuyCoursesPlugin'), '', ICON_SIZE_SMALL) + ."". + "". + Display::return_icon('delete.png', get_plugin_lang('DeleteOrder', 'BuyCoursesPlugin'), '', ICON_SIZE_SMALL) + ."". + "
"; + } elseif ($item['status'] == BuyCoursesPlugin::SALE_STATUS_COMPLETED) { + $item['status'] = get_plugin_lang('SaleStatusCompleted', 'BuyCoursesPlugin'); + } + $item['options'] = $option; + $item['date'] = api_get_local_time($item['date']); + $data .= json_encode($item).","; + } + + return " +"; + } + + /** + * Filter the registered courses for show in plugin catalog. + */ + private function getCourses(int $first, int $maxResults) + { + $em = Database::getManager(); + $urlId = api_get_current_access_url_id(); + + $qb = $em->createQueryBuilder(); + $qb2 = $em->createQueryBuilder(); + $qb3 = $em->createQueryBuilder(); + + $qb = $qb + ->select('c') + ->from('ChamiloCoreBundle:Course', 'c') + ->where( + $qb->expr()->notIn( + 'c', + $qb2 + ->select('course2') + ->from('ChamiloCoreBundle:SessionRelCourse', 'sc') + ->join('sc.course', 'course2') + ->innerJoin( + 'ChamiloCoreBundle:AccessUrlRelSession', + 'us', + Join::WITH, + 'us.sessionId = sc.session' + )->where( + $qb->expr()->eq('us.accessUrlId ', $urlId) + ) + ->getDQL() + ) + )->andWhere( + $qb->expr()->in( + 'c', + $qb3 + ->select('course3') + ->from('ChamiloCoreBundle:AccessUrlRelCourse', 'uc') + ->join('uc.course', 'course3') + ->where( + $qb3->expr()->eq('uc.url ', $urlId) + ) + ->getDQL() + ) + ) + ->setFirstResult($first) + ->setMaxResults($maxResults); + + return $qb; + } + + /** + * Get the user status for the session. + * + * @param int $userId The user ID + * @param Session $session The session + * + * @return string + */ + private function getUserStatusForSession(int $userId, Session $session) + { + if (empty($userId)) { + return 'NO'; + } + + $entityManager = Database::getManager(); + $scuRepo = $entityManager->getRepository('ChamiloCoreBundle:SessionRelCourseRelUser'); + + $buySaleTable = Database::get_main_table(self::TABLE_SALE); + + // Check if user bought the course + $sale = Database::select( + 'COUNT(1) as qty', + $buySaleTable, + [ + 'where' => [ + 'user_id = ? AND product_type = ? AND product_id = ? AND status = ?' => [ + $userId, + self::PRODUCT_TYPE_SESSION, + $session->getId(), + self::SALE_STATUS_PENDING, + ], + ], + ], + 'first' + ); + + if ($sale['qty'] > 0) { + return 'TMP'; + } + + // Check if user is already subscribe to session + $userSubscription = $scuRepo->findBy([ + 'session' => $session, + 'user' => $userId, + ]); + + if (!empty($userSubscription)) { + return 'YES'; + } + + return 'NO'; + } + + /** + * Get the user status for the course. + * + * @param int $userId The user Id + * @param Course $course The course + * + * @return string + */ + private function getUserStatusForCourse(int $userId, Course $course) + { + if (empty($userId)) { + return 'NO'; + } + + $entityManager = Database::getManager(); + $cuRepo = $entityManager->getRepository('ChamiloCoreBundle:CourseRelUser'); + $buySaleTable = Database::get_main_table(self::TABLE_SALE); + + // Check if user bought the course + $sale = Database::select( + 'COUNT(1) as qty', + $buySaleTable, + [ + 'where' => [ + 'user_id = ? AND product_type = ? AND product_id = ? AND status = ?' => [ + $userId, + self::PRODUCT_TYPE_COURSE, + $course->getId(), + self::SALE_STATUS_PENDING, + ], + ], + ], + 'first' + ); + + if ($sale['qty'] > 0) { + return 'TMP'; + } + + // Check if user is already subscribe to course + $userSubscription = $cuRepo->findBy([ + 'course' => $course, + 'user' => $userId, + ]); + + if (!empty($userSubscription)) { + return 'YES'; + } + + return 'NO'; + } + + /** + * Update the sale status. + * + * @param int $saleId The sale ID + * @param int $newStatus The new status + * + * @return bool + */ + private function updateSaleStatus(int $saleId, int $newStatus = self::SALE_STATUS_PENDING) + { + $saleTable = Database::get_main_table(self::TABLE_SALE); + + return Database::update( + $saleTable, + ['status' => (int) $newStatus], + ['id = ?' => (int) $saleId] + ); + } + + /** + * Search filtered sessions by name, and range of price. + * + * @param string $name Optional. The name filter + * @param int $min Optional. The minimum price filter + * @param int $max Optional. The maximum price filter + * @param string $typeResult Optional. 'all' and 'count' + * @param int $sessionCategory Optional. Session category id + * + * @return array + */ + private function filterSessionList( + int $start, + int $end, + string $name = null, + int $min = 0, + int $max = 0, + string $typeResult = 'all', + int $sessionCategory = 0 + ) { + $itemTable = Database::get_main_table(self::TABLE_ITEM); + $sessionTable = Database::get_main_table(TABLE_MAIN_SESSION); + + $innerJoin = "$itemTable i ON s.id = i.product_id"; + $whereConditions = [ + 'i.product_type = ? ' => self::PRODUCT_TYPE_SESSION, + ]; + + if (!empty($name)) { + $whereConditions['AND s.name LIKE %?%'] = $name; + } + + if (!empty($min)) { + $whereConditions['AND i.price >= ?'] = $min; + } + + if (!empty($max)) { + $whereConditions['AND i.price <= ?'] = $max; + } + + if ($sessionCategory != 0) { + $whereConditions['AND s.session_category_id = ?'] = $sessionCategory; + } + + $sessionIds = Database::select( + 's.id', + "$sessionTable s INNER JOIN $innerJoin", + ['where' => $whereConditions, 'limit' => "$start, $end"], + $typeResult + ); + + if ($typeResult === 'count') { + return $sessionIds; + } + + if (!$sessionIds) { + return []; + } + + $sessions = []; + + foreach ($sessionIds as $sessionId) { + $sessions[] = Database::getManager()->find( + 'ChamiloCoreBundle:Session', + $sessionId + ); + } + + return $sessions; + } + + /** + * Search filtered courses by name, and range of price. + * + * @param string $name Optional. The name filter + * @param int $min Optional. The minimun price filter + * @param int $max Optional. The maximum price filter + * + * @return array + */ + private function filterCourseList( + int $start, + int $end, + string $name = null, + int $min = 0, + int $max = 0, + string $typeResult = 'all' + ) { + $itemTable = Database::get_main_table(self::TABLE_ITEM); + $courseTable = Database::get_main_table(TABLE_MAIN_COURSE); + $urlTable = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE); + + $urlId = api_get_current_access_url_id(); + + $min = floatval($min); + $max = floatval($max); + + $whereConditions = [ + 'i.product_type = ? ' => self::PRODUCT_TYPE_COURSE, + ]; + + if (!empty($name)) { + $whereConditions['AND c.title LIKE %?%'] = $name; + } + + if (!empty($min)) { + $whereConditions['AND i.price >= ?'] = $min; + } + + if (!empty($max)) { + $whereConditions['AND i.price <= ?'] = $max; + } + + $whereConditions['AND url.access_url_id = ?'] = $urlId; + + $courseIds = Database::select( + 'c.id', + "$courseTable c + INNER JOIN $itemTable i + ON c.id = i.product_id + INNER JOIN $urlTable url + ON c.id = url.c_id + ", + ['where' => $whereConditions, 'limit' => "$start, $end"], + $typeResult + ); + + if ($typeResult === 'count') { + return $courseIds; + } + + if (!$courseIds) { + return []; + } + + $courses = []; + foreach ($courseIds as $courseId) { + $courses[] = Database::getManager()->find( + 'ChamiloCoreBundle:Course', + $courseId + ); + } + + return $courses; + } + + /** + * Search filtered sessions by name, and range of price. + * + * @param string $name Optional. The name filter + * @param int $sessionCategory Optional. Session category id + * + * @return array + */ + private function filterSubscriptionSessionList( + int $start, + int $end, + string $name = null, + string $typeResult = 'all', + int $sessionCategory = 0 + ) { + $subscriptionTable = Database::get_main_table(self::TABLE_SUBSCRIPTION); + $sessionTable = Database::get_main_table(TABLE_MAIN_SESSION); + + $innerJoin = "$subscriptionTable st ON s.id = st.product_id"; + $whereConditions = [ + 'st.product_type = ? ' => self::PRODUCT_TYPE_SESSION, + ]; + + if (!empty($name)) { + $whereConditions['AND s.name LIKE %?%'] = $name; + } + + if ($sessionCategory != 0) { + $whereConditions['AND s.session_category_id = ?'] = $sessionCategory; + } + + $sessionIds = Database::select( + 'DISTINCT s.id', + "$sessionTable s INNER JOIN $innerJoin", + ['where' => $whereConditions, 'limit' => "$start, $end"], + $typeResult + ); + + if ($typeResult === 'count') { + return $sessionIds; + } + + if (!$sessionIds) { + return []; + } + + $sessions = []; + + foreach ($sessionIds as $sessionId) { + $sessions[] = Database::getManager()->find( + 'ChamiloCoreBundle:Session', + $sessionId + ); + } + + return $sessions; + } + + /** + * Search filtered subscriptions courses by name, and range of price. + * + * @param string $name Optional. The name filter + * + * @return array + */ + private function filterSubscriptionCourseList( + int $start, + int $end, + string $name = '', + string $typeResult = 'all' + ) { + $subscriptionTable = Database::get_main_table(self::TABLE_SUBSCRIPTION); + $courseTable = Database::get_main_table(TABLE_MAIN_COURSE); + $urlTable = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE); + + $urlId = api_get_current_access_url_id(); + + $whereConditions = [ + 'st.product_type = ? ' => self::PRODUCT_TYPE_COURSE, + ]; + + if (!empty($name)) { + $whereConditions['AND c.title LIKE %?%'] = $name; + } + + $whereConditions['AND url.access_url_id = ?'] = $urlId; + + $courseIds = Database::select( + 'DISTINCT c.id', + "$courseTable c + INNER JOIN $subscriptionTable st + ON c.id = st.product_id + INNER JOIN $urlTable url + ON c.id = url.c_id + ", + ['where' => $whereConditions, 'limit' => "$start, $end"], + $typeResult + ); + + if ($typeResult === 'count') { + return $courseIds; + } + + if (!$courseIds) { + return []; + } + + $courses = []; + foreach ($courseIds as $courseId) { + $courses[] = Database::getManager()->find( + 'ChamiloCoreBundle:Course', + $courseId + ); + } + + return $courses; + } + + /** + * Update the service sale status. + * + * @param int $serviceSaleId The service sale ID + * @param int $newStatus The new status + * + * @return bool + */ + private function updateServiceSaleStatus( + int $serviceSaleId, + int $newStatus = self::SERVICE_STATUS_PENDING + ) { + $serviceSaleTable = Database::get_main_table(self::TABLE_SERVICES_SALE); + + return Database::update( + $serviceSaleTable, + ['status' => $newStatus], + ['id = ?' => $serviceSaleId] + ); + } + + /** + * Get the items (courses or sessions) of a coupon. + * + * @return array The item data + */ + private function getItemsCoupons(int $couponId, int $productType) + { + $couponItemTable = Database::get_main_table(self::TABLE_COUPON_ITEM); + + if ($productType == self::PRODUCT_TYPE_COURSE) { + $itemTable = Database::get_main_table(TABLE_MAIN_COURSE); + $select = ['ci.product_id as id', 'it.title']; + } elseif ($productType == self::PRODUCT_TYPE_SESSION) { + $itemTable = Database::get_main_table(TABLE_MAIN_SESSION); + $select = ['ci.product_id as id', 'it.name']; + } + + $couponFrom = " + $couponItemTable ci + INNER JOIN $itemTable it + on it.id = ci.product_id and ci.product_type = $productType + "; + + return Database::select( + $select, + $couponFrom, + [ + 'where' => [ + 'ci.coupon_id = ? ' => $couponId, + ], + ] + ); + } + + /** + * Get the services of a coupon. + * + * @param int $couponId The coupon ID + * + * @return array The service data + */ + private function getServicesCoupons(int $couponId) + { + $couponServiceTable = Database::get_main_table(self::TABLE_COUPON_SERVICE); + $serviceTable = Database::get_main_table(self::TABLE_SERVICES); + + $couponFrom = " + $couponServiceTable cs + INNER JOIN $serviceTable s + on s.id = cs.service_id + "; + + return Database::select( + ['cs.service_id as id', 's.name'], + $couponFrom, + [ + 'where' => [ + 'cs.coupon_id = ? ' => $couponId, + ], + ] + ); + } + + /** + * Get an array of coupons filtered by their status. + * + * @param int $status The coupon activation status + * + * @return array Coupons data + */ + private function getDataCoupons(int $status = null) + { + $couponTable = Database::get_main_table(self::TABLE_COUPON); + + if ($status != null) { + return Database::select( + ['*'], + $couponTable, + [ + 'where' => [ + ' active = ? ' => (int) $status, + ], + 'order' => 'id DESC', + ] + ); + } else { + return Database::select( + ['*'], + $couponTable, + [ + 'order' => 'id DESC', + ] + ); + } + } + + /** + * Get data of a coupon for a product (course or service) by the coupon ID. + * + * @param int $couponId The coupon code code + * @param int $productType The product type + * @param int $productId The product ID + * + * @return array The coupon data + */ + private function getDataCoupon(int $couponId, int $productType = null, int $productId = null) + { + $couponTable = Database::get_main_table(self::TABLE_COUPON); + + if ($productType == null || $productId == null) { + return Database::select( + ['*'], + $couponTable, + [ + 'where' => [ + 'id = ? ' => $couponId, + ], + ], + 'first' + ); + } else { + $couponItemTable = Database::get_main_table(self::TABLE_COUPON_ITEM); + $dtmNow = api_get_utc_datetime(); + + $couponFrom = " + $couponTable c + INNER JOIN $couponItemTable ci + on ci.coupon_id = c.id + "; + + return Database::select( + ['c.*'], + $couponFrom, + [ + 'where' => [ + 'c.id = ? AND ' => $couponId, + 'c.valid_start <= ? AND ' => $dtmNow, + 'c.valid_end >= ? AND ' => $dtmNow, + 'ci.product_type = ? AND ' => $productType, + 'ci.product_id = ?' => $productId, + ], + ], + 'first' + ); + } + } + + /** + * Get data of a coupon for a product (course or service) by the coupon code. + * + * @param string $couponCode The coupon code code + * @param int $productType The product type + * @param int $productId The product ID + * + * @return array The coupon data + */ + private function getDataCouponByCode(string $couponCode, int $productType = null, int $productId = null) + { + $couponTable = Database::get_main_table(self::TABLE_COUPON); + $couponItemTable = Database::get_main_table(self::TABLE_COUPON_ITEM); + $dtmNow = api_get_utc_datetime(); + + if ($productType == null || $productId == null) { + return Database::select( + ['*'], + $couponTable, + [ + 'where' => [ + 'code = ? ' => $couponCode, + ], + ], + 'first' + ); + } else { + $couponFrom = " + $couponTable c + INNER JOIN $couponItemTable ci + on ci.coupon_id = c.id + "; + + return Database::select( + ['c.*'], + $couponFrom, + [ + 'where' => [ + 'c.code = ? AND ' => $couponCode, + 'c.valid_start <= ? AND ' => $dtmNow, + 'c.valid_end >= ? AND ' => $dtmNow, + 'ci.product_type = ? AND ' => $productType, + 'ci.product_id = ?' => $productId, + ], + ], + 'first' + ); + } + } + + /** + * Get data of a coupon for a service by the coupon ID. + * + * @param int $couponId The coupon ID + * @param int $serviceId The service ID + * + * @return array The coupon data + */ + private function getDataCouponService(int $couponId, int $serviceId) + { + $couponTable = Database::get_main_table(self::TABLE_COUPON); + $couponServiceTable = Database::get_main_table(self::TABLE_COUPON_SERVICE); + $dtmNow = api_get_utc_datetime(); + + $couponFrom = " + $couponTable c + INNER JOIN $couponServiceTable cs + on cs.coupon_id = c.id + "; + + return Database::select( + ['c.*'], + $couponFrom, + [ + 'where' => [ + 'c.id = ? AND ' => $couponId, + 'c.valid_start <= ? AND ' => $dtmNow, + 'c.valid_end >= ? AND ' => $dtmNow, + 'cs.service_id = ?' => $serviceId, + ], + ], + 'first' + ); + } + + /** + * Get data of coupon for a service by the coupon code. + * + * @param string $couponCode The coupon code + * @param int $serviceId The service ID + * + * @return array The coupon data + */ + private function getDataCouponServiceByCode(string $couponCode, int $serviceId) + { + $couponTable = Database::get_main_table(self::TABLE_COUPON); + $couponServiceTable = Database::get_main_table(self::TABLE_COUPON_SERVICE); + $dtmNow = api_get_utc_datetime(); + + $couponFrom = " + $couponTable c + INNER JOIN $couponServiceTable cs + on cs.coupon_id = c.id + "; + + return Database::select( + ['c.*'], + $couponFrom, + [ + 'where' => [ + 'c.code = ? AND ' => $couponCode, + 'c.valid_start <= ? AND ' => $dtmNow, + 'c.valid_end >= ? AND ' => $dtmNow, + 'cs.service_id = ?' => $serviceId, + ], + ], + 'first' + ); + } + + /** + * Update a coupon. + * + * @return int + */ + private function updateCoupon(array $coupon) + { + $couponExist = $this->getCouponByCode($coupon['code']); + if (!$couponExist) { + Display::addFlash( + Display::return_message( + $this->get_lang('CouponNoExists'), + 'error', + false + ) + ); + + return false; + } + + $values = [ + 'valid_start' => $coupon['valid_start'], + 'valid_end' => $coupon['valid_end'], + 'active' => $coupon['active'], + ]; + + return Database::update( + self::TABLE_COUPON, + $values, + ['id = ?' => $coupon['id']] + ); + } + + /** + * Register a coupon. + * + * @return int + */ + private function registerCoupon(array $coupon) + { + $couponExist = $this->getCouponByCode($coupon['code']); + if ($couponExist) { + Display::addFlash( + Display::return_message( + $this->get_lang('CouponCodeUsed'), + 'error', + false + ) + ); + + return false; + } + + $values = [ + 'code' => (string) $coupon['code'], + 'discount_type' => (int) $coupon['discount_type'], + 'discount_amount' => $coupon['discount_amount'], + 'valid_start' => $coupon['valid_start'], + 'valid_end' => $coupon['valid_end'], + 'delivered' => 0, + 'active' => $coupon['active'], + ]; + + return Database::insert(self::TABLE_COUPON, $values); + } + + /** + * Register a coupon item. + * + * @param int $couponId The coupon ID + * @param int $productType The product type + * @param int $productId The product ID + * + * @return int + */ + private function registerCouponItem(int $couponId, int $productType, int $productId) + { + $coupon = $this->getDataCoupon($couponId); + if (empty($coupon)) { + Display::addFlash( + Display::return_message( + $this->get_lang('CouponNoExists'), + 'error', + false + ) + ); + + return false; + } + + $values = [ + 'coupon_id' => $couponId, + 'product_type' => $productType, + 'product_id' => $productId, + ]; + + return Database::insert(self::TABLE_COUPON_ITEM, $values); + } + + /** + * Remove all coupon items for a product type and coupon ID. + * + * @param int $productType The product type + * @param int $couponId The coupon ID + * + * @return int Rows affected. Otherwise return false + */ + private function deleteCouponItemsByCoupon(int $productType, int $couponId) + { + return Database::delete( + Database::get_main_table(self::TABLE_COUPON_ITEM), + [ + 'product_type = ? AND ' => $productType, + 'coupon_id = ?' => $couponId, + ] + ); + } + + /** + * Register a coupon service. + * + * @param int $couponId The coupon ID + * @param int $serviceId The service ID + * + * @return int + */ + private function registerCouponService(int $couponId, int $serviceId) + { + $coupon = $this->getDataCoupon($couponId); + if (empty($coupon)) { + Display::addFlash( + Display::return_message( + $this->get_lang('CouponNoExists'), + 'error', + false + ) + ); + + return false; + } + + $values = [ + 'coupon_id' => $couponId, + 'service_id' => $serviceId, + ]; + + return Database::insert(self::TABLE_COUPON_SERVICE, $values); + } + + /** + * Remove all coupon services for a product type and coupon ID. + * + * @return int Rows affected. Otherwise, return false + */ + private function deleteCouponServicesByCoupon(int $couponId) + { + return Database::delete( + Database::get_main_table(self::TABLE_COUPON_SERVICE), + [ + 'coupon_id = ?' => (int) $couponId, + ] + ); + } + + /** + * Get an array of subscriptions. + * + * @return array Subscriptions data + */ + private function getDataSubscriptions(int $productType, int $productId) + { + $subscriptionTable = Database::get_main_table(self::TABLE_SUBSCRIPTION); + + return Database::select( + ['*'], + $subscriptionTable, + [ + 'where' => [ + 'product_type = ? AND ' => (int) $productType, + 'product_id = ? ' => (int) $productId, + ], + 'order' => 'duration ASC', + ] + ); + } + + /** + * Get data of a subscription for a product (course or service) by the subscription ID. + * + * @param int $productType The product type + * @param int $productId The product ID + * @param int $duration The duration (in seconds) + * + * @return array The subscription data + */ + private function getDataSubscription(int $productType, int $productId, int $duration) + { + $subscriptionTable = Database::get_main_table(self::TABLE_SUBSCRIPTION); + + return Database::select( + ['*'], + $subscriptionTable, + [ + 'where' => [ + 'product_type = ? AND ' => $productType, + 'product_id = ? AND ' => $productId, + 'duration = ? ' => $duration, + ], + ], + 'first' + ); + } + + /** + * Update a subscription. + * + * @return int + */ + private function updateSubscription(int $productType, int $productId, int $taxPerc) + { + $values = [ + 'tax_perc' => $taxPerc, + ]; + + return Database::update( + self::TABLE_SUBSCRIPTION, + $values, + [ + 'product_type = ? AND ' => $productType, + 'product_id = ?' => $productId, + ] + ); + + return true; + } + + /** + * Register a subscription. + * + * @return int + */ + private function registerSubscription(array $subscription, array $frequency) + { + $values = [ + 'product_type' => (int) $subscription['product_type'], + 'product_id' => (int) $subscription['product_id'], + 'duration' => (int) $frequency['duration'], + 'currency_id' => (int) $subscription['currency_id'], + 'tax_perc' => (int) $subscription['tax_perc'], + 'price' => (float) $frequency['price'], + ]; + + Database::insert(self::TABLE_SUBSCRIPTION, $values); + + return true; + } + + /** + * Update the subscription sale status. + * + * @param int $saleId The sale ID + * @param int $newStatus The new status + * + * @return bool + */ + private function updateSubscriptionSaleStatus(int $saleId, int $newStatus = self::SALE_STATUS_PENDING) + { + $saleTable = Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE); + + return Database::update( + $saleTable, + ['status' => $newStatus], + ['id = ?' => $saleId] + ); + } + + /** + * Get the user status for the subscription session. + * + * @param int $userId The user ID + * @param Session $session The session + * + * @return string + */ + private function getUserStatusForSubscriptionSession(int $userId, Session $session) + { + if (empty($userId)) { + return 'NO'; + } + + $entityManager = Database::getManager(); + $scuRepo = $entityManager->getRepository('ChamiloCoreBundle:SessionRelCourseRelUser'); + + $buySaleTable = Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE); + + // Check if user bought the course + $sale = Database::select( + 'COUNT(1) as qty', + $buySaleTable, + [ + 'where' => [ + 'user_id = ? AND product_type = ? AND product_id = ? AND status = ? AND (expired is NULL OR expired <> ?)' => [ + $userId, + self::PRODUCT_TYPE_SESSION, + $session->getId(), + self::SALE_STATUS_PENDING, + 1, + ], + ], + ], + 'first' + ); + + if ($sale['qty'] > 0) { + return 'TMP'; + } + + // Check if user is already subscribe to session + $userSubscription = $scuRepo->findBy([ + 'session' => $session, + 'user' => $userId, + ]); + + if (!empty($userSubscription)) { + return 'YES'; + } + + return 'NO'; + } + + /** + * Get the user status for the subscription course. + * + * @param int $userId The user Id + * @param Course $course The course + * + * @return string + */ + private function getUserStatusForSubscriptionCourse(int $userId, Course $course) + { + if (empty($userId)) { + return 'NO'; + } + + $entityManager = Database::getManager(); + $cuRepo = $entityManager->getRepository('ChamiloCoreBundle:CourseRelUser'); + $buySaleTable = Database::get_main_table(self::TABLE_SUBSCRIPTION_SALE); + + // Check if user bought the course + $sale = Database::select( + 'COUNT(1) as qty', + $buySaleTable, + [ + 'where' => [ + 'user_id = ? AND product_type = ? AND product_id = ? AND status = ? AND (expired is NULL OR expired <> ?)' => [ + $userId, + self::PRODUCT_TYPE_COURSE, + $course->getId(), + self::SALE_STATUS_PENDING, + 1, + ], + ], + ], + 'first' + ); + + if ($sale['qty'] > 0) { + return 'TMP'; + } + + // Check if user is already subscribe to course + $userSubscription = $cuRepo->findBy([ + 'course' => $course, + 'user' => $userId, + ]); + + if (!empty($userSubscription)) { + return 'YES'; + } + + return 'NO'; + } +} diff --git a/plugin/buycourses/src/buycourses.ajax.php b/plugin/buycourses/src/buycourses.ajax.php new file mode 100644 index 000000000..1cb8de59f --- /dev/null +++ b/plugin/buycourses/src/buycourses.ajax.php @@ -0,0 +1,612 @@ +get('culqi_enable'); +$action = isset($_GET['a']) ? $_GET['a'] : null; + +$em = Database::getManager(); + +switch ($action) { + case 'verifyPaypal': + if (api_is_anonymous()) { + break; + } + + $userId = isset($_POST['id']) ? (int) $_POST['id'] : ''; + $isUserHavePaypalAccount = $plugin->verifyPaypalAccountByBeneficiary($userId); + if ($isUserHavePaypalAccount) { + echo ''; + } else { + echo '* '.$plugin->get_lang('NoPayPalAccountDetected').''; + } + break; + case 'saleInfo': + if (api_is_anonymous()) { + break; + } + + $saleId = isset($_POST['id']) ? (int) $_POST['id'] : ''; + $sale = $plugin->getSale($saleId); + $productType = $sale['product_type'] == 1 ? get_lang('Course') : get_lang('Session'); + $paymentType = $sale['payment_type'] == 1 ? 'Paypal' : $plugin->get_lang('BankTransfer'); + $productInfo = $sale['product_type'] == 1 + ? api_get_course_info_by_id($sale['product_id']) + : api_get_session_info($sale['product_id']); + $currency = $plugin->getSelectedCurrency(); + if ($sale['product_type'] == 1) { + $productImage = $productInfo['course_image_large']; + } else { + $productImage = ($productInfo['image']) + ? $productInfo['image'] + : Template::get_icon_path('session_default.png'); + } + + $userInfo = api_get_user_info($sale['user_id']); + + $html = '

'.$sale['product_name'].'

'; + $html .= '
'; + $html .= '
'; + $html .= '
    '; + $html .= '
  • '.$plugin->get_lang('OrderPrice').': '.$sale['total_price'].'
    • '; + $html .= '
  • '.$plugin->get_lang('CurrencyType').': '.$currency['iso_code'].'
    • '; + $html .= '
  • '.$plugin->get_lang('ProductType').': '.$productType.'
    • '; + $html .= '
  • '.$plugin->get_lang('OrderDate').': '. + api_format_date( + $sale['date'], + DATE_TIME_FORMAT_LONG_24H + ).'
    • '; + $html .= '
  • '.$plugin->get_lang('Buyer').': '.$userInfo['complete_name'].'
    • '; + $html .= '
  • '.$plugin->get_lang('PaymentMethods').': '.$paymentType.'
    • '; + $html .= '
'; + $html .= '
'; + $html .= '
'; + $html .= ''; + $html .= '
'; + $html .= '
'; + + echo $html; + break; + case 'stats': + if (api_is_anonymous()) { + break; + } + + $stats = []; + $stats['completed_count'] = 0; + $stats['completed_total_amount'] = 0; + $stats['pending_count'] = 0; + $stats['pending_total_amount'] = 0; + $stats['canceled_count'] = 0; + $stats['canceled_total_amount'] = 0; + + $completedPayouts = $plugin->getPayouts(BuyCoursesPlugin::PAYOUT_STATUS_COMPLETED); + $pendingPayouts = $plugin->getPayouts(BuyCoursesPlugin::PAYOUT_STATUS_PENDING); + $canceledPayouts = $plugin->getPayouts(BuyCoursesPlugin::PAYOUT_STATUS_CANCELED); + $currency = $plugin->getSelectedCurrency(); + + foreach ($completedPayouts as $completed) { + $stats['completed_count'] = count($completedPayouts); + $stats['completed_total_amount'] += $completed['commission']; + $stats['completed_total_amount'] = number_format($stats['completed_total_amount'], 2); + } + + foreach ($pendingPayouts as $pending) { + $stats['pending_count'] = count($pendingPayouts); + $stats['pending_total_amount'] += $pending['commission']; + $stats['pending_total_amount'] = number_format($stats['pending_total_amount'], 2); + } + + foreach ($canceledPayouts as $canceled) { + $stats['canceled_count'] = count($canceledPayouts); + $stats['canceled_total_amount'] += $canceled['commission']; + $stats['canceled_total_amount'] = number_format($stats['canceled_total_amount'], 2); + } + + $html = '
' + .'

' + .'

    ' + .'
  • '.get_plugin_lang("PayoutsTotalCompleted", "BuyCoursesPlugin").' '.$stats['completed_count'] + .' - '.get_plugin_lang("TotalAmount", "BuyCoursesPlugin").' '.$stats['completed_total_amount'].' ' + .$currency['iso_code'].'
    • ' + .'
  • '.get_plugin_lang("PayoutsTotalPending", "BuyCoursesPlugin").' '.$stats['pending_count'].' - ' + .get_plugin_lang("TotalAmount", "BuyCoursesPlugin").' '.$stats['pending_total_amount'].' ' + .$currency['iso_code'].'
    • ' + .'
  • '.get_plugin_lang("PayoutsTotalCanceled", "BuyCoursesPlugin").' '.$stats['canceled_count'] + .' - '.get_plugin_lang("TotalAmount", "BuyCoursesPlugin").' '.$stats['canceled_total_amount'].' ' + .$currency['iso_code'].'
    • ' + .'
' + .'

'; + $html .= '
'; + echo $html; + break; + case 'processPayout': + if (api_is_anonymous()) { + break; + } + + $html = ''; + $allPays = []; + $totalAccounts = 0; + $totalPayout = 0; + + $payouts = isset($_POST['payouts']) ? $_POST['payouts'] : ''; + + if (!$payouts) { + echo Display::return_message( + get_plugin_lang("SelectOptionToProceed", "BuyCoursesPlugin"), + 'error', + false + ); + break; + } + + foreach ($payouts as $index => $id) { + $allPays[] = $plugin->getPayouts(BuyCoursesPlugin::PAYOUT_STATUS_PENDING, $id); + } + + foreach ($allPays as $payout) { + $totalPayout += number_format($payout['commission'], 2); + $totalAccounts++; + } + + $currentCurrency = $plugin->getSelectedCurrency(); + $isoCode = $currentCurrency['iso_code']; + $html .= '

'.get_plugin_lang("VerifyTotalAmountToProceedPayout", "BuyCoursesPlugin").'

'; + $html .= '' + .'

' + .'

    ' + .'
  • '.get_plugin_lang("TotalAcounts", "BuyCoursesPlugin").' '.$totalAccounts.'
    • ' + .'
  • '.get_plugin_lang("TotalPayout", "BuyCoursesPlugin").' '.$isoCode.' '.$totalPayout.'
    • ' + .'
' + .'

'; + $html .= '

'.get_plugin_lang("CautionThisProcessCantBeCanceled", "BuyCoursesPlugin").'

'; + $html .= '

'; + $html .= '
'; + + echo $html; + break; + case 'proceedPayout': + if (api_is_anonymous()) { + break; + } + + $paypalParams = $plugin->getPaypalParams(); + + $pruebas = $paypalParams['sandbox'] == 1; + $paypalUsername = $paypalParams['username']; + $paypalPassword = $paypalParams['password']; + $paypalSignature = $paypalParams['signature']; + + require_once "paypalfunctions.php"; + + $allPayouts = []; + $totalAccounts = 0; + $totalPayout = 0; + + $payouts = isset($_POST['payouts']) ? $_POST['payouts'] : ''; + + if (!$payouts) { + echo Display::return_message( + get_plugin_lang("SelectOptionToProceed", "BuyCoursesPlugin"), + 'error', + false + ); + break; + } + + foreach ($payouts as $index => $id) { + $allPayouts[] = $plugin->getPayouts( + BuyCoursesPlugin::PAYOUT_STATUS_PENDING, + $id + ); + } + + $currentCurrency = $plugin->getSelectedCurrency(); + $isoCode = $currentCurrency['iso_code']; + $result = MassPayment($allPayouts, $isoCode); + if ($result['ACK'] === 'Success') { + foreach ($allPayouts as $payout) { + $plugin->setStatusPayouts( + $payout['id'], + BuyCoursesPlugin::PAYOUT_STATUS_COMPLETED + ); + if ($plugin->get('invoicing_enable') === 'true') { + $plugin->setInvoice($payout['id']); + } + } + + echo Display::return_message( + get_plugin_lang("PayoutSuccess", "BuyCoursesPlugin"), + 'success', + false + ); + } else { + echo Display::return_message( + ''.$result['L_SEVERITYCODE0'].' '.$result['L_ERRORCODE0'].' - '.$result['L_SHORTMESSAGE0'] + .'
  • '.$result['L_LONGMESSAGE0'].'
', + 'error', + false + ); + } + break; + case 'cancelPayout': + if (api_is_anonymous()) { + break; + } + + // $payoutId only gets used in setStatusPayout(), where it is filtered + $payoutId = isset($_POST['id']) ? $_POST['id'] : ''; + $plugin->setStatusPayouts( + $payoutId, + BuyCoursesPlugin::PAYOUT_STATUS_CANCELED + ); + + echo ''; + + break; + case 'culqi_cargo': + if (!$culqiEnable) { + break; + } + + $tokenId = $_REQUEST['token_id']; + $saleId = $_REQUEST['sale_id']; + + if (!$tokenId || !$saleId) { + break; + } + $sale = $plugin->getSale($saleId); + if (!$sale) { + break; + } + + require_once 'Requests.php'; + Requests::register_autoloader(); + require_once 'culqi.php'; + + $culqiParams = $plugin->getCulqiParams(); + + // API Key y autenticación + $SECRET_API_KEY = $culqiParams['api_key']; + $culqi = new Culqi\Culqi(['api_key' => $SECRET_API_KEY]); + + $environment = $culqiParams['integration']; + $environment = $environment + ? BuyCoursesPlugin::CULQI_INTEGRATION_TYPE + : BuyCoursesPlugin::CULQI_PRODUCTION_TYPE; + + $culqi->setEnv($environment); + + $user = api_get_user_info(); + $currency = $plugin->getSelectedCurrency(); + + try { + $cargo = $culqi->Cargos->create([ + "moneda" => $currency['iso_code'], + "monto" => intval(floatval($sale['price']) * 100), + "usuario" => $user['username'], + "descripcion" => $sale['product_name'], + "pedido" => $sale['reference'], + "codigo_pais" => "PE", + "direccion" => get_lang('None'), + "ciudad" => get_lang('None'), + "telefono" => 0, + "nombres" => $user['firstname'], + "apellidos" => $user['lastname'], + "correo_electronico" => $user['email'], + "token" => $tokenId, + ]); + + if (is_object($cargo)) { + $saleIsCompleted = $plugin->completeSale($sale['id']); + + if ($saleIsCompleted) { + Display::addFlash( + $plugin->getSubscriptionSuccessMessage($sale) + ); + } + } + + echo json_encode($cargo); + } catch (Exception $e) { + $cargo = json_decode($e->getMessage(), true); + $plugin->cancelSale($sale['id']); + unset($_SESSION['bc_sale_id']); + if (is_array($cargo)) { + Display::addFlash( + Display::return_message( + sprintf($plugin->get_lang('ErrorOccurred'), $cargo['codigo'], $cargo['mensaje']), + 'error', + false + ) + ); + } else { + Display::addFlash( + Display::return_message( + $plugin->get_lang('ErrorContactPlatformAdmin'), + 'error', + false + ) + ); + } + } + break; + case 'culqi_cargo_service': + if (!$culqiEnable) { + break; + } + + $tokenId = $_REQUEST['token_id']; + $serviceSaleId = $_REQUEST['service_sale_id']; + + if (!$tokenId || !$serviceSaleId) { + break; + } + + $serviceSale = $plugin->getServiceSale($serviceSaleId); + + if (!$serviceSale) { + break; + } + + require_once 'Requests.php'; + Requests::register_autoloader(); + require_once 'culqi.php'; + $culqiParams = $plugin->getCulqiParams(); + + // API Key y autenticación + $SECRET_API_KEY = $culqiParams['api_key']; + $culqi = new Culqi\Culqi(['api_key' => $SECRET_API_KEY]); + + $environment = $culqiParams['integration']; + $environment = $environment + ? BuyCoursesPlugin::CULQI_INTEGRATION_TYPE + : BuyCoursesPlugin::CULQI_PRODUCTION_TYPE; + + $culqi->setEnv($environment); + $user = api_get_user_info(); + + try { + $cargo = $culqi->Cargos->create([ + "moneda" => $serviceSale['currency'], + "monto" => intval(floatval($serviceSale['price']) * 100), + "usuario" => $user['username'], + "descripcion" => $serviceSale['service']['name'], + "pedido" => $serviceSale['reference'], + "codigo_pais" => "PE", + "direccion" => get_lang('None'), + "ciudad" => get_lang('None'), + "telefono" => 0, + "nombres" => $user['firstname'], + "apellidos" => $user['lastname'], + "correo_electronico" => $user['email'], + "token" => $tokenId, + ]); + + if (is_object($cargo)) { + $saleIsCompleted = $plugin->completeServiceSale($serviceSale['id']); + if ($saleIsCompleted) { + Display::addFlash( + Display::return_message( + sprintf( + $plugin->get_lang('SubscriptionToCourseXSuccessful'), + $serviceSale['service']['name'] + ), + 'success' + ) + ); + } + } + + echo json_encode($cargo); + } catch (Exception $e) { + $cargo = json_decode($e->getMessage(), true); + $plugin->cancelServiceSale($serviceSale['id']); + + unset($_SESSION['bc_sale_id']); + + if (is_array($cargo)) { + Display::addFlash( + Display::return_message( + sprintf($plugin->get_lang('ErrorOccurred'), $cargo['codigo'], $cargo['mensaje']), + 'error', + false + ) + ); + } else { + Display::addFlash( + Display::return_message( + $plugin->get_lang('ErrorContactPlatformAdmin'), + 'error', + false + ) + ); + } + } + break; + case 'service_sale_info': + $id = isset($_POST['id']) ? (int) $_POST['id'] : 0; + $serviceSale = $plugin->getServiceSale($id); + $isAdmin = api_is_platform_admin(); + if (!$serviceSale) { + break; + } + + $ajaxCallFile = $plugin->getPath('SRC').'buycourses.ajax.php'; + $serviceImg = $plugin->getPath('SERVICE_IMAGES').$serviceSale['service']['image']; + $html = ""; + $html .= "
"; + $html .= "{$plugin->get_lang('ServiceInformation')}"; + $html .= "
    "; + $html .= "
  • {$plugin->get_lang('ServiceName')}: {$serviceSale['service']['name']}
    • "; + $html .= "
  • {$plugin->get_lang('Description')}: {$serviceSale['service']['description']}
    • "; + $nodeType = $serviceSale['node_type']; + $nodeName = ''; + if ($nodeType == BuyCoursesPlugin::SERVICE_TYPE_USER) { + $nodeType = get_lang('User'); + /** @var User $user */ + $user = UserManager::getManager()->find($serviceSale['node_id']); + $nodeName = $user ? $user->getCompleteNameWithUsername() : null; + } else { + if ($nodeType == BuyCoursesPlugin::SERVICE_TYPE_COURSE) { + $nodeType = get_lang('Course'); + /** @var Course $course */ + $course = $em->find('ChamiloCoreBundle:Course', $serviceSale['node_id']); + $nodeName = $course ? $course->getTitle() : null; + } else { + if ($nodeType == BuyCoursesPlugin::SERVICE_TYPE_SESSION) { + $nodeType = get_lang('Session'); + /** @var Session $session */ + $session = $em->find('ChamiloCoreBundle:Session', $serviceSale['node_id']); + $nodeName = $session ? $session->getName() : null; + } else { + if ($nodeType == BuyCoursesPlugin::SERVICE_TYPE_LP_FINAL_ITEM) { + $nodeType = get_lang('TemplateTitleCertificate'); + /** @var CLp $lp */ + $lp = $em->find('ChamiloCourseBundle:CLp', $serviceSale['node_id']); + $nodeName = $lp ? $lp->getName() : null; + } + } + } + } + + $html .= "
"; + $html .= "{$plugin->get_lang('SaleInfo')}"; + $html .= "
    "; + $html .= "
  • {$plugin->get_lang('BoughtBy')}: {$serviceSale['buyer']['name']}
    • "; + $html .= "
  • {$plugin->get_lang('PurchaserUser')}: {$serviceSale['buyer']['username']}
    • "; + $html .= "
  • {$plugin->get_lang('Total')}: {$serviceSale['service']['total_price']}
    • "; + $orderDate = api_format_date($serviceSale['buy_date'], DATE_FORMAT_LONG); + $html .= "
  • {$plugin->get_lang('OrderDate')}: $orderDate
    • "; + $paymentType = $serviceSale['payment_type']; + if ($paymentType == BuyCoursesPlugin::PAYMENT_TYPE_PAYPAL) { + $paymentType = 'PayPal'; + } else { + if ($paymentType == BuyCoursesPlugin::PAYMENT_TYPE_TRANSFER) { + $paymentType = $plugin->get_lang('BankTransfer'); + } else { + if ($paymentType == BuyCoursesPlugin::PAYMENT_TYPE_CULQI) { + $paymentType = 'Culqi'; + } + } + } + $html .= "
  • {$plugin->get_lang('PaymentMethod')}: $paymentType
    • "; + $status = $serviceSale['status']; + $buttons = ''; + if ($status == BuyCoursesPlugin::SERVICE_STATUS_COMPLETED) { + $status = $plugin->get_lang('Active'); + } else { + if ($status == BuyCoursesPlugin::SERVICE_STATUS_PENDING) { + $status = $plugin->get_lang('Pending'); + if ($isAdmin) { + $buttons .= "{$plugin->get_lang('ConfirmOrder')}"; + $buttons .= "{$plugin->get_lang('CancelOrder')}"; + } + } else { + if ($status == BuyCoursesPlugin::SERVICE_STATUS_CANCELLED) { + $status = $plugin->get_lang('Cancelled'); + } + } + } + $html .= "
  • {$plugin->get_lang('Status')}: $status
    • "; + $html .= "
"; + $html .= "
"; + $html .= "
"; + $html .= "
"; + $html .= "
"; + $html .= "
"; + $html .= $buttons; + $html .= "
"; + $html .= "
"; + $html .= "
"; + $html .= ""; + + echo $html; + break; + case 'service_sale_confirm': + $id = isset($_POST['id']) ? (int) $_POST['id'] : 0; + $serviceSale = $plugin->getServiceSale($id); + $response = $plugin->completeServiceSale($id); + $html = "
"; + + if ($response) { + $html .= Display::return_message( + sprintf($plugin->get_lang('SubscriptionToServiceXSuccessful'), $serviceSale['service']['name']), + 'success' + ); + } else { + $html .= Display::return_message('Error - '.$plugin->get_lang('ErrorContactPlatformAdmin'), 'error'); + } + + $html .= "".$plugin->get_lang('ClickHereToFinish').""; + $html .= "
"; + $html .= ""; + echo $html; + break; + case 'service_sale_cancel': + $id = isset($_POST['id']) ? (int) $_POST['id'] : 0; + $response = $plugin->cancelServiceSale($id); + $html = ''; + $html .= "
"; + + if ($response) { + $html .= Display::return_message( + $plugin->get_lang('OrderCancelled'), + 'warning' + ); + } else { + $html .= Display::return_message('Error - '.$plugin->get_lang('ErrorContactPlatformAdmin'), 'error'); + } + + $html .= "".$plugin->get_lang('ClickHereToFinish').""; + $html .= "
"; + $html .= ""; + echo $html; + break; +} diff --git a/plugin/buycourses/src/cecabank_cancel.php b/plugin/buycourses/src/cecabank_cancel.php new file mode 100644 index 000000000..174faad75 --- /dev/null +++ b/plugin/buycourses/src/cecabank_cancel.php @@ -0,0 +1,30 @@ +get('cecabank_enable') === 'true'; + +if (!$cecabankEnabled) { + api_not_allowed(true); +} + +$sale = $plugin->getSale($_SESSION['bc_sale_id']); + +if (empty($sale)) { + api_not_allowed(true); +} + +Display::addFlash( + Display::return_message($plugin->get_lang('ErrorContactPlatformAdmin'), 'error') +); + +unset($_SESSION['bc_sale_id']); +header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/course_catalog.php'); +exit; diff --git a/plugin/buycourses/src/cecabank_response.php b/plugin/buycourses/src/cecabank_response.php new file mode 100644 index 000000000..1d6398d48 --- /dev/null +++ b/plugin/buycourses/src/cecabank_response.php @@ -0,0 +1,53 @@ +get('cecabank_enable') === 'true'; + +if (!$cecabankEnabled) { + api_not_allowed(true); +} + +$receivedAmount = (float) $_POST['Importe']; + +if (empty($_POST['Num_operacion']) || empty($_POST['Firma']) || empty($receivedAmount)) { + api_not_allowed(true); +} + +$signature = $plugin->getCecabankSignature($_POST['Num_operacion'], $receivedAmount); + +if ($signature != $_POST['Firma']) { + api_not_allowed(true); +} + +$sale = $plugin->getSaleFromReference($_POST['Num_operacion']); + +if (empty($sale)) { + api_not_allowed(true); +} + +$buyingCourse = false; +$buyingSession = false; + +switch ($sale['product_type']) { + case BuyCoursesPlugin::PRODUCT_TYPE_COURSE: + $buyingCourse = true; + $course = $plugin->getCourseInfo($sale['product_id']); + break; + case BuyCoursesPlugin::PRODUCT_TYPE_SESSION: + $buyingSession = true; + $session = $plugin->getSessionInfo($sale['product_id']); + break; +} + +$saleIsCompleted = $plugin->completeSale($sale['id']); +if ($saleIsCompleted) { + $plugin->storePayouts($sale['id']); +} diff --git a/plugin/buycourses/src/cecabank_success.php b/plugin/buycourses/src/cecabank_success.php new file mode 100644 index 000000000..9b95b375e --- /dev/null +++ b/plugin/buycourses/src/cecabank_success.php @@ -0,0 +1,30 @@ +get('cecabank_enable') === 'true'; + +if (!$cecabankEnabled) { + api_not_allowed(true); +} + +$sale = $plugin->getSale($_SESSION['bc_sale_id']); + +if (empty($sale)) { + api_not_allowed(true); +} + +Display::addFlash( + $plugin->getSubscriptionSuccessMessage($sale) +); + +unset($_SESSION['bc_sale_id']); +header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/course_catalog.php'); +exit; diff --git a/plugin/buycourses/src/configure_coupon.php b/plugin/buycourses/src/configure_coupon.php new file mode 100644 index 000000000..2db7a33f1 --- /dev/null +++ b/plugin/buycourses/src/configure_coupon.php @@ -0,0 +1,204 @@ +getCouponInfo($couponId); + +if (!isset($coupon)) { + api_not_allowed(); +} + +$couponDateRangeFrom = $coupon['valid_start']; +$couponDateRangeTo = $coupon['valid_end']; + +$includeSession = $plugin->get('include_sessions') === 'true'; +$includeServices = $plugin->get('include_services') === 'true'; + +$entityManager = Database::getManager(); +$userRepo = UserManager::getRepository(); +$currency = $plugin->getSelectedCurrency(); + +if (empty($currency)) { + Display::addFlash( + Display::return_message($plugin->get_lang('CurrencyIsNotConfigured'), 'error') + ); +} + +$currencyIso = null; + +$coursesList = CourseManager::get_courses_list( + 0, + 0, + 'title', + 'asc', + -1, + null, + api_get_current_access_url_id(), + false, + [], + [] +); + +foreach ($coursesList as $course) { + $courses[$course['id']] = $course['title']; +} + +$sessionsList = SessionManager::get_sessions_list( + [], + [], + null, + null, + api_get_current_access_url_id(), + [] +); + +foreach ($sessionsList as $session) { + $sessions[$session['id']] = $session['name']; +} + +$servicesList = $plugin->getAllServices(); + +foreach ($servicesList as $service) { + $services[$service['id']] = $service['name']; +} + +$discountTypes = $plugin->getCouponDiscountTypes(); + +// Build the form +$form = new FormValidator('add_coupon'); +$form->addText('code', $plugin->get_lang('CouponCode'), false); +$form->addText('discount_type', $plugin->get_lang('CouponDiscountType'), false); +$form->addText('discount_amount', $plugin->get_lang('CouponDiscount'), false); +$form->addDateRangePicker( + 'date', + get_lang('Date'), + true, + [ + 'value' => "$couponDateRangeFrom / $couponDateRangeTo", + ] +); + +$form->addCheckBox('active', $plugin->get_lang('CouponActive')); +$form->addElement( + 'advmultiselect', + 'courses', + get_lang('Courses'), + $courses +); + +if ($includeSession) { + $form->addElement( + 'advmultiselect', + 'sessions', + get_lang('Sessions'), + $sessions + ); +} + +if ($includeServices) { + $form->addElement( + 'advmultiselect', + 'services', + get_lang('Services'), + $services + ); +} + +$form->addHidden('id', null); + +$coursesAdded = $coupon["courses"]; +if (!empty($coursesAdded)) { + $coursesAdded = array_column($coursesAdded, 'id'); +} + +$sessionsAdded = $coupon["sessions"]; +if (!empty($sessionsAdded)) { + $sessionsAdded = array_column($sessionsAdded, 'id'); +} + +$servicesAdded = $coupon["services"]; +if (!empty($servicesAdded)) { + $servicesAdded = array_column($servicesAdded, 'id'); +} + +$formDefaults = [ + 'id' => $coupon['id'], + 'code' => $coupon['code'], + 'discount_type' => $discountTypes[$coupon['discount_type']], + 'discount_amount' => $coupon['discount_amount'], + 'date' => "$couponDateRangeFrom / $couponDateRangeTo", + 'active' => $coupon['active'], + 'courses' => $coursesAdded, + 'sessions' => $sessionsAdded, + 'services' => $servicesAdded, +]; + +$button = $form->addButtonSave(get_lang('Save')); +if (empty($currency)) { + $button->setAttribute('disabled'); +} + +$form->freeze(['code', 'discount_type', 'discount_amount']); + +if ($form->validate()) { + $formValues = $form->exportValues(); + + $coupon['id'] = $formValues['id']; + $coupon['valid_start'] = $formValues['date_start']; + $coupon['valid_end'] = $formValues['date_end']; + $coupon['active'] = $formValues['active']; + $coupon['courses'] = isset($formValues['courses']) ? $formValues['courses'] : []; + $coupon['sessions'] = isset($formValues['sessions']) ? $formValues['sessions'] : []; + $coupon['services'] = isset($formValues['services']) ? $formValues['services'] : []; + + $result = $plugin->updateCouponData($coupon); + + if ($result) { + Display::addFlash( + Display::return_message( + $plugin->get_lang('CouponUpdate'), + 'success', + false + ) + ); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/configure_coupon.php?id='.$coupon["id"]); + } else { + header('Location:'.api_get_self().'?'.$queryString); + } + + exit; +} + +$form->setDefaults($formDefaults); + +$templateName = $plugin->get_lang('ConfigureCoupon'); +$interbreadcrumb[] = [ + 'url' => 'paymentsetup.php', + 'name' => get_lang('Configuration'), +]; +$interbreadcrumb[] = [ + 'url' => 'coupons.php', + 'name' => $plugin->get_lang('CouponList'), +]; + +$template = new Template($templateName); +$template->assign('header', $templateName); +$template->assign('content', $form->returnForm()); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/configure_course.php b/plugin/buycourses/src/configure_course.php new file mode 100644 index 000000000..94aed74ed --- /dev/null +++ b/plugin/buycourses/src/configure_course.php @@ -0,0 +1,363 @@ +get('commissions_enable'); + +if ($commissionsEnable == 'true') { + $htmlHeadXtra[] = ''; + $commissions = ''; +} + +$includeSession = $plugin->get('include_sessions') === 'true'; +$editingCourse = $type === BuyCoursesPlugin::PRODUCT_TYPE_COURSE; +$editingSession = $type === BuyCoursesPlugin::PRODUCT_TYPE_SESSION; + +$entityManager = Database::getManager(); +$userRepo = UserManager::getRepository(); +$currency = $plugin->getSelectedCurrency(); + +if (empty($currency)) { + Display::addFlash( + Display::return_message($plugin->get_lang('CurrencyIsNotConfigured'), 'error') + ); + $currency = null; +} + +$currencyIso = null; + +if ($editingCourse) { + $course = $entityManager->find('ChamiloCoreBundle:Course', $id); + + if (!$course) { + api_not_allowed(true); + } + + /*if (!$plugin->isValidCourse($course)) { + api_not_allowed(true); + }*/ + + $courseItem = $plugin->getCourseForConfiguration($course, $currency); + $defaultBeneficiaries = []; + $teachers = $course->getTeachers(); + $teachersOptions = []; + + foreach ($teachers as $courseTeacher) { + $teacher = $courseTeacher->getUser(); + $teachersOptions[] = [ + 'text' => $teacher->getCompleteName(), + 'value' => $teacher->getId(), + ]; + $defaultBeneficiaries[] = $teacher->getId(); + } + + if (!empty($courseItem['item_id'])) { + $currentBeneficiaries = $plugin->getItemBeneficiaries($courseItem['course_id']); + if (!empty($currentBeneficiaries)) { + $defaultBeneficiaries = array_column($currentBeneficiaries, 'user_id'); + if ($commissionsEnable === 'true') { + $defaultCommissions = array_column($currentBeneficiaries, 'commissions'); + foreach ($defaultCommissions as $defaultCommission) { + $commissions .= $defaultCommission.','; + } + $commissions = substr($commissions, 0, -1); + } + } + + $currencyIso = $courseItem['currency']; + $formDefaults = [ + 'product_type' => get_lang('Course'), + 'id' => $courseItem['course_id'], + 'type' => BuyCoursesPlugin::PRODUCT_TYPE_COURSE, + 'name' => $courseItem['course_title'], + 'visible' => $courseItem['visible'], + 'price' => $courseItem['price'], + 'tax_perc' => $courseItem['tax_perc'], + 'beneficiaries' => $defaultBeneficiaries, + $commissionsEnable == 'true' ? 'commissions' : '' => $commissionsEnable == 'true' ? $commissions : '', + ]; + } else { + $formDefaults = [ + 'product_type' => get_lang('Course'), + 'id' => $courseItem['course_id'], + 'type' => BuyCoursesPlugin::PRODUCT_TYPE_COURSE, + 'name' => $courseItem['course_title'], + 'visible' => false, + 'price' => 0, + 'tax_perc' => 0, + 'beneficiaries' => [], + $commissionsEnable == 'true' ? 'commissions' : '' => $commissionsEnable == 'true' ? '' : '', + ]; + } +} elseif ($editingSession) { + if (!$includeSession) { + api_not_allowed(true); + } + + $session = $entityManager->find('ChamiloCoreBundle:Session', $id); + if (!$session) { + api_not_allowed(true); + } + + $sessionItem = $plugin->getSessionForConfiguration($session, $currency); + $generalCoach = $session->getGeneralCoach(); + $generalCoachOption = [ + 'text' => $generalCoach->getCompleteName(), + 'value' => $generalCoach->getId(), + ]; + $defaultBeneficiaries = [ + $generalCoach->getId(), + ]; + $courseCoachesOptions = []; + $sessionCourses = $session->getCourses(); + + foreach ($sessionCourses as $sessionCourse) { + $courseCoaches = $userRepo->getCoachesForSessionCourse($session, $sessionCourse->getCourse()); + + foreach ($courseCoaches as $courseCoach) { + if ($generalCoach->getId() === $courseCoach->getId()) { + continue; + } + + $courseCoachesOptions[] = [ + 'text' => $courseCoach->getCompleteName(), + 'value' => $courseCoach->getId(), + ]; + $defaultBeneficiaries[] = $courseCoach->getId(); + } + } + + if ($sessionItem['item_id']) { + $currentBeneficiaries = $plugin->getItemBeneficiaries($sessionItem['item_id']); + } + + if (!empty($currentBeneficiaries)) { + $defaultBeneficiaries = array_column($currentBeneficiaries, 'user_id'); + + if ($commissionsEnable == 'true') { + $defaultCommissions = array_column($currentBeneficiaries, 'commissions'); + + foreach ($defaultCommissions as $defaultCommission) { + $commissions .= $defaultCommission.','; + } + + $commissions = substr($commissions, 0, -1); + } + } + + $currencyIso = $sessionItem['currency']; + $formDefaults = [ + 'product_type' => get_lang('Session'), + 'id' => $session->getId(), + 'type' => BuyCoursesPlugin::PRODUCT_TYPE_SESSION, + 'name' => $sessionItem['session_name'], + 'visible' => $sessionItem['visible'], + 'price' => $sessionItem['price'], + 'tax_perc' => $sessionItem['tax_perc'], + 'beneficiaries' => $defaultBeneficiaries, + $commissionsEnable == 'true' ? 'commissions' : '' => $commissionsEnable == 'true' ? $commissions : '', + ]; +} else { + api_not_allowed(true); +} + +if ($commissionsEnable === 'true') { + $htmlHeadXtra[] = " + + "; +} + +$globalSettingsParams = $plugin->getGlobalParameters(); + +$form = new FormValidator('beneficiaries'); +$form->addText('product_type', $plugin->get_lang('ProductType'), false); +$form->addText('name', get_lang('Name'), false); +$form->addCheckBox( + 'visible', + $plugin->get_lang('VisibleInCatalog'), + $plugin->get_lang('ShowOnCourseCatalog') +); +$form->addElement( + 'number', + 'price', + [$plugin->get_lang('Price'), null, $currencyIso], + ['step' => 0.01] +); +$form->addElement( + 'number', + 'tax_perc', + [$plugin->get_lang('TaxPerc'), $plugin->get_lang('TaxPercDescription'), '%'], + ['step' => 1, 'placeholder' => $globalSettingsParams['global_tax_perc'].'% '.$plugin->get_lang('ByDefault')] +); +$beneficiariesSelect = $form->addSelect( + 'beneficiaries', + $plugin->get_lang('Beneficiaries'), + null, + ['multiple' => 'multiple', 'id' => 'selectBox'] +); + +if ($editingCourse) { + $teachersOptions = api_unique_multidim_array($teachersOptions, 'value'); + $beneficiariesSelect->addOptGroup($teachersOptions, get_lang('Teachers')); +} elseif ($editingSession) { + $courseCoachesOptions = api_unique_multidim_array($courseCoachesOptions, 'value'); + $beneficiariesSelect->addOptGroup([$generalCoachOption], get_lang('SessionGeneralCoach')); + $beneficiariesSelect->addOptGroup($courseCoachesOptions, get_lang('SessionCourseCoach')); +} + +if ($commissionsEnable === 'true') { + $platformCommission = $plugin->getPlatformCommission(); + $form->addHtml( + ' +
+ +
+ '.Display::return_message( + sprintf($plugin->get_lang('TheActualPlatformCommissionIsX'), $platformCommission['commission'].'%'), + 'info', + false + ).' +
+
+
' + ); + $form->addHidden('commissions', ''); +} + +$form->addHidden('type', null); +$form->addHidden('id', null); +$button = $form->addButtonSave(get_lang('Save')); + +if (empty($currency)) { + $button->setAttribute('disabled'); +} + +$form->freeze(['product_type', 'name']); + +if ($form->validate()) { + $formValues = $form->exportValues(); + $id = $formValues['id']; + $type = $formValues['type']; + + $productItem = $plugin->getItemByProduct($id, $type); + if (isset($formValues['visible'])) { + $taxPerc = $formValues['tax_perc'] != '' ? (int) $formValues['tax_perc'] : null; + if (!empty($productItem)) { + $plugin->updateItem( + [ + 'price' => floatval($formValues['price']), + 'tax_perc' => $taxPerc, + ], + $id, + $type + ); + } else { + $itemId = $plugin->registerItem([ + 'currency_id' => (int) $currency['id'], + 'product_type' => $type, + 'product_id' => $id, + 'price' => floatval($_POST['price']), + 'tax_perc' => $taxPerc, + ]); + $productItem['id'] = $itemId; + } + + $plugin->deleteItemBeneficiaries($productItem['id']); + + if (isset($formValues['beneficiaries'])) { + if ($commissionsEnable === 'true') { + $usersId = $formValues['beneficiaries']; + $commissions = explode(',', $formValues['commissions']); + $commissions = (count($usersId) != count($commissions)) + ? array_fill(0, count($usersId), 0) + : $commissions; + $beneficiaries = array_combine($usersId, $commissions); + } else { + $usersId = $formValues['beneficiaries']; + $commissions = array_fill(0, count($usersId), 0); + $beneficiaries = array_combine($usersId, $commissions); + } + $plugin->registerItemBeneficiaries($productItem['id'], $beneficiaries); + } + } else { + if (!empty($productItem['id'])) { + $plugin->deleteItem($productItem['id']); + } + } + $url = 'list.php'; + if ($type == 2) { + $url = 'list_session.php'; + } + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/'.$url); + exit; +} + +$form->setDefaults($formDefaults); + +$templateName = ''; +$interbreadcrumb[] = [ + 'url' => 'paymentsetup.php', + 'name' => get_lang('Configuration'), +]; +switch ($type) { + case 2: + $interbreadcrumb[] = [ + 'url' => 'list_session.php', + 'name' => $plugin->get_lang('Sessions'), + ]; + $templateName = $plugin->get_lang('Sessions'); + break; + default: + $interbreadcrumb[] = [ + 'url' => 'list.php', + 'name' => $plugin->get_lang('AvailableCourses'), + ]; + $templateName = $plugin->get_lang('AvailableCourse'); +} + +$template = new Template($templateName); +$template->assign('header', $templateName); +$template->assign('content', $form->returnForm()); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/configure_frequency.php b/plugin/buycourses/src/configure_frequency.php new file mode 100644 index 000000000..814ceeec0 --- /dev/null +++ b/plugin/buycourses/src/configure_frequency.php @@ -0,0 +1,119 @@ +selectFrequency($_GET['d']); + + if (!empty($frequency)) { + $subscriptionsItems = $plugin->getSubscriptionsItemsByDuration($_GET['d']); + + if (empty($subscriptionsItems)) { + $plugin->deleteFrequency($_GET['d']); + + Display::addFlash( + Display::return_message($plugin->get_lang('FrequencyRemoved'), 'success') + ); + } else { + Display::addFlash( + Display::return_message($plugin->get_lang('SubscriptionPeriodOnUse'), 'error') + ); + } + } else { + Display::addFlash( + Display::return_message($plugin->get_lang('FrequencyNotExits'), 'error') + ); + } + } else { + Display::addFlash( + Display::return_message($plugin->get_lang('FrequencyIncorrect'), 'error') + ); + } + + header('Location: '.api_get_self()); + exit; + } +} + +$frequencies = $plugin->getFrequenciesList(); + +$globalSettingsParams = $plugin->getGlobalParameters(); + +$form = new FormValidator('add_frequency'); + +$form->addText('name', get_lang('Name'), false); + +$form->addElement( + 'number', + 'duration', + [$plugin->get_lang('Duration'), $plugin->get_lang('Days')], + ['step' => 1, 'placeholder' => $plugin->get_lang('SubscriptionFrequencyValueDays')] +); + +$button = $form->addButtonSave(get_lang('Save')); + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + $duration = $formValues['duration']; + $name = $formValues['name']; + + $frequency = $plugin->selectFrequency($duration); + + if (!empty($frequency)) { + $result = $plugin->updateFrequency($duration, $name); + + if (!isset($result)) { + Display::addFlash( + Display::return_message($plugin->get_lang('FrequencyNotUpdated'), 'error') + ); + } + } else { + $result = $plugin->addFrequency($duration, $name); + + if (!isset($result)) { + Display::addFlash( + Display::return_message($plugin->get_lang('FrequencyNotSaved'), 'error') + ); + } + } + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/configure_frequency.php'); + + exit; +} + +//$form->setDefaults($formDefaults); + +$templateName = $plugin->get_lang('FrequencyAdd'); +$interbreadcrumb[] = [ + 'url' => 'subscriptions_courses.php', + 'name' => get_lang('Configuration'), +]; +$interbreadcrumb[] = [ + 'url' => 'subscriptions_courses.php', + 'name' => $plugin->get_lang('SubscriptionList'), +]; + +$template = new Template($templateName); +$template->assign('header', $templateName); +$template->assign('items_form', $form->returnForm()); +$template->assign('frequencies_list', $frequencies); + +$content = $template->fetch('buycourses/view/configure_frequency.tpl'); +$template->assign('content', $content); + +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/configure_subscription.php b/plugin/buycourses/src/configure_subscription.php new file mode 100644 index 000000000..8a438021b --- /dev/null +++ b/plugin/buycourses/src/configure_subscription.php @@ -0,0 +1,246 @@ +get('include_sessions') === 'true'; + +if (isset($_GET['action'], $_GET['d'])) { + if ($_GET['action'] == 'delete_frequency') { + $plugin->deleteSubscription($type, $id, $_GET['d']); + + Display::addFlash( + Display::return_message(get_lang('ItemRemoved'), 'success') + ); + + header('Location: '.api_get_self().'?'.$queryString); + exit; + } +} + +$entityManager = Database::getManager(); +$userRepo = UserManager::getRepository(); +$currency = $plugin->getSelectedCurrency(); + +if (empty($currency)) { + Display::addFlash( + Display::return_message($plugin->get_lang('CurrencyIsNotConfigured'), 'error') + ); +} + +$subscriptions = $plugin->getSubscriptions($type, $id); + +$taxtPerc = 0; + +if (isset($subscriptions) && !empty($subscriptions)) { + $taxtPerc = $subscriptions[0]['tax_perc']; +} + +$currencyIso = null; + +if ($editingCourse) { + $course = $entityManager->find('ChamiloCoreBundle:Course', $id); + if (!$course) { + api_not_allowed(true); + } + + $courseItem = $plugin->getCourseForConfiguration($course, $currency); + + $currencyIso = $courseItem['currency']; + $formDefaults = [ + 'product_type' => get_lang('Course'), + 'id' => $courseItem['course_id'], + 'type' => BuyCoursesPlugin::PRODUCT_TYPE_COURSE, + 'name' => $courseItem['course_title'], + 'visible' => $courseItem['visible'], + 'tax_perc' => $taxtPerc, + ]; +} elseif ($editingSession) { + if (!$includeSession) { + api_not_allowed(true); + } + + $session = $entityManager->find('ChamiloCoreBundle:Session', $id); + if (!$session) { + api_not_allowed(true); + } + + $sessionItem = $plugin->getSessionForConfiguration($session, $currency); + + $currencyIso = $sessionItem['currency']; + $formDefaults = [ + 'product_type' => get_lang('Session'), + 'id' => $session->getId(), + 'type' => BuyCoursesPlugin::PRODUCT_TYPE_SESSION, + 'name' => $sessionItem['session_name'], + 'visible' => $sessionItem['visible'], + 'tax_perc' => $taxtPerc, + ]; +} else { + api_not_allowed(true); +} + +$globalSettingsParams = $plugin->getGlobalParameters(); + +$form = new FormValidator('add_subscription'); + +$form->addText('product_type', $plugin->get_lang('ProductType'), false); +$form->addText('name', get_lang('Name'), false); + +$form->freeze(['product_type', 'name']); + +$form->addElement( + 'number', + 'tax_perc', + [$plugin->get_lang('TaxPerc'), $plugin->get_lang('TaxPercDescription'), '%'], + ['step' => 1, 'placeholder' => $globalSettingsParams['global_tax_perc'].'% '.$plugin->get_lang('ByDefault')] +); + +$frequenciesOptions = $plugin->getFrequencies(); + +$frequencyForm = new FormValidator('frequency_config', 'post', api_get_self().'?'.$queryString); + +$frequencyFormDefaults = [ + 'id' => $id, + 'type' => $type, + 'tax_perc' => $taxtPerc, + 'currency_id' => $currency['id'], +]; + +$frequencyForm->setDefaults($frequencyFormDefaults); + +if ($frequencyForm->validate()) { + $frequencyFormValues = $frequencyForm->getSubmitValues(); + + $subscription['product_id'] = $frequencyFormValues['id']; + $subscription['product_type'] = $frequencyFormValues['type']; + $subscription['tax_perc'] = $frequencyFormValues['tax_perc'] != '' ? (int) $frequencyFormValues['tax_perc'] : null; + $subscription['currency_id'] = $currency['id']; + $duration = $frequencyFormValues['duration']; + $price = $frequencyFormValues['price']; + + for ($i = 0; $i <= count($subscriptions); $i++) { + if ($subscriptions[$i]['duration'] == $duration) { + Display::addFlash( + Display::return_message($plugin->get_lang('SubscriptionAlreadyExists'), 'error') + ); + + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + } + + $subscription['frequencies'] = [['duration' => $duration, 'price' => $price]]; + + $result = $plugin->addNewSubscription($subscription); + + Display::addFlash( + Display::return_message(get_lang('Saved'), 'success') + ); + + header('Location:'.api_get_self().'?'.$queryString); + exit; +} + +$frequencyForm->addElement( + 'select', + 'duration', + $plugin->get_lang('Duration'), + $frequenciesOptions, + ['cols-size' => [2, 8, 2]] +); + +$frequencyForm->addElement( + 'number', + 'price', + [$plugin->get_lang('Price'), null, $currencyIso], + false, + [ + 'step' => 1, + 'cols-size' => [3, 8, 1], + ] +); + +$frequencyForm->addHidden('type', $type); +$frequencyForm->addHidden('id', $id); +$frequencyForm->addHidden('tax_perc', $taxtPerc); +$frequencyForm->addHidden('currency_id', $currency['id']); +$frequencyForm->addButtonCreate('Add'); + +for ($i = 0; $i < count($subscriptions); $i++) { + if ($subscriptions[$i]['duration'] > 0) { + $subscriptions[$i]['durationName'] = $frequenciesOptions[$subscriptions[$i]['duration']]; + } +} + +$form->addHidden('type', $type); +$form->addHidden('id', $id); +$button = $form->addButtonSave(get_lang('Save')); + +if (empty($currency)) { + $button->setAttribute('disabled'); +} + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + $id = $formValues['id']; + $type = $formValues['type']; + $taxPerc = $formValues['tax_perc'] != '' ? (int) $formValues['tax_perc'] : null; + + $result = $plugin->updateSubscriptions($type, $id, $taxPerc); + + if ($result) { + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/subscriptions_courses.php'); + } else { + header('Location:'.api_get_self().'?'.$queryString); + } + + exit; +} + +$form->setDefaults($formDefaults); + +$templateName = $plugin->get_lang('SubscriptionAdd'); +$interbreadcrumb[] = [ + 'url' => 'subscriptions_courses.php', + 'name' => get_lang('Configuration'), +]; +$interbreadcrumb[] = [ + 'url' => 'subscriptions_courses.php', + 'name' => $plugin->get_lang('SubscriptionList'), +]; + +$template = new Template($templateName); +$template->assign('header', $templateName); +$template->assign('items_form', $form->returnForm()); +$template->assign('frequency_form', $frequencyForm->returnForm()); +$template->assign('subscriptions', $subscriptions); +$template->assign('currencyIso', $currencyIso); + +$content = $template->fetch('buycourses/view/configure_subscription.tpl'); +$template->assign('content', $content); + +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/coupon_add.php b/plugin/buycourses/src/coupon_add.php new file mode 100644 index 000000000..8ef7e0b5d --- /dev/null +++ b/plugin/buycourses/src/coupon_add.php @@ -0,0 +1,167 @@ +get('include_sessions') === 'true'; +$includeServices = $plugin->get('include_services') === 'true'; + +$entityManager = Database::getManager(); +$userRepo = UserManager::getRepository(); +$currency = $plugin->getSelectedCurrency(); + +if (empty($currency)) { + Display::addFlash( + Display::return_message($plugin->get_lang('CurrencyIsNotConfigured'), 'error') + ); +} + +$currencyIso = null; + +$coursesList = CourseManager::get_courses_list( + 0, + 0, + 'title', + 'asc', + -1, + null, + api_get_current_access_url_id(), + false, + [], + [] +); + +foreach ($coursesList as $course) { + $courses[$course['id']] = $course['title']; +} + +$sessionsList = SessionManager::get_sessions_list( + [], + [], + null, + null, + api_get_current_access_url_id(), + [] +); + +foreach ($sessionsList as $session) { + $sessions[$session['id']] = $session['name']; +} + +$servicesList = $plugin->getAllServices(); + +foreach ($servicesList as $service) { + $services[$service['id']] = $service['name']; +} + +$discountTypes = $plugin->getCouponDiscountTypes(); + +// Build the form +$form = new FormValidator('add_coupon'); +$form->addText('code', $plugin->get_lang('CouponCode'), true); +$form->addRadio('discount_type', $plugin->get_lang('CouponDiscountType'), $discountTypes); +$form->addElement( + 'number', + 'discount_amount', + [$plugin->get_lang('CouponDiscount'), null, $currencyIso], + ['step' => 1] +); +$form->addDateRangePicker('date', get_lang('Date'), true); +$form->addCheckBox('active', get_lang('Active')); +$form->addElement( + 'advmultiselect', + 'courses', + get_lang('Courses'), + $courses +); + +if ($includeSession) { + $form->addElement( + 'advmultiselect', + 'sessions', + get_lang('Sessions'), + $sessions + ); +} + +if ($includeServices) { + $form->addElement( + 'advmultiselect', + 'services', + get_lang('Services'), + $services + ); +} + +$button = $form->addButtonSave(get_lang('Save')); + +if (empty($currency)) { + $button->setAttribute('disabled'); +} + +if ($form->validate()) { + $formValues = $form->exportValues(); + + $coupon['code'] = $formValues['code']; + $coupon['discount_type'] = $formValues['discount_type']; + $coupon['discount_amount'] = $formValues['discount_amount']; + $coupon['valid_start'] = $formValues['date_start']; + $coupon['valid_end'] = $formValues['date_end']; + $coupon['active'] = $formValues['active']; + + if ($coupon['discount_type'] == BuyCoursesPlugin::COUPON_DISCOUNT_TYPE_PERCENTAGE && $coupon['discount_amount'] > 100) { + Display::addFlash( + Display::return_message($plugin->get_lang('CouponDiscountExceed100'), 'error', false) + ); + } + + $coupon['courses'] = isset($formValues['courses']) ? $formValues['courses'] : []; + $coupon['sessions'] = isset($formValues['sessions']) ? $formValues['sessions'] : []; + $coupon['services'] = isset($formValues['services']) ? $formValues['services'] : []; + + $result = $plugin->addNewCoupon($coupon); + + if ($result) { + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/coupons.php'); + } else { + header('Location:'.api_get_self().'?'.$queryString); + } + + exit; +} + +$formDefaults = [ + 'code' => '', + 'discount_type' => null, + 'discount_amount' => 0, + 'active' => 0, + 'courses' => [], + 'sessions' => [], + 'services' => [], +]; + +$form->setDefaults($formDefaults); + +$templateName = $plugin->get_lang('CouponAdd'); +$interbreadcrumb[] = [ + 'url' => 'paymentsetup.php', + 'name' => get_lang('Configuration'), +]; +$interbreadcrumb[] = [ + 'url' => 'coupons.php', + 'name' => $plugin->get_lang('CouponList'), +]; + +$template = new Template($templateName); +$template->assign('header', $templateName); +$template->assign('content', $form->returnForm()); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/coupons.php b/plugin/buycourses/src/coupons.php new file mode 100644 index 000000000..60c574437 --- /dev/null +++ b/plugin/buycourses/src/coupons.php @@ -0,0 +1,109 @@ +getCouponInfo($_GET['coupon_id']); + + if (empty($coupon)) { + api_not_allowed(true); + } + + $urlToRedirect = api_get_self().'?'; + + switch ($_GET['action']) { + case 'deactivate': + //activate coupon + break; + case 'activate': + //deactivate coupon + break; + } + + header("Location: $urlToRedirect"); + exit; +} + +$discountTypes = $plugin->getCouponDiscountTypes(); +$couponStatuses = $plugin->getCouponStatuses(); + +$selectedFilterType = '0'; +$selectedStatus = isset($_GET['status']) ? $_GET['status'] : BuyCoursesPlugin::COUPON_STATUS_ACTIVE; + +$form = new FormValidator('search', 'get'); + +if ($form->validate()) { + $selectedStatus = $form->getSubmitValue('status'); + + if ($selectedStatus === false) { + $selectedStatus = BuyCoursesPlugin::COUPON_STATUS_ACTIVE; + } + + if ($selectedFilterType === false) { + $selectedFilterType = '0'; + } +} + +$form->addHtml('
'); +$form->addSelect('status', $plugin->get_lang('CouponStatus'), $couponStatuses); +$form->addHtml('
'); +$form->addButtonFilter(get_lang('Search')); +$form->setDefaults([ + 'filter_type' => $selectedFilterType, + 'status' => $selectedStatus, +]); + +$coupons = $plugin->getCouponsListByStatus($selectedStatus); +$currency = $plugin->getSelectedCurrency(); + +foreach ($coupons as &$coupon) { + if ($coupon['discount_type'] == BuyCoursesPlugin::COUPON_DISCOUNT_TYPE_PERCENTAGE) { + $coupon['discount_value'] = $coupon['discount_amount']." %"; + } elseif ($coupon['discount_type'] == BuyCoursesPlugin::COUPON_DISCOUNT_TYPE_AMOUNT) { + $coupon['discount_value'] = $plugin->getPriceWithCurrencyFromIsoCode($coupon['discount_amount'], $currency['iso_code']); + } + $coupon['discount_type'] = $discountTypes[$coupon['discount_type']]; +} + +$interbreadcrumb[] = ['url' => '../index.php', 'name' => $plugin->get_lang('plugin_title')]; + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$templateName = $plugin->get_lang('CouponList'); +$template = new Template($templateName); + +$toolbar = Display::url( + Display::returnFontAwesomeIcon('fas fa-plus'). + $plugin->get_lang('CouponAdd'), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/coupon_add.php', + ['class' => 'btn btn-primary'] +); + +$template->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); + +$template->assign('form', $form->returnForm()); +$template->assign('selected_status', $selectedStatus); +$template->assign('coupon_list', $coupons); +$template->assign('coupon_status_active', BuyCoursesPlugin::COUPON_STATUS_ACTIVE); +$template->assign('coupon_status_disable', BuyCoursesPlugin::COUPON_STATUS_DISABLE); + +$content = $template->fetch('buycourses/view/coupons.tpl'); + +$template->assign('header', $templateName); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/course_catalog.php b/plugin/buycourses/src/course_catalog.php new file mode 100644 index 000000000..02c1d8fb2 --- /dev/null +++ b/plugin/buycourses/src/course_catalog.php @@ -0,0 +1,100 @@ +get('include_sessions') === 'true'; +$includeServices = $plugin->get('include_services') === 'true'; + +$nameFilter = ''; +$minFilter = 0; +$maxFilter = 0; + +$form = new FormValidator( + 'search_filter_form', + 'get', + null, + null, + [], + FormValidator::LAYOUT_INLINE +); + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + $nameFilter = isset($formValues['name']) ? $formValues['name'] : null; + $minFilter = isset($formValues['min']) ? $formValues['min'] : 0; + $maxFilter = isset($formValues['max']) ? $formValues['max'] : 0; +} + +$form->addHeader($plugin->get_lang('SearchFilter')); +$form->addText('name', get_lang('CourseName'), false); +$form->addElement( + 'number', + 'min', + $plugin->get_lang('MinimumPrice'), + ['step' => '0.01', 'min' => '0'] +); +$form->addElement( + 'number', + 'max', + $plugin->get_lang('MaximumPrice'), + ['step' => '0.01', 'min' => '0'] +); +$form->addHtml('
'); +$form->addButtonFilter(get_lang('Search')); + +$pageSize = BuyCoursesPlugin::PAGINATION_PAGE_SIZE; +$currentPage = isset($_GET['page']) ? (int) $_GET['page'] : 1; +$first = $pageSize * ($currentPage - 1); +$courseList = $plugin->getCatalogCourseList($first, $pageSize, $nameFilter, $minFilter, $maxFilter); +$totalItems = $plugin->getCatalogCourseList($first, $pageSize, $nameFilter, $minFilter, $maxFilter, 'count'); +$pagesCount = ceil($totalItems / $pageSize); + +$pagination = BuyCoursesPlugin::returnPagination(api_get_self(), $currentPage, $pagesCount, $totalItems); + +// View +if (api_is_platform_admin()) { + $interbreadcrumb[] = [ + 'url' => 'list.php', + 'name' => $plugin->get_lang('AvailableCoursesConfiguration'), + ]; + $interbreadcrumb[] = [ + 'url' => 'paymentsetup.php', + 'name' => $plugin->get_lang('PaymentsConfiguration'), + ]; +} else { + $interbreadcrumb[] = [ + 'url' => 'course_panel.php', + 'name' => get_lang('TabsDashboard'), + ]; +} + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$templateName = $plugin->get_lang('CourseListOnSale'); +$tpl = new Template($templateName); +$tpl->assign('search_filter_form', $form->returnForm()); +$tpl->assign('showing_courses', true); +$tpl->assign('courses', $courseList); +$tpl->assign('sessions_are_included', $includeSessions); +$tpl->assign('services_are_included', $includeServices); +$tpl->assign('pagination', $pagination); + +$countSessions = $plugin->getCatalogSessionList($first, $pageSize, $nameFilter, $minFilter, $maxFilter, 'count'); + +$tpl->assign('coursesExist', true); +$tpl->assign('sessionExist', $countSessions > 0); + +$content = $tpl->fetch('buycourses/view/catalog.tpl'); + +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/course_panel.php b/plugin/buycourses/src/course_panel.php new file mode 100644 index 000000000..7a2d027f8 --- /dev/null +++ b/plugin/buycourses/src/course_panel.php @@ -0,0 +1,67 @@ +get('include_sessions') === 'true'; +$includeServices = $plugin->get('include_services') === 'true'; + +$userInfo = api_get_user_info(); + +$productTypes = $plugin->getProductTypes(); +$saleStatuses = $plugin->getSaleStatuses(); +$paymentTypes = $plugin->getPaymentTypes(); + +$sales = $plugin->getSaleListByUserId($userInfo['id']); + +$saleList = []; + +foreach ($sales as $sale) { + if ($sale['product_type'] == 1) { + $saleList[] = [ + 'id' => $sale['id'], + 'reference' => $sale['reference'], + 'date' => api_format_date($sale['date'], DATE_TIME_FORMAT_LONG_24H), + 'currency' => $sale['iso_code'], + 'price' => $sale['price'], + 'product_name' => $sale['product_name'], + 'product_type' => $productTypes[$sale['product_type']], + 'payment_type' => $paymentTypes[$sale['payment_type']], + ]; + } +} + +$toolbar = Display::toolbarButton( + $plugin->get_lang('CourseListOnSale'), + 'course_catalog.php', + 'search-plus', + 'primary', + ['title' => $plugin->get_lang('CourseListOnSale')] +); + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$templateName = get_lang('TabsDashboard'); +$tpl = new Template($templateName); +$tpl->assign('showing_courses', true); +$tpl->assign('sessions_are_included', $includeSessions); +$tpl->assign('services_are_included', $includeServices); +$tpl->assign('sale_list', $saleList); + +$content = $tpl->fetch('buycourses/view/course_panel.tpl'); + +$tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/error.php b/plugin/buycourses/src/error.php new file mode 100644 index 000000000..f0ef55241 --- /dev/null +++ b/plugin/buycourses/src/error.php @@ -0,0 +1,14 @@ +addDatePicker('date_start', get_lang('DateStart'), false); +$form->addDatePicker('date_end', get_lang('DateEnd'), false); +$form->addButton('export_sales', get_lang('ExportExcel'), 'check', 'primary'); +$salesStatus = []; + +if ($form->validate()) { + $reportValues = $form->getSubmitValues(); + + $dateStart = $reportValues['date_start']; + $dateEnd = $reportValues['date_end']; + + if ($dateStart == null || $dateEnd == null) { + Display::addFlash( + Display::return_message($plugin->get_lang('SelectDateRange'), 'error', false) + ); + } elseif ($dateStart > $dateEnd) { + Display::addFlash( + Display::return_message(get_lang('EndDateCannotBeBeforeTheStartDate'), 'error', false) + ); + } else { + $salesStatus = $plugin->getSaleListReport($dateStart, $dateEnd); + } +} + +if (!empty($salesStatus)) { + $archiveFile = 'export_report_sales_'.api_get_local_time(); + Export::arrayToXls($salesStatus, $archiveFile); +} +$interbreadcrumb[] = [ + 'url' => '../index.php', 'name' => $plugin->get_lang('plugin_title'), +]; +$interbreadcrumb[] = [ + 'url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/src/sales_report.php', + 'name' => $plugin->get_lang('SalesReport'), +]; + +$templateName = $plugin->get_lang('ExportReport'); +$toolbar = Display::url( + Display::return_icon('back.png', get_lang('GoBack'), [], ICON_SIZE_MEDIUM), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/sales_report.php' +); +$template = new Template($templateName); +$template->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); +$template->assign('form', $form->returnForm()); +$content = $template->fetch('buycourses/view/export_report.tpl'); +$template->assign('header', $templateName); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/export_subscription_report.php b/plugin/buycourses/src/export_subscription_report.php new file mode 100644 index 000000000..ba81299e8 --- /dev/null +++ b/plugin/buycourses/src/export_subscription_report.php @@ -0,0 +1,63 @@ +addDatePicker('date_start', get_lang('DateStart'), false); +$form->addDatePicker('date_end', get_lang('DateEnd'), false); +$form->addButton('export_sales', get_lang('ExportExcel'), 'check', 'primary'); +$salesStatus = []; + +if ($form->validate()) { + $reportValues = $form->getSubmitValues(); + + $dateStart = $reportValues['date_start']; + $dateEnd = $reportValues['date_end']; + + if ($dateStart == null || $dateEnd == null) { + Display::addFlash( + Display::return_message($plugin->get_lang('SelectDateRange'), 'error', false) + ); + } elseif ($dateStart > $dateEnd) { + Display::addFlash( + Display::return_message(get_lang('EndDateCannotBeBeforeTheStartDate'), 'error', false) + ); + } else { + $salesStatus = $plugin->getSubscriptionSaleListReport($dateStart, $dateEnd); + } +} + +if (!empty($salesStatus)) { + $archiveFile = 'export_report_sales_'.api_get_local_time(); + Export::arrayToXls($salesStatus, $archiveFile); +} +$interbreadcrumb[] = [ + 'url' => '../index.php', 'name' => $plugin->get_lang('plugin_title'), +]; +$interbreadcrumb[] = [ + 'url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/src/subscription_sales_report.php', + 'name' => $plugin->get_lang('SubscriptionSalesReport'), +]; + +$templateName = $plugin->get_lang('ExportReport'); +$toolbar = Display::url( + Display::return_icon('back.png', get_lang('GoBack'), [], ICON_SIZE_MEDIUM), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/subscription_sales_report.php' +); +$template = new Template($templateName); +$template->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); +$template->assign('form', $form->returnForm()); +$content = $template->fetch('buycourses/view/export_report.tpl'); +$template->assign('header', $templateName); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/expresscheckout.php b/plugin/buycourses/src/expresscheckout.php new file mode 100644 index 000000000..43fb80e2e --- /dev/null +++ b/plugin/buycourses/src/expresscheckout.php @@ -0,0 +1,47 @@ +get('unregistered_users_enable'); + +$userIsAdmin = api_is_platform_admin(); + +if (($allow === 'true' && api_is_anonymous()) || !api_is_anonymous()) { + $webPluginPath = api_get_path(WEB_PLUGIN_PATH).'buycourses/'; + + $countCourses = $plugin->getCatalogCourseList( + 0, + BuyCoursesPlugin::PAGINATION_PAGE_SIZE, + null, + 0, + 0, + 'count' + ); + + if ($countCourses > 0 && !$userIsAdmin) { + api_location($webPluginPath.'src/course_catalog.php'); + } + + $countSessions = $plugin->getCatalogSessionList( + 0, + BuyCoursesPlugin::PAGINATION_PAGE_SIZE, + null, + 0, + 0, + 'count' + ); + + if ($countSessions > 0 && !$userIsAdmin) { + api_location($webPluginPath.'src/session_catalog.php'); + } + + $htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + + $tpl = new Template(); + $content = $tpl->fetch('buycourses/view/index.tpl'); + $tpl->assign('content', $content); + $tpl->display_one_col_template(false); +} diff --git a/plugin/buycourses/src/index.php b/plugin/buycourses/src/index.php new file mode 100644 index 000000000..b3d9bbc7f --- /dev/null +++ b/plugin/buycourses/src/index.php @@ -0,0 +1 @@ +get('invoicing_enable') === 'true'; +if (!$invoicingEnable) { + api_not_allowed(true, $plugin->get_lang('NoInvoiceEnable')); +} + +$saleId = isset($_GET['invoice']) ? (int) $_GET['invoice'] : 0; +$isService = isset($_GET['is_service']) ? (int) $_GET['is_service'] : 0; + +$globalParameters = $plugin->getGlobalParameters(); +$infoSale = $plugin->getDataSaleInvoice($saleId, $isService); +$buyer = api_get_user_info($infoSale['user_id']); +$extraUserInfoData = UserManager::get_extra_user_data($infoSale['user_id']); +$infoInvoice = $plugin->getDataInvoice($saleId, $isService); + +$taxAppliesTo = $globalParameters['tax_applies_to']; +$taxEnable = $plugin->get('tax_enable') === 'true' && + ($taxAppliesTo == BuyCoursesPlugin::TAX_APPLIES_TO_ALL || + ($taxAppliesTo == BuyCoursesPlugin::TAX_APPLIES_TO_ONLY_COURSE && !$isService) || + ($taxAppliesTo == BuyCoursesPlugin::TAX_APPLIES_TO_ONLY_SESSION && $isService)); + +$htmlText = ''; +$htmlText .= ''; +$htmlText .= ''; +$htmlText .= ''; + +$organization = ChamiloApi::getPlatformLogo('', [], true); +// Use custom logo image. +$pdfLogo = api_get_setting('pdf_logo_header'); +if ($pdfLogo === 'true') { + $visualTheme = api_get_visual_theme(); + $img = api_get_path(SYS_CSS_PATH).'themes/'.$visualTheme.'/images/pdf_logo_header.png'; + if (file_exists($img)) { + $organization = ""; + } +} +$htmlText .= $organization; + +// Seller and customer info +$htmlText .= ''; +$htmlText .= ''; +$htmlText .= ''; +$htmlText .= ''; +$htmlText .= ''; +$htmlText .= '
'; +$htmlText .= ''.$globalParameters['seller_name'].'
'; +$htmlText .= $globalParameters['seller_id'].'
'; +$htmlText .= $globalParameters['seller_address'].'
'; +$htmlText .= $globalParameters['seller_email'].'
'; +$htmlText .= '		'; +$htmlText .= ''.$buyer['complete_name'].'
'; +$htmlText .= ($extraUserInfoData['buycourses_company'] ? $extraUserInfoData['buycourses_company'].'
' : ''); +$htmlText .= ($extraUserInfoData['buycourses_vat'] ? $extraUserInfoData['buycourses_vat'].'
' : ''); +$htmlText .= ($extraUserInfoData['buycourses_address'] ? $extraUserInfoData['buycourses_address'].'
' : ''); +$htmlText .= ($buyer['phone'] ? $buyer['phone'].'
' : ''); +$htmlText .= ($buyer['email'] ? $buyer['email'].'
' : ''); +$htmlText .= '
'; + +$htmlText .= '

'; +$htmlText .= '

'; +$htmlText .= $plugin->get_lang('InvoiceDate').': ' + .api_convert_and_format_date($infoInvoice['date_invoice'], DATE_TIME_FORMAT_LONG_24H).'
'; +$htmlText .= $plugin->get_lang('InvoiceNumber').': ' + .$infoInvoice['serie'].$infoInvoice['year'].'/'.$infoInvoice['num_invoice'].'
'; +$htmlText .= '



'; + +$header = [ + $plugin->get_lang('OrderReference'), + $plugin->get_lang('ProductType'), + $plugin->get_lang('Price'), +]; + +if ($taxEnable) { + $header[] = $globalParameters['tax_name']; + $header[] = $plugin->get_lang('Total'); +} + +$data = []; +$row = [ + $infoSale['reference'], + $infoSale['product_name'], +]; + +//var_dump($infoSale);exit; +$isoCode = $plugin->getCurrency($infoSale['currency_id'])['iso_code']; + +if ($taxEnable) { + $row[] = $plugin->getPriceWithCurrencyFromIsoCode($infoSale['price_without_tax'], $isoCode); + $row[] = $plugin->getPriceWithCurrencyFromIsoCode($infoSale['tax_amount'], $isoCode).' ('.(int) $infoSale['tax_perc'].'%)'; +} + +$totalPrice = $plugin->getPriceWithCurrencyFromIsoCode( + $infoSale['price'], + $plugin->getCurrency($infoSale['currency_id'])['iso_code'] +); + +$row[] = $totalPrice; +$data[] = $row; + +$totalPrice = $plugin->getPriceWithCurrencyFromIsoCode( + $infoSale['price'], + $plugin->getCurrency($infoSale['currency_id'])['iso_code'] +); + +if ($taxEnable) { + $row = [ + '', + '', + '', + $plugin->get_lang('TotalPayout'), + $totalPrice, + ]; +} else { + $row = [ + '', + $plugin->get_lang('TotalPayout'), + $totalPrice, + ]; +} +$data[] = $row; +$attr = []; +$attr['class'] = 'table table-hover table-striped data_table'; +$attr['width'] = '100%'; +$htmlText .= Display::table($header, $data, $attr); +$htmlText .= ''; + +$fileName = $infoInvoice['serie'].$infoInvoice['year'].'-'.$infoInvoice['num_invoice']; +$fileName = api_replace_dangerous_char($fileName); +$params = [ + 'filename' => $fileName, + 'pdf_title' => $plugin->get_lang('Invoice'), + 'pdf_description' => '', + 'format' => 'A4', + 'orientation' => 'P', +]; +$pdf = new PDF($params['format'], $params['orientation'], $params); +@$pdf->content_to_pdf($htmlText, '', $fileName, null, 'D', false, null, false, false, false); +exit; diff --git a/plugin/buycourses/src/list.php b/plugin/buycourses/src/list.php new file mode 100644 index 000000000..eb6386669 --- /dev/null +++ b/plugin/buycourses/src/list.php @@ -0,0 +1,87 @@ +get('include_sessions') === 'true'; +$includeServices = $plugin->get('include_services') === 'true'; +$taxEnable = $plugin->get('tax_enable') === 'true'; + +api_protect_admin_script(true); + +Display::addFlash( + Display::return_message( + get_lang('Info').' - '.$plugin->get_lang('CoursesInSessionsDoesntDisplayHere'), + 'info' + ) +); + +$pageSize = BuyCoursesPlugin::PAGINATION_PAGE_SIZE; +$type = isset($_GET['type']) ? (int) $_GET['type'] : BuyCoursesPlugin::PRODUCT_TYPE_COURSE; +$currentPage = isset($_GET['page']) ? (int) $_GET['page'] : 1; +$first = $pageSize * ($currentPage - 1); + +$qb = $plugin->getCourseList($first, $pageSize); +$query = $qb->getQuery(); +$courses = new Paginator($query, $fetchJoinCollection = true); +foreach ($courses as $course) { + $item = $plugin->getItemByProduct($course->getId(), BuyCoursesPlugin::PRODUCT_TYPE_COURSE); + $course->buyCourseData = []; + if ($item !== false) { + $course->buyCourseData = $item; + } +} + +$totalItems = count($courses); +$pagesCount = ceil($totalItems / $pageSize); + +$pagination = BuyCoursesPlugin::returnPagination( + api_get_self(), + $currentPage, + $pagesCount, + $totalItems, + ['type' => $type] +); + +// breadcrumbs +$interbreadcrumb[] = [ + 'url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php', + 'name' => $plugin->get_lang('plugin_title'), +]; + +$templateName = $plugin->get_lang('AvailableCourses'); + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$tpl = new Template($templateName); + +$tpl->assign('product_type_course', BuyCoursesPlugin::PRODUCT_TYPE_COURSE); +$tpl->assign('product_type_session', BuyCoursesPlugin::PRODUCT_TYPE_SESSION); +$tpl->assign('courses', $courses); +$tpl->assign('course_pagination', $pagination); +$tpl->assign('sessions_are_included', $includeSession); +$tpl->assign('services_are_included', $includeServices); +$tpl->assign('tax_enable', $taxEnable); + +if ($taxEnable) { + $globalParameters = $plugin->getGlobalParameters(); + $tpl->assign('global_tax_perc', $globalParameters['global_tax_perc']); + $tpl->assign('tax_applies_to', $globalParameters['tax_applies_to']); + $tpl->assign('tax_name', $globalParameters['tax_name']); +} + +$content = $tpl->fetch('buycourses/view/list.tpl'); + +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/list_coupon.php b/plugin/buycourses/src/list_coupon.php new file mode 100644 index 000000000..8f9aacd9e --- /dev/null +++ b/plugin/buycourses/src/list_coupon.php @@ -0,0 +1,96 @@ +getCouponInfo($_GET['coupon_id']); + + if (empty($coupon)) { + api_not_allowed(true); + } + + $urlToRedirect = api_get_self().'?'; + + switch ($_GET['action']) { + case 'deactivate': + //activate coupon + break; + case 'activate': + //deactivate coupon + break; + } + + header("Location: $urlToRedirect"); + exit; +} + +$discountTypes = $plugin->getCouponDiscountTypes(); +$couponStatuses = $plugin->getCouponStatuses(); + +$selectedFilterType = '0'; +$selectedStatus = isset($_GET['status']) ? $_GET['status'] : BuyCoursesPlugin::COUPON_STATUS_ACTIVE; + +$form = new FormValidator('search', 'get'); + +if ($form->validate()) { + $selectedStatus = $form->getSubmitValue('status'); + + if ($selectedStatus === false) { + $selectedStatus = BuyCoursesPlugin::COUPON_STATUS_ACTIVE; + } + + if ($selectedFilterType === false) { + $selectedFilterType = '0'; + } +} + +$form->addHtml('
'); +$form->addSelect('status', $plugin->get_lang('CouponStatus'), $couponStatuses); +$form->addHtml('
'); +$form->addButtonFilter(get_lang('Search')); +$form->setDefaults([ + 'filter_type' => $selectedFilterType, + 'status' => $selectedStatus, +]); + +$coupons = $plugin->getCouponsListByStatus($selectedStatus); + +foreach ($coupons as &$coupon) { + if ($coupon['discount_type'] == BuyCoursesPlugin::COUPON_DISCOUNT_TYPE_PERCENTAGE) { + $coupon['discount_value'] = $coupon['discount_amount']." %"; + } elseif ($coupon['discount_type'] == BuyCoursesPlugin::COUPON_DISCOUNT_TYPE_AMOUNT) { + $coupon['discount_value'] = $plugin->getPriceWithCurrencyFromIsoCode($coupon['discount_amount'], $coupon['iso_code']); + } + $coupon['discount_type'] = $discountTypes[$coupon['discount_type']]; +} + +$interbreadcrumb[] = ['url' => '../index.php', 'name' => $plugin->get_lang('plugin_title')]; + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$templateName = $plugin->get_lang('CouponList'); +$template = new Template($templateName); + +$template->assign('form', $form->returnForm()); +$template->assign('selected_status', $selectedStatus); +$template->assign('coupon_list', $coupons); +$template->assign('coupon_status_active', BuyCoursesPlugin::COUPON_STATUS_ACTIVE); +$template->assign('coupon_status_disable', BuyCoursesPlugin::COUPON_STATUS_DISABLE); + +$content = $template->fetch('buycourses/view/list_coupon.tpl'); + +$template->assign('header', $templateName); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/list_service.php b/plugin/buycourses/src/list_service.php new file mode 100644 index 000000000..051f3d61e --- /dev/null +++ b/plugin/buycourses/src/list_service.php @@ -0,0 +1,71 @@ +get('include_sessions') === 'true'; +$includeServices = $plugin->get('include_services') === 'true'; +if (!$includeServices) { + api_not_allowed(true); +} + +$taxEnable = $plugin->get('tax_enable') === 'true'; + +api_protect_admin_script(true); + +Display::addFlash( + Display::return_message( + get_lang('Info').' - '.$plugin->get_lang('CoursesInSessionsDoesntDisplayHere'), + 'info' + ) +); + +$pageSize = BuyCoursesPlugin::PAGINATION_PAGE_SIZE; +$currentPage = isset($_GET['page']) ? (int) $_GET['page'] : 1; +$first = $pageSize * ($currentPage - 1); + +$services = $plugin->getServices($first, $pageSize); +$totalItems = $plugin->getServices(0, 1000000000, 'count'); +$pagesCount = ceil($totalItems / $pageSize); + +$pagination = BuyCoursesPlugin::returnPagination(api_get_self(), $currentPage, $pagesCount, $totalItems); + +// breadcrumbs +$interbreadcrumb[] = [ + 'url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php', + 'name' => $plugin->get_lang('plugin_title'), +]; + +$templateName = $plugin->get_lang('Services'); + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$tpl = new Template($templateName); + +$tpl->assign('product_type_course', BuyCoursesPlugin::PRODUCT_TYPE_COURSE); +$tpl->assign('product_type_session', BuyCoursesPlugin::PRODUCT_TYPE_SESSION); +$tpl->assign('sessions_are_included', $includeSession); +$tpl->assign('services_are_included', $includeServices); +$tpl->assign('tax_enable', $taxEnable); +$tpl->assign('services', $services); +$tpl->assign('service_pagination', $pagination); + +if ($taxEnable) { + $globalParameters = $plugin->getGlobalParameters(); + $tpl->assign('global_tax_perc', $globalParameters['global_tax_perc']); + $tpl->assign('tax_applies_to', $globalParameters['tax_applies_to']); + $tpl->assign('tax_name', $globalParameters['tax_name']); +} + +$content = $tpl->fetch('buycourses/view/list.tpl'); + +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/list_session.php b/plugin/buycourses/src/list_session.php new file mode 100644 index 000000000..cf380ab0c --- /dev/null +++ b/plugin/buycourses/src/list_session.php @@ -0,0 +1,89 @@ +get('include_sessions') === 'true'; + +if (!$includeSession) { + api_not_allowed(true); +} +$includeServices = $plugin->get('include_services') === 'true'; +$taxEnable = $plugin->get('tax_enable') === 'true'; + +api_protect_admin_script(true); + +Display::addFlash( + Display::return_message( + get_lang('Info').' - '.$plugin->get_lang('CoursesInSessionsDoesntDisplayHere'), + 'info' + ) +); + +$pageSize = BuyCoursesPlugin::PAGINATION_PAGE_SIZE; +$currentPage = isset($_GET['page']) ? (int) $_GET['page'] : 1; +$first = $pageSize * ($currentPage - 1); + +// breadcrumbs +$interbreadcrumb[] = [ + 'url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php', + 'name' => $plugin->get_lang('plugin_title'), +]; + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$templateName = $plugin->get_lang('Sessions'); + +$tpl = new Template($templateName); + +$tpl->assign('product_type_course', BuyCoursesPlugin::PRODUCT_TYPE_COURSE); +$tpl->assign('product_type_session', BuyCoursesPlugin::PRODUCT_TYPE_SESSION); +$tpl->assign('sessions_are_included', $includeSession); +$tpl->assign('services_are_included', $includeServices); +$tpl->assign('tax_enable', $taxEnable); + +$query = CoursesAndSessionsCatalog::browseSessions(null, ['start' => $first, 'length' => $pageSize], true); +$sessions = new Paginator($query, $fetchJoinCollection = true); +foreach ($sessions as $session) { + $item = $plugin->getItemByProduct($session->getId(), BuyCoursesPlugin::PRODUCT_TYPE_SESSION); + $session->buyCourseData = []; + if ($item !== false) { + $session->buyCourseData = $item; + } +} + +$totalItems = count($sessions); +$pagesCount = ceil($totalItems / $pageSize); + +$pagination = BuyCoursesPlugin::returnPagination( + api_get_self(), + $currentPage, + $pagesCount, + $totalItems, + ['type' => BuyCoursesPlugin::PRODUCT_TYPE_SESSION] +); + +$tpl->assign('sessions', $sessions); +$tpl->assign('session_pagination', $pagination); + +if ($taxEnable) { + $globalParameters = $plugin->getGlobalParameters(); + $tpl->assign('global_tax_perc', $globalParameters['global_tax_perc']); + $tpl->assign('tax_applies_to', $globalParameters['tax_applies_to']); + $tpl->assign('tax_name', $globalParameters['tax_name']); +} + +$content = $tpl->fetch('buycourses/view/list.tpl'); + +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/panel.ajax.php b/plugin/buycourses/src/panel.ajax.php new file mode 100644 index 000000000..a968c7ddb --- /dev/null +++ b/plugin/buycourses/src/panel.ajax.php @@ -0,0 +1,221 @@ +get('paypal_enable'); +$commissionsEnable = $plugin->get('commissions_enable'); + +$action = isset($_GET['a']) ? $_GET['a'] : null; + +switch ($action) { + case 'saleInfo': + //$saleId is only used in getSale() and is always filtered there + $saleId = isset($_POST['id']) ? $_POST['id'] : ''; + $sale = $plugin->getSale($saleId); + $productType = ($sale['product_type'] == 1) ? get_lang('Course') : get_lang('Session'); + $paymentType = ($sale['payment_type'] == 1) ? 'Paypal' : $plugin->get_lang('BankTransfer'); + $productInfo = ($sale['product_type'] == 1) + ? api_get_course_info_by_id($sale['product_id']) + : api_get_session_info($sale['product_id']); + $currency = $plugin->getSelectedCurrency(); + if ($sale['product_type'] == 1) { + $productImage = $productInfo['course_image_large']; + } else { + $productImage = ($productInfo['image']) + ? $productInfo['image'] + : Template::get_icon_path('session_default.png'); + } + + $userInfo = api_get_user_info($sale['user_id']); + + $html = '

'.$sale['product_name'].'

'; + $html .= '
'; + $html .= '
'; + $html .= '
    '; + $html .= '
  • '.$plugin->get_lang('OrderPrice').': '.$sale['price'].'
    • '; + $html .= '
  • '.$plugin->get_lang('CurrencyType').': '.$currency['iso_code'].'
    • '; + $html .= '
  • '.$plugin->get_lang('ProductType').': '.$productType.'
    • '; + $html .= '
  • '.$plugin->get_lang('OrderDate').': ' + .api_format_date($sale['date'], DATE_TIME_FORMAT_LONG_24H).'
    • '; + $html .= '
  • '.$plugin->get_lang('Buyer').': '.$userInfo['complete_name'].'
    • '; + $html .= '
  • '.$plugin->get_lang('PaymentMethods').': '.$paymentType.'
    • '; + $html .= '
'; + $html .= '
'; + $html .= '
'; + $html .= ''; + $html .= '
'; + $html .= '
'; + echo $html; + break; + case 'stats': + $stats = []; + $stats['completed_count'] = 0; + $stats['completed_total_amount'] = 0; + $stats['pending_count'] = 0; + $stats['pending_total_amount'] = 0; + $stats['canceled_count'] = 0; + $stats['canceled_total_amount'] = 0; + + $completedPayouts = $plugin->getPayouts(BuyCoursesPlugin::PAYOUT_STATUS_COMPLETED); + $pendingPayouts = $plugin->getPayouts(BuyCoursesPlugin::PAYOUT_STATUS_PENDING); + $canceledPayouts = $plugin->getPayouts(BuyCoursesPlugin::PAYOUT_STATUS_CANCELED); + $currency = $plugin->getSelectedCurrency(); + + foreach ($completedPayouts as $completed) { + $stats['completed_count'] = count($completedPayouts); + $stats['completed_total_amount'] += $completed['commission']; + $stats['completed_total_amount'] = number_format($stats['completed_total_amount'], 2); + } + + foreach ($pendingPayouts as $pending) { + $stats['pending_count'] = count($pendingPayouts); + $stats['pending_total_amount'] += $pending['commission']; + $stats['pending_total_amount'] = number_format($stats['pending_total_amount'], 2); + } + + foreach ($canceledPayouts as $canceled) { + $stats['canceled_count'] = count($canceledPayouts); + $stats['canceled_total_amount'] += $canceled['commission']; + $stats['canceled_total_amount'] = number_format($stats['canceled_total_amount'], 2); + } + + $html = ' +
+

+

    +
  • + '.get_plugin_lang("PayoutsTotalCompleted", "BuyCoursesPlugin").' + '.$stats['completed_count'].' - '.get_plugin_lang("TotalAmount", "BuyCoursesPlugin").' + '.$stats['completed_total_amount'].' '.$currency['iso_code'].' +
    • +
  • '.get_plugin_lang("PayoutsTotalPending", "BuyCoursesPlugin").' + '.$stats['pending_count'].' - '.get_plugin_lang("TotalAmount", "BuyCoursesPlugin").' + '.$stats['pending_total_amount'].' '.$currency['iso_code'].' +
    • +
  • '.get_plugin_lang("PayoutsTotalCanceled", "BuyCoursesPlugin").' + '.$stats['canceled_count'].' - '.get_plugin_lang("TotalAmount", "BuyCoursesPlugin").' + '.$stats['canceled_total_amount'].' '.$currency['iso_code'].' +
    • +
+

+
+ '; + echo $html; + break; + case 'processPayout': + if (api_is_anonymous()) { + break; + } + + $html = ''; + $allPays = []; + $totalAccounts = 0; + $totalPayout = 0; + $payouts = isset($_POST['payouts']) ? $_POST['payouts'] : ''; + + if (!$payouts) { + echo Display::return_message(get_plugin_lang("SelectOptionToProceed", "BuyCoursesPlugin"), 'error', false); + + break; + } + + foreach ($payouts as $index => $id) { + $allPays[] = $plugin->getPayouts(BuyCoursesPlugin::PAYOUT_STATUS_PENDING, $id); + } + + foreach ($allPays as $payout) { + $totalPayout += number_format($payout['commission'], 2); + $totalAccounts++; + } + + $currentCurrency = $plugin->getSelectedCurrency(); + + $isoCode = $currentCurrency['iso_code']; + + $html .= '

'.get_plugin_lang("VerifyTotalAmountToProceedPayout", "BuyCoursesPlugin").'

'; + $html .= ' +

+

    +
  • '.get_plugin_lang("TotalAcounts", "BuyCoursesPlugin").' '.$totalAccounts.'
    • +
  • '.get_plugin_lang("TotalPayout", "BuyCoursesPlugin").' '.$isoCode.' '.$totalPayout.'
    • +
+

+

'.get_plugin_lang("CautionThisProcessCantBeCanceled", "BuyCoursesPlugin").'

+

+
+ '; + + echo $html; + break; + + case 'proceedPayout': + if (api_is_anonymous()) { + break; + } + + $paypalParams = $plugin->getPaypalParams(); + $pruebas = $paypalParams['sandbox'] == 1; + $paypalUsername = $paypalParams['username']; + $paypalPassword = $paypalParams['password']; + $paypalSignature = $paypalParams['signature']; + require_once "paypalfunctions.php"; + $allPayouts = []; + $totalAccounts = 0; + $totalPayout = 0; + + $payouts = isset($_POST['payouts']) ? $_POST['payouts'] : ''; + + if (!$payouts) { + echo Display::return_message(get_plugin_lang("SelectOptionToProceed", "BuyCoursesPlugin"), 'error', false); + + break; + } + + foreach ($payouts as $index => $id) { + $allPayouts[] = $plugin->getPayouts(BuyCoursesPlugin::PAYOUT_STATUS_PENDING, $id); + } + + $currentCurrency = $plugin->getSelectedCurrency(); + + $isoCode = $currentCurrency['iso_code']; + + $result = MassPayment($allPayouts, $isoCode); + + if ($result['ACK'] === 'Success') { + foreach ($allPayouts as $payout) { + $plugin->setStatusPayouts($payout['id'], BuyCoursesPlugin::PAYOUT_STATUS_COMPLETED); + } + echo Display::return_message(get_plugin_lang("PayoutSuccess", "BuyCoursesPlugin"), 'success', false); + } else { + echo Display::return_message( + ''.$result['L_SEVERITYCODE0'].' '.$result['L_ERRORCODE0'].' - ' + .$result['L_SHORTMESSAGE0'].'
  • '.$result['L_LONGMESSAGE0'].'
', + 'error', + false + ); + } + break; + + case 'cancelPayout': + if (api_is_anonymous()) { + break; + } + + $payoutId = isset($_POST['id']) ? $_POST['id'] : ''; + $plugin->setStatusPayouts($payoutId, BuyCoursesPlugin::PAYOUT_STATUS_CANCELED); + echo ''; + break; +} +exit; diff --git a/plugin/buycourses/src/paymentsetup.php b/plugin/buycourses/src/paymentsetup.php new file mode 100644 index 000000000..6983c4e10 --- /dev/null +++ b/plugin/buycourses/src/paymentsetup.php @@ -0,0 +1,538 @@ +get('paypal_enable'); +$transferEnable = $plugin->get('transfer_enable'); +$tpvRedsysEnable = $plugin->get('tpv_redsys_enable'); +$commissionsEnable = $plugin->get('commissions_enable'); +$culqiEnable = $plugin->get('culqi_enable'); +$stripeEnable = $plugin->get('stripe_enable') === 'true'; +$cecabankEnable = $plugin->get('cecabank_enable') === 'true'; + +if (isset($_GET['action'], $_GET['id'])) { + if ($_GET['action'] == 'delete_taccount') { + $plugin->deleteTransferAccount($_GET['id']); + + Display::addFlash( + Display::return_message(get_lang('ItemRemoved'), 'success') + ); + + header('Location: '.api_get_self()); + exit; + } +} + +$globalSettingForm = new FormValidator('currency'); + +if ($globalSettingForm->validate()) { + $globalSettingFormValues = $globalSettingForm->getSubmitValues(); + + $plugin->saveCurrency($globalSettingFormValues['currency']); + unset($globalSettingFormValues['currency']); + $plugin->saveGlobalParameters($globalSettingFormValues); + + Display::addFlash( + Display::return_message(get_lang('Saved'), 'success') + ); + + header('Location:'.api_get_self()); + exit; +} + +$currencies = $plugin->getCurrencies(); + +$currencySelect = $globalSettingForm->addSelect( + 'currency', + [ + $plugin->get_lang('CurrencyType'), + $plugin->get_lang('InfoCurrency'), + ], + [get_lang('Select')] +); + +foreach ($currencies as $currency) { + $currencyText = implode( + ' => ', + [ + $currency['country_name'], + $currency['iso_code'], + ] + ); + $currencyValue = $currency['id']; + $currencySelect->addOption($currencyText, $currencyValue); + + if ($currency['status']) { + $currencySelect->setSelected($currencyValue); + } +} + +$globalSettingForm->addTextarea( + 'terms_and_conditions', + [ + get_lang('TermsAndConditions'), + $plugin->get_lang('WriteHereTheTermsAndConditionsOfYourECommerce'), + ] +); + +$globalSettingForm->addElement( + 'text', + 'sale_email', + $plugin->get_lang('SaleEmail') +); + +$taxEnable = $plugin->get('tax_enable') === 'true'; +$invoicingEnable = $plugin->get('invoicing_enable') === 'true'; + +if ($taxEnable) { + $globalSettingForm->addHtml('
'); + + $globalSettingForm->addElement( + 'number', + 'global_tax_perc', + [$plugin->get_lang('GlobalTaxPerc'), $plugin->get_lang('GlobalTaxPercDescription'), '%'], + ['step' => 1] + ); + + $taxAppliesTo = $plugin->getTaxAppliesTo(); + + $taxTypeSelect = $globalSettingForm->addSelect( + 'tax_applies_to', + $plugin->get_lang('TaxAppliesTo'), + [get_lang('Select')] + ); + + foreach ($taxAppliesTo as $key => $value) { + $optionText = $value; + $optionyValue = $key; + + $taxTypeSelect->addOption($optionText, $optionyValue); + } + + $globalSettingForm->addElement( + 'text', + 'tax_name', + $plugin->get_lang('TaxNameCustom'), + ['placeholder' => $plugin->get_lang('TaxNameExamples')] + ); +} + +if ($invoicingEnable) { + $globalSettingForm->addHtml('
'); + + $globalSettingForm->addElement( + 'text', + 'seller_name', + $plugin->get_lang('SellerName') + ); + + $globalSettingForm->addElement( + 'text', + 'seller_id', + $plugin->get_lang('SellerId') + ); + + $globalSettingForm->addElement( + 'text', + 'seller_address', + $plugin->get_lang('SellerAddress') + ); + + $globalSettingForm->addElement( + 'text', + 'seller_email', + $plugin->get_lang('SellerEmail') + ); + + $globalSettingForm->addElement( + 'number', + 'next_number_invoice', + [$plugin->get_lang('NextNumberInvoice'), $plugin->get_lang('NextNumberInvoiceDescription')], + ['step' => 1] + ); + + $globalSettingForm->addElement( + 'text', + 'invoice_series', + [$plugin->get_lang('InvoiceSeries'), $plugin->get_lang('InvoiceSeriesDescription')] + ); +} + +$globalSettingForm->addButtonSave(get_lang('Save')); +$globalSettingForm->setDefaults($plugin->getGlobalParameters()); + +$termsAndConditionsForm = new FormValidator('termsconditions'); + +$paypalForm = new FormValidator('paypal'); + +if ($paypalForm->validate()) { + $paypalFormValues = $paypalForm->getSubmitValues(); + + $plugin->savePaypalParams($paypalFormValues); + + Display::addFlash( + Display::return_message(get_lang('Saved'), 'success') + ); + + header('Location:'.api_get_self()); + exit; +} + +$paypalForm->addText( + 'username', + $plugin->get_lang('ApiUsername'), + false, + ['cols-size' => [3, 8, 1]] +); +$paypalForm->addText( + 'password', + $plugin->get_lang('ApiPassword'), + false, + ['cols-size' => [3, 8, 1]] +); +$paypalForm->addText( + 'signature', + $plugin->get_lang('ApiSignature'), + false, + ['cols-size' => [3, 8, 1]] +); +$paypalForm->addCheckBox('sandbox', null, $plugin->get_lang('Sandbox')); +$paypalForm->addButtonSave(get_lang('Save')); +$paypalForm->setDefaults($plugin->getPaypalParams()); + +// TPV Redsys +$htmlTpvRedsys = Display::return_message($plugin->get_lang('NotFindRedsysFile'), 'warning', false); +if (file_exists(api_get_path(SYS_PLUGIN_PATH).'buycourses/resources/apiRedsys.php')) { + $tpvRedsysForm = new FormValidator('tpv_redsys'); + $tpvRedsysForm->addHtml( + Display::return_message($plugin->get_lang('InfoTpvRedsysApiCredentials'), 'info', false) + ); + + if ($tpvRedsysForm->validate()) { + $tpvRedsysFormValues = $tpvRedsysForm->getSubmitValues(); + + $plugin->saveTpvRedsysParams($tpvRedsysFormValues); + + Display::addFlash( + Display::return_message(get_lang('Saved'), 'success') + ); + + header('Location:'.api_get_self()); + exit; + } + + $tpvRedsysForm->addText( + 'merchantcode', + [$plugin->get_lang('DS_MERCHANT_MERCHANTCODE'), 'DS_MERCHANT_MERCHANTCODE'], + false, + ['cols-size' => [3, 8, 1]] + ); + $tpvRedsysForm->addText( + 'terminal', + [$plugin->get_lang('DS_MERCHANT_TERMINAL'), 'DS_MERCHANT_TERMINAL'], + false, + ['cols-size' => [3, 8, 1]] + ); + $tpvRedsysForm->addText( + 'currency', + [$plugin->get_lang('DS_MERCHANT_CURRENCY'), 'DS_MERCHANT_CURRENCY'], + false, + ['cols-size' => [3, 8, 1]] + ); + $tpvRedsysForm->addText( + 'kc', + $plugin->get_lang('kc'), + false, + ['cols-size' => [3, 8, 1]] + ); + $tpvRedsysForm->addText( + 'url_redsys', + $plugin->get_lang('url_redsys'), + false, + ['cols-size' => [3, 8, 1]] + ); + $tpvRedsysForm->addText( + 'url_redsys_sandbox', + $plugin->get_lang('url_redsys_sandbox'), + false, + ['cols-size' => [3, 8, 1]] + ); + $tpvRedsysForm->addCheckBox('sandbox', null, $plugin->get_lang('Sandbox')); + $tpvRedsysForm->addButtonSave(get_lang('Save')); + $tpvRedsysForm->setDefaults($plugin->getTpvRedsysParams()); + + $htmlTpvRedsys = $tpvRedsysForm->returnForm(); +} + +// Platform Commissions + +$commissionForm = new FormValidator('commissions'); + +if ($commissionForm->validate()) { + $commissionFormValues = $commissionForm->getSubmitValues(); + + $plugin->updateCommission($commissionFormValues); + + Display::addFlash( + Display::return_message(get_lang('Saved'), 'success') + ); + + header('Location:'.api_get_self()); + exit; +} + +$commissionForm->addElement( + 'number', + 'commission', + [$plugin->get_lang('Commission'), null, '%'], + ['step' => 1, 'cols-size' => [3, 7, 1], 'min' => 0, 'max' => 100] +); + +$commissionForm->addButtonSave(get_lang('Save')); +$commissionForm->setDefaults($plugin->getPlatformCommission()); + +$transferForm = new FormValidator('transfer_account'); + +if ($transferForm->validate()) { + $transferFormValues = $transferForm->getSubmitValues(); + + $plugin->saveTransferAccount($transferFormValues); + + Display::addFlash( + Display::return_message(get_lang('Saved'), 'success') + ); + + header('Location:'.api_get_self()); + exit; +} + +$transferForm->addText( + 'tname', + get_lang('Name'), + false, + ['cols-size' => [3, 8, 1]] +); +$transferForm->addText( + 'taccount', + $plugin->get_lang('BankAccount'), + false, + ['cols-size' => [3, 8, 1]] +); +$transferForm->addText( + 'tswift', + [$plugin->get_lang('SWIFT'), $plugin->get_lang('SWIFT_help')], + false, + ['cols-size' => [3, 8, 1]] +); +$transferForm->addButtonCreate(get_lang('Add')); + +$transferAccounts = $plugin->getTransferAccounts(); + +$transferInfoForm = new FormValidator('transfer_info'); + +if ($transferInfoForm->validate()) { + $transferInfoFormValues = $transferInfoForm->getSubmitValues(); + + $plugin->saveTransferInfoEmail($transferInfoFormValues); + + Display::addFlash( + Display::return_message(get_lang('Saved'), 'success') + ); + + header('Location:'.api_get_self()); + exit; +} +$transferInfoForm->addHtmlEditor( + 'tinfo_email_extra', + $plugin->get_lang('InfoEmailExtra'), + false, + false, + ['ToolbarSet' => 'Minimal'] +); +$transferInfoForm->addButtonCreate(get_lang('Save')); +$transferInfoForm->setDefaults($plugin->getTransferInfoExtra()); + +// Culqi main configuration + +$culqiForm = new FormValidator('culqi_config'); + +if ($culqiForm->validate()) { + $culqiFormValues = $culqiForm->getSubmitValues(); + + $plugin->saveCulqiParameters($culqiFormValues); + + Display::addFlash( + Display::return_message(get_lang('Saved'), 'success') + ); + + header('Location:'.api_get_self()); + exit; +} + +$culqiForm->addText( + 'commerce_code', + $plugin->get_lang('CommerceCode'), + false, + ['cols-size' => [3, 8, 1]] +); +$culqiForm->addText( + 'api_key', + $plugin->get_lang('ApiPassword'), + false, + ['cols-size' => [3, 8, 1]] +); +$culqiForm->addCheckBox('integration', null, $plugin->get_lang('Sandbox')); +$culqiForm->addButtonSave(get_lang('Save')); +$culqiForm->setDefaults($plugin->getCulqiParams()); + +// Stripe main configuration + +$stripeForm = new FormValidator('stripe_config'); + +if ($stripeForm->validate()) { + $stripeFormValues = $stripeForm->getSubmitValues(); + + $plugin->saveStripeParameters($stripeFormValues); + + Display::addFlash( + Display::return_message(get_lang('Saved'), 'success') + ); + + header('Location:'.api_get_self()); + exit; +} + +$stripeForm->addText( + 'account_id', + $plugin->get_lang('StripeAccountId'), + false, + ['cols-size' => [3, 8, 1]] +); +$stripeForm->addText( + 'secret_key', + $plugin->get_lang('StripeSecret'), + false, + ['cols-size' => [3, 8, 1]] +); +$stripeForm->addText( + 'endpoint_secret', + $plugin->get_lang('StripeEndpointSecret'), + false, + ['cols-size' => [3, 8, 1]] +); +$stripeForm->addButtonSave(get_lang('Save')); +$stripeForm->setDefaults($plugin->getStripeParams()); + +// Cecabank main configuration + +$cecabankForm = new FormValidator('cecabank_config'); + +if ($cecabankForm->validate()) { + $cecabankFormValues = $cecabankForm->getSubmitValues(); + + $plugin->saveCecabankParameters($cecabankFormValues); + + Display::addFlash( + Display::return_message(get_lang('Saved'), 'success') + ); + + header('Location:'.api_get_self()); + exit; +} + +$cecabankForm->addText( + 'crypto_key', + $plugin->get_lang('CecaSecret'), + false, + ['cols-size' => [3, 8, 1]] +); +$cecabankForm->addText( + 'url', + $plugin->get_lang('CecaUrl'), + false, + ['cols-size' => [3, 8, 1]] +); +$cecabankForm->addText( + 'merchant_id', + $plugin->get_lang('CecaMerchanId'), + false, + ['cols-size' => [3, 8, 1]] +); +$cecabankForm->addText( + 'acquirer_bin', + $plugin->get_lang('CecaAcquirerId'), + false, + ['cols-size' => [3, 8, 1]] +); +$cecabankForm->addText( + 'terminal_id', + $plugin->get_lang('CecaTerminalId'), + false, + ['cols-size' => [3, 8, 1]] +); +$cecabankForm->addText( + 'cypher', + $plugin->get_lang('CecaCypher'), + false, + ['cols-size' => [3, 8, 1]] +); +$cecabankForm->addText( + 'exponent', + $plugin->get_lang('CecaExponent'), + false, + ['cols-size' => [3, 8, 1]] +); +$cecabankForm->addText( + 'supported_payment', + $plugin->get_lang('CecaSupportedPayment'), + false, + ['cols-size' => [3, 8, 1]] +); +$cecabankForm->addButtonSave(get_lang('Save')); +$cecabankForm->setDefaults($plugin->getCecabankParams()); + +// breadcrumbs +$interbreadcrumb[] = [ + 'url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php', + 'name' => $plugin->get_lang('plugin_title'), +]; + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$templateName = $plugin->get_lang('PaymentsConfiguration'); +$tpl = new Template($templateName); +$tpl->assign('header', $templateName); +$tpl->assign('global_config_form', $globalSettingForm->returnForm()); +$tpl->assign('paypal_form', $paypalForm->returnForm()); +$tpl->assign('commission_form', $commissionForm->returnForm()); +$tpl->assign('transfer_form', $transferForm->returnForm()); +$tpl->assign('transfer_info_form', $transferInfoForm->returnForm()); +$tpl->assign('culqi_form', $culqiForm->returnForm()); +$tpl->assign('transfer_accounts', $transferAccounts); +$tpl->assign('paypal_enable', $paypalEnable); +$tpl->assign('commissions_enable', $commissionsEnable); +$tpl->assign('transfer_enable', $transferEnable); +$tpl->assign('culqi_enable', $culqiEnable); +$tpl->assign('tpv_redsys_enable', $tpvRedsysEnable); +$tpl->assign('tpv_redsys_form', $htmlTpvRedsys); +$tpl->assign('stripe_enable', $stripeEnable); +$tpl->assign('stripe_form', $stripeForm->returnForm()); +$tpl->assign('cecabank_enable', $cecabankEnable); +$tpl->assign('cecabank_form', $cecabankForm->returnForm()); + +$content = $tpl->fetch('buycourses/view/paymentsetup.tpl'); + +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/payout_panel.php b/plugin/buycourses/src/payout_panel.php new file mode 100644 index 000000000..f972fed32 --- /dev/null +++ b/plugin/buycourses/src/payout_panel.php @@ -0,0 +1,65 @@ +get('include_sessions') === 'true'; + +$userInfo = api_get_user_info(); + +$payouts = $plugin->getPayouts(BuyCoursesPlugin::PAYOUT_STATUS_COMPLETED, 0, $userInfo['id']); + +$payoutList = []; + +foreach ($payouts as $payout) { + $payoutList[] = [ + 'id' => $payout['id'], + 'sale_id' => $payout['sale_id'], + 'reference' => $payout['sale_reference'], + 'date' => api_format_date($payout['date'], DATE_TIME_FORMAT_LONG_24H), + 'payout_date' => ($payout['payout_date'] === '0000-00-00 00:00:00') + ? '-' + : api_format_date($payout['payout_date'], DATE_TIME_FORMAT_LONG_24H), + 'currency' => $payout['iso_code'], + 'price' => $payout['item_price'], + 'commission' => $payout['commission'], + 'paypal_account' => $payout['paypal_account'], + 'status' => $payout['status'], + ]; +} + +$toolbar = Display::toolbarButton( + $plugin->get_lang('CourseListOnSale'), + 'course_catalog.php', + 'search-plus', + 'primary', + ['title' => $plugin->get_lang('CourseListOnSale')] +); + +$templateName = get_lang('TabsDashboard'); + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$tpl = new Template($templateName); +$tpl->assign('showing_courses', true); +$tpl->assign('sessions_are_included', $includeSessions); +$tpl->assign('payout_list', $payoutList); + +$content = $tpl->fetch('buycourses/view/payout_panel.tpl'); + +$tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/payout_report.php b/plugin/buycourses/src/payout_report.php new file mode 100644 index 000000000..36fa0d7ef --- /dev/null +++ b/plugin/buycourses/src/payout_report.php @@ -0,0 +1,94 @@ +'; + +api_protect_admin_script(true); + +$plugin = BuyCoursesPlugin::create(); + +$commissionsEnable = $plugin->get('commissions_enable'); +$payoutStatuses = $plugin->getPayoutStatuses(); +$selectedStatus = isset($_GET['status']) ? $_GET['status'] : BuyCoursesPlugin::SALE_STATUS_COMPLETED; + +if ($commissionsEnable !== "true") { + api_not_allowed(true); +} + +$form = new FormValidator('search', 'get'); + +if ($form->validate()) { + $selectedStatus = $form->getSubmitValue('status'); + + if ($selectedStatus === false) { + $selectedStatus = BuyCoursesPlugin::PAYOUT_STATUS_PENDING; + } +} + +$form->addSelect('status', $plugin->get_lang('PayoutStatus'), $payoutStatuses); +$form->addButtonFilter(get_lang('Search')); +$form->setDefaults([ + 'status' => $selectedStatus, +]); + +switch ($selectedStatus) { + case '2': + $payouts = $plugin->getPayouts($selectedStatus); + + break; + case '1': + $payouts = $plugin->getPayouts($selectedStatus); + + break; + case '0': + default: + $payouts = $plugin->getPayouts(); + + break; +} + +$payoutList = []; + +foreach ($payouts as $payout) { + $payoutList[] = [ + 'id' => $payout['id'], + 'sale_id' => $payout['sale_id'], + 'reference' => $payout['sale_reference'], + 'date' => api_format_date($payout['date'], DATE_TIME_FORMAT_LONG_24H), + 'payout_date' => ($payout['payout_date'] === '0000-00-00 00:00:00') + ? '-' + : api_format_date($payout['payout_date'], DATE_TIME_FORMAT_LONG_24H), + 'currency' => $payout['iso_code'], + 'price' => $payout['item_price'], + 'commission' => $payout['commission'], + 'beneficiary' => api_get_person_name($payout['firstname'], $payout['lastname']), + 'paypal_account' => $payout['paypal_account'], + 'status' => $payout['status'], + ]; +} + +$templateName = $plugin->get_lang('PayoutReport'); + +$template = new Template($templateName); + +$template->assign('form', $form->returnForm()); +$template->assign('payout_list', $payoutList); +$template->assign('selected_status', $selectedStatus); + +$content = $template->fetch('buycourses/view/payout_report.tpl'); + +$template->assign('header', $templateName); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/paypal_payout.php b/plugin/buycourses/src/paypal_payout.php new file mode 100644 index 000000000..17a3dd2e1 --- /dev/null +++ b/plugin/buycourses/src/paypal_payout.php @@ -0,0 +1,55 @@ +get('paypal_enable'); +$commissionsEnable = $plugin->get('commissions_enable'); + +if ($paypalEnable !== "true" && $commissionsEnable !== "true") { + api_not_allowed(true); +} + +$payouts = $plugin->getPayouts(); + +$payoutList = []; + +foreach ($payouts as $payout) { + $payoutList[] = [ + 'id' => $payout['id'], + 'reference' => $payout['sale_reference'], + 'date' => api_format_date($payout['date'], DATE_TIME_FORMAT_LONG_24H), + 'currency' => $payout['iso_code'], + 'price' => $payout['item_price'], + 'commission' => $payout['commission'], + 'paypal_account' => $payout['paypal_account'], + ]; +} + +$templateName = $plugin->get_lang('PaypalPayoutCommissions'); + +$template = new Template($templateName); + +$template->assign('payout_list', $payoutList); + +$content = $template->fetch('buycourses/view/paypal_payout.tpl'); + +$template->assign('header', $templateName); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/paypalfunctions.php b/plugin/buycourses/src/paypalfunctions.php new file mode 100644 index 000000000..8bb0e4fe7 --- /dev/null +++ b/plugin/buycourses/src/paypalfunctions.php @@ -0,0 +1,432 @@ + with your API Username + * Replace with your API Password + * Replace with your Signature. + */ +$API_UserName = $paypalUsername; +$API_Password = $paypalPassword; +$API_Signature = $paypalSignature; + +// BN Code is only applicable for partners +$sBNCode = "PP-ECWizard"; + +/** + * Define the PayPal Redirect URLs. + * This is the URL that the buyer is first sent to do authorize payment with their paypal account + * change the URL depending if you are testing on the sandbox or the live PayPal site. + * + * For the sandbox, the URL is https://www.sandbox.paypal.com/webscr&cmd=_express-checkout&token= + * For the live site, the URL is https://www.paypal.com/webscr&cmd=_express-checkout&token= + */ +if ($SandboxFlag == true) { + $API_Endpoint = "https://api-3t.sandbox.paypal.com/nvp"; + $PAYPAL_URL = "https://www.sandbox.paypal.com/webscr?cmd=_express-checkout&token="; +} else { + $API_Endpoint = "https://api-3t.paypal.com/nvp"; + $PAYPAL_URL = "https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token="; +} + +$USE_PROXY = false; +$version = "93"; + +if (session_id() == "") { + session_start(); +} + +/** + * An express checkout transaction starts with a token, that + * identifies to PayPal your transaction + * In this example, when the script sees a token, the script + * knows that the buyer has already authorized payment through + * paypal. If no token was found, the action is to send the buyer + * to PayPal to first authorize payment. + */ + +/** + * Purpose: Prepares the parameters for the SetExpressCheckout API Call. + * Inputs: + * paymentAmount: Total value of the shopping cart + * currencyCodeType: Currency code value the PayPal API + * paymentType: paymentType has to be one of the following values: Sale or Order or Authorization + * returnURL: the page where buyers return to after they are done with the payment review on PayPal + * cancelURL: the page where buyers return to when they cancel the payment review on PayPal. + */ +function CallShortcutExpressCheckout($paymentAmount, $currencyCodeType, $paymentType, $returnURL, $cancelURL, $extra) +{ + // Construct the parameter string that describes the SetExpressCheckout API call in the shortcut implementation + $nvpstr = "&PAYMENTREQUEST_0_AMT=".$paymentAmount; + $nvpstr .= "&PAYMENTREQUEST_0_ITEMAMT=".$paymentAmount; + $nvpstr .= "&PAYMENTREQUEST_0_PAYMENTACTION=".$paymentType; + $nvpstr .= "&RETURNURL=".$returnURL; + $nvpstr .= "&CANCELURL=".$cancelURL; + $nvpstr .= "&PAYMENTREQUEST_0_CURRENCYCODE=".$currencyCodeType; + $nvpstr .= $extra; + + $_SESSION["currencyCodeType"] = $currencyCodeType; + $_SESSION["PaymentType"] = $paymentType; + + /** + * Make the API call to PayPal + * If the API call succeded, then redirect the buyer to PayPal to begin to authorize payment. + * If an error occured, show the resulting errors. + */ + $resArray = hash_call("SetExpressCheckout", $nvpstr); + $ack = strtoupper($resArray["ACK"]); + if ($ack == "SUCCESS" || $ack == "SUCCESSWITHWARNING") { + $token = urldecode($resArray["TOKEN"]); + $_SESSION['TOKEN'] = $token; + } + + return $resArray; +} + +/** + * Purpose: Prepares the parameters for the SetExpressCheckout API Call. + * Inputs: + * paymentAmount: Total value of the shopping cart + * currencyCodeType: Currency code value the PayPal API + * paymentType: paymentType has to be one of the following values: Sale or Order or Authorization + * returnURL: the page where buyers return to after they are done with the payment review on PayPal + * cancelURL: the page where buyers return to when they cancel the payment review on PayPal + * shipToName: the Ship to name entered on the merchant's site + * shipToStreet: the Ship to Street entered on the merchant's site + * shipToCity: the Ship to City entered on the merchant's site + * shipToState: the Ship to State entered on the merchant's site + * shipToCountryCode: the Code for Ship to Country entered on the merchant's site + * shipToZip: the Ship to ZipCode entered on the merchant's site + * shipToStreet2: the Ship to Street2 entered on the merchant's site + * phoneNum: the phoneNum entered on the merchant's site. + */ +function CallMarkExpressCheckout( + $paymentAmount, + $currencyCodeType, + $paymentType, + $returnURL, + $cancelURL, + $shipToName, + $shipToStreet, + $shipToCity, + $shipToState, + $shipToCountryCode, + $shipToZip, + $shipToStreet2, + $phoneNum +) { + // Construct the parameter string that describes the SetExpressCheckout API call in the shortcut implementation + $nvpstr = "&PAYMENTREQUEST_0_AMT=".$paymentAmount; + $nvpstr = $nvpstr."&PAYMENTREQUEST_0_PAYMENTACTION=".$paymentType; + $nvpstr = $nvpstr."&RETURNURL=".$returnURL; + $nvpstr = $nvpstr."&CANCELURL=".$cancelURL; + $nvpstr = $nvpstr."&PAYMENTREQUEST_0_CURRENCYCODE=".$currencyCodeType; + $nvpstr = $nvpstr."&ADDROVERRIDE=1"; + $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTONAME=".$shipToName; + $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOSTREET=".$shipToStreet; + $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOSTREET2=".$shipToStreet2; + $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOCITY=".$shipToCity; + $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOSTATE=".$shipToState; + $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE=".$shipToCountryCode; + $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOZIP=".$shipToZip; + $nvpstr = $nvpstr."&PAYMENTREQUEST_0_SHIPTOPHONENUM=".$phoneNum; + + $_SESSION["currencyCodeType"] = $currencyCodeType; + $_SESSION["PaymentType"] = $paymentType; + + /** + * Make the API call to PayPal + * If the API call succeded, then redirect the buyer to PayPal to begin to authorize payment. + * If an error occured, show the resulting errors. + */ + $resArray = hash_call("SetExpressCheckout", $nvpstr); + $ack = strtoupper($resArray["ACK"]); + if ($ack == "SUCCESS" || $ack == "SUCCESSWITHWARNING") { + $token = urldecode($resArray["TOKEN"]); + $_SESSION['TOKEN'] = $token; + } + + return $resArray; +} + +/** + * Purpose: Prepares the parameters for the GetExpressCheckoutDetails API Call. + * + * Inputs: + * None + * Returns: + * The NVP Collection object of the GetExpressCheckoutDetails Call Response. + */ +function GetShippingDetails($token) +{ + /** + * At this point, the buyer has completed authorizing the payment + * at PayPal. The function will call PayPal to obtain the details + * of the authorization, including any shipping information of the + * buyer. Remember, the authorization is not a completed transaction + * at this state - the buyer still needs an additional step to finalize + * the transaction. + * + * Build a second API request to PayPal, using the token as the + * ID to get the details on the payment authorization + */ + $nvpstr = "&TOKEN=".$token; + + /** + * Make the API call and store the results in an array. + * If the call was a success, show the authorization details, and provide + * an action to complete the payment. + * If failed, show the error. + */ + $resArray = hash_call("GetExpressCheckoutDetails", $nvpstr); + $ack = strtoupper($resArray["ACK"]); + if ($ack == "SUCCESS" || $ack == "SUCCESSWITHWARNING") { + $_SESSION['payer_id'] = $resArray['PAYERID']; + } + + return $resArray; +} + +/** + * Purpose: Prepares the parameters for the GetExpressCheckoutDetails API Call. + * Inputs: + * sBNCode: The BN code used by PayPal to track the transactions from a given shopping cart. + * Returns: + * The NVP Collection object of the GetExpressCheckoutDetails Call Response. + */ +function ConfirmPayment($FinalPaymentAmt) +{ + /** + * Gather the information to make the final call to + * finalize the PayPal payment. The variable nvpstr + * holds the name value pairs. + */ + + //Format the other parameters that were stored in the session from the previous calls + + $token = urlencode($_SESSION['TOKEN']); + $paymentType = urlencode($_SESSION['PaymentType']); + $currencyCodeType = urlencode($_SESSION['currencyCodeType']); + $payerID = urlencode($_SESSION['payer_id']); + $serverName = urlencode($_SERVER['SERVER_NAME']); + + $nvpstr = + '&TOKEN='.$token.'&PAYERID='.$payerID.'&PAYMENTREQUEST_0_PAYMENTACTION='.$paymentType.'&PAYMENTREQUEST_0_AMT=' + .$FinalPaymentAmt; + $nvpstr .= '&PAYMENTREQUEST_0_CURRENCYCODE='.$currencyCodeType.'&IPADDRESS='.$serverName; + $nvpstr = '&'.http_build_query([ + 'TOKEN' => $token, + 'PAYERID' => $payerID, + 'PAYMENTACTION' => $paymentType, + 'PAYMENTREQUEST_0_AMT' => $FinalPaymentAmt, + 'PAYMENTREQUEST_0_CURRENCYCODE' => $currencyCodeType, + 'IPADDRESS' => $serverName, + 'paymentactionspecified' => 'true', + ]); + + /** + * Make the call to PayPal to finalize payment + * If an error occured, show the resulting errors. + */ + $resArray = hash_call("DoExpressCheckoutPayment", $nvpstr); + + /** + * Display the API response back to the browser. + * If the response from PayPal was a success, display the response parameters + * If the response was an error, display the errors received using APIError.php. + */ + $ack = strtoupper($resArray["ACK"]); + + return $resArray; +} + +/** + * Purpose: This function makes a DoDirectPayment API call + * Inputs: + * paymentType: paymentType has to be one of the following values: Sale or Order or Authorization + * paymentAmount: total value of the shopping cart + * currencyCode: currency code value the PayPal API + * firstName: first name as it appears on credit card + * lastName: last name as it appears on credit card + * street: buyer's street address line as it appears on credit card + * city: buyer's city + * state: buyer's state + * countryCode: buyer's country code + * zip: buyer's zip + * creditCardType: buyer's credit card type (i.e. Visa, MasterCard ... ) + * creditCardNumber: buyers credit card number without any spaces, dashes or any other characters + * expDate: credit card expiration date + * cvv2: Card Verification Value + * Returns: + * The NVP Collection object of the DoDirectPayment Call Response. + */ +function DirectPayment( + $paymentType, + $paymentAmount, + $creditCardType, + $creditCardNumber, + $expDate, + $cvv2, + $firstName, + $lastName, + $street, + $city, + $state, + $zip, + $countryCode, + $currencyCode +) { + //Construct the parameter string that describes DoDirectPayment + $nvpstr = "&AMT=".$paymentAmount; + $nvpstr = $nvpstr."&CURRENCYCODE=".$currencyCode; + $nvpstr = $nvpstr."&PAYMENTACTION=".$paymentType; + $nvpstr = $nvpstr."&CREDITCARDTYPE=".$creditCardType; + $nvpstr = $nvpstr."&ACCT=".$creditCardNumber; + $nvpstr = $nvpstr."&EXPDATE=".$expDate; + $nvpstr = $nvpstr."&CVV2=".$cvv2; + $nvpstr = $nvpstr."&FIRSTNAME=".$firstName; + $nvpstr = $nvpstr."&LASTNAME=".$lastName; + $nvpstr = $nvpstr."&STREET=".$street; + $nvpstr = $nvpstr."&CITY=".$city; + $nvpstr = $nvpstr."&STATE=".$state; + $nvpstr = $nvpstr."&COUNTRYCODE=".$countryCode; + $nvpstr = $nvpstr."&IPADDRESS=".$_SERVER['REMOTE_ADDR']; + + $resArray = hash_call("DoDirectPayment", $nvpstr); + + return $resArray; +} + +/** + * Purpose: This function makes a MassPay API call + * Inputs: + * Beneficiarie: Array that contains the Beneficiearie paypal account and the payout amount + * Currency Code: The currency Iso code + * Returns: + * The NVP Collection object of the MassPay Call Response. + */ +function MassPayment(array $beneficiaries, $currencyCode) +{ + $nvpstr = "&RECEIVERTYPE=EmailAddress"; + $nvpstr .= "&CURRENCYCODE=".$currencyCode; + + $index = 0; + + foreach ($beneficiaries as $beneficiary) { + $nvpstr .= "&L_EMAIL".$index."=".$beneficiary['paypal_account']; + $nvpstr .= "&L_AMT".$index."=".$beneficiary['commission']; + $index++; + } + + $resArray = hash_call("MassPay", $nvpstr); + + return $resArray; +} + +/** + * hash_call: Function to perform the API call to PayPal using API signature. + * + * @methodName is name of API method. + * @nvpStr is nvp string. + * returns an associtive array containing the response from the server. + */ +function hash_call($methodName, $nvpStr) +{ + //declaring of global variables + global $API_Endpoint, $version, $API_UserName, $API_Password, $API_Signature; + global $USE_PROXY, $PROXY_HOST, $PROXY_PORT; + global $sBNCode; + + //setting the curl parameters. + $ch = curl_init(); + curl_setopt($ch, CURLOPT_URL, $API_Endpoint); + curl_setopt($ch, CURLOPT_VERBOSE, 1); + //turning off the server and peer verification(TrustManager Concept). + curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); + curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); + curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); + curl_setopt($ch, CURLOPT_POST, 1); + + //if USE_PROXY constant set to TRUE in Constants.php, then only proxy will be enabled. + //Set proxy name to PROXY_HOST and port number to PROXY_PORT in constants.php + if ($USE_PROXY) { + curl_setopt($ch, CURLOPT_PROXY, $PROXY_HOST.":".$PROXY_PORT); + } + + //NVPRequest for submitting to server + $nvpreq = "METHOD=".urlencode($methodName)."&VERSION=".urlencode($version). + "&PWD=".urlencode($API_Password)."&USER=".urlencode($API_UserName). + "&SIGNATURE=".urlencode($API_Signature).$nvpStr."&BUTTONSOURCE=".urlencode($sBNCode); + + //setting the nvpreq as POST FIELD to curl + curl_setopt($ch, CURLOPT_POSTFIELDS, $nvpreq); + //getting response from server + $response = curl_exec($ch); + //converting NVPResponse to an Associative Array + $nvpResArray = deformatNVP($response); + $nvpReqArray = deformatNVP($nvpreq); + + $_SESSION['nvpReqArray'] = $nvpReqArray; + + if (curl_errno($ch)) { + // moving to display page to display curl errors + $_SESSION['curl_error_no'] = curl_errno($ch); + $_SESSION['curl_error_msg'] = curl_error($ch); + //Execute the Error handling module to display errors. + } else { + //closing the curl + curl_close($ch); + } + + return $nvpResArray; +} + +/** + * Purpose: Redirects to PayPal.com site. + * Inputs: NVP string. + */ +function RedirectToPayPal($token) +{ + global $PAYPAL_URL; + // Redirect to paypal.com here + $payPalURL = $PAYPAL_URL.$token; + header("Location: ".$payPalURL); + exit; +} + +/** + * This function will take NVPString and convert it to an Associative Array and it will decode the response. + * It is usefull to search for a particular key and displaying arrays. + * + * @nvpstr is NVPString. + * @nvpArray is Associative Array. + */ +function deformatNVP($nvpstr) +{ + $intial = 0; + $nvpArray = []; + + while (strlen($nvpstr)) { + //postion of Key + $keypos = strpos($nvpstr, '='); + //position of value + $valuepos = strpos($nvpstr, '&') ? strpos($nvpstr, '&') : strlen($nvpstr); + /*getting the Key and Value values and storing in a Associative Array*/ + $keyval = substr($nvpstr, $intial, $keypos); + $valval = substr($nvpstr, $keypos + 1, $valuepos - $keypos - 1); + //decoding the respose + $nvpArray[urldecode($keyval)] = urldecode($valval); + $nvpstr = substr($nvpstr, $valuepos + 1, strlen($nvpstr)); + } + + return $nvpArray; +} diff --git a/plugin/buycourses/src/process.php b/plugin/buycourses/src/process.php new file mode 100644 index 000000000..b2ccc9369 --- /dev/null +++ b/plugin/buycourses/src/process.php @@ -0,0 +1,188 @@ +'; +$plugin = BuyCoursesPlugin::create(); +$includeSession = $plugin->get('include_sessions') === 'true'; +$paypalEnabled = $plugin->get('paypal_enable') === 'true'; +$transferEnabled = $plugin->get('transfer_enable') === 'true'; +$culqiEnabled = $plugin->get('culqi_enable') === 'true'; +$tpvRedsysEnable = $plugin->get('tpv_redsys_enable') === 'true'; +$stripeEnable = $plugin->get('stripe_enable') === 'true'; +$tpvCecabankEnable = $plugin->get('cecabank_enable') === 'true'; + +if (!$paypalEnabled && !$transferEnabled && !$culqiEnabled && !$tpvRedsysEnable && !$stripeEnable && !$tpvCecabankEnable) { + api_not_allowed(true); +} + +if (!isset($_REQUEST['t'], $_REQUEST['i'])) { + api_not_allowed(true); +} + +$currency = $plugin->getSelectedCurrency(); +$buyingCourse = intval($_REQUEST['t']) === BuyCoursesPlugin::PRODUCT_TYPE_COURSE; +$buyingSession = intval($_REQUEST['t']) === BuyCoursesPlugin::PRODUCT_TYPE_SESSION; +$queryString = 'i='.intval($_REQUEST['i']).'&t='.intval($_REQUEST['t']); + +$coupon = null; + +if (isset($_REQUEST['c'])) { + $couponId = (int) $_REQUEST['c']; + if ($buyingCourse) { + $coupon = $plugin->getCoupon($couponId, BuyCoursesPlugin::PRODUCT_TYPE_COURSE, $_REQUEST['i']); + } else { + $coupon = $plugin->getCoupon($couponId, BuyCoursesPlugin::PRODUCT_TYPE_SESSION, $_REQUEST['i']); + } +} + +if (empty($currentUserId)) { + Session::write('buy_course_redirect', api_get_self().'?'.$queryString); + header('Location: '.api_get_path(WEB_CODE_PATH).'auth/inscription.php'); + exit; +} + +if ($buyingCourse) { + $courseInfo = $plugin->getCourseInfo($_REQUEST['i'], $coupon); + $item = $plugin->getItemByProduct($_REQUEST['i'], BuyCoursesPlugin::PRODUCT_TYPE_COURSE); +} elseif ($buyingSession) { + $sessionInfo = $plugin->getSessionInfo($_REQUEST['i'], $coupon); + $item = $plugin->getItemByProduct($_REQUEST['i'], BuyCoursesPlugin::PRODUCT_TYPE_SESSION); +} + +$form = new FormValidator('confirm_sale'); +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + + if (!$formValues['payment_type']) { + Display::addFlash( + Display::return_message($plugin->get_lang('NeedToSelectPaymentType'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + + $saleId = $plugin->registerSale($item['id'], $formValues['payment_type'], $formValues['c']); + + if ($saleId !== false) { + $_SESSION['bc_sale_id'] = $saleId; + + if (isset($formValues['c'])) { + $couponSaleId = $plugin->registerCouponSale($saleId, $formValues['c']); + if ($couponSaleId !== false) { + $plugin->updateCouponDelivered($formValues['c']); + $_SESSION['bc_coupon_id'] = $formValues['c']; + } + } + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/process_confirm.php'); + } + + exit; +} + +$paymentTypesOptions = $plugin->getPaymentTypes(true); + +$count = count($paymentTypesOptions); +if ($count === 0) { + $form->addHtml($plugin->get_lang('NoPaymentOptionAvailable')); + $form->addHtml('
'); + $form->addHtml('
'); +} elseif ($count === 1) { + // get the only array item + foreach ($paymentTypesOptions as $type => $value) { + $form->addHtml(sprintf($plugin->get_lang('XIsOnlyPaymentMethodAvailable'), $value)); + $form->addHtml('
'); + $form->addHtml('
'); + $form->addHidden('payment_type', $type); + } +} else { + $form->addHtml( + Display::return_message( + $plugin->get_lang('PleaseSelectThePaymentMethodBeforeConfirmYourOrder'), + 'info' + ) + ); + $form->addRadio('payment_type', null, $paymentTypesOptions); +} + +$form->addHidden('t', intval($_REQUEST['t'])); +$form->addHidden('i', intval($_REQUEST['i'])); +if ($coupon != null) { + $form->addHidden('c', intval($coupon['id'])); +} +$form->addButton('submit', $plugin->get_lang('ConfirmOrder'), 'check', 'success', 'btn-lg pull-right'); + +$formCoupon = new FormValidator('confirm_coupon'); +if ($formCoupon->validate()) { + $formCouponValues = $formCoupon->getSubmitValues(); + + if (!$formCouponValues['coupon_code']) { + Display::addFlash( + Display::return_message($plugin->get_lang('NeedToAddCouponCode'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + + if ($buyingCourse) { + $coupon = $plugin->getCouponByCode($formCouponValues['coupon_code'], BuyCoursesPlugin::PRODUCT_TYPE_COURSE, $_REQUEST['i']); + } else { + $coupon = $plugin->getCouponByCode($formCouponValues['coupon_code'], BuyCoursesPlugin::PRODUCT_TYPE_SESSION, $_REQUEST['i']); + } + + if ($coupon == null) { + Display::addFlash( + Display::return_message($plugin->get_lang('CouponNotValid'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + + Display::addFlash( + Display::return_message($plugin->get_lang('CouponRedeemed'), 'success', false) + ); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/process.php?i='.$_REQUEST['i'].'&t='.$_REQUEST['t'].'&c='.$coupon['id']); + + exit; +} +$formCoupon->addText('coupon_code', $plugin->get_lang('CouponsCode'), true); +$formCoupon->addHidden('t', intval($_GET['t'])); +$formCoupon->addHidden('i', intval($_GET['i'])); +$formCoupon->addButton('submit', $plugin->get_lang('RedeemCoupon'), 'check', 'success', 'btn-lg pull-right'); + +// View +$templateName = $plugin->get_lang('PaymentMethods'); +$interbreadcrumb[] = ['url' => 'course_catalog.php', 'name' => $plugin->get_lang('CourseListOnSale')]; + +$tpl = new Template($templateName); +$tpl->assign('item_type', (int) $_GET['t']); +$tpl->assign('buying_course', $buyingCourse); +$tpl->assign('buying_session', $buyingSession); +$tpl->assign('user', api_get_user_info()); +$tpl->assign('form_coupon', $formCoupon->returnForm()); +$tpl->assign('form', $form->returnForm()); + +if ($buyingCourse) { + $tpl->assign('course', $courseInfo); +} elseif ($buyingSession) { + $tpl->assign('session', $sessionInfo); +} + +$content = $tpl->fetch('buycourses/view/process.tpl'); + +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/process_confirm.php b/plugin/buycourses/src/process_confirm.php new file mode 100644 index 000000000..ecb24794e --- /dev/null +++ b/plugin/buycourses/src/process_confirm.php @@ -0,0 +1,597 @@ +getSale($saleId); + +$coupon = []; +if (!empty($couponId)) { + $coupon = $plugin->getCoupon($couponId, $sale['product_type'], $sale['product_id']); +} + +$userInfo = api_get_user_info($sale['user_id']); + +if (empty($sale)) { + api_not_allowed(true); +} + +$currency = $plugin->getCurrency($sale['currency_id']); +$globalParameters = $plugin->getGlobalParameters(); + +switch ($sale['payment_type']) { + case BuyCoursesPlugin::PAYMENT_TYPE_PAYPAL: + $paypalParams = $plugin->getPaypalParams(); + + $pruebas = $paypalParams['sandbox'] == 1; + $paypalUsername = $paypalParams['username']; + $paypalPassword = $paypalParams['password']; + $paypalSignature = $paypalParams['signature']; + + require_once "paypalfunctions.php"; + + $i = 0; + $extra = "&L_PAYMENTREQUEST_0_NAME0={$sale['product_name']}"; + $extra .= "&L_PAYMENTREQUEST_0_AMT0={$sale['price']}"; + $extra .= "&L_PAYMENTREQUEST_0_QTY0=1"; + + $expressCheckout = CallShortcutExpressCheckout( + $sale['price'], + $currency['iso_code'], + 'paypal', + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/success.php', + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/error.php', + $extra + ); + + if ($expressCheckout["ACK"] !== 'Success') { + $erroMessage = vsprintf( + $plugin->get_lang('ErrorOccurred'), + [$expressCheckout['L_ERRORCODE0'], $expressCheckout['L_LONGMESSAGE0']] + ); + Display::addFlash( + Display::return_message($erroMessage, 'error', false) + ); + header('Location: ../index.php'); + exit; + } + + if (!empty($globalParameters['sale_email'])) { + $messageConfirmTemplate = new Template(); + $messageConfirmTemplate->assign('user', $userInfo); + $messageConfirmTemplate->assign( + 'sale', + [ + 'date' => $sale['date'], + 'product' => $sale['product_name'], + 'currency' => $currency['iso_code'], + 'price' => $sale['price'], + 'reference' => $sale['reference'], + ] + ); + + api_mail_html( + '', + $globalParameters['sale_email'], + $plugin->get_lang('bc_subject'), + $messageConfirmTemplate->fetch('buycourses/view/message_confirm.tpl') + ); + } + + RedirectToPayPal($expressCheckout["TOKEN"]); + break; + case BuyCoursesPlugin::PAYMENT_TYPE_TRANSFER: + $buyingCourse = false; + $buyingSession = false; + + switch ($sale['product_type']) { + case BuyCoursesPlugin::PRODUCT_TYPE_COURSE: + $buyingCourse = true; + $course = $plugin->getCourseInfo($sale['product_id'], $coupon); + break; + case BuyCoursesPlugin::PRODUCT_TYPE_SESSION: + $buyingSession = true; + $session = $plugin->getSessionInfo($sale['product_id'], $coupon); + break; + } + + $transferAccounts = $plugin->getTransferAccounts(); + $infoEmailExtra = $plugin->getTransferInfoExtra()['tinfo_email_extra']; + + $form = new FormValidator( + 'success', + 'POST', + api_get_self(), + null, + null, + FormValidator::LAYOUT_INLINE + ); + + if ($form->validate()) { + $formValues = $form->getSubmitValues(); + + if (isset($formValues['cancel'])) { + $plugin->cancelSale($sale['id']); + + unset($_SESSION['bc_sale_id']); + unset($_SESSION['bc_coupon_id']); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php'); + exit; + } + + $messageTemplate = new Template(); + $messageTemplate->assign('user', $userInfo); + $messageTemplate->assign( + 'sale', + [ + 'date' => $sale['date'], + 'product' => $sale['product_name'], + 'currency' => $currency['iso_code'], + 'price' => $sale['price'], + 'reference' => $sale['reference'], + ] + ); + $messageTemplate->assign('transfer_accounts', $transferAccounts); + $messageTemplate->assign('info_email_extra', $infoEmailExtra); + + MessageManager::send_message_simple( + $userInfo['user_id'], + $plugin->get_lang('bc_subject'), + $messageTemplate->fetch('buycourses/view/message_transfer.tpl') + ); + + if (!empty($globalParameters['sale_email'])) { + $messageConfirmTemplate = new Template(); + $messageConfirmTemplate->assign('user', $userInfo); + $messageConfirmTemplate->assign( + 'sale', + [ + 'date' => $sale['date'], + 'product' => $sale['product_name'], + 'currency' => $currency['iso_code'], + 'price' => $sale['price'], + 'reference' => $sale['reference'], + ] + ); + + api_mail_html( + '', + $globalParameters['sale_email'], + $plugin->get_lang('bc_subject'), + $messageConfirmTemplate->fetch('buycourses/view/message_confirm.tpl') + ); + } + + Display::addFlash( + Display::return_message( + sprintf( + $plugin->get_lang('PurchaseStatusX'), + $plugin->get_lang('PendingReasonByTransfer') + ), + 'success', + false + ) + ); + + unset($_SESSION['bc_sale_id']); + unset($_SESSION['bc_coupon_id']); + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/course_catalog.php'); + exit; + } + + $form->addButton( + 'confirm', + $plugin->get_lang('ConfirmOrder'), + 'check', + 'success', + 'default', + null, + ['id' => 'confirm'] + ); + $form->addButtonCancel($plugin->get_lang('CancelOrder'), 'cancel'); + + $template = new Template(); + + if ($buyingCourse) { + $template->assign('course', $course); + } elseif ($buyingSession) { + $template->assign('session', $session); + } + + $template->assign('buying_course', $buyingCourse); + $template->assign('buying_session', $buyingSession); + $template->assign('terms', $globalParameters['terms_and_conditions']); + $template->assign('title', $sale['product_name']); + $template->assign('price', $sale['price']); + $template->assign('currency', $sale['currency_id']); + $template->assign('user', $userInfo); + $template->assign('transfer_accounts', $transferAccounts); + $template->assign('form', $form->returnForm()); + $template->assign('is_bank_transfer', true); + + $content = $template->fetch('buycourses/view/process_confirm.tpl'); + + $template->assign('content', $content); + $template->display_one_col_template(); + break; + case BuyCoursesPlugin::PAYMENT_TYPE_CULQI: + // We need to include the main online script, acording to the Culqi documentation the JS needs to be loeaded + // directly from the main url "https://integ-pago.culqi.com" because a local copy of this JS is not supported + $htmlHeadXtra[] = ''; + + $buyingCourse = false; + $buyingSession = false; + + switch ($sale['product_type']) { + case BuyCoursesPlugin::PRODUCT_TYPE_COURSE: + $buyingCourse = true; + $course = $plugin->getCourseInfo($sale['product_id'], $coupon); + break; + case BuyCoursesPlugin::PRODUCT_TYPE_SESSION: + $buyingSession = true; + $session = $plugin->getSessionInfo($sale['product_id'], $coupon); + break; + } + + $form = new FormValidator( + 'success', + 'POST', + api_get_self(), + null, + null, + FormValidator::LAYOUT_INLINE + ); + + if ($form->validate()) { + $formValues = $form->getSubmitValues(); + + if (isset($formValues['cancel'])) { + $plugin->cancelSale($sale['id']); + + unset($_SESSION['bc_sale_id']); + unset($_SESSION['bc_coupon_id']); + + Display::addFlash( + Display::return_message( + $plugin->get_lang('OrderCanceled'), + 'warning', + false + ) + ); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php'); + exit; + } + } + $form->addButton( + 'confirm', + $plugin->get_lang('ConfirmOrder'), + 'check', + 'success', + 'default', + null, + ['id' => 'confirm'] + ); + $form->addButton( + 'cancel', + $plugin->get_lang('CancelOrder'), + 'times', + 'danger', + 'default', + null, + ['id' => 'cancel'] + ); + + $template = new Template(); + + if ($buyingCourse) { + $template->assign('course', $course); + } elseif ($buyingSession) { + $template->assign('session', $session); + } + + $template->assign('buying_course', $buyingCourse); + $template->assign('buying_session', $buyingSession); + $template->assign('terms', $globalParameters['terms_and_conditions']); + $template->assign('title', $sale['product_name']); + $template->assign('price', floatval($sale['price'])); + $template->assign('currency', $plugin->getSelectedCurrency()); + $template->assign('user', $userInfo); + $template->assign('sale', $sale); + $template->assign('form', $form->returnForm()); + $template->assign('is_culqi_payment', true); + $template->assign('culqi_params', $culqiParams = $plugin->getCulqiParams()); + + $content = $template->fetch('buycourses/view/process_confirm.tpl'); + + $template->assign('content', $content); + $template->display_one_col_template(); + + break; + case BuyCoursesPlugin::PAYMENT_TYPE_TPV_REDSYS: + $tpvRedsysParams = $plugin->getTpvRedsysParams(); + + require_once '../resources/apiRedsys.php'; + $tpv = new RedsysAPI(); + + $merchantcode = $tpvRedsysParams['merchantcode']; + $terminal = $tpvRedsysParams['terminal']; + $currency = $tpvRedsysParams['currency']; + $transactionType = "0"; + $urlMerchant = api_get_path(WEB_PLUGIN_PATH).'buycourses/src/tpv_response.php'; + $urlSuccess = api_get_path(WEB_PLUGIN_PATH).'buycourses/src/tpv_success.php'; + $urlFailed = api_get_path(WEB_PLUGIN_PATH).'buycourses/src/tpv_error.php'; + $order = str_pad(strval($saleId), 4, "0", STR_PAD_LEFT); + $amount = $sale['price'] * 100; + $description = $plugin->get_lang('OrderReference').": ".$sale['reference']; + $tpv->setParameter("DS_MERCHANT_AMOUNT", $amount); + $tpv->setParameter("DS_MERCHANT_ORDER", $order); + $tpv->setParameter("DS_MERCHANT_MERCHANTCODE", $merchantcode); + $tpv->setParameter("DS_MERCHANT_CURRENCY", $currency); + $tpv->setParameter("DS_MERCHANT_TRANSACTIONTYPE", $transactionType); + $tpv->setParameter("DS_MERCHANT_TERMINAL", $terminal); + $tpv->setParameter("DS_MERCHANT_MERCHANTURL", $urlMerchant); + $tpv->setParameter("DS_MERCHANT_URLOK", $urlSuccess); + $tpv->setParameter("DS_MERCHANT_URLKO", $urlFailed); + $tpv->setParameter("DS_MERCHANT_PRODUCTDESCRIPTION", $description); + + $version = "HMAC_SHA256_V1"; + $kc = $tpvRedsysParams['kc']; + + $urlTpv = $tpvRedsysParams['url_redsys']; + $sandboxFlag = $tpvRedsysParams['sandbox'] == 1; + if ($sandboxFlag === true) { + $urlTpv = $tpvRedsysParams['url_redsys_sandbox']; + } + + $params = $tpv->createMerchantParameters(); + $signature = $tpv->createMerchantSignature($kc); + + echo '
'; + echo ''; + echo ''; + echo ''; + echo '
'; + + echo ''; + + break; + case BuyCoursesPlugin::PAYMENT_TYPE_STRIPE: + $buyingCourse = false; + $buyingSession = false; + + switch ($sale['product_type']) { + case BuyCoursesPlugin::PRODUCT_TYPE_COURSE: + $buyingCourse = true; + $course = $plugin->getCourseInfo($sale['product_id'], $coupon); + break; + case BuyCoursesPlugin::PRODUCT_TYPE_SESSION: + $buyingSession = true; + $session = $plugin->getSessionInfo($sale['product_id'], $coupon); + break; + } + + $form = new FormValidator( + 'success', + 'POST', + api_get_self(), + null, + null, + FormValidator::LAYOUT_INLINE + ); + + if ($form->validate()) { + $formValues = $form->getSubmitValues(); + + if (isset($formValues['cancel'])) { + $plugin->cancelSale($sale['id']); + + unset($_SESSION['bc_sale_id']); + unset($_SESSION['bc_coupon_id']); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php'); + exit; + } + + $stripeParams = $plugin->getStripeParams(); + $currency = $plugin->getCurrency($sale['currency_id']); + + \Stripe\Stripe::setApiKey($stripeParams['secret_key']); + \Stripe\Stripe::setAppInfo("ChamiloBuyCoursesPlugin"); + + $session = \Stripe\Checkout\Session::create([ + 'payment_method_types' => ['card'], + 'line_items' => [[ + 'price_data' => [ + 'unit_amount_decimal' => $sale['price'] * 100, + 'currency' => $currency['iso_code'], + 'product_data' => [ + 'name' => $sale['product_name'], + ], + ], + 'quantity' => 1, + ]], + 'customer_email' => $_SESSION['_user']['email'], + 'mode' => 'payment', + 'success_url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/src/stripe_success.php', + 'cancel_url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/src/stripe_cancel.php', + ]); + + if (!empty($session)) { + $plugin->updateSaleReference($saleId, $session->id); + + unset($_SESSION['bc_coupon_id']); + + header('HTTP/1.1 301 Moved Permanently'); + header('Location: '.$session->url); + } else { + Display::addFlash( + Display::return_message( + $plugin->get_lang('ErrorOccurred'), + 'error', + false + ) + ); + header('Location: ../index.php'); + } + + exit; + } + + $form->addButton( + 'confirm', + $plugin->get_lang('ConfirmOrder'), + 'check', + 'success', + 'default', + null, + ['id' => 'confirm'] + ); + $form->addButtonCancel($plugin->get_lang('CancelOrder'), 'cancel'); + + $template = new Template(); + + if ($buyingCourse) { + $template->assign('course', $course); + } elseif ($buyingSession) { + $template->assign('session', $session); + } + + $template->assign('buying_course', $buyingCourse); + $template->assign('buying_session', $buyingSession); + $template->assign('terms', $globalParameters['terms_and_conditions']); + $template->assign('title', $sale['product_name']); + $template->assign('price', $sale['price']); + $template->assign('currency', $sale['currency_id']); + $template->assign('user', $userInfo); + $template->assign('transfer_accounts', $transferAccounts); + $template->assign('form', $form->returnForm()); + $template->assign('is_bank_transfer', false); + + $content = $template->fetch('buycourses/view/process_confirm.tpl'); + + $template->assign('content', $content); + $template->display_one_col_template(); + + break; + + case BuyCoursesPlugin::PAYMENT_TYPE_TPV_CECABANK: + $buyingCourse = false; + $buyingSession = false; + + switch ($sale['product_type']) { + case BuyCoursesPlugin::PRODUCT_TYPE_COURSE: + $buyingCourse = true; + $course = $plugin->getCourseInfo($sale['product_id']); + break; + case BuyCoursesPlugin::PRODUCT_TYPE_SESSION: + $buyingSession = true; + $session = $plugin->getSessionInfo($sale['product_id']); + break; + } + + $cecabankParams = $plugin->getcecabankParams(); + $currency = $plugin->getCurrency($sale['currency_id']); + + $form = new FormValidator( + 'success', + 'POST', + api_get_self(), + null, + null, + FormValidator::LAYOUT_INLINE + ); + + if ($form->validate()) { + $formValues = $form->getSubmitValues(); + + if (isset($formValues['cancel'])) { + $plugin->cancelSale($sale['id']); + + unset($_SESSION['bc_sale_id']); + unset($_SESSION['bc_coupon_id']); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php'); + exit; + } + + $urlTpv = $cecabankParams['url']; + $currency = $plugin->getCurrency($sale['currency_id']); + $signature = $plugin->getCecabankSignature($sale['reference'], $sale['price']); + + echo '
'; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo '
'; + + echo ''; + + exit; + } + + $form->addButton( + 'confirm', + $plugin->get_lang('ConfirmOrder'), + 'check', + 'success', + 'default', + null, + ['id' => 'confirm'] + ); + $form->addButtonCancel($plugin->get_lang('CancelOrder'), 'cancel'); + + $template = new Template(); + + if ($buyingCourse) { + $template->assign('course', $course); + } elseif ($buyingSession) { + $template->assign('session', $session); + } + + $template->assign('buying_course', $buyingCourse); + $template->assign('buying_session', $buyingSession); + $template->assign('terms', $globalParameters['terms_and_conditions']); + $template->assign('title', $sale['product_name']); + $template->assign('price', $sale['price']); + $template->assign('currency', $sale['currency_id']); + $template->assign('user', $userInfo); + $template->assign('transfer_accounts', $transferAccounts); + $template->assign('form', $form->returnForm()); + $template->assign('is_bank_transfer', false); + + $content = $template->fetch('buycourses/view/process_confirm.tpl'); + + $template->assign('content', $content); + $template->display_one_col_template(); + + break; +} diff --git a/plugin/buycourses/src/process_subscription_confirm.php b/plugin/buycourses/src/process_subscription_confirm.php new file mode 100644 index 000000000..2c334b8f8 --- /dev/null +++ b/plugin/buycourses/src/process_subscription_confirm.php @@ -0,0 +1,375 @@ +getSubscriptionSale($saleId); + +if (!empty($couponId)) { + $coupon = $plugin->getCoupon($couponId, $sale['product_type'], $sale['product_id']); +} + +$userInfo = api_get_user_info($sale['user_id']); + +if (empty($sale)) { + api_not_allowed(true); +} + +$currency = $plugin->getCurrency($sale['currency_id']); +$globalParameters = $plugin->getGlobalParameters(); + +switch ($sale['payment_type']) { + case BuyCoursesPlugin::PAYMENT_TYPE_PAYPAL: + $paypalParams = $plugin->getPaypalParams(); + + $pruebas = $paypalParams['sandbox'] == 1; + $paypalUsername = $paypalParams['username']; + $paypalPassword = $paypalParams['password']; + $paypalSignature = $paypalParams['signature']; + + require_once "paypalfunctions.php"; + + $i = 0; + $extra = "&L_PAYMENTREQUEST_0_NAME0={$sale['product_name']}"; + $extra .= "&L_PAYMENTREQUEST_0_AMT0={$sale['price']}"; + $extra .= "&L_PAYMENTREQUEST_0_QTY0=1"; + + $expressCheckout = CallShortcutExpressCheckout( + $sale['price'], + $currency['iso_code'], + 'paypal', + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/success.php', + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/error.php', + $extra + ); + + if ($expressCheckout["ACK"] !== 'Success') { + $erroMessage = vsprintf( + $plugin->get_lang('ErrorOccurred'), + [$expressCheckout['L_ERRORCODE0'], $expressCheckout['L_LONGMESSAGE0']] + ); + Display::addFlash( + Display::return_message($erroMessage, 'error', false) + ); + header('Location: ../index.php'); + exit; + } + + if (!empty($globalParameters['sale_email'])) { + $messageConfirmTemplate = new Template(); + $messageConfirmTemplate->assign('user', $userInfo); + $messageConfirmTemplate->assign( + 'sale', + [ + 'date' => $sale['date'], + 'product' => $sale['product_name'], + 'currency' => $currency['iso_code'], + 'price' => $sale['price'], + 'reference' => $sale['reference'], + ] + ); + + api_mail_html( + '', + $globalParameters['sale_email'], + $plugin->get_lang('bc_subject'), + $messageConfirmTemplate->fetch('buycourses/view/message_confirm.tpl') + ); + } + + RedirectToPayPal($expressCheckout["TOKEN"]); + break; + case BuyCoursesPlugin::PAYMENT_TYPE_TRANSFER: + $buyingCourse = false; + $buyingSession = false; + + switch ($sale['product_type']) { + case BuyCoursesPlugin::PRODUCT_TYPE_COURSE: + $buyingCourse = true; + $course = $plugin->getSubscriptionCourseInfo($sale['product_id'], $coupon); + break; + case BuyCoursesPlugin::PRODUCT_TYPE_SESSION: + $buyingSession = true; + $session = $plugin->getSubscriptionSessionInfo($sale['product_id'], $coupon); + break; + } + + $transferAccounts = $plugin->getTransferAccounts(); + $infoEmailExtra = $plugin->getTransferInfoExtra()['tinfo_email_extra']; + + $form = new FormValidator( + 'success', + 'POST', + api_get_self(), + null, + null, + FormValidator::LAYOUT_INLINE + ); + + if ($form->validate()) { + $formValues = $form->getSubmitValues(); + + if (isset($formValues['cancel'])) { + $plugin->cancelSubscriptionSale($sale['id']); + + unset($_SESSION['bc_sale_id']); + unset($_SESSION['bc_coupon_id']); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php'); + exit; + } + + $messageTemplate = new Template(); + $messageTemplate->assign('user', $userInfo); + $messageTemplate->assign( + 'sale', + [ + 'date' => $sale['date'], + 'product' => $sale['product_name'], + 'currency' => $currency['iso_code'], + 'price' => $sale['price'], + 'reference' => $sale['reference'], + ] + ); + $messageTemplate->assign('transfer_accounts', $transferAccounts); + $messageTemplate->assign('info_email_extra', $infoEmailExtra); + + MessageManager::send_message_simple( + $userInfo['user_id'], + $plugin->get_lang('bc_subject'), + $messageTemplate->fetch('buycourses/view/message_transfer.tpl') + ); + + if (!empty($globalParameters['sale_email'])) { + $messageConfirmTemplate = new Template(); + $messageConfirmTemplate->assign('user', $userInfo); + $messageConfirmTemplate->assign( + 'sale', + [ + 'date' => $sale['date'], + 'product' => $sale['product_name'], + 'currency' => $currency['iso_code'], + 'price' => $sale['price'], + 'reference' => $sale['reference'], + ] + ); + + api_mail_html( + '', + $globalParameters['sale_email'], + $plugin->get_lang('bc_subject'), + $messageConfirmTemplate->fetch('buycourses/view/message_confirm.tpl') + ); + } + + Display::addFlash( + Display::return_message( + sprintf( + $plugin->get_lang('PurchaseStatusX'), + $plugin->get_lang('PendingReasonByTransfer') + ), + 'success', + false + ) + ); + + unset($_SESSION['bc_sale_id']); + unset($_SESSION['bc_coupon_id']); + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/course_catalog.php'); + exit; + } + + $form->addButton( + 'confirm', + $plugin->get_lang('ConfirmOrder'), + 'check', + 'success', + 'default', + null, + ['id' => 'confirm'] + ); + $form->addButtonCancel($plugin->get_lang('CancelOrder'), 'cancel'); + + $template = new Template(); + + if ($buyingCourse) { + $template->assign('course', $course); + } elseif ($buyingSession) { + $template->assign('session', $session); + } + + $template->assign('buying_course', $buyingCourse); + $template->assign('buying_session', $buyingSession); + $template->assign('terms', $globalParameters['terms_and_conditions']); + $template->assign('title', $sale['product_name']); + $template->assign('price', $sale['price']); + $template->assign('currency', $sale['currency_id']); + $template->assign('user', $userInfo); + $template->assign('transfer_accounts', $transferAccounts); + $template->assign('form', $form->returnForm()); + $template->assign('is_bank_transfer', true); + + $content = $template->fetch('buycourses/view/subscription_process_confirm.tpl'); + + $template->assign('content', $content); + $template->display_one_col_template(); + break; + case BuyCoursesPlugin::PAYMENT_TYPE_CULQI: + // We need to include the main online script, acording to the Culqi documentation the JS needs to be loeaded + // directly from the main url "https://integ-pago.culqi.com" because a local copy of this JS is not supported + $htmlHeadXtra[] = ''; + + $buyingCourse = false; + $buyingSession = false; + + switch ($sale['product_type']) { + case BuyCoursesPlugin::PRODUCT_TYPE_COURSE: + $buyingCourse = true; + $course = $plugin->getSubscriptionCourseInfo($sale['product_id'], $coupon); + break; + case BuyCoursesPlugin::PRODUCT_TYPE_SESSION: + $buyingSession = true; + $session = $plugin->getSubscriptionSessionInfo($sale['product_id'], $coupon); + break; + } + + $form = new FormValidator( + 'success', + 'POST', + api_get_self(), + null, + null, + FormValidator::LAYOUT_INLINE + ); + + if ($form->validate()) { + $formValues = $form->getSubmitValues(); + + if (isset($formValues['cancel'])) { + $plugin->cancelSubscriptionSale($sale['id']); + + unset($_SESSION['bc_sale_id']); + unset($_SESSION['bc_coupon_id']); + + Display::addFlash( + Display::return_message( + $plugin->get_lang('OrderCanceled'), + 'warning', + false + ) + ); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php'); + exit; + } + } + $form->addButton( + 'confirm', + $plugin->get_lang('ConfirmOrder'), + 'check', + 'success', + 'default', + null, + ['id' => 'confirm'] + ); + $form->addButton( + 'cancel', + $plugin->get_lang('CancelOrder'), + 'times', + 'danger', + 'default', + null, + ['id' => 'cancel'] + ); + + $template = new Template(); + + if ($buyingCourse) { + $template->assign('course', $course); + } elseif ($buyingSession) { + $template->assign('session', $session); + } + + $template->assign('buying_course', $buyingCourse); + $template->assign('buying_session', $buyingSession); + $template->assign('terms', $globalParameters['terms_and_conditions']); + $template->assign('title', $sale['product_name']); + $template->assign('price', floatval($sale['price'])); + $template->assign('currency', $plugin->getSelectedCurrency()); + $template->assign('user', $userInfo); + $template->assign('sale', $sale); + $template->assign('form', $form->returnForm()); + $template->assign('is_culqi_payment', true); + $template->assign('culqi_params', $culqiParams = $plugin->getCulqiParams()); + + $content = $template->fetch('buycourses/view/subscription_process_confirm.tpl'); + + $template->assign('content', $content); + $template->display_one_col_template(); + + break; + case BuyCoursesPlugin::PAYMENT_TYPE_TPV_REDSYS: + $tpvRedsysParams = $plugin->getTpvRedsysParams(); + + require_once '../resources/apiRedsys.php'; + $tpv = new RedsysAPI(); + + $merchantcode = $tpvRedsysParams['merchantcode']; + $terminal = $tpvRedsysParams['terminal']; + $currency = $tpvRedsysParams['currency']; + $transactionType = "0"; + $urlMerchant = api_get_path(WEB_PLUGIN_PATH).'buycourses/src/tpv_response.php'; + $urlSuccess = api_get_path(WEB_PLUGIN_PATH).'buycourses/src/tpv_success.php'; + $urlFailed = api_get_path(WEB_PLUGIN_PATH).'buycourses/src/tpv_error.php'; + $order = str_pad(strval($saleId), 4, "0", STR_PAD_LEFT); + $amount = $sale['price'] * 100; + $description = $plugin->get_lang('OrderReference').": ".$sale['reference']; + $tpv->setParameter("DS_MERCHANT_AMOUNT", $amount); + $tpv->setParameter("DS_MERCHANT_ORDER", $order); + $tpv->setParameter("DS_MERCHANT_MERCHANTCODE", $merchantcode); + $tpv->setParameter("DS_MERCHANT_CURRENCY", $currency); + $tpv->setParameter("DS_MERCHANT_TRANSACTIONTYPE", $transactionType); + $tpv->setParameter("DS_MERCHANT_TERMINAL", $terminal); + $tpv->setParameter("DS_MERCHANT_MERCHANTURL", $urlMerchant); + $tpv->setParameter("DS_MERCHANT_URLOK", $urlSuccess); + $tpv->setParameter("DS_MERCHANT_URLKO", $urlFailed); + $tpv->setParameter("DS_MERCHANT_PRODUCTDESCRIPTION", $description); + + $version = "HMAC_SHA256_V1"; + $kc = $tpvRedsysParams['kc']; + + $urlTpv = $tpvRedsysParams['url_redsys']; + $sandboxFlag = $tpvRedsysParams['sandbox'] == 1; + if ($sandboxFlag === true) { + $urlTpv = $tpvRedsysParams['url_redsys_sandbox']; + } + + $params = $tpv->createMerchantParameters(); + $signature = $tpv->createMerchantSignature($kc); + + echo '
'; + echo ''; + echo ''; + echo ''; + echo '
'; + + echo ''; + + break; +} diff --git a/plugin/buycourses/src/sales_report.php b/plugin/buycourses/src/sales_report.php new file mode 100644 index 000000000..e66fcfb60 --- /dev/null +++ b/plugin/buycourses/src/sales_report.php @@ -0,0 +1,216 @@ +get('paypal_enable'); +$commissionsEnable = $plugin->get('commissions_enable'); +$includeServices = $plugin->get('include_services'); +$invoicingEnable = $plugin->get('invoicing_enable') === 'true'; + +if (isset($_GET['order'])) { + $sale = $plugin->getSale($_GET['order']); + if (empty($sale)) { + api_not_allowed(true); + } + + $urlToRedirect = api_get_self().'?'; + + switch ($_GET['action']) { + case 'confirm': + $plugin->completeSale($sale['id']); + $plugin->storePayouts($sale['id']); + Display::addFlash( + $plugin->getSubscriptionSuccessMessage($sale) + ); + + $urlToRedirect .= http_build_query([ + 'status' => BuyCoursesPlugin::SALE_STATUS_COMPLETED, + 'sale' => $sale['id'], + ]); + break; + case 'cancel': + $plugin->cancelSale($sale['id']); + + Display::addFlash( + Display::return_message( + $plugin->get_lang('OrderCanceled'), + 'warning' + ) + ); + + $urlToRedirect .= http_build_query([ + 'status' => BuyCoursesPlugin::SALE_STATUS_CANCELED, + 'sale' => $sale['id'], + ]); + break; + } + + header("Location: $urlToRedirect"); + exit; +} + +$productTypes = $plugin->getProductTypes(); +$saleStatuses = $plugin->getSaleStatuses(); +$paymentTypes = $plugin->getPaymentTypes(); + +$selectedFilterType = '0'; +$selectedStatus = isset($_GET['status']) ? $_GET['status'] : BuyCoursesPlugin::SALE_STATUS_PENDING; +$selectedSale = isset($_GET['sale']) ? intval($_GET['sale']) : 0; +$dateStart = isset($_GET['date_start']) ? $_GET['date_start'] : date('Y-m-d H:i', mktime(0, 0, 0)); +$dateEnd = isset($_GET['date_end']) ? $_GET['date_end'] : date('Y-m-d H:i', mktime(23, 59, 59)); +$searchTerm = ''; +$email = ''; + +$form = new FormValidator('search', 'get'); + +if ($form->validate()) { + $selectedFilterType = $form->getSubmitValue('filter_type'); + $selectedStatus = $form->getSubmitValue('status'); + $searchTerm = $form->getSubmitValue('user'); + $dateStart = $form->getSubmitValue('date_start'); + $dateEnd = $form->getSubmitValue('date_end'); + $email = $form->getSubmitValue('email'); + + if ($selectedStatus === false) { + $selectedStatus = BuyCoursesPlugin::SALE_STATUS_PENDING; + } + + if ($selectedFilterType === false) { + $selectedFilterType = '0'; + } +} + +$form->addRadio( + 'filter_type', + get_lang('Filter'), + [ + $plugin->get_lang('ByStatus'), + $plugin->get_lang('ByUser'), + $plugin->get_lang('ByDate'), + $plugin->get_lang('ByEmail'), + ] +); +$form->addHtml('
'); +$form->addSelect('status', $plugin->get_lang('OrderStatus'), $saleStatuses); +$form->addHtml('
'); +$form->addHtml('
'); +$form->addText('user', get_lang('UserName'), false); +$form->addHtml('
'); +$form->addHtml('
'); +$form->addDateRangePicker('date', get_lang('Date'), false); +$form->addHtml('
'); +$form->addHtml('
'); +$form->addText('email', get_lang('Email'), false); +$form->addHtml('
'); +$form->addButtonFilter(get_lang('Search')); +$form->setDefaults([ + 'filter_type' => $selectedFilterType, + 'status' => $selectedStatus, + 'date_start' => $dateStart, + 'date_end' => $dateEnd, + 'email' => $email, +]); + +switch ($selectedFilterType) { + case '0': + $sales = $plugin->getSaleListByStatus($selectedStatus); + break; + case '1': + $sales = $plugin->getSaleListByUser($searchTerm); + break; + case '2': + $sales = $plugin->getSaleListByDate($dateStart, $dateEnd); + break; + case '3': + $sales = $plugin->getSaleListByEmail($email); + break; +} + +foreach ($sales as &$sale) { + $sale['product_type'] = $productTypes[$sale['product_type']]; + $sale['payment_type'] = $paymentTypes[$sale['payment_type']]; + $sale['complete_user_name'] = api_get_person_name($sale['firstname'], $sale['lastname']); + $sale['num_invoice'] = $plugin->getNumInvoice($sale['id'], 0); + $sale['total_price'] = $plugin->getPriceWithCurrencyFromIsoCode($sale['price'], $sale['iso_code']); + if (isset($sale['discount_amount']) && $sale['discount_amount'] != 0) { + $sale['total_discount'] = $plugin->getPriceWithCurrencyFromIsoCode($sale['discount_amount'], $sale['iso_code']); + $sale['coupon_code'] = $plugin->getSaleCouponCode($sale['id']); + } +} + +$interbreadcrumb[] = ['url' => '../index.php', 'name' => $plugin->get_lang('plugin_title')]; + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); +$htmlHeadXtra[] = api_get_jqgrid_js(); +$htmlHeadXtra[] = BuyCoursesPlugin::getSalesReportScript($sales, $invoicingEnable); + +$templateName = $plugin->get_lang('SalesReport'); +$template = new Template($templateName); + +$toolbar = Display::url( + Display::returnFontAwesomeIcon('file-excel-o'). + get_lang('GenerateReport'), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/export_report.php', + ['class' => 'btn btn-primary'] +); + +if ($paypalEnable === 'true' && $commissionsEnable === 'true') { + $toolbar .= Display::toolbarButton( + $plugin->get_lang('PaypalPayoutCommissions'), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/paypal_payout.php', + 'paypal', + 'primary', + ['title' => $plugin->get_lang('PaypalPayoutCommissions')] + ); + + $template->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) + ); +} + +if ($commissionsEnable === 'true') { + $toolbar .= Display::toolbarButton( + $plugin->get_lang('PayoutReport'), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/payout_report.php', + 'money', + 'info', + ['title' => $plugin->get_lang('PayoutReport')] + ); + + $template->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) + ); +} +$template->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); +$template->assign('form', $form->returnForm()); +$template->assign('selected_sale', $selectedSale); +$template->assign('selected_status', $selectedStatus); +$template->assign('services_are_included', $includeServices); +$template->assign('sale_list', $sales); +$template->assign('sale_status_canceled', BuyCoursesPlugin::SALE_STATUS_CANCELED); +$template->assign('sale_status_pending', BuyCoursesPlugin::SALE_STATUS_PENDING); +$template->assign('sale_status_completed', BuyCoursesPlugin::SALE_STATUS_COMPLETED); +$template->assign('invoicing_enable', $invoicingEnable); + +$content = $template->fetch('buycourses/view/sales_report.tpl'); + +$template->assign('header', $templateName); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/service_catalog.php b/plugin/buycourses/src/service_catalog.php new file mode 100644 index 000000000..46929b3fc --- /dev/null +++ b/plugin/buycourses/src/service_catalog.php @@ -0,0 +1,101 @@ +get('include_sessions') === 'true'; +$includeServices = $plugin->get('include_services') === 'true'; + +$nameFilter = null; +$minFilter = 0; +$maxFilter = 0; +$appliesToFilter = ''; + +$form = new FormValidator( + 'search_filter_form', + 'get', + null, + null, + [], + FormValidator::LAYOUT_INLINE +); + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + $nameFilter = isset($formValues['name']) ? $formValues['name'] : null; + $minFilter = isset($formValues['min']) ? $formValues['min'] : 0; + $maxFilter = isset($formValues['max']) ? $formValues['max'] : 0; + $appliesToFilter = isset($formValues['applies_to']) ? $formValues['applies_to'] : ''; +} + +$form->addHeader($plugin->get_lang('SearchFilter')); +$form->addText('name', $plugin->get_lang('ServiceName'), false); +$form->addElement( + 'number', + 'min', + $plugin->get_lang('MinimumPrice'), + ['step' => '0.01', 'min' => '0'] +); +$form->addElement( + 'number', + 'max', + $plugin->get_lang('MaximumPrice'), + ['step' => '0.01', 'min' => '0'] +); +$appliesToOptions = [ + '' => get_lang('Any'), + 0 => get_lang('None'), + 1 => get_lang('User'), + 2 => get_lang('Course'), + 3 => get_lang('Session'), + 4 => get_lang('TemplateTitleCertificate'), +]; +$form->addSelect('applies_to', $plugin->get_lang('AppliesTo'), $appliesToOptions); +$form->addHtml('
'); +$form->addButtonFilter(get_lang('Search')); + +$pageSize = BuyCoursesPlugin::PAGINATION_PAGE_SIZE; +$currentPage = isset($_GET['page']) ? (int) $_GET['page'] : 1; +$first = $pageSize * ($currentPage - 1); +$serviceList = $plugin->getCatalogServiceList($first, $pageSize, $nameFilter, $minFilter, $maxFilter, $appliesToFilter); +$totalItems = $plugin->getCatalogServiceList($first, $pageSize, $nameFilter, $minFilter, $maxFilter, $appliesToFilter, 'count'); +$pagesCount = ceil($totalItems / $pageSize); +$pagination = BuyCoursesPlugin::returnPagination(api_get_self(), $currentPage, $pagesCount, $totalItems); + +// View +if (api_is_platform_admin()) { + $interbreadcrumb[] = [ + 'url' => 'list.php', + 'name' => $plugin->get_lang('AvailableCoursesConfiguration'), + ]; + $interbreadcrumb[] = [ + 'url' => 'paymentsetup.php', + 'name' => $plugin->get_lang('PaymentsConfiguration'), + ]; +} else { + $interbreadcrumb[] = [ + 'url' => '../index.php', + 'name' => $plugin->get_lang('UserPanel'), + ]; +} + +$templateName = $plugin->get_lang('ListOfServicesOnSale'); +$tpl = new Template($templateName); +$tpl->assign('search_filter_form', $form->returnForm()); +$tpl->assign('showing_services', true); +$tpl->assign('services', $serviceList); +$tpl->assign('sessions_are_included', $includeSessions); +$tpl->assign('services_are_included', $includeServices); +$tpl->assign('pagination', $pagination); + +$content = $tpl->fetch('buycourses/view/catalog.tpl'); + +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/service_error.php b/plugin/buycourses/src/service_error.php new file mode 100644 index 000000000..43ebe9003 --- /dev/null +++ b/plugin/buycourses/src/service_error.php @@ -0,0 +1,35 @@ +getServiceSale($serviceSaleId); + + $plugin->cancelServiceSale(intval($serviceSaleId)); + Display::addFlash( + Display::return_message( + $plugin->get_lang('OrderCancelled'), + 'error', + false + ) + ); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_catalog.php'); + exit; +} + +Display::addFlash( + Display::return_message($plugin->get_lang('ErrorOccurred'), 'error', false) +); + +header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_catalog.php'); + +exit; diff --git a/plugin/buycourses/src/service_information.php b/plugin/buycourses/src/service_information.php new file mode 100644 index 000000000..f8f2f6522 --- /dev/null +++ b/plugin/buycourses/src/service_information.php @@ -0,0 +1,42 @@ + + * + * @package chamilo.buycourses_plugin + */ +$cidReset = true; + +require_once '../../../main/inc/global.inc.php'; + +$serviceId = isset($_GET['service_id']) ? intval($_GET['service_id']) : false; +$htmlHeadXtra[] = ''; +$plugin = BuyCoursesPlugin::create(); + +$includeServices = $plugin->get('include_services') === 'true'; + +if (!$includeServices) { + api_not_allowed(true); +} + +$service = $plugin->getService($serviceId); + +if (!$service['id']) { + api_not_allowed(true); +} + +$template = new Template(false); +$template->assign('pageUrl', api_get_path(WEB_PATH)."service/{$serviceId}/information/"); +$template->assign('service', $service); +$template->assign('essence', Essence\Essence::instance()); + +$content = $template->fetch('buycourses/view/service_information.tpl'); + +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/service_panel.php b/plugin/buycourses/src/service_panel.php new file mode 100644 index 000000000..78caecc8f --- /dev/null +++ b/plugin/buycourses/src/service_panel.php @@ -0,0 +1,74 @@ +get('include_services') === 'true'; +$includeSessions = $plugin->get('include_sessions') === 'true'; +$servicesOnly = $plugin->get('show_services_only') === 'true'; + +$userInfo = api_get_user_info(); + +if (!$userInfo) { + api_not_allowed(true); +} +$serviceTypes = $plugin->getServiceTypes(); +$serviceSaleStatuses['status_cancelled'] = BuyCoursesPlugin::SERVICE_STATUS_CANCELLED; +$serviceSaleStatuses['status_pending'] = BuyCoursesPlugin::SERVICE_STATUS_PENDING; +$serviceSaleStatuses['status_completed'] = BuyCoursesPlugin::SERVICE_STATUS_COMPLETED; + +$serviceSales = $plugin->getServiceSales($userInfo['user_id']); +$saleList = []; + +foreach ($serviceSales as $sale) { + $saleList[] = [ + 'id' => $sale['id'], + 'name' => $sale['service']['name'], + 'service_type' => $serviceTypes[$sale['service']['applies_to']], + 'applies_to' => $sale['service']['applies_to'], + 'reference' => $sale['reference'], + 'date' => api_format_date(api_get_local_time($sale['buy_date']), DATE_TIME_FORMAT_LONG_24H), + 'date_end' => api_format_date(api_get_local_time($sale['date_end']), DATE_TIME_FORMAT_LONG_24H), + 'currency' => $sale['currency'], + 'price' => $sale['price'], + 'status' => $sale['status'], + ]; +} + +$toolbar = Display::toolbarButton( + $plugin->get_lang('CourseListOnSale'), + 'course_catalog.php', + 'search-plus', + 'primary', + ['title' => $plugin->get_lang('CourseListOnSale')] +); + +$webPluginPath = api_get_path(WEB_PLUGIN_PATH); +$htmlHeadXtra[] = api_get_css($webPluginPath.'buycourses/resources/css/style.css'); +$htmlHeadXtra[] = api_get_js_simple($webPluginPath.'buycourses/resources/js/modals.js'); + +$templateName = $plugin->get_lang('TabsDashboard'); +$tpl = new Template($templateName); +$tpl->assign('showing_courses', true); +$tpl->assign('services_are_included', $includeServices); +$tpl->assign('sessions_are_included', $includeSessions); +$tpl->assign('service_sale_statuses', $serviceSaleStatuses); +$tpl->assign('sale_list', $saleList); +if ($servicesOnly) { + $tpl->assign('show_services_only', true); +} + +$content = $tpl->fetch('buycourses/view/service_panel.tpl'); + +$tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/service_process.php b/plugin/buycourses/src/service_process.php new file mode 100644 index 000000000..b383fa5c3 --- /dev/null +++ b/plugin/buycourses/src/service_process.php @@ -0,0 +1,304 @@ +'; +$em = Database::getManager(); +$plugin = BuyCoursesPlugin::create(); +$includeServices = $plugin->get('include_services'); +$additionalQueryString = ''; +if ($includeServices !== 'true') { + api_not_allowed(true); +} + +$typeUser = $type === BuyCoursesPlugin::SERVICE_TYPE_USER; +$typeCourse = $type === BuyCoursesPlugin::SERVICE_TYPE_COURSE; +$typeSession = $type === BuyCoursesPlugin::SERVICE_TYPE_SESSION; +$typeFinalLp = $type === BuyCoursesPlugin::SERVICE_TYPE_LP_FINAL_ITEM; +$queryString = 'i='.$serviceId.'&t='.$type.$additionalQueryString; + +if (isset($_REQUEST['c'])) { + $couponCode = $_REQUEST['c']; + $coupon = $plugin->getCouponServiceByCode($couponCode, $_REQUEST['i']); +} + +$serviceInfo = $plugin->getService($serviceId, $coupon); +$userInfo = api_get_user_info($currentUserId); + +$form = new FormValidator('confirm_sale'); +$paymentTypesOptions = $plugin->getPaymentTypes(true); + +$form->addHtml( + Display::return_message( + $plugin->get_lang('PleaseSelectThePaymentMethodBeforeConfirmYourOrder'), + 'info' + ) +); +$form->addRadio('payment_type', null, $paymentTypesOptions); + +$infoRequired = false; +if ($typeUser || $typeCourse || $typeSession || $typeFinalLp) { + $infoRequired = true; + $form->addHtml( + Display::return_message( + $plugin->get_lang('PleaseSelectTheCorrectInfoToApplyTheService'), + 'info' + ) + ); +} + +$selectOptions = [ + 0 => get_lang('None'), +]; + +if ($typeUser) { + $users = UserManager::getRepository()->findAll(); + $selectOptions[$userInfo['user_id']] = api_get_person_name( + $userInfo['firstname'], + $userInfo['lastname'] + ).' ('.get_lang('Myself').')'; + + if (!empty($users)) { + /** @var User $user */ + foreach ($users as $user) { + if (intval($userInfo['user_id']) !== intval($user->getId())) { + $selectOptions[$user->getId()] = $user->getCompleteNameWithUsername(); + } + } + } + $form->addSelect('info_select', get_lang('User'), $selectOptions); +} elseif ($typeCourse) { + /** @var User $user */ + $user = UserManager::getRepository()->find($currentUserId); + $courses = $user->getCourses(); + $checker = false; + foreach ($courses as $course) { + $checker = true; + $selectOptions[$course->getCourse()->getId()] = $course->getCourse()->getTitle(); + } + if (!$checker) { + $form->addHtml( + Display::return_message( + $plugin->get_lang('YouNeedToBeRegisteredInAtLeastOneCourse'), + 'error' + ) + ); + } + $form->addSelect('info_select', get_lang('Course'), $selectOptions); +} elseif ($typeSession) { + $sessions = []; + /** @var User $user */ + $user = UserManager::getRepository()->find($currentUserId); + $userSubscriptions = $user->getSessionCourseSubscriptions(); + + /** @var SessionRelCourseRelUser $userSubscription */ + foreach ($userSubscriptions as $userSubscription) { + $sessions[$userSubscription->getSession()->getId()] = $userSubscription->getSession()->getName(); + } + + $sessionsAsGeneralCoach = $user->getSessionAsGeneralCoach(); + /** @var Session $sessionAsGeneralCoach */ + foreach ($sessionsAsGeneralCoach as $sessionAsGeneralCoach) { + $sessions[$sessionAsGeneralCoach->getId()] = $sessionAsGeneralCoach->getName(); + } + + if (!$sessions) { + $form->addHtml(Display::return_message($plugin->get_lang('YouNeedToBeRegisteredInAtLeastOneSession'), 'error')); + } else { + $selectOptions = $sessions; + $form->addSelect('info_select', get_lang('Session'), $selectOptions); + } +} elseif ($typeFinalLp) { + // We need here to check the current user courses first + /** @var User $user */ + $user = UserManager::getRepository()->find($currentUserId); + $courses = $user->getCourses(); + $courseLpList = []; + $sessionLpList = []; + $checker = false; + foreach ($courses as $course) { + // Now get all the courses lp's + $thisLpList = $em->getRepository('ChamiloCourseBundle:CLp')->findBy(['cId' => $course->getCourse()->getId()]); + foreach ($thisLpList as $lp) { + $courseLpList[$lp->getCId()] = $lp->getName().' ('.$course->getCourse()->getTitle().')'; + } + } + + // Here now checking the current user sessions + $sessions = $user->getSessionCourseSubscriptions(); + foreach ($sessions as $session) { + $thisLpList = $em + ->getRepository('ChamiloCourseBundle:CLp') + ->findBy(['sessionId' => $session->getSession()->getId()]); + + // Here check all the lpItems + foreach ($thisLpList as $lp) { + $thisLpItems = $em->getRepository('ChamiloCourseBundle:CLpItem')->findBy(['lpId' => $lp->getId()]); + + foreach ($thisLpItems as $item) { + //Now only we need the final item and return the current LP + if ($item->getItemType() == TOOL_LP_FINAL_ITEM) { + $checker = true; + $sessionLpList[$lp->getCId()] = $lp->getName().' ('.$session->getSession()->getName().')'; + } + } + } + + $thisLpList = $em->getRepository('ChamiloCourseBundle:CLp')->findBy(['cId' => $session->getCourse()->getId()]); + + // Here check all the lpItems + foreach ($thisLpList as $lp) { + $thisLpItems = $em->getRepository('ChamiloCourseBundle:CLpItem')->findBy(['lpId' => $lp->getId()]); + foreach ($thisLpItems as $item) { + //Now only we need the final item and return the current LP + if ($item->getItemType() == TOOL_LP_FINAL_ITEM) { + $checker = true; + $sessionLpList[$lp->getCId()] = $lp->getName().' ('.$session->getSession()->getName().')'; + } + } + } + } + + $selectOptions = $selectOptions + $courseLpList + $sessionLpList; + if (!$checker) { + $form->addHtml( + Display::return_message( + $plugin->get_lang('YourCoursesNeedAtLeastOneLearningPath'), + 'error' + ) + ); + } + $form->addSelect('info_select', get_lang('LearningPath'), $selectOptions); +} + +$form->addHidden('t', intval($_GET['t'])); +$form->addHidden('i', intval($_GET['i'])); +$form->addButton('submit', $plugin->get_lang('ConfirmOrder'), 'check', 'success'); + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + + if (!isset($formValues['payment_type'])) { + Display::addFlash( + Display::return_message($plugin->get_lang('NeedToSelectPaymentType'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + + $infoSelected = []; + if ($infoRequired) { + if (isset($formValues['info_select'])) { + $infoSelected = $formValues['info_select']; + } else { + Display::addFlash( + Display::return_message($plugin->get_lang('AdditionalInfoRequired'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + } + + $serviceSaleId = $plugin->registerServiceSale( + $serviceId, + $formValues['payment_type'], + $infoSelected, + $formValues['c'] + ); + + if ($serviceSaleId !== false) { + $_SESSION['bc_service_sale_id'] = $serviceSaleId; + + if (isset($formValues['c'])) { + $couponSaleId = $plugin->registerCouponServiceSale($serviceSaleId, $formValues['c']); + if ($couponSaleId !== false) { + $plugin->updateCouponDelivered($formValues['c']); + $_SESSION['bc_coupon_id'] = $formValues['c']; + } + } + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_process_confirm.php'); + } + exit; +} + +$formCoupon = new FormValidator('confirm_coupon'); +if ($formCoupon->validate()) { + $formCouponValues = $formCoupon->getSubmitValues(); + + if (!$formCouponValues['coupon_code']) { + Display::addFlash( + Display::return_message($plugin->get_lang('NeedToAddCouponCode'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + + $coupon = $plugin->getCouponServiceByCode($formCouponValues['coupon_code'], $formCouponValues['i']); + + if ($coupon == null) { + Display::addFlash( + Display::return_message($plugin->get_lang('CouponNotValid'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + + Display::addFlash( + Display::return_message($plugin->get_lang('CouponRedeemed'), 'success', false) + ); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_process.php?i='.$_REQUEST['i'].'&t='.$_REQUEST['t'].'&c='.$formCouponValues['coupon_code']); + + exit; +} +$formCoupon->addText('coupon_code', $plugin->get_lang('CouponsCode'), true); +$formCoupon->addHidden('t', intval($_GET['t'])); +$formCoupon->addHidden('i', intval($_GET['i'])); +if ($coupon != null) { + $form->addHidden('c', intval($coupon['id'])); +} +$formCoupon->addButton('submit', $plugin->get_lang('RedeemCoupon'), 'check', 'success', 'btn-lg pull-right'); + +// View +$templateName = $plugin->get_lang('PaymentMethods'); +$interbreadcrumb[] = [ + 'url' => 'service_catalog.php', + 'name' => $plugin->get_lang('ListOfServicesOnSale'), +]; + +$tpl = new Template($templateName); +$tpl->assign('buying_service', true); +$tpl->assign('service', $serviceInfo); +$tpl->assign('user', api_get_user_info()); +$tpl->assign('form_coupon', $formCoupon->returnForm()); +$tpl->assign('form', $form->returnForm()); +$content = $tpl->fetch('buycourses/view/service_process.tpl'); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/service_process_confirm.php b/plugin/buycourses/src/service_process_confirm.php new file mode 100644 index 000000000..6362b1f56 --- /dev/null +++ b/plugin/buycourses/src/service_process_confirm.php @@ -0,0 +1,385 @@ +getServiceSale($serviceSaleId, $coupon); +$userInfo = api_get_user_info($serviceSale['buyer']['id']); + +if (!empty($couponId)) { + $coupon = $plugin->getCouponService($couponId, $serviceSale['service_id']); + $serviceSale['item'] = $plugin->getService($serviceSale['service_id'], $coupon); +} + +if (empty($serviceSale)) { + api_not_allowed(true); +} + +$currency = $plugin->getCurrency($serviceSale['currency_id']); +$globalParameters = $plugin->getGlobalParameters(); + +switch ($serviceSale['payment_type']) { + case BuyCoursesPlugin::PAYMENT_TYPE_PAYPAL: + $paypalParams = $plugin->getPaypalParams(); + + $pruebas = $paypalParams['sandbox'] == 1; + $paypalUsername = $paypalParams['username']; + $paypalPassword = $paypalParams['password']; + $paypalSignature = $paypalParams['signature']; + + // This var $itemPrice may be "0" if the transaction does not include a one-time purchase such as when you set up + // a billing agreement for a recurring payment that is not immediately charged. When the field is set to 0, + // purchase-specific fields are ignored. This little condition handle this fact. + $itemPrice = $serviceSale['price']; + + $returnUrl = api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_success.php'; + $cancelUrl = api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_error.php'; + + // The extra params for handle the hard job, this var is VERY IMPORTANT !! + $extra = ''; + require_once 'paypalfunctions.php'; + + $extra .= "&L_PAYMENTREQUEST_0_NAME0={$serviceSale['service']['name']}"; + $extra .= "&L_PAYMENTREQUEST_0_QTY0=1"; + $extra .= "&L_PAYMENTREQUEST_0_AMT0=$itemPrice"; + + // Full Checkout express + $expressCheckout = CallShortcutExpressCheckout( + $itemPrice, + $currency['iso_code'], + 'paypal', + $returnUrl, + $cancelUrl, + $extra + ); + + if ($expressCheckout['ACK'] !== 'Success') { + $erroMessage = vsprintf( + $plugin->get_lang('ErrorOccurred'), + [$expressCheckout['L_ERRORCODE0'], $expressCheckout['L_LONGMESSAGE0']] + ); + Display::addFlash( + Display::return_message($erroMessage, 'error', false) + ); + + $plugin->cancelServiceSale($serviceSale['id']); + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_catalog.php'); + exit; + } + + if (!empty($globalParameters['sale_email'])) { + $messageConfirmTemplate = new Template(); + $messageConfirmTemplate->assign('user', $userInfo); + $messageConfirmTemplate->assign( + 'sale', + [ + 'date' => $serviceSale['buy_date'], + 'product' => $serviceSale['service']['name'], + 'currency' => $currency['iso_code'], + 'price' => $serviceSale['price'], + 'reference' => $serviceSale['reference'], + ] + ); + + api_mail_html( + '', + $globalParameters['sale_email'], + $plugin->get_lang('bc_subject'), + $messageConfirmTemplate->fetch('buycourses/view/message_confirm.tpl') + ); + } + + RedirectToPayPal($expressCheckout['TOKEN']); + break; + case BuyCoursesPlugin::PAYMENT_TYPE_TRANSFER: + $transferAccounts = $plugin->getTransferAccounts(); + + $form = new FormValidator( + 'success', + 'POST', + api_get_self(), + null, + null, + FormValidator::LAYOUT_INLINE + ); + + if ($form->validate()) { + $formValues = $form->getSubmitValues(); + + if (isset($formValues['cancel'])) { + $plugin->cancelServiceSale($serviceSale['id']); + + unset($_SESSION['bc_service_sale_id']); + unset($_SESSION['bc_coupon_id']); + Display::addFlash( + Display::return_message($plugin->get_lang('OrderCancelled'), 'error', false) + ); + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_catalog.php'); + exit; + } + + $messageTemplate = new Template(); + $messageTemplate->assign( + 'service_sale', + [ + 'name' => $serviceSale['service']['name'], + 'buyer' => $serviceSale['buyer']['name'], + 'buy_date' => $serviceSale['buy_date'], + 'start_date' => $serviceSale['start_date'], + 'end_date' => $serviceSale['end_date'], + 'currency' => $currency['iso_code'], + 'price' => $serviceSale['price'], + 'reference' => $serviceSale['reference'], + ] + ); + $messageTemplate->assign('transfer_accounts', $transferAccounts); + $buyer = api_get_user_info($serviceSale['buyer']['id']); + + MessageManager::send_message_simple( + $buyer['user_id'], + $plugin->get_lang('bc_subject'), + $messageTemplate->fetch('buycourses/view/service_message_transfer.tpl') + ); + + if (!empty($globalParameters['sale_email'])) { + $messageConfirmTemplate = new Template(); + $messageConfirmTemplate->assign('user', $userInfo); + $messageConfirmTemplate->assign( + 'sale', + [ + 'date' => $serviceSale['buy_date'], + 'product' => $serviceSale['service']['name'], + 'currency' => $currency['iso_code'], + 'price' => $serviceSale['price'], + 'reference' => $serviceSale['reference'], + ] + ); + + api_mail_html( + '', + $globalParameters['sale_email'], + $plugin->get_lang('bc_subject'), + $messageConfirmTemplate->fetch('buycourses/view/message_confirm.tpl') + ); + } + + Display::addFlash( + Display::return_message( + sprintf( + $plugin->get_lang('PurchaseStatusX'), + $plugin->get_lang('PendingReasonByTransfer') + ), + 'success', + false + ) + ); + + unset($_SESSION['bc_service_sale_id']); + unset($_SESSION['bc_coupon_id']); + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_catalog.php'); + exit; + } + + $form->addButton( + 'confirm', + $plugin->get_lang('ConfirmOrder'), + 'check', + 'success', + 'default', + null, + ['id' => 'confirm'] + ); + $form->addButton( + 'cancel', + $plugin->get_lang('CancelOrder'), + 'times', + 'danger', + 'default', + null, + ['id' => 'cancel'] + ); + + $template = new Template(); + $template->assign('terms', $globalParameters['terms_and_conditions']); + $template->assign('title', $serviceSale['service']['name']); + $template->assign('price', $serviceSale['price']); + $template->assign('currency', $serviceSale['currency_id']); + $template->assign('buying_service', $serviceSale); + $template->assign('user', $userInfo); + $template->assign('service', $serviceSale['service']); + $template->assign('service_item', $serviceSale['item']); + $template->assign('transfer_accounts', $transferAccounts); + $template->assign('form', $form->returnForm()); + + $content = $template->fetch('buycourses/view/process_confirm.tpl'); + + $template->assign('content', $content); + $template->display_one_col_template(); + break; + case BuyCoursesPlugin::PAYMENT_TYPE_CULQI: + // We need to include the main online script, acording to the Culqi documentation the JS needs to be loeaded + // directly from the main url "https://integ-pago.culqi.com" because a local copy of this JS is not supported + $htmlHeadXtra[] = ''; + + $form = new FormValidator( + 'success', + 'POST', + api_get_self(), + null, + null, + FormValidator::LAYOUT_INLINE + ); + + if ($form->validate()) { + $formValues = $form->getSubmitValues(); + if (isset($formValues['cancel'])) { + $plugin->cancelServiceSale($serviceSale['id']); + + unset($_SESSION['bc_service_sale_id']); + unset($_SESSION['bc_coupon_id']); + + Display::addFlash( + Display::return_message( + $plugin->get_lang('OrderCanceled'), + 'warning', + false + ) + ); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php'); + exit; + } + } + $form->addButton( + 'confirm', + $plugin->get_lang('ConfirmOrder'), + 'check', + 'success', + 'default', + null, + ['id' => 'confirm'] + ); + $form->addButton( + 'cancel', + $plugin->get_lang('CancelOrder'), + 'times', + 'danger', + 'default', + null, + ['id' => 'cancel'] + ); + + $template = new Template(); + $template->assign('terms', $globalParameters['terms_and_conditions']); + $template->assign('title', $serviceSale['service']['name']); + $template->assign('price', floatval($serviceSale['price'])); + $template->assign('currency', $plugin->getSelectedCurrency()); + $template->assign('buying_service', $serviceSale); + $template->assign('user', $userInfo); + $template->assign('service', $serviceSale['service']); + $template->assign('service_item', $serviceSale['item']); + $template->assign('form', $form->returnForm()); + $template->assign('is_culqi_payment', true); + $template->assign('culqi_params', $culqiParams = $plugin->getCulqiParams()); + $content = $template->fetch('buycourses/view/process_confirm.tpl'); + $template->assign('content', $content); + $template->display_one_col_template(); + break; + + case BuyCoursesPlugin::PAYMENT_TYPE_TPV_CECABANK: + $cecabankParams = $plugin->getcecabankParams(); + $currency = $plugin->getCurrency($sale['currency_id']); + + $form = new FormValidator( + 'success', + 'POST', + api_get_self(), + null, + null, + FormValidator::LAYOUT_INLINE + ); + + if ($form->validate()) { + $formValues = $form->getSubmitValues(); + + if (isset($formValues['cancel'])) { + $plugin->cancelServiceSale($sale['id']); + + unset($_SESSION['bc_sale_id']); + unset($_SESSION['bc_coupon_id']); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php'); + exit; + } + + $urlTpv = $cecabankParams['merchart_id']; + $currency = $plugin->getCurrency($sale['currency_id']); + $signature = $plugin->getCecabankSignature($sale['reference'], $sale['price']); + + echo '
'; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo ''; + echo '
'; + + echo ''; + + exit; + } + + $form->addButton( + 'confirm', + $plugin->get_lang('ConfirmOrder'), + 'check', + 'success', + 'default', + null, + ['id' => 'confirm'] + ); + $form->addButtonCancel($plugin->get_lang('CancelOrder'), 'cancel'); + + $template = new Template(); + $template->assign('terms', $globalParameters['terms_and_conditions']); + $template->assign('title', $serviceSale['service']['name']); + $template->assign('price', $serviceSale['price']); + $template->assign('currency', $serviceSale['currency_id']); + $template->assign('buying_service', $serviceSale); + $template->assign('user', $userInfo); + $template->assign('service', $serviceSale['service']); + $template->assign('service_item', $serviceSale['item']); + $template->assign('transfer_accounts', $transferAccounts); + $template->assign('form', $form->returnForm()); + + $content = $template->fetch('buycourses/view/process_confirm.tpl'); + + $template->assign('content', $content); + $template->display_one_col_template(); + + break; +} diff --git a/plugin/buycourses/src/service_sales_report.php b/plugin/buycourses/src/service_sales_report.php new file mode 100644 index 000000000..3d4cc6eff --- /dev/null +++ b/plugin/buycourses/src/service_sales_report.php @@ -0,0 +1,103 @@ +get('paypal_enable'); +$commissionsEnable = $plugin->get('commissions_enable'); +$includeServices = $plugin->get('include_services'); +$invoicingEnable = $plugin->get('invoicing_enable') === 'true'; + +$saleStatuses = $plugin->getServiceSaleStatuses(); +$selectedStatus = isset($_GET['status']) ? $_GET['status'] : BuyCoursesPlugin::SALE_STATUS_PENDING; +$form = new FormValidator('search', 'get'); + +if ($form->validate()) { + $selectedStatus = $form->getSubmitValue('status'); + if ($selectedStatus === false) { + $selectedStatus = BuyCoursesPlugin::SALE_STATUS_PENDING; + } +} + +$form->addSelect('status', $plugin->get_lang('OrderStatus'), $saleStatuses, ['cols-size' => [0, 0, 0]]); +$form->addText('user', get_lang('User'), false, ['cols-size' => [0, 0, 0]]); +$form->addButtonSearch(get_lang('Search'), 'search'); + +$servicesSales = $plugin->getServiceSales(0, $selectedStatus); + +foreach ($servicesSales as &$sale) { + if (isset($sale['discount_amount']) && $sale['discount_amount'] != 0) { + $sale['total_discount'] = $plugin->getPriceWithCurrencyFromIsoCode($sale['discount_amount'], $sale['iso_code']); + $sale['coupon_code'] = $plugin->getServiceSaleCouponCode($sale['id']); + } +} + +$interbreadcrumb[] = ['url' => '../index.php', 'name' => $plugin->get_lang('plugin_title')]; + +$webPluginPath = api_get_path(WEB_PLUGIN_PATH); +$htmlHeadXtra[] = api_get_css($webPluginPath.'buycourses/resources/css/style.css'); +$htmlHeadXtra[] = api_get_css($webPluginPath.'buycourses/resources/js/modals.js'); + +$templateName = $plugin->get_lang('SalesReport'); + +$template = new Template($templateName); + +$toolbar = Display::url( + Display::returnFontAwesomeIcon('file-excel-o'). + get_lang('GenerateReport'), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/export_report.php', + ['class' => 'btn btn-primary'] +); + +if ($paypalEnable == 'true' && $commissionsEnable == 'true') { + $toolbar .= Display::toolbarButton( + $plugin->get_lang('PaypalPayoutCommissions'), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/paypal_payout.php', + 'paypal', + 'primary', + ['title' => $plugin->get_lang('PaypalPayoutCommissions')] + ); +} + +$template->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); + +if ($commissionsEnable == 'true') { + $toolbar = Display::toolbarButton( + $plugin->get_lang('PayoutReport'), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/payout_report.php', + 'money', + 'info', + ['title' => $plugin->get_lang('PayoutReport')] + ); + + $template->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) + ); +} +$template->assign('form', $form->returnForm()); +$template->assign('showing_services', true); +$template->assign('services_are_included', $includeServices); +$template->assign('sale_list', $servicesSales); +$template->assign('sale_status_cancelled', BuyCoursesPlugin::SERVICE_STATUS_CANCELLED); +$template->assign('sale_status_pending', BuyCoursesPlugin::SERVICE_STATUS_PENDING); +$template->assign('sale_status_completed', BuyCoursesPlugin::SERVICE_STATUS_COMPLETED); +$template->assign('invoicing_enable', $invoicingEnable); +$content = $template->fetch('buycourses/view/service_sales_report.tpl'); +$template->assign('content', $content); +$template->assign('header', $templateName); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/service_success.php b/plugin/buycourses/src/service_success.php new file mode 100644 index 000000000..5dc02762e --- /dev/null +++ b/plugin/buycourses/src/service_success.php @@ -0,0 +1,186 @@ +get('paypal_enable') === 'true'; + +if (!$paypalEnabled) { + api_not_allowed(true); +} + +$serviceSaleId = $_SESSION['bc_service_sale_id']; +$serviceSale = $plugin->getServiceSale($serviceSaleId); +$itemPrice = $serviceSale['price']; + +if (empty($serviceSale)) { + api_not_allowed(true); +} + +$paypalParams = $plugin->getPaypalParams(); + +$pruebas = $paypalParams['sandbox'] == 1; +$paypalUsername = $paypalParams['username']; +$paypalPassword = $paypalParams['password']; +$paypalSignature = $paypalParams['signature']; + +require_once "paypalfunctions.php"; + +$buyerInformation = GetShippingDetails(urlencode($_SESSION['TOKEN'])); + +$form = new FormValidator( + 'success', + 'POST', + api_get_self(), + null, + null, + FormValidator::LAYOUT_INLINE +); +$form->addButton( + 'confirm', + $plugin->get_lang('ConfirmOrder'), + 'check', + 'success' +); +$form->addButtonCancel($plugin->get_lang('CancelOrder'), 'cancel'); + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + if (isset($formValues['cancel'])) { + $plugin->cancelServiceSale($serviceSale['id']); + + unset($_SESSION['bc_service_sale_id']); + + Display::addFlash( + Display::return_message($plugin->get_lang('OrderCancelled'), 'error', false) + ); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_catalog.php'); + exit; + } + + $confirmPayments = ConfirmPayment($itemPrice); + if ($confirmPayments['ACK'] !== 'Success') { + $erroMessage = vsprintf( + $plugin->get_lang('ErrorOccurred'), + [$expressCheckout['L_ERRORCODE0'], $confirmPayments['L_LONGMESSAGE0']] + ); + Display::addFlash( + Display::return_message($erroMessage, 'error', false) + ); + unset($_SESSION['wizard']); + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_catalog.php'); + exit; + } + + switch ($confirmPayments["PAYMENTINFO_0_PAYMENTSTATUS"]) { + case 'Completed': + $serviceSaleIsCompleted = $plugin->completeServiceSale($serviceSale['id']); + + if ($serviceSaleIsCompleted) { + Display::addFlash( + Display::return_message( + sprintf($plugin->get_lang('SubscriptionToServiceXSuccessful'), $serviceSale['service']['name']), + 'success' + ) + ); + + break; + } + + Display::addFlash( + Display::return_message($plugin->get_lang('ErrorContactPlatformAdmin'), 'error') + ); + break; + case 'Pending': + switch ($confirmPayments["PAYMENTINFO_0_PENDINGREASON"]) { + case 'address': + $purchaseStatus = $plugin->get_lang('PendingReasonByAddress'); + break; + case 'authorization': + $purchaseStatus = $plugin->get_lang('PendingReasonByAuthorization'); + break; + case 'echeck': + $purchaseStatus = $plugin->get_lang('PendingReasonByEcheck'); + break; + case 'intl': + $purchaseStatus = $plugin->get_lang('PendingReasonByIntl'); + break; + case 'multicurrency': + $purchaseStatus = $plugin->get_lang('PendingReasonByMulticurrency'); + break; + case 'order': + $purchaseStatus = $plugin->get_lang('PendingReasonByOrder'); + break; + case 'paymentreview': + $purchaseStatus = $plugin->get_lang('PendingReasonByPaymentReview'); + break; + case 'regulatoryreview': + $purchaseStatus = $plugin->get_lang('PendingReasonByRegulatoryReview'); + break; + case 'unilateral': + $purchaseStatus = $plugin->get_lang('PendingReasonByUnilateral'); + break; + case 'upgrade': + $purchaseStatus = $plugin->get_lang('PendingReasonByUpgrade'); + break; + case 'verify': + $purchaseStatus = $plugin->get_lang('PendingReasonByVerify'); + break; + case 'other': + default: + $purchaseStatus = $plugin->get_lang('PendingReasonByOther'); + break; + } + + Display::addFlash( + Display::return_message( + sprintf($plugin->get_lang('PurchaseStatusX'), $purchaseStatus), + 'warning', + false + ) + ); + break; + default: + $plugin->cancelServiceSale(intval($serviceSale['id'])); + + Display::addFlash( + Display::return_message($plugin->get_lang('ErrorContactPlatformAdmin'), 'error') + ); + break; + } + + unset($_SESSION['bc_service_sale_id']); + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/service_catalog.php'); + exit; +} + +$token = isset($_GET['token']) ? Security::remove_XSS($_GET['token']) : null; +if (empty($token)) { + api_not_allowed(true); +} + +$interbreadcrumb[] = [ + "url" => "service_catalog.php", + "name" => $plugin->get_lang('ListOfServicesOnSale'), +]; + +$templateName = $plugin->get_lang('PaymentMethods'); +$tpl = new Template($templateName); +$tpl->assign('title', $serviceSale['service']['name']); +$tpl->assign('price', $serviceSale['price']); +$tpl->assign('currency', $serviceSale['currency_id']); +$tpl->assign('service', $serviceSale); +$tpl->assign('buying_service', true); +$tpl->assign('user', api_get_user_info($serviceSale['buyer']['id'])); +$tpl->assign('form', $form->returnForm()); + +$content = $tpl->fetch('buycourses/view/success.tpl'); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/services_add.php b/plugin/buycourses/src/services_add.php new file mode 100644 index 000000000..0d038b614 --- /dev/null +++ b/plugin/buycourses/src/services_add.php @@ -0,0 +1,141 @@ +getSelectedCurrency(); +$em = Database::getManager(); +$users = UserManager::getRepository()->findAll(); +$userOptions = []; +if (!empty($users)) { + foreach ($users as $user) { + $userOptions[$user->getId()] = $user->getCompleteNameWithUsername(); + } +} + +api_protect_admin_script(true); + +$htmlHeadXtra[] = api_get_css_asset('cropper/dist/cropper.min.css'); +$htmlHeadXtra[] = api_get_asset('cropper/dist/cropper.min.js'); + +//view +$interbreadcrumb[] = [ + 'url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php', + 'name' => $plugin->get_lang('plugin_title'), +]; +$interbreadcrumb[] = [ + 'url' => 'list_service.php', + 'name' => $plugin->get_lang('Services'), +]; + +$globalSettingsParams = $plugin->getGlobalParameters(); + +$formDefaultValues = [ + 'price' => 0, + 'tax_perc' => $globalSettingsParams['global_tax_perc'], + 'duration_days' => 0, + 'applies_to' => 0, + 'visibility' => true, +]; + +$form = new FormValidator('Services'); +$form->addText('name', $plugin->get_lang('ServiceName')); +$form->addHtmlEditor('description', $plugin->get_lang('Description')); +$form->addElement( + 'number', + 'price', + [$plugin->get_lang('Price'), null, $currency['iso_code']], + ['step' => 0.01] +); +$form->addElement( + 'number', + 'tax_perc', + [$plugin->get_lang('TaxPerc'), $plugin->get_lang('TaxPercDescription'), '%'], + ['step' => 1, 'placeholder' => $globalSettingsParams['global_tax_perc'].'% '.$plugin->get_lang('ByDefault')] +); +$form->addElement( + 'number', + 'duration_days', + [$plugin->get_lang('Duration'), null, get_lang('Days')], + ['step' => 1] +); +$form->addElement( + 'radio', + 'applies_to', + $plugin->get_lang('AppliesTo'), + get_lang('None'), + 0 +); +$form->addElement( + 'radio', + 'applies_to', + null, + get_lang('User'), + 1 +); +$form->addElement( + 'radio', + 'applies_to', + null, + get_lang('Course'), + 2 +); +$form->addElement( + 'radio', + 'applies_to', + null, + get_lang('Session'), + 3 +); +$form->addElement( + 'radio', + 'applies_to', + null, + get_lang('TemplateTitleCertificate'), + 4 +); +$form->addSelect( + 'owner_id', + get_lang('Owner'), + $userOptions +); +$form->addCheckBox('visibility', $plugin->get_lang('VisibleInCatalog')); +$form->addFile( + 'picture', + (get_lang( + 'AddImage' + )), + ['id' => 'picture', 'class' => 'picture-form', 'crop_image' => true, 'crop_ratio' => '16 / 9'] +); +$form->addText('video_url', get_lang('VideoUrl'), false); +$form->addHtmlEditor('service_information', $plugin->get_lang('ServiceInformation'), false); +$form->addButtonSave(get_lang('Add')); +$form->setDefaults($formDefaultValues); + +if ($form->validate()) { + $values = $form->getSubmitValues(); + + $plugin->storeService($values); + + Display::addFlash( + Display::return_message($plugin->get_lang('ServiceAdded'), 'success') + ); + + header('Location: list_service.php'); + exit; +} + +$templateName = $plugin->get_lang('NewService'); +$tpl = new Template($templateName); + +$tpl->assign('header', $templateName); +$tpl->assign('content', $form->returnForm()); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/services_edit.php b/plugin/buycourses/src/services_edit.php new file mode 100644 index 000000000..98d801866 --- /dev/null +++ b/plugin/buycourses/src/services_edit.php @@ -0,0 +1,161 @@ +getSelectedCurrency(); +$users = UserManager::getRepository()->findAll(); +$userOptions = []; +if (!empty($users)) { + foreach ($users as $user) { + $userOptions[$user->getId()] = $user->getCompleteNameWithUsername(); + } +} + +api_protect_admin_script(true); +$htmlHeadXtra[] = api_get_css_asset('cropper/dist/cropper.min.css'); +$htmlHeadXtra[] = api_get_asset('cropper/dist/cropper.min.js'); + +//view +// breadcrumbs +$interbreadcrumb[] = [ + 'url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php', + 'name' => $plugin->get_lang('plugin_title'), +]; +$interbreadcrumb[] = [ + 'url' => 'list_service.php', + 'name' => $plugin->get_lang('Services'), +]; + +$globalSettingsParams = $plugin->getGlobalParameters(); +$service = $plugin->getService($serviceId); + +$formDefaultValues = [ + 'name' => $service['name'], + 'description' => $service['description'], + 'price' => $service['price'], + 'tax_perc' => $service['tax_perc'], + 'duration_days' => $service['duration_days'], + 'owner_id' => intval($service['owner_id']), + 'applies_to' => intval($service['applies_to']), + 'visibility' => ($service['visibility'] == 1) ? true : false, + 'image' => is_file(api_get_path(SYS_PLUGIN_PATH).'buycourses/uploads/services/images/simg-'.$serviceId.'.png') + ? api_get_path(WEB_PLUGIN_PATH).'buycourses/uploads/services/images/simg-'.$serviceId.'.png' + : api_get_path(WEB_CODE_PATH).'img/session_default.png', + 'video_url' => $service['video_url'], + 'service_information' => $service['service_information'], +]; + +$form = new FormValidator('Services'); +$form->addText('name', $plugin->get_lang('ServiceName')); +$form->addHtmlEditor('description', $plugin->get_lang('Description')); +$form->addElement( + 'number', + 'price', + [$plugin->get_lang('Price'), null, $currency['iso_code']], + ['step' => 0.01] +); +$form->addElement( + 'number', + 'tax_perc', + [$plugin->get_lang('TaxPerc'), $plugin->get_lang('TaxPercDescription'), '%'], + ['step' => 1, 'placeholder' => $globalSettingsParams['global_tax_perc'].'% '.$plugin->get_lang('ByDefault')] +); +$form->addElement( + 'number', + 'duration_days', + [$plugin->get_lang('Duration'), null, get_lang('Days')], + ['step' => 1] +); +$form->addElement( + 'radio', + 'applies_to', + $plugin->get_lang('AppliesTo'), + get_lang('None'), + 0 +); +$form->addElement( + 'radio', + 'applies_to', + null, + get_lang('User'), + 1 +); +$form->addElement( + 'radio', + 'applies_to', + null, + get_lang('Course'), + 2 +); +$form->addElement( + 'radio', + 'applies_to', + null, + get_lang('Session'), + 3 +); +$form->addElement( + 'radio', + 'applies_to', + null, + get_lang('TemplateTitleCertificate'), + 4 +); +$form->addSelect( + 'owner_id', + get_lang('Owner'), + $userOptions +); +$form->addCheckBox('visibility', $plugin->get_lang('VisibleInCatalog')); +$form->addFile( + 'picture', + $formDefaultValues['image'] != '' ? get_lang('UpdateImage') : get_lang('AddImage'), + ['id' => 'picture', 'class' => 'picture-form', 'crop_image' => true, 'crop_ratio' => '16 / 9'] +); +$form->addText('video_url', get_lang('VideoUrl'), false); +$form->addHtmlEditor('service_information', $plugin->get_lang('ServiceInformation'), false); +$form->addHidden('id', $serviceId); +$form->addButtonSave(get_lang('Edit')); +$form->addHtml('



'); +$form->addButtonDelete($plugin->get_lang('DeleteThisService'), 'delete_service'); +$form->setDefaults($formDefaultValues); +if ($form->validate()) { + $values = $form->getSubmitValues(); + + if (isset($values['delete_service'])) { + $plugin->deleteService($serviceId); + Display::addFlash( + Display::return_message($plugin->get_lang('ServiceDeleted'), 'error') + ); + } else { + $plugin->updateService($values, $serviceId); + Display::addFlash( + Display::return_message($plugin->get_lang('ServiceEdited'), 'success') + ); + } + header('Location: list_service.php'); + exit; +} + +$templateName = $plugin->get_lang('EditService'); +$tpl = new Template($templateName); + +$tpl->assign('header', $templateName); +$tpl->assign('content', $form->returnForm()); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/session_catalog.php b/plugin/buycourses/src/session_catalog.php new file mode 100644 index 000000000..47ea13108 --- /dev/null +++ b/plugin/buycourses/src/session_catalog.php @@ -0,0 +1,127 @@ +get('include_sessions') === 'true'; +$includeServices = $plugin->get('include_services') === 'true'; + +if (!$includeSessions) { + api_not_allowed(true); +} + +$nameFilter = null; +$minFilter = 0; +$maxFilter = 0; +$sessionCategory = isset($_GET['session_category']) ? (int) $_GET['session_category'] : 0; +$form = new FormValidator( + 'search_filter_form', + 'get', + null, + null, + [], + FormValidator::LAYOUT_INLINE +); + +$form->removeAttribute('class'); + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + $nameFilter = isset($formValues['name']) ? $formValues['name'] : null; + $minFilter = isset($formValues['min']) ? $formValues['min'] : 0; + $maxFilter = isset($formValues['max']) ? $formValues['max'] : 0; + $sessionCategory = isset($formValues['session_category']) ? $formValues['session_category'] : $sessionCategory; +} + +$form->addHeader($plugin->get_lang('SearchFilter')); + +$categoriesOptions = [ + '0' => get_lang('AllCategories'), +]; +$categoriesList = SessionManager::get_all_session_category(); +if ($categoriesList != false) { + foreach ($categoriesList as $categoryItem) { + $categoriesOptions[$categoryItem['id']] = $categoryItem['name']; + } +} +$form->addSelect( + 'session_category', + get_lang('SessionCategory'), + $categoriesOptions, + [ + 'id' => 'session_category', + ] +); + +$form->addText('name', get_lang('SessionName'), false); + +$form->addElement( + 'number', + 'min', + $plugin->get_lang('MinimumPrice'), + ['step' => '0.01', 'min' => '0'] +); +$form->addElement( + 'number', + 'max', + $plugin->get_lang('MaximumPrice'), + ['step' => '0.01', 'min' => '0'] +); +$form->addHtml('
'); +$form->addButtonFilter(get_lang('Search')); + +$form->setDefaults( + [ + 'session_category' => $sessionCategory, + ] +); +$pageSize = BuyCoursesPlugin::PAGINATION_PAGE_SIZE; +$currentPage = isset($_GET['page']) ? (int) $_GET['page'] : 1; +$first = $pageSize * ($currentPage - 1); +$sessionList = $plugin->getCatalogSessionList($first, $pageSize, $nameFilter, $minFilter, $maxFilter, 'all', $sessionCategory); +$totalItems = $plugin->getCatalogSessionList($first, $pageSize, $nameFilter, $minFilter, $maxFilter, 'count', $sessionCategory); +$pagesCount = ceil($totalItems / $pageSize); +$pagination = BuyCoursesPlugin::returnPagination(api_get_self(), $currentPage, $pagesCount, $totalItems); + +// View +if (api_is_platform_admin()) { + $interbreadcrumb[] = [ + 'url' => 'list.php', + 'name' => $plugin->get_lang('AvailableCoursesConfiguration'), + ]; + $interbreadcrumb[] = [ + 'url' => 'paymentsetup.php', + 'name' => $plugin->get_lang('PaymentsConfiguration'), + ]; +} + +$templateName = $plugin->get_lang('CourseListOnSale'); + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$template = new Template($templateName); +$template->assign('search_filter_form', $form->returnForm()); +$template->assign('sessions_are_included', $includeSessions); +$template->assign('services_are_included', $includeServices); +$template->assign('showing_sessions', true); +$template->assign('sessions', $sessionList); +$template->assign('pagination', $pagination); + +$countCourses = $plugin->getCatalogCourseList($first, $pageSize, $nameFilter, $minFilter, $maxFilter, 'count'); + +$template->assign('coursesExist', $countCourses > 0); +$template->assign('sessionExist', true); + +$content = $template->fetch('buycourses/view/catalog.tpl'); + +$template->assign('header', $templateName); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/session_panel.php b/plugin/buycourses/src/session_panel.php new file mode 100644 index 000000000..f6506a3fa --- /dev/null +++ b/plugin/buycourses/src/session_panel.php @@ -0,0 +1,67 @@ +get('include_sessions') === 'true'; +$includeServices = $plugin->get('include_services') === 'true'; + +$userInfo = api_get_user_info(); + +$productTypes = $plugin->getProductTypes(); +$saleStatuses = $plugin->getSaleStatuses(); +$paymentTypes = $plugin->getPaymentTypes(); + +$sales = $plugin->getSaleListByUserId($userInfo['id']); + +$saleList = []; + +foreach ($sales as $sale) { + if ($sale['product_type'] == 2) { + $saleList[] = [ + 'id' => $sale['id'], + 'reference' => $sale['reference'], + 'date' => api_format_date($sale['date'], DATE_TIME_FORMAT_LONG_24H), + 'currency' => $sale['iso_code'], + 'price' => $sale['price'], + 'product_name' => $sale['product_name'], + 'product_type' => $productTypes[$sale['product_type']], + 'payment_type' => $paymentTypes[$sale['payment_type']], + ]; + } +} + +$toolbar = Display::toolbarButton( + $plugin->get_lang('CourseListOnSale'), + 'course_catalog.php', + 'search-plus', + 'primary', + ['title' => $plugin->get_lang('CourseListOnSale')] +); + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$templateName = get_lang('TabsDashboard'); +$tpl = new Template($templateName); +$tpl->assign('showing_courses', true); +$tpl->assign('sessions_are_included', $includeSessions); +$tpl->assign('services_are_included', $includeServices); +$tpl->assign('sale_list', $saleList); + +$content = $tpl->fetch('buycourses/view/session_panel.tpl'); + +$tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/stripe_cancel.php b/plugin/buycourses/src/stripe_cancel.php new file mode 100644 index 000000000..1382ec627 --- /dev/null +++ b/plugin/buycourses/src/stripe_cancel.php @@ -0,0 +1,30 @@ +get('stripe_enable') === 'true'; + +if (!$stripeEnabled) { + api_not_allowed(true); +} + +$sale = $plugin->getSale($_SESSION['bc_sale_id']); + +if (empty($sale)) { + api_not_allowed(true); +} + +Display::addFlash( + Display::return_message($plugin->get_lang('ErrorContactPlatformAdmin'), 'error') +); + +unset($_SESSION['bc_sale_id']); +header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/course_catalog.php'); +exit; diff --git a/plugin/buycourses/src/stripe_response.php b/plugin/buycourses/src/stripe_response.php new file mode 100644 index 000000000..f4b11bd88 --- /dev/null +++ b/plugin/buycourses/src/stripe_response.php @@ -0,0 +1,65 @@ +get('stripe_enable') === 'true'; + +if (!$stripeEnabled) { + api_not_allowed(true); +} + +$stripeParams = $plugin->getStripeParams(); + +$payload = @file_get_contents('php://input'); +$sig_header = $_SERVER['HTTP_STRIPE_SIGNATURE']; +$event = null; + +try { + $event = \Stripe\Webhook::constructEvent( + $payload, $sig_header, $stripeParams['endpoint_secret'] + ); +} catch (\UnexpectedValueException $e) { + http_response_code(400); + exit(); +} catch (\Stripe\Exception\SignatureVerificationException $e) { + http_response_code(400); + exit(); +} + +switch ($event->type) { + case 'checkout.session.completed': + $checkoutSession = $event->data->object; + + $sale = $plugin->getSaleFromReference($checkoutSession->id); + + if (empty($sale)) { + api_not_allowed(true); + } + + $buyingCourse = false; + $buyingSession = false; + + switch ($sale['product_type']) { + case BuyCoursesPlugin::PRODUCT_TYPE_COURSE: + $buyingCourse = true; + $course = $plugin->getCourseInfo($sale['product_id']); + break; + case BuyCoursesPlugin::PRODUCT_TYPE_SESSION: + $buyingSession = true; + $session = $plugin->getSessionInfo($sale['product_id']); + break; + } + + $saleIsCompleted = $plugin->completeSale($sale['id']); + + if ($saleIsCompleted) { + $plugin->storePayouts($sale['id']); + } + + // no break + default: + echo 'Received unknown event type '.$event->type; +} + +http_response_code(200); diff --git a/plugin/buycourses/src/stripe_success.php b/plugin/buycourses/src/stripe_success.php new file mode 100644 index 000000000..545e3fcb3 --- /dev/null +++ b/plugin/buycourses/src/stripe_success.php @@ -0,0 +1,78 @@ +get('stripe_enable') === 'true'; + +if (!$stripeEnabled) { + api_not_allowed(true); +} + +$sale = $plugin->getSale($_SESSION['bc_sale_id']); + +if (empty($sale)) { + api_not_allowed(true); +} + +$userInfo = api_get_user_info($sale['user_id']); +$currency = $plugin->getCurrency($sale['currency_id']); +$globalParameters = $plugin->getGlobalParameters(); + +if (!empty($globalParameters['sale_email'])) { + $messageConfirmBuyerTemplate = new Template(); + $messageConfirmBuyerTemplate->assign('user', $userInfo); + $messageConfirmBuyerTemplate->assign( + 'sale', + [ + 'date' => $sale['date'], + 'product' => $sale['product_name'], + 'currency' => $currency['iso_code'], + 'price' => $sale['price'], + 'reference' => $sale['reference'], + ] + ); + + api_mail_html( + $userInfo['complete_name'], + $userInfo['email'], + $plugin->get_lang('bc_subject'), + $messageConfirmBuyerTemplate->fetch('buycourses/view/message_confirm_buyer.tpl'), + '', + $globalParameters['sale_email'] + ); + + $messageConfirmTemplate = new Template(); + $messageConfirmTemplate->assign('user', $userInfo); + $messageConfirmTemplate->assign( + 'sale', + [ + 'date' => $sale['date'], + 'product' => $sale['product_name'], + 'currency' => $currency['iso_code'], + 'price' => $sale['price'], + 'reference' => $sale['reference'], + ] + ); + + api_mail_html( + '', + $globalParameters['sale_email'], + $plugin->get_lang('bc_subject'), + $messageConfirmTemplate->fetch('buycourses/view/message_confirm.tpl') + ); +} + +Display::addFlash( + $plugin->getSubscriptionSuccessMessage($sale) +); + +unset($_SESSION['bc_sale_id']); +header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/course_catalog.php'); +exit; diff --git a/plugin/buycourses/src/subscription_add.php b/plugin/buycourses/src/subscription_add.php new file mode 100644 index 000000000..3ae12ba45 --- /dev/null +++ b/plugin/buycourses/src/subscription_add.php @@ -0,0 +1,234 @@ +get('include_sessions') === 'true'; + +$entityManager = Database::getManager(); +$userRepo = UserManager::getRepository(); +$currency = $plugin->getSelectedCurrency(); + +if (empty($currency)) { + Display::addFlash( + Display::return_message($plugin->get_lang('CurrencyIsNotConfigured'), 'error') + ); +} + +$currencyIso = null; + +if ($editingCourse) { + $course = $entityManager->find('ChamiloCoreBundle:Course', $id); + if (!$course) { + api_not_allowed(true); + } + + $courseItem = $plugin->getCourseForConfiguration($course, $currency); + + $currencyIso = $courseItem['currency']; + $formDefaults = [ + 'product_type' => get_lang('Course'), + 'id' => $courseItem['course_id'], + 'type' => BuyCoursesPlugin::PRODUCT_TYPE_COURSE, + 'name' => $courseItem['course_title'], + 'visible' => $courseItem['visible'], + 'price' => $courseItem['price'], + 'tax_perc' => $courseItem['tax_perc'], + 'currency_id' => $currency['id'], + ]; +} elseif ($editingSession) { + if (!$includeSession) { + api_not_allowed(true); + } + + $session = $entityManager->find('ChamiloCoreBundle:Session', $id); + if (!$session) { + api_not_allowed(true); + } + + $sessionItem = $plugin->getSessionForConfiguration($session, $currency); + + $currencyIso = $sessionItem['currency']; + $formDefaults = [ + 'product_type' => get_lang('Session'), + 'id' => $session->getId(), + 'type' => BuyCoursesPlugin::PRODUCT_TYPE_SESSION, + 'name' => $sessionItem['session_name'], + 'visible' => $sessionItem['visible'], + 'price' => $sessionItem['price'], + 'tax_perc' => $sessionItem['tax_perc'], + 'currency_id' => $currency['id'], + ]; +} else { + api_not_allowed(true); +} + +$globalSettingsParams = $plugin->getGlobalParameters(); + +$form = new FormValidator('add_subscription'); + +$form->addText('product_type', $plugin->get_lang('ProductType'), false); +$form->addText('name', get_lang('Name'), false); + +$form->freeze(['product_type', 'name']); + +$form->addElement( + 'number', + 'tax_perc', + [$plugin->get_lang('TaxPerc'), $plugin->get_lang('TaxPercDescription'), '%'], + ['step' => 1, 'placeholder' => $globalSettingsParams['global_tax_perc'].'% '.$plugin->get_lang('ByDefault')] +); + +$frequencies = $plugin->getFrequencies(); + +$selectOptions = ''; +foreach ($frequencies as $key => $frequency) { + $selectOptions .= ''; +} + +if (empty($frequencies)) { + Display::addFlash( + Display::return_message($plugin->get_lang('FrequencyIsNotConfigured'), 'error') + ); +} + +$platformCommission = $plugin->getPlatformCommission(); +$form->addHtml( + ' +
+
+
+
+

'.$plugin->get_lang('FrequencyConfig').'

+
+
+
+
+
+ +
+
+ +
+
+
+
+
+ +
+ +
+
+ '.$currencyIso.' +
+
+
+
+ Add +
+
+
+
+
+
+ + + + + + + + + + +
'.$plugin->get_lang('Duration').''.$plugin->get_lang('Price').''.$plugin->get_lang('Actions').'
+
+
+
+
+
+
+
+
+
+ ' +); + +$form->addHidden('type', null); +$form->addHidden('id', null); +$button = $form->addButtonSave(get_lang('Save')); + +if (empty($currency) || empty($frequencies)) { + $button->setAttribute('disabled'); +} + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + $subscription['product_id'] = $formValues['id']; + $subscription['product_type'] = $formValues['type']; + $subscription['currency_id'] = $currency['id']; + $subscription['tax_perc'] = $formValues['tax_perc'] != '' ? (int) $formValues['tax_perc'] : null; + $subscription['frequencies'] = isset($formValues['frequencies']) ? $formValues['frequencies'] : []; + + $result = $plugin->addNewSubscription($subscription); + + if ($result) { + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/subscriptions_courses.php'); + } else { + header('Location:'.api_get_self().'?'.$queryString); + } + + exit; +} + +$form->setDefaults($formDefaults); + +$templateName = $plugin->get_lang('SubscriptionAdd'); +$interbreadcrumb[] = [ + 'url' => 'subscriptions_courses.php', + 'name' => get_lang('Configuration'), +]; +$interbreadcrumb[] = [ + 'url' => 'subscriptions_courses.php', + 'name' => $plugin->get_lang('SubscriptionList'), +]; + +$template = new Template($templateName); +$template->assign('header', $templateName); +$template->assign('items_form', $form->returnForm()); +$template->assign('currencyIso', $currencyIso); + +$content = $template->fetch('buycourses/view/subscription_add.tpl'); +$template->assign('content', $content); + +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/subscription_course_catalog.php b/plugin/buycourses/src/subscription_course_catalog.php new file mode 100644 index 000000000..db9e2c7f7 --- /dev/null +++ b/plugin/buycourses/src/subscription_course_catalog.php @@ -0,0 +1,88 @@ +get('include_sessions') === 'true'; +$includeServices = $plugin->get('include_services') === 'true'; + +$nameFilter = ''; + +$form = new FormValidator( + 'search_filter_form', + 'get', + null, + null, + [], + FormValidator::LAYOUT_INLINE +); + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + $nameFilter = isset($formValues['name']) ? $formValues['name'] : null; +} + +$form->addHeader($plugin->get_lang('SearchFilter')); +$form->addText('name', get_lang('CourseName'), false); +$form->addHtml('
'); +$form->addButtonFilter(get_lang('Search')); + +$pageSize = BuyCoursesPlugin::PAGINATION_PAGE_SIZE; +$currentPage = isset($_GET['page']) ? (int) $_GET['page'] : 1; +$first = $pageSize * ($currentPage - 1); +$courseList = $plugin->getCatalogSubscriptionCourseList($first, $pageSize, $nameFilter); +$totalItems = $plugin->getCatalogSubscriptionCourseList($first, $pageSize, $nameFilter, 'count'); +$pagesCount = ceil($totalItems / $pageSize); + +$pagination = BuyCoursesPlugin::returnPagination(api_get_self(), $currentPage, $pagesCount, $totalItems); + +// View +if (api_is_platform_admin()) { + $interbreadcrumb[] = [ + 'url' => 'subscriptions_courses.php', + 'name' => $plugin->get_lang('AvailableCoursesConfiguration'), + ]; + $interbreadcrumb[] = [ + 'url' => 'paymentsetup.php', + 'name' => $plugin->get_lang('PaymentsConfiguration'), + ]; +} else { + $interbreadcrumb[] = [ + 'url' => 'course_panel.php', + 'name' => get_lang('TabsDashboard'), + ]; +} + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$templateName = $plugin->get_lang('SubscriptionListOnSale'); +$tpl = new Template($templateName); +$tpl->assign('search_filter_form', $form->returnForm()); +$tpl->assign('showing_courses', true); +$tpl->assign('courses', $courseList); +$tpl->assign('sessions_are_included', $includeSessions); +$tpl->assign('pagination', $pagination); + +$sessionList = $plugin->getCatalogSubscriptionSessionList($first, $pageSize, $nameFilter, 'first', 0); +$coursesExist = true; +$sessionExist = true; +if (count($sessionList) <= 0) { + $sessionExist = false; +} + +$tpl->assign('coursesExist', $coursesExist); +$tpl->assign('sessionExist', $sessionExist); + +$content = $tpl->fetch('buycourses/view/subscription_catalog.tpl'); + +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/subscription_process.php b/plugin/buycourses/src/subscription_process.php new file mode 100644 index 000000000..ab5034247 --- /dev/null +++ b/plugin/buycourses/src/subscription_process.php @@ -0,0 +1,266 @@ +'; +$plugin = BuyCoursesPlugin::create(); +$includeSession = $plugin->get('include_sessions') === 'true'; +$paypalEnabled = $plugin->get('paypal_enable') === 'true'; +$transferEnabled = $plugin->get('transfer_enable') === 'true'; +$culqiEnabled = $plugin->get('culqi_enable') === 'true'; +$tpvRedsysEnable = $plugin->get('tpv_redsys_enable') === 'true'; + +if (!$paypalEnabled && !$transferEnabled && !$culqiEnabled && !$tpvRedsysEnable) { + api_not_allowed(true); +} + +if (!isset($_REQUEST['t'], $_REQUEST['i'])) { + api_not_allowed(true); +} + +$buyingCourse = intval($_REQUEST['t']) === BuyCoursesPlugin::PRODUCT_TYPE_COURSE; +$buyingSession = intval($_REQUEST['t']) === BuyCoursesPlugin::PRODUCT_TYPE_SESSION; +$queryString = 'i='.intval($_REQUEST['i']).'&t='.intval($_REQUEST['t']); + +if (isset($_REQUEST['c'])) { + $couponCode = $_REQUEST['c']; + if ($buyingCourse) { + $coupon = $plugin->getCouponByCode($couponCode, BuyCoursesPlugin::PRODUCT_TYPE_COURSE, $_REQUEST['i']); + } else { + $coupon = $plugin->getCouponByCode($couponCode, BuyCoursesPlugin::PRODUCT_TYPE_SESSION, $_REQUEST['i']); + } + + $queryString .= 'c='.$coupon['code']; +} + +if (isset($_REQUEST['d'])) { + $duration = $_REQUEST['d']; + if ($buyingCourse) { + $subscriptionItem = $plugin->getSubscription(BuyCoursesPlugin::PRODUCT_TYPE_COURSE, $_REQUEST['i'], $duration, $coupon); + } else { + $subscriptionItem = $plugin->getSubscription(BuyCoursesPlugin::PRODUCT_TYPE_SESSION, $_REQUEST['i'], $duration, $coupon); + } +} + +if (empty($currentUserId)) { + Session::write('buy_course_redirect', api_get_self().'?'.$queryString); + header('Location: '.api_get_path(WEB_CODE_PATH).'auth/inscription.php'); + exit; +} + +$subscriptionItems = $plugin->getSubscriptionsItemsByProduct($_REQUEST['i'], $_REQUEST['t']); + +if (!isset($subscriptionItems) || empty($subscriptionItems)) { + api_not_allowed(true); +} + +if (!isset($subscriptionItem) || empty($subscriptionItem)) { + $subscriptionItem = $plugin->getSubscription($subscriptionItems[0]['product_type'], $subscriptionItems[0]['product_id'], $subscriptionItems[0]['duration'], $coupon); +} + +$queryString .= 'd='.intval($subscriptionItem['duration']); + +if ($buyingCourse) { + $courseInfo = $plugin->getSubscriptionCourseInfo($_REQUEST['i'], $coupon); + $item = $plugin->getSubscriptionItemByProduct($_REQUEST['i'], BuyCoursesPlugin::PRODUCT_TYPE_COURSE); +} elseif ($buyingSession) { + $sessionInfo = $plugin->getSubscriptionSessionInfo($_REQUEST['i'], $coupon); + $item = $plugin->getSubscriptionItemByProduct($_REQUEST['i'], BuyCoursesPlugin::PRODUCT_TYPE_SESSION); +} + +$form = new FormValidator('confirm_sale'); +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + + if (!$formValues['payment_type']) { + Display::addFlash( + Display::return_message($plugin->get_lang('NeedToSelectPaymentType'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + + $saleId = $plugin->registerSubscriptionSale($item['product_id'], $item['product_type'], $formValues['payment_type'], $formValues['d'], $formValues['c']); + + if ($saleId !== false) { + $_SESSION['bc_sale_id'] = $saleId; + + if (isset($formValues['c'])) { + $couponSaleId = $plugin->registerCouponSubscriptionSale($saleId, $formValues['c']); + if ($couponSaleId !== false) { + $plugin->updateCouponDelivered($formValues['c']); + $_SESSION['bc_coupon_id'] = $formValues['c']; + } + } + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/process_subscription_confirm.php'); + } + + exit; +} + +$paymentTypesOptions = $plugin->getPaymentTypes(true); + +$count = count($paymentTypesOptions); +if ($count === 0) { + $form->addHtml($plugin->get_lang('NoPaymentOptionAvailable')); + $form->addHtml('
'); + $form->addHtml('
'); +} elseif ($count === 1) { + // get the only array item + foreach ($paymentTypesOptions as $type => $value) { + $form->addHtml(sprintf($plugin->get_lang('XIsOnlyPaymentMethodAvailable'), $value)); + $form->addHtml('
'); + $form->addHtml('
'); + $form->addHidden('payment_type', $type); + } +} else { + $form->addHtml( + Display::return_message( + $plugin->get_lang('PleaseSelectThePaymentMethodBeforeConfirmYourOrder'), + 'info' + ) + ); + $form->addRadio('payment_type', null, $paymentTypesOptions); +} + +$form->addHidden('t', intval($_GET['t'])); +$form->addHidden('i', intval($_GET['i'])); +if ($coupon != null) { + $form->addHidden('c', intval($coupon['id'])); +} +$form->addButton('submit', $plugin->get_lang('ConfirmOrder'), 'check', 'success', 'btn-lg pull-right'); + +$formSubscription = new FormValidator('confirm_subscription'); +if ($formSubscription->validate()) { + $formSubscriptionValues = $formSubscription->getSubmitValues(); + + if (!$formSubscriptionValues['duration']) { + Display::addFlash( + Display::return_message($plugin->get_lang('NeedToAddDuration'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + + if ($buyingCourse) { + $subscription = $plugin->getSubscription(BuyCoursesPlugin::PRODUCT_TYPE_COURSE, $_REQUEST['i'], $formSubscriptionValues['duration']); + } else { + $subscription = $plugin->getSubscription(BuyCoursesPlugin::PRODUCT_TYPE_SESSION, $_REQUEST['i'], $formSubscriptionValues['duration']); + } + + if ($subscription == null) { + Display::addFlash( + Display::return_message($plugin->get_lang('SubscriptionNotValid'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/subscription_process.php?i='.$_REQUEST['i'].'&t='.$_REQUEST['t'].'&d='.$formSubscriptionValues['duration']); + + exit; +} + +$frequencies = $plugin->getFrequencies(); +$selectedFrequencies = []; + +foreach ($subscriptionItems as $si) { + if (isset($frequencies[$si['duration']])) { + $selectedFrequencies[$si['duration']] = $frequencies[$si['duration']].' - '.$si['price_formatted'].' '.$si['iso_code']; + } +} + +$formSubscription->addRadio('duration', null, $selectedFrequencies); + +if (!empty($selectedFrequencies)) { + $formSubscriptionDefaults['duration'] = $subscriptionItem['duration']; + $formSubscription->setDefaults($formSubscriptionDefaults); +} + +$selectedDurationName = $frequencies[$subscriptionItem['duration']]; + +$formSubscription->addHidden('t', intval($_GET['t'])); +$formSubscription->addHidden('i', intval($_GET['i'])); + +$form->addHidden('d', $subscriptionItem['duration']); + +$formCoupon = new FormValidator('confirm_coupon'); +if ($formCoupon->validate()) { + $formCouponValues = $formCoupon->getSubmitValues(); + + if (!$formCouponValues['coupon_code']) { + Display::addFlash( + Display::return_message($plugin->get_lang('NeedToAddCouponCode'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + + if ($buyingCourse) { + $coupon = $plugin->getCouponByCode($formCouponValues['coupon_code'], BuyCoursesPlugin::PRODUCT_TYPE_COURSE, $_REQUEST['i']); + } else { + $coupon = $plugin->getCouponByCode($formCouponValues['coupon_code'], BuyCoursesPlugin::PRODUCT_TYPE_SESSION, $_REQUEST['i']); + } + + if ($coupon == null) { + Display::addFlash( + Display::return_message($plugin->get_lang('CouponNotValid'), 'error', false) + ); + header('Location:'.api_get_self().'?'.$queryString); + exit; + } + + Display::addFlash( + Display::return_message($plugin->get_lang('CouponRedeemed'), 'success', false) + ); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/subscription_process.php?i='.$_REQUEST['i'].'&t='.$_REQUEST['t'].'&d='.$_REQUEST['d'].'&c='.$formCouponValues['coupon_code']); + + exit; +} +$formCoupon->addText('coupon_code', $plugin->get_lang('CouponsCode'), true); +$formCoupon->addHidden('t', intval($_GET['t'])); +$formCoupon->addHidden('i', intval($_GET['i'])); +$formCoupon->addHidden('d', $subscriptionItem['duration']); +$formCoupon->addButton('submit', $plugin->get_lang('RedeemCoupon'), 'check', 'success', 'btn-lg pull-right'); + +// View +$templateName = $plugin->get_lang('PaymentMethods'); +$interbreadcrumb[] = ['url' => 'subscription_course_catalog.php', 'name' => $plugin->get_lang('CourseListOnSale')]; + +$tpl = new Template($templateName); +$tpl->assign('item_type', (int) $_GET['t']); +$tpl->assign('buying_course', $buyingCourse); +$tpl->assign('buying_session', $buyingSession); +$tpl->assign('user', api_get_user_info()); +$tpl->assign('form_coupon', $formCoupon->returnForm()); +$tpl->assign('message_payment', $messagePayment); +$tpl->assign('selected_duration_name', $selectedDurationName); +$tpl->assign('form', $form->returnForm()); +$tpl->assign('form_subscription', $formSubscription->returnForm()); + +if ($buyingCourse) { + $tpl->assign('course', $courseInfo); +} elseif ($buyingSession) { + $tpl->assign('session', $sessionInfo); +} + +$tpl->assign('subscription', $subscriptionItem); + +$content = $tpl->fetch('buycourses/view/subscription_process.tpl'); + +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/subscription_sales_report.php b/plugin/buycourses/src/subscription_sales_report.php new file mode 100644 index 000000000..a29c4eded --- /dev/null +++ b/plugin/buycourses/src/subscription_sales_report.php @@ -0,0 +1,201 @@ +get('paypal_enable'); +$commissionsEnable = $plugin->get('commissions_enable'); +$includeServices = $plugin->get('include_services'); +$invoicingEnable = $plugin->get('invoicing_enable') === 'true'; + +if (isset($_GET['order'])) { + $sale = $plugin->getSubscriptionSale($_GET['order']); + + if (empty($sale)) { + api_not_allowed(true); + } + + $urlToRedirect = api_get_self().'?'; + + switch ($_GET['action']) { + case 'confirm': + $plugin->completeSubscriptionSale($sale['id']); + $plugin->storeSubscriptionPayouts($sale['id']); + Display::addFlash( + $plugin->getSubscriptionSuccessMessage($sale) + ); + + $urlToRedirect .= http_build_query([ + 'status' => BuyCoursesPlugin::SALE_STATUS_COMPLETED, + 'sale' => $sale['id'], + ]); + break; + case 'cancel': + $plugin->cancelSubscriptionSale($sale['id']); + + Display::addFlash( + Display::return_message( + $plugin->get_lang('OrderCanceled'), + 'warning' + ) + ); + + $urlToRedirect .= http_build_query([ + 'status' => BuyCoursesPlugin::SALE_STATUS_CANCELED, + 'sale' => $sale['id'], + ]); + break; + } + + header("Location: $urlToRedirect"); + exit; +} + +$productTypes = $plugin->getProductTypes(); +$saleStatuses = $plugin->getSaleStatuses(); +$paymentTypes = $plugin->getPaymentTypes(); + +$selectedFilterType = '0'; +$selectedStatus = isset($_GET['status']) ? $_GET['status'] : BuyCoursesPlugin::SALE_STATUS_PENDING; +$selectedSale = isset($_GET['sale']) ? intval($_GET['sale']) : 0; +$dateStart = isset($_GET['date_start']) ? $_GET['date_start'] : date('Y-m-d H:i', mktime(0, 0, 0)); +$dateEnd = isset($_GET['date_end']) ? $_GET['date_end'] : date('Y-m-d H:i', mktime(23, 59, 59)); +$searchTerm = ''; +$email = ''; + +$form = new FormValidator('search', 'get'); + +if ($form->validate()) { + $selectedFilterType = $form->getSubmitValue('filter_type'); + $selectedStatus = $form->getSubmitValue('status'); + $searchTerm = $form->getSubmitValue('user'); + $dateStart = $form->getSubmitValue('date_start'); + $dateEnd = $form->getSubmitValue('date_end'); + $email = $form->getSubmitValue('email'); + + if ($selectedStatus === false) { + $selectedStatus = BuyCoursesPlugin::SALE_STATUS_PENDING; + } + + if ($selectedFilterType === false) { + $selectedFilterType = '0'; + } +} + +$form->addRadio( + 'filter_type', + get_lang('Filter'), + [ + $plugin->get_lang('ByStatus'), + $plugin->get_lang('ByUser'), + $plugin->get_lang('ByDate'), + $plugin->get_lang('ByEmail'), + ] +); +$form->addHtml('
'); +$form->addSelect('status', $plugin->get_lang('OrderStatus'), $saleStatuses); +$form->addHtml('
'); +$form->addHtml('
'); +$form->addText('user', get_lang('UserName'), false); +$form->addHtml('
'); +$form->addHtml('
'); +$form->addDateRangePicker('date', get_lang('Date'), false); +$form->addHtml('
'); +$form->addHtml('
'); +$form->addText('email', get_lang('Email'), false); +$form->addHtml('
'); +$form->addButtonFilter(get_lang('Search')); +$form->setDefaults([ + 'filter_type' => $selectedFilterType, + 'status' => $selectedStatus, + 'date_start' => $dateStart, + 'date_end' => $dateEnd, + 'email' => $email, +]); + +switch ($selectedFilterType) { + case '0': + $sales = $plugin->getSubscriptionSaleListByStatus($selectedStatus); + break; + case '1': + $sales = $plugin->getSubscriptionSaleListByUser($searchTerm); + break; + case '2': + $sales = $plugin->getSubscriptionSaleListByDate($dateStart, $dateEnd); + break; + case '3': + $sales = $plugin->getSubscriptionSaleListByEmail($email); + break; +} + +foreach ($sales as &$sale) { + $sale['product_type'] = $productTypes[$sale['product_type']]; + $sale['payment_type'] = $paymentTypes[$sale['payment_type']]; + $sale['complete_user_name'] = api_get_person_name($sale['firstname'], $sale['lastname']); + $sale['num_invoice'] = $plugin->getNumInvoice($sale['id'], 0); + $sale['total_price'] = $plugin->getPriceWithCurrencyFromIsoCode($sale['price'], $sale['iso_code']); + if (isset($sale['discount_amount']) && $sale['discount_amount'] != 0) { + $sale['total_discount'] = $plugin->getPriceWithCurrencyFromIsoCode($sale['discount_amount'], $sale['iso_code']); + $sale['coupon_code'] = $plugin->getSaleCouponCode($sale['id']); + } +} + +$interbreadcrumb[] = ['url' => '../index.php', 'name' => $plugin->get_lang('plugin_title')]; + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$templateName = $plugin->get_lang('SalesReport'); +$template = new Template($templateName); + +$toolbar = Display::url( + Display::returnFontAwesomeIcon('file-excel-o'). + get_lang('GenerateReport'), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/export_subscription_report.php', + ['class' => 'btn btn-primary'] +); + +if ($paypalEnable === 'true' && $commissionsEnable === 'true') { + $toolbar .= Display::toolbarButton( + $plugin->get_lang('PaypalPayoutCommissions'), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/paypal_payout.php', + 'paypal', + 'primary', + ['title' => $plugin->get_lang('PaypalPayoutCommissions')] + ); + + $template->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) + ); +} + +$template->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); +$template->assign('form', $form->returnForm()); +$template->assign('selected_sale', $selectedSale); +$template->assign('selected_status', $selectedStatus); +$template->assign('services_are_included', $includeServices); +$template->assign('sale_list', $sales); +$template->assign('sale_status_canceled', BuyCoursesPlugin::SALE_STATUS_CANCELED); +$template->assign('sale_status_pending', BuyCoursesPlugin::SALE_STATUS_PENDING); +$template->assign('sale_status_completed', BuyCoursesPlugin::SALE_STATUS_COMPLETED); +$template->assign('invoicing_enable', $invoicingEnable); + +$content = $template->fetch('buycourses/view/subscription_sales_report.tpl'); + +$template->assign('header', $templateName); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/subscription_session_catalog.php b/plugin/buycourses/src/subscription_session_catalog.php new file mode 100644 index 000000000..a52309899 --- /dev/null +++ b/plugin/buycourses/src/subscription_session_catalog.php @@ -0,0 +1,114 @@ +get('include_sessions') === 'true'; +$includeServices = $plugin->get('include_services') === 'true'; + +if (!$includeSessions) { + api_not_allowed(true); +} + +$nameFilter = null; +$sessionCategory = isset($_GET['session_category']) ? (int) $_GET['session_category'] : 0; +$form = new FormValidator( + 'search_filter_form', + 'get', + null, + null, + [], + FormValidator::LAYOUT_INLINE +); + +$form->removeAttribute('class'); + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + $nameFilter = isset($formValues['name']) ? $formValues['name'] : null; + $sessionCategory = isset($formValues['session_category']) ? $formValues['session_category'] : $sessionCategory; +} + +$form->addHeader($plugin->get_lang('SearchFilter')); + +$categoriesOptions = [ + '0' => get_lang('AllCategories'), +]; +$categoriesList = SessionManager::get_all_session_category(); +if ($categoriesList != false) { + foreach ($categoriesList as $categoryItem) { + $categoriesOptions[$categoryItem['id']] = $categoryItem['name']; + } +} +$form->addSelect( + 'session_category', + get_lang('SessionCategory'), + $categoriesOptions, + [ + 'id' => 'session_category', + ] +); + +$form->addText('name', get_lang('SessionName'), false); + +$form->addHtml('
'); +$form->addButtonFilter(get_lang('Search')); + +$form->setDefaults( + [ + 'session_category' => $sessionCategory, + ] +); +$pageSize = BuyCoursesPlugin::PAGINATION_PAGE_SIZE; +$currentPage = isset($_GET['page']) ? (int) $_GET['page'] : 1; +$first = $pageSize * ($currentPage - 1); +$sessionList = $plugin->getCatalogSubscriptionSessionList($first, $pageSize, $nameFilter, 'all', $sessionCategory); +$totalItems = $plugin->getCatalogSubscriptionSessionList($first, $pageSize, $nameFilter, 'count', $sessionCategory); +$pagesCount = ceil($totalItems / $pageSize); +$pagination = BuyCoursesPlugin::returnPagination(api_get_self(), $currentPage, $pagesCount, $totalItems); + +// View +if (api_is_platform_admin()) { + $interbreadcrumb[] = [ + 'url' => 'subscriptions_sessions.php', + 'name' => $plugin->get_lang('AvailableCoursesConfiguration'), + ]; + $interbreadcrumb[] = [ + 'url' => 'paymentsetup.php', + 'name' => $plugin->get_lang('PaymentsConfiguration'), + ]; +} + +$templateName = $plugin->get_lang('CourseListOnSale'); + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$template = new Template($templateName); +$template->assign('search_filter_form', $form->returnForm()); +$template->assign('sessions_are_included', $includeSessions); +$template->assign('showing_sessions', true); +$template->assign('sessions', $sessionList); +$template->assign('pagination', $pagination); + +$courseList = $plugin->getCatalogSubscriptionCourseList($first, $pageSize, $nameFilter); +$coursesExist = true; +$sessionExist = true; +if (count($courseList) <= 0) { + $coursesExist = false; +} +$template->assign('coursesExist', $coursesExist); +$template->assign('sessionExist', $sessionExist); + +$content = $template->fetch('buycourses/view/subscription_catalog.tpl'); + +$template->assign('header', $templateName); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/buycourses/src/subscriptions_courses.php b/plugin/buycourses/src/subscriptions_courses.php new file mode 100644 index 000000000..1347e233e --- /dev/null +++ b/plugin/buycourses/src/subscriptions_courses.php @@ -0,0 +1,97 @@ +get('include_sessions') === 'true'; +$taxEnable = $plugin->get('tax_enable') === 'true'; + +api_protect_admin_script(true); + +Display::addFlash( + Display::return_message( + get_lang('Info').' - '.$plugin->get_lang('CoursesInSessionsDoesntDisplayHere'), + 'info' + ) +); + +$pageSize = BuyCoursesPlugin::PAGINATION_PAGE_SIZE; +$type = isset($_GET['type']) ? (int) $_GET['type'] : BuyCoursesPlugin::PRODUCT_TYPE_COURSE; +$currentPage = isset($_GET['page']) ? (int) $_GET['page'] : 1; +$first = $pageSize * ($currentPage - 1); + +$qb = $plugin->getCourseList($first, $pageSize); +$query = $qb->getQuery(); +$courses = new Paginator($query, $fetchJoinCollection = true); +foreach ($courses as $course) { + $item = $plugin->getSubscriptionItemByProduct($course->getId(), BuyCoursesPlugin::PRODUCT_TYPE_COURSE); + $course->buyCourseData = []; + if ($item !== false) { + $course->buyCourseData = $item; + } +} + +$totalItems = count($courses); +$pagesCount = ceil($totalItems / $pageSize); + +$pagination = BuyCoursesPlugin::returnPagination( + api_get_self(), + $currentPage, + $pagesCount, + $totalItems, + ['type' => $type] +); + +// breadcrumbs +$interbreadcrumb[] = [ + 'url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php', + 'name' => $plugin->get_lang('plugin_title'), +]; + +$templateName = $plugin->get_lang('AvailableCourses'); + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$tpl = new Template($templateName); + +$toolbar = Display::url( + Display::returnFontAwesomeIcon('fa-calendar-alt'). + $plugin->get_lang('ConfigureSubscriptionsFrequencies'), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/configure_frequency.php', + ['class' => 'btn btn-primary'] +); + +$tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); + +$tpl->assign('product_type_course', BuyCoursesPlugin::PRODUCT_TYPE_COURSE); +$tpl->assign('product_type_session', BuyCoursesPlugin::PRODUCT_TYPE_SESSION); +$tpl->assign('courses', $courses); +$tpl->assign('course_pagination', $pagination); +$tpl->assign('sessions_are_included', $includeSession); +$tpl->assign('tax_enable', $taxEnable); + +if ($taxEnable) { + $globalParameters = $plugin->getGlobalParameters(); + $tpl->assign('global_tax_perc', $globalParameters['global_tax_perc']); + $tpl->assign('tax_applies_to', $globalParameters['tax_applies_to']); + $tpl->assign('tax_name', $globalParameters['tax_name']); +} + +$content = $tpl->fetch('buycourses/view/subscriptions.tpl'); + +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/subscriptions_sessions.php b/plugin/buycourses/src/subscriptions_sessions.php new file mode 100644 index 000000000..a892d79e9 --- /dev/null +++ b/plugin/buycourses/src/subscriptions_sessions.php @@ -0,0 +1,101 @@ +get('include_sessions') === 'true'; + +if (!$includeSession) { + api_not_allowed(true); +} +$includeServices = $plugin->get('include_services') === 'true'; +$taxEnable = $plugin->get('tax_enable') === 'true'; + +api_protect_admin_script(true); + +Display::addFlash( + Display::return_message( + get_lang('Info').' - '.$plugin->get_lang('CoursesInSessionsDoesntDisplayHere'), + 'info' + ) +); + +$pageSize = BuyCoursesPlugin::PAGINATION_PAGE_SIZE; +$currentPage = isset($_GET['page']) ? (int) $_GET['page'] : 1; +$first = $pageSize * ($currentPage - 1); + +// breadcrumbs +$interbreadcrumb[] = [ + 'url' => api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php', + 'name' => $plugin->get_lang('plugin_title'), +]; + +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_PLUGIN_PATH).'buycourses/resources/css/style.css'); + +$templateName = $plugin->get_lang('AvailableCourses'); + +$tpl = new Template($templateName); + +$toolbar = Display::url( + Display::returnFontAwesomeIcon('fa-calendar-alt'). + $plugin->get_lang('ConfigureSubscriptionsFrequencies'), + api_get_path(WEB_PLUGIN_PATH).'buycourses/src/configure_frequency.php', + ['class' => 'btn btn-primary'] +); + +$tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$toolbar]) +); + +$tpl->assign('product_type_course', BuyCoursesPlugin::PRODUCT_TYPE_COURSE); +$tpl->assign('product_type_session', BuyCoursesPlugin::PRODUCT_TYPE_SESSION); +$tpl->assign('sessions_are_included', $includeSession); +$tpl->assign('services_are_included', $includeServices); +$tpl->assign('tax_enable', $taxEnable); + +$query = CoursesAndSessionsCatalog::browseSessions(null, ['start' => $first, 'length' => $pageSize], true); +$sessions = new Paginator($query, $fetchJoinCollection = true); +foreach ($sessions as $session) { + $item = $plugin->getSubscriptionItemByProduct($session->getId(), BuyCoursesPlugin::PRODUCT_TYPE_SESSION); + $session->buyCourseData = []; + if ($item !== false) { + $session->buyCourseData = $item; + } +} + +$totalItems = count($sessions); +$pagesCount = ceil($totalItems / $pageSize); + +$pagination = BuyCoursesPlugin::returnPagination( + api_get_self(), + $currentPage, + $pagesCount, + $totalItems, + ['type' => BuyCoursesPlugin::PRODUCT_TYPE_SESSION] +); + +$tpl->assign('sessions', $sessions); +$tpl->assign('session_pagination', $pagination); + +if ($taxEnable) { + $globalParameters = $plugin->getGlobalParameters(); + $tpl->assign('global_tax_perc', $globalParameters['global_tax_perc']); + $tpl->assign('tax_applies_to', $globalParameters['tax_applies_to']); + $tpl->assign('tax_name', $globalParameters['tax_name']); +} + +$content = $tpl->fetch('buycourses/view/subscriptions.tpl'); + +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/success.php b/plugin/buycourses/src/success.php new file mode 100644 index 000000000..2b2caffa4 --- /dev/null +++ b/plugin/buycourses/src/success.php @@ -0,0 +1,200 @@ +get('paypal_enable') === 'true'; + +if (!$paypalEnabled) { + api_not_allowed(true); +} + +$sale = $plugin->getSale($_SESSION['bc_sale_id']); + +if (empty($sale)) { + api_not_allowed(true); +} + +$buyingCourse = false; +$buyingSession = false; + +switch ($sale['product_type']) { + case BuyCoursesPlugin::PRODUCT_TYPE_COURSE: + $buyingCourse = true; + $course = $plugin->getCourseInfo($sale['product_id']); + break; + case BuyCoursesPlugin::PRODUCT_TYPE_SESSION: + $buyingSession = true; + $session = $plugin->getSessionInfo($sale['product_id']); + break; +} + +$paypalParams = $plugin->getPaypalParams(); +$pruebas = $paypalParams['sandbox'] == 1; +$paypalUsername = $paypalParams['username']; +$paypalPassword = $paypalParams['password']; +$paypalSignature = $paypalParams['signature']; + +require_once "paypalfunctions.php"; + +$form = new FormValidator( + 'success', + 'POST', + api_get_self(), + null, + null, + FormValidator::LAYOUT_INLINE +); +$form->addButton('confirm', $plugin->get_lang('ConfirmOrder'), 'check', 'success'); +$form->addButtonCancel($plugin->get_lang('CancelOrder'), 'cancel'); + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + if (isset($formValues['cancel'])) { + $plugin->cancelSale($sale['id']); + unset($_SESSION['bc_sale_id']); + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/index.php'); + exit; + } + + $confirmPayments = ConfirmPayment($sale['price']); + + if ($confirmPayments['ACK'] !== 'Success') { + $erroMessage = vsprintf( + $plugin->get_lang('ErrorOccurred'), + [$expressCheckout['L_ERRORCODE0'], $confirmPayments['L_LONGMESSAGE0']] + ); + Display::addFlash( + Display::return_message($erroMessage, 'error', false) + ); + header('Location: ../index.php'); + exit; + } + + $transactionId = $confirmPayments['PAYMENTINFO_0_TRANSACTIONID']; + $transactionType = $confirmPayments['PAYMENTINFO_0_TRANSACTIONTYPE']; + + switch ($confirmPayments['PAYMENTINFO_0_PAYMENTSTATUS']) { + case 'Completed': + $saleIsCompleted = $plugin->completeSale($sale['id']); + if ($saleIsCompleted) { + Display::addFlash( + $plugin->getSubscriptionSuccessMessage($sale) + ); + $plugin->storePayouts($sale['id']); + break; + } + + Display::addFlash( + Display::return_message($plugin->get_lang('ErrorContactPlatformAdmin'), 'error') + ); + break; + case 'Pending': + switch ($confirmPayments["PAYMENTINFO_0_PENDINGREASON"]) { + case 'address': + $purchaseStatus = $plugin->get_lang('PendingReasonByAddress'); + break; + case 'authorization': + $purchaseStatus = $plugin->get_lang('PendingReasonByAuthorization'); + break; + case 'echeck': + $purchaseStatus = $plugin->get_lang('PendingReasonByEcheck'); + break; + case 'intl': + $purchaseStatus = $plugin->get_lang('PendingReasonByIntl'); + break; + case 'multicurrency': + $purchaseStatus = $plugin->get_lang('PendingReasonByMulticurrency'); + break; + case 'order': + $purchaseStatus = $plugin->get_lang('PendingReasonByOrder'); + break; + case 'paymentreview': + $purchaseStatus = $plugin->get_lang('PendingReasonByPaymentReview'); + break; + case 'regulatoryreview': + $purchaseStatus = $plugin->get_lang('PendingReasonByRegulatoryReview'); + break; + case 'unilateral': + $purchaseStatus = $plugin->get_lang('PendingReasonByUnilateral'); + break; + case 'upgrade': + $purchaseStatus = $plugin->get_lang('PendingReasonByUpgrade'); + break; + case 'verify': + $purchaseStatus = $plugin->get_lang('PendingReasonByVerify'); + break; + case 'other': + default: + $purchaseStatus = $plugin->get_lang('PendingReasonByOther'); + break; + } + + Display::addFlash( + Display::return_message( + sprintf($plugin->get_lang('PurchaseStatusX'), $purchaseStatus), + 'warning', + false + ) + ); + break; + default: + Display::addFlash( + Display::return_message($plugin->get_lang('ErrorContactPlatformAdmin'), 'error') + ); + break; + } + + unset($_SESSION['bc_sale_id']); + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/course_catalog.php'); + exit; +} + +$token = isset($_GET['token']) ? $_GET['token'] : null; + +if (empty($token)) { + api_not_allowed(true); +} + +$shippingDetails = GetShippingDetails($token); + +if ($shippingDetails['ACK'] !== 'Success') { + $erroMessage = vsprintf( + $plugin->get_lang('ErrorOccurred'), + [$expressCheckout['L_ERRORCODE0'], $shippingDetails['L_LONGMESSAGE0']] + ); + Display::addFlash( + Display::return_message($erroMessage, 'error', false) + ); + header('Location: ../index.php'); + exit; +} + +$interbreadcrumb[] = ["url" => "course_catalog.php", "name" => $plugin->get_lang('CourseListOnSale')]; + +$templateName = $plugin->get_lang('PaymentMethods'); +$tpl = new Template($templateName); + +if ($buyingCourse) { + $tpl->assign('course', $course); +} elseif ($buyingSession) { + $tpl->assign('session', $session); +} + +$tpl->assign('buying_course', $buyingCourse); +$tpl->assign('buying_session', $buyingSession); +$tpl->assign('title', $sale['product_name']); +$tpl->assign('price', $sale['price']); +$tpl->assign('currency', $sale['currency_id']); +$tpl->assign('user', api_get_user_info($sale['user_id'])); +$tpl->assign('form', $form->returnForm()); + +$content = $tpl->fetch('buycourses/view/success.tpl'); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/buycourses/src/tpv_error.php b/plugin/buycourses/src/tpv_error.php new file mode 100644 index 000000000..51680ceca --- /dev/null +++ b/plugin/buycourses/src/tpv_error.php @@ -0,0 +1,30 @@ +get('tpv_redsys_enable') === 'true'; + +if (!$tpvRedsysEnabled) { + api_not_allowed(true); +} + +$sale = $plugin->getSale($_SESSION['bc_sale_id']); + +if (empty($sale)) { + api_not_allowed(true); +} + +Display::addFlash( + Display::return_message($plugin->get_lang('ErrorContactPlatformAdmin'), 'error') +); + +unset($_SESSION['bc_sale_id']); +header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/course_catalog.php'); +exit; diff --git a/plugin/buycourses/src/tpv_response.php b/plugin/buycourses/src/tpv_response.php new file mode 100644 index 000000000..1498390d9 --- /dev/null +++ b/plugin/buycourses/src/tpv_response.php @@ -0,0 +1,68 @@ +get('tpv_redsys_enable') === 'true'; + +if (!$tpvRedsysEnabled) { + api_not_allowed(true); +} + +$tpvRedsysParams = $plugin->getTpvRedsysParams(); + +$version = $_POST['Ds_SignatureVersion']; +$params = $_POST["Ds_MerchantParameters"]; +$signatureReceived = $_POST['Ds_Signature']; + +require_once '../resources/apiRedsys.php'; +$tpv = new RedsysAPI(); + +$decodec = $tpv->decodeMerchantParameters($params); +$kc = $tpvRedsysParams['kc']; +$signature = $tpv->createMerchantSignatureNotif($kc, $params); + +if ($signature === $signatureReceived) { + $saleId = (int) $tpv->getParameter("Ds_Order"); + $response = $tpv->getParameter("Ds_Response"); + + // other fields available + // $Ds_Amount=$miObj->getParameter("Ds_Amount"); + // $Ds_MerchantCode=$miObj->getParameter("Ds_MerchantCode"); + // $Ds_TransactionType=$miObj->getParameter("Ds_TransactionType"); + // $Ds_MerchantData=$miObj->getParameter("Ds_MerchantData"); + // $Ds_Date=$miObj->getParameter("Ds_Date"); + // $Ds_Hour=$miObj->getParameter("Ds_Hour"); + + $sale = $plugin->getSale($saleId); + if (empty($sale)) { + api_not_allowed(true); + } + + $buyingCourse = false; + $buyingSession = false; + + switch ($sale['product_type']) { + case BuyCoursesPlugin::PRODUCT_TYPE_COURSE: + $buyingCourse = true; + $course = $plugin->getCourseInfo($sale['product_id']); + break; + case BuyCoursesPlugin::PRODUCT_TYPE_SESSION: + $buyingSession = true; + $session = $plugin->getSessionInfo($sale['product_id']); + break; + } + + if ($response == "0000") { + $saleIsCompleted = $plugin->completeSale($sale['id']); + if ($saleIsCompleted) { + $plugin->storePayouts($sale['id']); + } + } +} diff --git a/plugin/buycourses/src/tpv_success.php b/plugin/buycourses/src/tpv_success.php new file mode 100644 index 000000000..cf9683ea2 --- /dev/null +++ b/plugin/buycourses/src/tpv_success.php @@ -0,0 +1,31 @@ +get('tpv_redsys_enable') === 'true'; + +if (!$tpvRedsysEnabled) { + api_not_allowed(true); +} + +$sale = $plugin->getSale($_SESSION['bc_sale_id']); + +if (empty($sale)) { + api_not_allowed(true); +} + +Display::addFlash( + $plugin->getSubscriptionSuccessMessage($sale) +); +//$plugin->storePayouts($sale['id']); + +unset($_SESSION['bc_sale_id']); +header('Location: '.api_get_path(WEB_PLUGIN_PATH).'buycourses/src/course_catalog.php'); +exit; diff --git a/plugin/buycourses/uninstall.php b/plugin/buycourses/uninstall.php new file mode 100644 index 000000000..f1804e34d --- /dev/null +++ b/plugin/buycourses/uninstall.php @@ -0,0 +1,15 @@ +uninstall(); diff --git a/plugin/buycourses/update.php b/plugin/buycourses/update.php new file mode 100644 index 000000000..2b204456f --- /dev/null +++ b/plugin/buycourses/update.php @@ -0,0 +1,14 @@ +update(); diff --git a/plugin/buycourses/uploads/services/images/.gitignore b/plugin/buycourses/uploads/services/images/.gitignore new file mode 100644 index 000000000..cec9082b6 --- /dev/null +++ b/plugin/buycourses/uploads/services/images/.gitignore @@ -0,0 +1,3 @@ +* + +!.gitignore diff --git a/plugin/buycourses/view/catalog.tpl b/plugin/buycourses/view/catalog.tpl new file mode 100644 index 000000000..f6bbc8902 --- /dev/null +++ b/plugin/buycourses/view/catalog.tpl @@ -0,0 +1,223 @@ +
+ {% if sessions_are_included %} + + {% endif %} + +
+
+
+
+ {{ search_filter_form }} +
+
+
+ {% if showing_courses %} + {% for course in courses %} +
+
+
+
+ {{ course.title }} +
+
+
+ {% set course_description_url = _p.web_ajax ~ 'course_home.ajax.php?' ~ {'code': course.code, 'a': 'show_course_information'}|url_encode() %} +

+ {{ course.title }} +

+
    + {% for teacher in course.teachers %} +
  • {{ teacher }}
    • + {% endfor %} +
+

+ + {{ course.item.total_price_formatted }} + +

+ {% if course.enrolled == "YES" %} +
+ {{ 'TheUserIsAlreadyRegisteredInTheCourse'|get_plugin_lang('BuyCoursesPlugin') }} +
+ {% elseif course.enrolled == "NO" %} +
+ + {{ 'SeeDescription'|get_plugin_lang('BuyCoursesPlugin') }} + + + {{ 'Buy'|get_plugin_lang('BuyCoursesPlugin') }} + +
+ {% elseif course.enrolled == "TMP" %} +
{{ 'WaitingToReceiveThePayment'|get_plugin_lang('BuyCoursesPlugin') }}
+ {% endif %} +
+
+
+ {% endfor %} + {% endif %} + + {% if showing_sessions %} + {% for session in sessions %} +
+
+
+
+ {{ session.name }} +
+
+
+

+ {{ session.name }} +

+ {% if 'show_session_coach'|api_get_setting == 'true' %} +

{{ session.coach }}

+ {% endif %} +

+ + {% if session.duration %} + {{ 'SessionDurationXDaysTotal'|get_lang|format(session.duration) }} + {% else %} + {{ session.dates.display }} + {% endif %} +

+

+ + {{ session.item.total_price_formatted }} + +

+ + {% if session.enrolled == "YES" %} +
+ {{ 'TheUserIsAlreadyRegisteredInTheSession'|get_plugin_lang('BuyCoursesPlugin') }} +
+ {% elseif session.enrolled == "NO" %} +
+ + {{ 'Buy'|get_plugin_lang('BuyCoursesPlugin') }} + +
+ {% elseif session.enrolled == "TMP" %} +
{{ 'WaitingToReceiveThePayment'|get_plugin_lang('BuyCoursesPlugin') }}
+ {% endif %} +
+
+
+ {% endfor %} + {% endif %} + + {% if showing_services %} + {% for service in services %} +
+
+
+ +
+ {{ service.name }} +
+ +
+
+

+ + {{ service.name }} + +

+
    +
  • + {{ 'Duration'|get_plugin_lang('BuyCoursesPlugin') }} + : {{ service.duration_days == 0 ? 'NoLimit'|get_lang : service.duration_days ~ ' ' ~ 'Days'|get_lang }} +
    • + {% if service.applies_to == 0 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'None'|get_lang }} +
    • + {% elseif service.applies_to == 1 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'User'|get_lang }} +
    • + {% elseif service.applies_to == 2 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'Course'|get_lang }} +
    • + {% elseif service.applies_to == 3 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'Session'|get_lang }} +
    • + {% elseif service.applies_to == 4 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'TemplateTitleCertificate'|get_plugin_lang('BuyCoursesPlugin') }} +
    • + {% endif %} +
  • {{ service.owner_name }}
    • +
+

+ + {{ service.total_price_formatted }} + +

+
+ + {{ 'ServiceInformation'|get_plugin_lang('BuyCoursesPlugin') }} + + + {{ 'Buy'|get_plugin_lang('BuyCoursesPlugin') }} + +
+
+
+
+ {% endfor %} + {% endif %} +
+ {{ pagination }} +
+
+
+
+
diff --git a/plugin/buycourses/view/configure_frequency.tpl b/plugin/buycourses/view/configure_frequency.tpl new file mode 100644 index 000000000..7abce503f --- /dev/null +++ b/plugin/buycourses/view/configure_frequency.tpl @@ -0,0 +1,32 @@ +
+
+ {{ items_form }} +
+
+
+ + + + + + + + + + {% for frequency in frequencies_list %} + + + + + + {% endfor %} + +
{{ 'Name'|get_lang }}{{ 'SubscriptionPeriodDuration'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Options'|get_lang }}
{{ frequency.name }}{{ frequency.duration }} +
+ + + +
+
+
\ No newline at end of file diff --git a/plugin/buycourses/view/configure_subscription.tpl b/plugin/buycourses/view/configure_subscription.tpl new file mode 100644 index 000000000..556f63e3d --- /dev/null +++ b/plugin/buycourses/view/configure_subscription.tpl @@ -0,0 +1,45 @@ +
+
+ {{ items_form }} +
+
+
+
+

{{ 'FrequencyConfig'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+ {{ frequency_form }} +
+
+
+ + + + + + + + + + {% for subscription in subscriptions %} + + + + + + {% endfor %} + +
{{ 'Duration'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Actions'|get_lang }}
{{ subscription.durationName }}{{ subscription.price }} {{ currencyIso }} + + + +
+
+
+
+
+
+ diff --git a/plugin/buycourses/view/coupons.tpl b/plugin/buycourses/view/coupons.tpl new file mode 100644 index 000000000..6280b9de7 --- /dev/null +++ b/plugin/buycourses/view/coupons.tpl @@ -0,0 +1,39 @@ +
+
+{{ form }} + +
+ + + + + + + + + + + + + + {% for coupon in coupon_list %} + + + + + + + + + + {% endfor %} + +
{{ 'CouponCode'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDiscountType'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDiscount'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDateStart'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDateEnd'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDelivered'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Options'|get_lang }}
{{ coupon.code }}{{ coupon.discount_type }}{{ coupon.discount_value }}{{ coupon.valid_start | api_get_local_time }}{{ coupon.valid_end | api_get_local_time }}{{ coupon.delivered }} +
+ + + +
+
+
\ No newline at end of file diff --git a/plugin/buycourses/view/course_panel.tpl b/plugin/buycourses/view/course_panel.tpl new file mode 100644 index 000000000..e142ae6b6 --- /dev/null +++ b/plugin/buycourses/view/course_panel.tpl @@ -0,0 +1,48 @@ +
+ + + + + + + + + + + + + + + {% for sale in sale_list %} + + + + + + + + {% endfor %} + +
{{ 'Course'|get_lang }}{{ 'PaymentMethod'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderDate'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderReference'|get_plugin_lang('BuyCoursesPlugin') }}
{{ sale.product_name }}{{ sale.payment_type }}{{ sale.currency ~ ' ' ~ sale.price }}{{ sale.date }}{{ sale.reference }}
+ + +
diff --git a/plugin/buycourses/view/export_report.tpl b/plugin/buycourses/view/export_report.tpl new file mode 100644 index 000000000..f9a859ae9 --- /dev/null +++ b/plugin/buycourses/view/export_report.tpl @@ -0,0 +1 @@ +{{ form }} diff --git a/plugin/buycourses/view/index.tpl b/plugin/buycourses/view/index.tpl new file mode 100644 index 000000000..969e9483d --- /dev/null +++ b/plugin/buycourses/view/index.tpl @@ -0,0 +1,117 @@ +{% if _u.is_admin %} +
+
+
+

{{ 'TitlePlugin'|get_plugin_lang('BuyCoursesPlugin') }}

+

{{ 'PluginPresentation'|get_plugin_lang('BuyCoursesPlugin') }}

+
    +
  • + {{ 'Instructions'|get_plugin_lang('BuyCoursesPlugin') }} +
      +
    • {{ 'InstructionsStepOne'|get_plugin_lang('BuyCoursesPlugin') }}
      • +
    • {{ 'InstructionsStepTwo'|get_plugin_lang('BuyCoursesPlugin') }}
      • +
    • {{ 'InstructionsStepThree'|get_plugin_lang('BuyCoursesPlugin') }}
      • +
    +
    • +
+
+
+
+{% endif %} + +
+
+
+ + + +
+

+ {{ 'BuyCourses'|get_plugin_lang('BuyCoursesPlugin') }} +

+
+
+
+
+
+ + + +
+

+ {{ 'BuySubscriptions'|get_plugin_lang('BuyCoursesPlugin') }} +

+
+
+
+ + {% if _u.is_admin %} +
+
+ + + +
+

+ {{ 'ConfigurationOfCoursesAndPrices'|get_plugin_lang('BuyCoursesPlugin') }} +

+
+
+
+
+
+ + + +
+

+ {{ 'ConfigurationOfSubscriptionsAndPrices'|get_plugin_lang('BuyCoursesPlugin') }} +

+
+
+
+
+
+ + + +
+

+ {{ 'CouponsConfiguration'|get_plugin_lang('BuyCoursesPlugin') }} +

+
+
+
+
+
+ + + +
+

+ {{ 'PaymentsConfiguration'|get_plugin_lang('BuyCoursesPlugin') }} +

+
+
+
+
+
+ + + +
+

+ {{ 'SalesReport'|get_plugin_lang('BuyCoursesPlugin') }} +

+
+
+
+ {% endif %} +
diff --git a/plugin/buycourses/view/list.tpl b/plugin/buycourses/view/list.tpl new file mode 100644 index 000000000..b6c3fde7f --- /dev/null +++ b/plugin/buycourses/view/list.tpl @@ -0,0 +1,231 @@ +{% if sessions_are_included or services_are_included %} + +{% endif %} + +
+
+
+ + + + + + + + {% if tax_enable and (tax_applies_to == 1 or tax_applies_to == 2) %} + + {% endif %} + + + + + {% for item in courses %} + + + + + + {% if tax_enable and (tax_applies_to == 1 or tax_applies_to == 2) %} + + {% endif %} + + + {% endfor %} + +
{{ 'Title'|get_lang }}{{ 'OfficialCode'|get_lang }}{{ 'VisibleInCatalog'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }}{{ tax_name }}{{ 'Options'|get_lang }}
+ {% if item.visibility == 0 %} + {{ 'CourseVisibilityClosed'|get_lang }} + {% elseif item.visibility == 1 %} + {{ 'Private'|get_lang }} + {% elseif item.visibility == 2 %} + {{ 'OpenToThePlatform'|get_lang }} + {% elseif item.visibility == 3 %} + {{ 'OpenToTheWorld'|get_lang }} + {% elseif item.visibility == 4 %} + {{ 'CourseVisibilityHidden'|get_lang }} + {% endif %} + + {{ item.title }} + + {{ item.code }} + + {{ item.code }} + + {% if item.buyCourseData %} + + {% else %} + + {% endif %} + + {{ item.buyCourseData.price_formatted }} + + {{ item.buyCourseData.tax_perc_show }} % + + + {{ 'Configure'|get_lang }} + +
+
+ {{ course_pagination }} +
+ + {% if sessions_are_included %} +
+
+ + + + + + + + + {% if tax_enable and (tax_applies_to == 1 or tax_applies_to == 3) %} + + {% endif %} + + + + + {% for item in sessions %} + + + + + + + {% if tax_enable and (tax_applies_to == 1 or tax_applies_to == 3) %} + + {% endif %} + + + {% endfor %} + +
{{ 'Title'|get_lang }}{{ 'StartDate'|get_lang }}{{ 'EndDate'|get_lang }}{{ 'VisibleInCatalog'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }}{{ tax_name }}{{ 'Options'|get_lang }}
+ {{ item.name }} + + {{ item.displayStartDate | api_convert_and_format_date(6)}} + + {{ item.displayEndDate |api_convert_and_format_date(6)}} + + {% if item.buyCourseData %} + + {% else %} + + {% endif %} + + {{ item.buyCourseData.price_formatted }} + + {{ item.buyCourseData.tax_perc_show }} % + + + + {{ 'Configure'|get_lang }} + +
+ {{ session_pagination }} +
+
+ {% endif %} + {% if services_are_included %} + + {{ 'NewService'| get_plugin_lang('BuyCoursesPlugin') }} + +
+
+
+
+ + + + + + + + + + {% if tax_enable and (tax_applies_to == 1 or tax_applies_to == 4) %} + + {% endif %} + + + + + {% for item in services %} + + + + + + + + {% if tax_enable and (tax_applies_to == 1 or tax_applies_to == 4) %} + + {% endif %} + + + {% endfor %} + +
{{ 'Service'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Description'|get_lang }}{{ 'Duration'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'VisibleInCatalog'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Owner'|get_lang }}{{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }}{{ tax_name }}{{ 'Options'|get_lang }}
+ {{ item.name }} + + {{ item.description }} + + {% if item.duration_days == 0 %} + {{ 'NoLimit'|get_lang }} + {% else %} + {{ item.duration_days }} {{ 'Days'|get_lang }} + {% endif %} + + {% if item.visibility == 1 %} + + {% else %} + + {% endif %} + + {{ item.owner_name }} + + {{ item.price_formatted }} + + {% if item.tax_perc is null %} + {{ global_tax_perc }} % + {% else %} + {{ item.tax_perc }} % + {% endif %} + + + {{ 'Edit'|get_lang }} + +
+
+ {{ service_pagination }} +
+ {% endif %} +
diff --git a/plugin/buycourses/view/list_coupon.tpl b/plugin/buycourses/view/list_coupon.tpl new file mode 100644 index 000000000..447c56731 --- /dev/null +++ b/plugin/buycourses/view/list_coupon.tpl @@ -0,0 +1,49 @@ +
+
+{{ form }} + +
+ + + + + + + + + + + + + + {% for coupon in coupon_list %} + + + + + + + + + + {% endfor %} + +
{{ 'CouponCode'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDiscountType'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDiscount'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDateStart'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDateEnd'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDelivered'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Options'|get_lang }}
{{ coupon.code }}{{ coupon.discount_type }}{{ coupon.discount_value }}{{ coupon.valid_start | api_get_local_time }}{{ coupon.valid_end | api_get_local_time }}{{ coupon.delivered }} + {% if coupon.active == coupon_status_active %} +
+ + + +
+ {% endif %} + {% if coupon.active == coupon_status_disable %} +
+ + + +
+ {% endif %} +
+
\ No newline at end of file diff --git a/plugin/buycourses/view/list_subscription.tpl b/plugin/buycourses/view/list_subscription.tpl new file mode 100644 index 000000000..e69de29bb diff --git a/plugin/buycourses/view/message_confirm.tpl b/plugin/buycourses/view/message_confirm.tpl new file mode 100644 index 000000000..7f10c4a73 --- /dev/null +++ b/plugin/buycourses/view/message_confirm.tpl @@ -0,0 +1,14 @@ +
+
+
{{ 'OrderDate'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.date|api_convert_and_format_date(constant('DATE_TIME_FORMAT_LONG_24H')) }}
+
{{ 'OrderReference'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.reference }}
+
{{ 'UserName'|get_lang }}
+
{{ user.complete_name }}
+
{{ 'Product'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.product }}
+
{{ 'SalePrice'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.currency ~ ' ' ~ sale.price }}
+
+
diff --git a/plugin/buycourses/view/message_confirm_buyer.tpl b/plugin/buycourses/view/message_confirm_buyer.tpl new file mode 100644 index 000000000..ec386c39a --- /dev/null +++ b/plugin/buycourses/view/message_confirm_buyer.tpl @@ -0,0 +1,16 @@ +

{{ 'Dear'|get_lang }} {{ user.complete_name }},

+

{{ 'bc_subject'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
{{ 'OrderDate'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.date|api_convert_and_format_date(constant('DATE_TIME_FORMAT_LONG_24H')) }}
+
{{ 'OrderReference'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.reference }}
+
{{ 'Product'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.product }}
+
{{ 'SalePrice'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.currency ~ ' ' ~ sale.price }}
+
+
+ +

{{ 'SignatureFormula'|get_lang }}

diff --git a/plugin/buycourses/view/message_transfer.tpl b/plugin/buycourses/view/message_transfer.tpl new file mode 100644 index 000000000..4d18ab1e1 --- /dev/null +++ b/plugin/buycourses/view/message_transfer.tpl @@ -0,0 +1,37 @@ +
+

{{ 'DearUser'|get_lang }}

+

{{ 'PurchaseDetailsIntro'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
{{ 'OrderDate'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.date|api_convert_and_format_date(constant('DATE_TIME_FORMAT_LONG_24H')) }}
+
{{ 'OrderReference'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.reference }}
+
{{ 'UserName'|get_lang }}
+
{{ user.complete_name }}
+
{{ 'ProductName'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.product }}
+
{{ 'SalePrice'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ sale.currency ~ ' ' ~ sale.price }}
+
+

{{ 'BankAccountIntro'|get_plugin_lang('BuyCoursesPlugin')|format(sale.product) }}

+ + + + + + + + + + {% for account in transfer_accounts %} + + + + + + {% endfor %} + +
{{ 'Name'|get_lang }}{{ 'BankAccount'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'SWIFT'|get_plugin_lang('BuyCoursesPlugin') }}
{{ account.name }}{{ account.account }}{{ account.swift }}
+

{{ info_email_extra }}

+

{{ 'PurchaseDetailsEnd'|get_plugin_lang('BuyCoursesPlugin') }}

+
diff --git a/plugin/buycourses/view/paymentsetup.tpl b/plugin/buycourses/view/paymentsetup.tpl new file mode 100644 index 000000000..cdb5920f9 --- /dev/null +++ b/plugin/buycourses/view/paymentsetup.tpl @@ -0,0 +1,171 @@ +
+
+

{{ 'GlobalConfig'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+ {{ global_config_form }} +
+
+
+
+ +

+ {{ 'PluginInstruction'|get_plugin_lang('BuyCoursesPlugin') }} + {{ 'ClickHere'|get_plugin_lang('BuyCoursesPlugin') }} +

+ +{% if paypal_enable == "true" %} +
+
+

{{ 'PayPalConfig'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+

{{ 'InfoApiCredentials'|get_plugin_lang('BuyCoursesPlugin') }}

+
    +
  • {{ 'InfoApiStepOne'|get_plugin_lang('BuyCoursesPlugin') }}
    • +
  • {{ 'InfoApiStepTwo'|get_plugin_lang('BuyCoursesPlugin') }}
    • +
  • {{ 'InfoApiStepThree'|get_plugin_lang('BuyCoursesPlugin') }}
    • +
+
+
+ {{ paypal_form }} +
+
+
+
+{% endif %} + +{% if tpv_redsys_enable == "true" %} +
+
+

{{ 'TpvRedsysConfig'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+ {{ tpv_redsys_form }} +
+
+
+
+{% endif %} + +{% if commissions_enable == "true" %} +
+
+

{{ 'CommissionsConfig'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+

{{ 'InfoCommissions'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+ {{ commission_form }} +
+
+
+
+{% endif %} + +{% if transfer_enable == "true" %} +
+
+

{{ 'TransfersConfig'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+ {{ transfer_form }} +
+
+
+ + + + + + + + + + + {% for account in transfer_accounts %} + + + + + + + {% endfor %} + +
{{ 'Name'|get_lang }}{{ 'BankAccount'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'SWIFT'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Actions'|get_lang }}
{{ account.name }}{{ account.account }}{{ account.swift }} + + {{ 'Delete'|get_lang }} + +
+
+
+
+ {{ transfer_info_form }} +
+
+
+
+{% endif %} + +{% if culqi_enable == "true" %} +
+
+

{{ 'CulqiConfig'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+

{{ 'InfoCulqiCredentials'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+ {{ culqi_form }} +
+
+
+
+{% endif %} + +{% if stripe_enable == "true" %} +
+
+

{{ 'StripeConfig'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+

{{ 'InfoStripeCredentials'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+ {{ stripe_form }} +
+
+
+
+{% endif %} + +{% if cecabank_enable == "true" %} +
+
+

{{ 'CecabankConfig'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+ {{ cecabank_form }} +
+
+
+
+{% endif %} diff --git a/plugin/buycourses/view/payout_panel.tpl b/plugin/buycourses/view/payout_panel.tpl new file mode 100644 index 000000000..01c5a4033 --- /dev/null +++ b/plugin/buycourses/view/payout_panel.tpl @@ -0,0 +1,50 @@ +
+ + + {% if not payout_list %} +

+ {{ 'WantToSellCourses'|get_plugin_lang('BuyCoursesPlugin') }} + {{ 'ClickHere'|get_plugin_lang('BuyCoursesPlugin') }} +

+ {% endif %} + + {% if payout_list %} + + + + + + + + + + + {% for payout in payout_list %} + + + + + + + {% endfor %} + +
{{ 'OrderReference'| get_plugin_lang('BuyCoursesPlugin') }}{{ 'PayoutDate'| get_plugin_lang('BuyCoursesPlugin') }}{{ 'Commission'| get_plugin_lang('BuyCoursesPlugin') }}{{ 'PayPalAccount'| get_plugin_lang('BuyCoursesPlugin') }}
{{ payout.reference }}{{ payout.payout_date }}{{ payout.currency ~ ' ' ~ payout.commission }}{{ payout.paypal_account }}
+ {% endif %} + +
diff --git a/plugin/buycourses/view/payout_report.tpl b/plugin/buycourses/view/payout_report.tpl new file mode 100644 index 000000000..118169399 --- /dev/null +++ b/plugin/buycourses/view/payout_report.tpl @@ -0,0 +1,99 @@ +{{ form }} +
+ + + + + + + + + + + + {% for payout in payout_list %} + + + + + + {% if payout.paypal_account %} + + {% else %} + + {% endif %} + + {% endfor %} + +
{{ 'OrderReference'| get_plugin_lang('BuyCoursesPlugin') }}{{ 'PayoutDate'| get_plugin_lang('BuyCoursesPlugin') }}{{ 'Commission'| get_plugin_lang('BuyCoursesPlugin') }}{{ 'Names'| get_lang }}{{ 'PayPalAccount'| get_plugin_lang('BuyCoursesPlugin') }}
{{ payout.reference }}{{ payout.payout_date }}{{ payout.currency ~ ' ' ~ payout.commission }}{{ payout.beneficiary }}{{ payout.paypal_account }}{{ 'NoPayPalAccountDetected'| get_plugin_lang('BuyCoursesPlugin') }}
+ + + +
+ +
+ +
+ + diff --git a/plugin/buycourses/view/paypal_payout.tpl b/plugin/buycourses/view/paypal_payout.tpl new file mode 100644 index 000000000..16fd803b2 --- /dev/null +++ b/plugin/buycourses/view/paypal_payout.tpl @@ -0,0 +1,131 @@ +
+ + + + + + + + + + + + + {% for payout in payout_list %} + + + + + + {% if payout.paypal_account %} + + {% else %} + + {% endif %} + + + {% endfor %} + +
{{ 'OrderReference'| get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderDate'| get_plugin_lang('BuyCoursesPlugin') }}{{ 'Commission'| get_plugin_lang('BuyCoursesPlugin') }}{{ 'PayPalAccount'| get_plugin_lang('BuyCoursesPlugin') }}{{ 'Options'| get_lang }}
{% if payout.paypal_account %} {% endif %}{{ payout.reference }}{{ payout.date }}{{ payout.currency ~ ' ' ~ payout.commission }}{{ payout.paypal_account }}{{ 'NoPayPalAccountDetected'| get_plugin_lang('BuyCoursesPlugin') }} + +
+ + +
+
+ +
+ + \ No newline at end of file diff --git a/plugin/buycourses/view/process.tpl b/plugin/buycourses/view/process.tpl new file mode 100644 index 000000000..862ce8d19 --- /dev/null +++ b/plugin/buycourses/view/process.tpl @@ -0,0 +1,167 @@ +
+ {% if item_type == 1 %} + {% set back_url = _p.web_plugin ~ 'buycourses/src/course_catalog.php' %} + {% elseif item_type == 2 %} + {% set back_url = _p.web_plugin ~ 'buycourses/src/session_catalog.php' %} + {% else %} + {% set back_url = _p.web_plugin ~ 'buycourses/src/service_catalog.php' %} + {% endif %} + + + {{ + +
+
+

{{ 'PurchaseData'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+
+
+ {% if buying_course %} +
+
+ + {{ course.title }} + + {% if course.tax_enable %} +
+ {{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }} : + {{ course.item.price_formatted }} +
+ {{ course.tax_name }} ({{ course.item.tax_perc_show }}%): + {{ course.item.tax_amount_formatted }} +
+ {% endif %} +
+ {{ 'Total'|get_plugin_lang('BuyCoursesPlugin') }} : + {{ course.item.total_price_formatted }} +
+ {% if course.item.has_coupon %} +
+ {{ 'DiscountAmount'|get_plugin_lang('BuyCoursesPlugin') }}: + {{ course.item.discount_amount_formatted }} +
+ {% endif %} +
+ {{ 'DoYouHaveACoupon'|get_plugin_lang('BuyCoursesPlugin') }} +
+
+ {{ form_coupon }} +
+
+
+
+

+ + {{ course.title }} + +

+ {% if course.description %} +
+ {{ course.description }} +
+ {% endif %} + + {% if course.teachers %} +
+

+ {{ 'Teachers'|get_plugin_lang('BuyCoursesPlugin') }} : + {% for teacher in course.teachers %} + + {{ teacher.name }}, + {% endfor %} +

+
+ {% endif %} +
+
+
+ {% elseif buying_session %} +
+
+ {{ session.name }} + {% if session.tax_enable %} +
+ {{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }} : + {{ session.item.price_formatted }} +
+ {{ session.tax_name }} ({{ session.item.tax_perc_show }}%): + {{ session.item.tax_amount_formatted }} +
+ {% endif %} +
+ {{ 'Total'|get_plugin_lang('BuyCoursesPlugin') }} : + {{ session.item.total_price_formatted }} +
+ {% if session.item.has_coupon %} +
+ {{ 'DiscountAmount'|get_plugin_lang('BuyCoursesPlugin') }}: + {{ session.item.discount_amount_formatted }} +
+ {% endif %} +
+ {{ 'DoYouHaveACoupon'|get_plugin_lang('BuyCoursesPlugin') }} +
+
+ {{ form_coupon }} +
+
+
+
+

{{ session.name }}

+ {% if session.description %} +
+ {{ session.description }} +
+ {% endif %} +
+ {{ session.dates.display }} +
+
+
+ {% for course in session.courses %} +

+ {{ course.title }} +

+ {% if course.coaches|length %} +

+ {{ 'Teachers'|get_plugin_lang('BuyCoursesPlugin') }} : + + {% for coach in course.coaches %} + + {{ coach.name }}, + {% endfor %} +

+ {% endif %} + {% endfor %} +
+
+
+
+ {% endif %} +
+
+

{{ 'PaymentMethods'|get_plugin_lang('BuyCoursesPlugin') }}

+ {{ form }} +
+
+
+
+
+ diff --git a/plugin/buycourses/view/process_confirm.tpl b/plugin/buycourses/view/process_confirm.tpl new file mode 100644 index 000000000..d37208c17 --- /dev/null +++ b/plugin/buycourses/view/process_confirm.tpl @@ -0,0 +1,283 @@ +
+
+
+
+
+

{{ 'PurchaseData'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+ {% if buying_course %} +
+
+ + {{ course.title }} + +
+
+

+ {{ course.title }} +

+
    + {% for teacher in course.teachers %} +
  • {{ teacher.name }}
    • + {% endfor %} +
+

+ + {{ course.item.total_price_formatted }} + +

+

+
+
+ {% elseif buying_session %} +
+
+

+ {{ session.name }} +

+
+
+

{{ session.name }}

+

{{ session.dates.display }}

+
    + {% for course in session.courses %} +
  • + {{ course.title }} + {% if course.coaches|length %} +
      + {% for coach in course.coaches %} +
    • {{ coach.name }}
      • + {% endfor %} +
    + {% endif %} +
    • + {% endfor %} +
+

+ + {{ session.item.total_price_formatted }} + +

+

+
+
+ {% elseif buying_service %} +
+
+ + {{ service.name }} + +
+
+
+
+

+ {{ service.name }} +

+
    + {% if service.applies_to == 0 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'None'|get_lang }} +
    • + {% elseif service.applies_to == 1 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'User'|get_lang }} +
    • + {% elseif service.applies_to == 2 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'Course'|get_lang }} +
    • + {% elseif service.applies_to == 3 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'Session'|get_lang }} +
    • + {% elseif service.applies_to == 4 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'TemplateTitleCertificate'|get_lang }} +
    • + {% endif %} +
  • + + {{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }} + : {{ service_item.total_price_formatted }} + / {{ service.duration_days == 0 ? 'NoLimit'|get_lang : service.duration_days ~ ' ' ~ 'Days'|get_lang }} +
    • +
  • {{ service.owner.name }}
    • + {% if service.description %} +
  • {{ service.description }}
    • + {% endif %} +
+

+ + {{ service_item.total_price_formatted }} + +

+

+
+
+ {% endif %} +
+
+
+ {% if terms %} +
+
+
+

{{ 'TermsAndConditions'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+ +
+
+ +
+
+
+
+
+ {% endif %} +
+ +{% if is_bank_transfer %} +
+
+

{{ 'BankAccountInformation'|get_plugin_lang('BuyCoursesPlugin') }}

+
+ + + + + + + + + + {% for account in transfer_accounts %} + + + + + + {% endfor %} + +
{{ 'Name'|get_lang }}{{ 'BankAccount'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'SWIFT'|get_plugin_lang('BuyCoursesPlugin') }}
{{ account.name }}{{ account.account }}{{ account.swift }}
+
+

{{ 'OnceItIsConfirmedYouWillReceiveAnEmailWithTheBankInformationAndAnOrderReference'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+{% endif %} + +
+
+ {{ form }} +
+
+ diff --git a/plugin/buycourses/view/sales_report.tpl b/plugin/buycourses/view/sales_report.tpl new file mode 100644 index 000000000..c7c7f4199 --- /dev/null +++ b/plugin/buycourses/view/sales_report.tpl @@ -0,0 +1,55 @@ + +
+
+{{ form }} + +
+ +
+
+
+ + diff --git a/plugin/buycourses/view/service_information.tpl b/plugin/buycourses/view/service_information.tpl new file mode 100644 index 000000000..24a8ad6e6 --- /dev/null +++ b/plugin/buycourses/view/service_information.tpl @@ -0,0 +1,108 @@ +
+
+

{{ service.name }}

+
+
+
+
+
+
+
+ {% if service.video_url %} +
+
+ {{ essence.replace(service.video_url) }} +
+
+ {% elseif service.image %} +
+ + {{ service.name }} + +
+ {% endif %} +
+ +
+
+ {% if service.description %} +
+ {{ service.description }} +
+ {% endif %} +
+ {% if service.applies_to != 0 %} +

{{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} : + {% if service.applies_to == 1 %} + {{ 'User'|get_lang }} + {% elseif service.applies_to == 2 %} + {{ 'Course'|get_lang }} + {% elseif service.applies_to == 3 %} + {{ 'Session'|get_lang }} + {% elseif service.applies_to == 4 %} + {{ 'TemplateTitleCertificate'|get_lang }} + {% endif %} +

+ {% endif %} +
+
+
+
+
+ {{ 'Total'|get_lang }} + {{ service.total_price_formatted }} +
+
+
+ + {{ 'Buy'|get_plugin_lang('BuyCoursesPlugin') }} + +
+
+
+
+
+
+
+
+
+
+
+
+
+

{{ 'ServiceInformation'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+ {{ service.service_information }} +
+
+
+
+
+
diff --git a/plugin/buycourses/view/service_message_transfer.tpl b/plugin/buycourses/view/service_message_transfer.tpl new file mode 100644 index 000000000..d15f9b224 --- /dev/null +++ b/plugin/buycourses/view/service_message_transfer.tpl @@ -0,0 +1,36 @@ +
+

{{ 'DearUser'|get_lang }}

+

{{ 'PurchaseDetailsIntro'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
{{ 'OrderDate'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ service_sale.buy_date|api_convert_and_format_date(constant('DATE_TIME_FORMAT_LONG_24H')) }}
+
{{ 'OrderReference'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ service_sale.reference }}
+
{{ 'UserName'|get_lang }}
+
{{ service_sale.buyer }}
+
{{ 'Service'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ service_sale.name }}
+
{{ 'SalePrice'|get_plugin_lang('BuyCoursesPlugin') }}
+
{{ service_sale.currency ~ ' ' ~ service_sale.price }}
+
+

{{ 'BankAccountIntro'|get_plugin_lang('BuyCoursesPlugin')|format(service_sale.name) }}

+ + + + + + + + + + {% for account in transfer_accounts %} + + + + + + {% endfor %} + +
{{ 'Name'|get_lang }}{{ 'BankAccount'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'SWIFT'|get_plugin_lang('BuyCoursesPlugin') }}
{{ account.name }}{{ account.account }}{{ account.swift }}
+

{{ 'PurchaseDetailsEnd'|get_plugin_lang('BuyCoursesPlugin') }}

+
diff --git a/plugin/buycourses/view/service_panel.tpl b/plugin/buycourses/view/service_panel.tpl new file mode 100644 index 000000000..08c400622 --- /dev/null +++ b/plugin/buycourses/view/service_panel.tpl @@ -0,0 +1,85 @@ +
+ + + + + + + + + + + + + + {% for sale in sale_list %} + + + + + + + + + + {% endfor %} + +
{{ 'Service'| get_plugin_lang('BuyCoursesPlugin') }}{{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderDate'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderReference'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'ServiceSaleInfo'|get_plugin_lang('BuyCoursesPlugin') }}
{{ sale.name }}{{ sale.service_type }}{{ sale.currency ~ ' ' ~ sale.price }}{{ sale.date | api_get_local_time }}{{ sale.reference }} + {{ 'Info'|get_lang }} +
+
+ diff --git a/plugin/buycourses/view/service_process.tpl b/plugin/buycourses/view/service_process.tpl new file mode 100644 index 000000000..037a76a66 --- /dev/null +++ b/plugin/buycourses/view/service_process.tpl @@ -0,0 +1,120 @@ +
+ + {{ + +
+
+

{{ 'PurchaseData'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+
+
+ {% if buying_service %} +
+
+ + {{ service.name }} + + {% if service.tax_enable %} +
+ {{ 'Price'|get_plugin_lang('BuyCoursesPlugin')}} : + {{ service.price_formatted }} +
+ {{ service.tax_name }} ({{ service.tax_perc_show }}%): + {{ service.tax_amount_formatted }} +
+
+ {{ 'Total'|get_plugin_lang('BuyCoursesPlugin')}} : + {{ service.total_price_formatted }} +
+ {% if service.has_coupon %} +
+ {{ 'DiscountAmount'|get_plugin_lang('BuyCoursesPlugin') }}: + {{ service.discount_amount_formatted }} +
+ {% endif %} +
+ {{ 'DoYouHaveACoupon'|get_plugin_lang('BuyCoursesPlugin') }} +
+
+ {{ form_coupon }} +
+ {% else %} +
+ {{ 'Total'|get_plugin_lang('BuyCoursesPlugin')}} : + {{ service.total_price_formatted }} +
+ {% if service.has_coupon %} +
+ {{ 'DiscountAmount'|get_plugin_lang('BuyCoursesPlugin') }}: + {{ service.discount_amount_formatted }} +
+ {% endif %} +
+ {{ 'DoYouHaveACoupon'|get_plugin_lang('BuyCoursesPlugin') }} +
+
+ {{ form_coupon }} +
+ {% endif %} + +
+
+
+

+ {{ service.name }} +

+ {% if service.description %} +
+ {{ service.description }} +
+ {% endif %} +
    + {% if service.applies_to %} +
  • + + {% if service.applies_to == 0 %} + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') ~ ' ' ~ 'None'|get_lang }} + {% elseif service.applies_to == 1 %} + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') ~ ' ' ~ 'User'|get_lang }} + {% elseif service.applies_to == 2 %} + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') ~ ' ' ~ 'Course'|get_lang }} + {% elseif service.applies_to == 3 %} + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') ~ ' ' ~ 'Session'|get_lang }} + {% elseif service.applies_to == 4 %} + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') ~ ' ' ~ 'TemplateTitleCertificate'|get_lang }} + {% endif %} +
    • + {% endif %} +
  • + + {{ service.duration_days == 0 ? 'NoLimit'|get_lang : service.duration_days ~ ' ' ~ 'Days'|get_lang }} +
    • +
  • {{ service.owner_name }}
    • + +
+
+
+
+ {% endif %} +
+
+

{{ 'PaymentMethods'|get_plugin_lang('BuyCoursesPlugin') }}

+ {{ form }} +
+
+
+
+
+ diff --git a/plugin/buycourses/view/service_sales_report.tpl b/plugin/buycourses/view/service_sales_report.tpl new file mode 100644 index 000000000..39ae19e59 --- /dev/null +++ b/plugin/buycourses/view/service_sales_report.tpl @@ -0,0 +1,121 @@ + +
+
+
+
+

{{ 'Filter'|get_lang }}

+ {{ form }} +
+
+
+ + + + + + + + + + + {% if invoicing_enable %} + + {% endif %} + + + + + {% for sale in sale_list %} + + + + + + + + + {% if invoicing_enable %} + + {% endif %} + + + {% endfor %} + +
{{ 'ServiceName'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderReference'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderStatus'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderDate'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDiscount'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Coupon'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Invoice'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'ServiceSaleInfo'|get_plugin_lang('BuyCoursesPlugin') }}
{{ sale.name }}{{ sale.reference }} + {% if sale.status == sale_status_cancelled %} + {{ 'SaleStatusCancelled'|get_plugin_lang('BuyCoursesPlugin') }} + {% elseif sale.status == sale_status_pending %} + {{ 'SaleStatusPending'|get_plugin_lang('BuyCoursesPlugin') }} + {% elseif sale.status == sale_status_completed %} + {{ 'SaleStatusCompleted'|get_plugin_lang('BuyCoursesPlugin') }} + {% endif %} + {{ sale.buy_date | api_get_local_time}}{{ sale.service.total_price }}{{ sale.total_discount }}{{ sale.coupon_code }} + {% if sale.invoice == 1 %} + + {{ 'InvoiceView'|get_plugin_lang('BuyCoursesPlugin') }} +
{{ sale.num_invoice }} + + {% endif %} + 		+ + {{ 'Info'|get_lang }} + +
+
+
+
+ + diff --git a/plugin/buycourses/view/session_panel.tpl b/plugin/buycourses/view/session_panel.tpl new file mode 100644 index 000000000..265b8d3e4 --- /dev/null +++ b/plugin/buycourses/view/session_panel.tpl @@ -0,0 +1,48 @@ +
+ + + + + + + + + + + + + + + {% for sale in sale_list %} + + + + + + + + {% endfor %} + +
{{ 'Session'|get_lang }}{{ 'PaymentMethod'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderDate'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderReference'|get_plugin_lang('BuyCoursesPlugin') }}
{{ sale.product_name }}{{ sale.payment_type }}{{ sale.currency ~ ' ' ~ sale.price }}{{ sale.date }}{{ sale.reference }}
+ + +
diff --git a/plugin/buycourses/view/subscription_add.tpl b/plugin/buycourses/view/subscription_add.tpl new file mode 100644 index 000000000..ce8a838a9 --- /dev/null +++ b/plugin/buycourses/view/subscription_add.tpl @@ -0,0 +1,37 @@ +
+
+ {{ items_form }} +
+
+ + diff --git a/plugin/buycourses/view/subscription_catalog.tpl b/plugin/buycourses/view/subscription_catalog.tpl new file mode 100644 index 000000000..7edbc2ccd --- /dev/null +++ b/plugin/buycourses/view/subscription_catalog.tpl @@ -0,0 +1,122 @@ +
+ {% if sessions_are_included %} + + {% endif %} + +
+
+
+
+ {{ search_filter_form }} +
+
+
+ {% if showing_courses %} + {% for course in courses %} +
+
+
+
+ {{ course.title }} +
+
+
+ {% set course_description_url = _p.web_ajax ~ 'course_home.ajax.php?' ~ {'code': course.code, 'a': 'show_course_information'}|url_encode() %} +

+ {{ course.title }} +

+
    + {% for teacher in course.teachers %} +
  • {{ teacher }}
    • + {% endfor %} +
+ {% if course.enrolled == "YES" %} +
+ {{ 'TheUserIsAlreadyRegisteredInTheCourse'|get_plugin_lang('BuyCoursesPlugin') }} +
+ {% elseif course.enrolled == "NO" %} +
+ + {{ 'SeeDescription'|get_plugin_lang('BuyCoursesPlugin') }} + + + {{ 'Buy'|get_plugin_lang('BuyCoursesPlugin') }} + +
+ {% elseif course.enrolled == "TMP" %} +
{{ 'WaitingToReceiveThePayment'|get_plugin_lang('BuyCoursesPlugin') }}
+ {% endif %} +
+
+
+ {% endfor %} + {% endif %} + + {% if showing_sessions %} + {% for session in sessions %} +
+
+
+
+ {{ session.name }} +
+
+
+

+ {{ session.name }} +

+ {% if 'show_session_coach'|api_get_setting == 'true' %} +

{{ session.coach }}

+ {% endif %} +

+ + {% if session.duration %} + {{ 'SessionDurationXDaysTotal'|get_lang|format(session.duration) }} + {% else %} + {{ session.dates.display }} + {% endif %} +

+ {% if session.enrolled == "YES" %} +
+ {{ 'TheUserIsAlreadyRegisteredInTheSession'|get_plugin_lang('BuyCoursesPlugin') }} +
+ {% elseif session.enrolled == "NO" %} +
+ + {{ 'Buy'|get_plugin_lang('BuyCoursesPlugin') }} + +
+ {% elseif session.enrolled == "TMP" %} +
{{ 'WaitingToReceiveThePayment'|get_plugin_lang('BuyCoursesPlugin') }}
+ {% endif %} +
+
+
+ {% endfor %} + {% endif %} +
+ {{ pagination }} +
+
+
+
+
diff --git a/plugin/buycourses/view/subscription_process.tpl b/plugin/buycourses/view/subscription_process.tpl new file mode 100644 index 000000000..5df69fdd9 --- /dev/null +++ b/plugin/buycourses/view/subscription_process.tpl @@ -0,0 +1,187 @@ +
+ {% if item_type == 1 %} + {% set back_url = _p.web_plugin ~ 'buycourses/src/subscription_course_catalog.php' %} + {% elseif item_type == 2 %} + {% set back_url = _p.web_plugin ~ 'buycourses/src/subscription_session_catalog.php' %} + {% endif %} + + + {{ + +
+
+

{{ 'PurchaseData'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+
+
+ {% if buying_course %} +
+
+ + {{ course.title }} + + {% if course.tax_enable %} +
+ {{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }} : + {{ subscription.price_formatted }} +
+ {{ course.tax_name }} ({{ subscription.item.tax_perc_show }}%): + {{ subscription.tax_amount_formatted }} +
+ {% endif %} +
+ {{ 'Total'|get_plugin_lang('BuyCoursesPlugin') }} : + {{ subscription.total_price_formatted }} +
+ {% if course.has_coupon %} +
+ {{ 'DiscountAmount'|get_plugin_lang('BuyCoursesPlugin') }}: + {{ course.discount_amount_formatted }} +
+ {% endif %} +
+ {{ 'SelecSubscription'|get_plugin_lang('BuyCoursesPlugin') }} +
+
+ {{ form_subscription }} +
+
+ {{ 'DoYouHaveACoupon'|get_plugin_lang('BuyCoursesPlugin') }} +
+
+ {{ form_coupon }} +
+
+
+
+

+ + {{ course.title }} + +

+ {% if course.description %} +
+ {{ course.description }} +
+ {% endif %} + + {% if course.teachers %} +
+

+ {{ 'Teachers'|get_plugin_lang('BuyCoursesPlugin') }} : + {% for teacher in course.teachers %} + + {{ teacher.name }}, + {% endfor %} +

+
+ {% endif %} +
+
+
+ {% elseif buying_session %} +
+
+ {{ session.name }} + {% if session.tax_enable %} +
+ {{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }} : + {{ subscription.price_formatted }} +
+ {{ session.tax_name }} ({{ subscription.item.tax_perc_show }}%): + {{ subscription.tax_amount_formatted }} +
+ {% endif %} +
+ {{ 'Total'|get_plugin_lang('BuyCoursesPlugin') }} : + {{ subscription.total_price_formatted }} +
+ {% if session.has_coupon %} +
+ {{ 'DiscountAmount'|get_plugin_lang('BuyCoursesPlugin') }}: + {{ session.discount_amount_formatted }} +
+ {% endif %} +
+ {{ 'SelecSubscription'|get_plugin_lang('BuyCoursesPlugin') }} +
+
+ {{ form_subscription }} +
+
+ {{ 'DoYouHaveACoupon'|get_plugin_lang('BuyCoursesPlugin') }} +
+
+ {{ form_coupon }} +
+
+
+
+

{{ session.name }}

+ {% if session.description %} +
+ {{ session.description }} +
+ {% endif %} +
+ {{ session.dates.display }} +
+
+
+ {% for course in session.courses %} +

+ {{ course.title }} +

+ {% if course.coaches|length %} +

+ {{ 'Teachers'|get_plugin_lang('BuyCoursesPlugin') }} : + + {% for coach in course.coaches %} + + {{ coach.name }}, + {% endfor %} +

+ {% endif %} + {% endfor %} +
+
+
+
+ {% endif %} +
+
+

{{ 'PaymentMethods'|get_plugin_lang('BuyCoursesPlugin') }}

+ {% if message_payment %} + {{ message_payment }} + {% else %} + {{ form }} + {% endif %} +
+
+
+
+
+ diff --git a/plugin/buycourses/view/subscription_process_confirm.tpl b/plugin/buycourses/view/subscription_process_confirm.tpl new file mode 100644 index 000000000..daaad8808 --- /dev/null +++ b/plugin/buycourses/view/subscription_process_confirm.tpl @@ -0,0 +1,283 @@ +
+
+
+
+
+

{{ 'PurchaseData'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+ {% if buying_course %} +
+
+ + {{ course.title }} + +
+
+

+ {{ course.title }} +

+
    + {% for teacher in course.teachers %} +
  • {{ teacher.name }}
    • + {% endfor %} +
+

+ + {{ course.item.total_price_formatted }} + +

+

+
+
+ {% elseif buying_session %} +
+
+

+ {{ session.name }} +

+
+
+

{{ session.name }}

+

{{ session.dates.display }}

+
    + {% for course in session.courses %} +
  • + {{ course.title }} + {% if course.coaches|length %} +
      + {% for coach in course.coaches %} +
    • {{ coach }}
      • + {% endfor %} +
    + {% endif %} +
    • + {% endfor %} +
+

+ + {{ session.item.total_price_formatted }} + +

+

+
+
+ {% elseif buying_service %} +
+
+ + {{ service.name }} + +
+
+
+
+

+ {{ service.name }} +

+
    + {% if service.applies_to == 0 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'None'|get_lang }} +
    • + {% elseif service.applies_to == 1 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'User'|get_lang }} +
    • + {% elseif service.applies_to == 2 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'Course'|get_lang }} +
    • + {% elseif service.applies_to == 3 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'Session'|get_lang }} +
    • + {% elseif service.applies_to == 4 %} +
  • + {{ 'AppliesTo'|get_plugin_lang('BuyCoursesPlugin') }} {{ 'TemplateTitleCertificate'|get_lang }} +
    • + {% endif %} +
  • + + {{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }} + : {{ service_item.total_price_formatted }} + / {{ service.duration_days == 0 ? 'NoLimit'|get_lang : service.duration_days ~ ' ' ~ 'Days'|get_lang }} +
    • +
  • {{ service.owner.name }}
    • + {% if service.description %} +
  • {{ service.description }}
    • + {% endif %} +
+

+ + {{ service_item.total_price_formatted }} + +

+

+
+
+ {% endif %} +
+
+
+ {% if terms %} +
+
+
+

{{ 'TermsAndConditions'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+
+
+ +
+
+ +
+
+
+
+
+ {% endif %} +
+ +{% if is_bank_transfer %} +
+
+

{{ 'BankAccountInformation'|get_plugin_lang('BuyCoursesPlugin') }}

+
+ + + + + + + + + + {% for account in transfer_accounts %} + + + + + + {% endfor %} + +
{{ 'Name'|get_lang }}{{ 'BankAccount'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'SWIFT'|get_plugin_lang('BuyCoursesPlugin') }}
{{ account.name }}{{ account.account }}{{ account.swift }}
+
+

{{ 'OnceItIsConfirmedYouWillReceiveAnEmailWithTheBankInformationAndAnOrderReference'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
+{% endif %} + +
+
+ {{ form }} +
+
+ diff --git a/plugin/buycourses/view/subscription_sales_report.tpl b/plugin/buycourses/view/subscription_sales_report.tpl new file mode 100644 index 000000000..c88207224 --- /dev/null +++ b/plugin/buycourses/view/subscription_sales_report.tpl @@ -0,0 +1,122 @@ + +
+
+{{ form }} + +
+ + + + + + + + + + + + + + + {% if invoicing_enable %} + + {% endif %} + + + + + {% for sale in sale_list %} + + + + + + + + + + + + + {% if invoicing_enable %} + + {% endif %} + + + {% endfor %} + +
{{ 'OrderReference'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderStatus'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'OrderDate'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'PaymentMethod'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Price'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'CouponDiscount'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Coupon'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'ProductType'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Name'|get_lang }}{{ 'UserName'|get_lang }}{{ 'Email'|get_lang }}{{ 'Invoice'|get_plugin_lang('BuyCoursesPlugin') }}{{ 'Options'|get_lang }}
{{ sale.reference }} + {% if sale.status == sale_status_canceled %} + {{ 'SaleStatusCanceled'|get_plugin_lang('BuyCoursesPlugin') }} + {% elseif sale.status == sale_status_pending %} + {{ 'SaleStatusPending'|get_plugin_lang('BuyCoursesPlugin') }} + {% elseif sale.status == sale_status_completed %} + {{ 'SaleStatusCompleted'|get_plugin_lang('BuyCoursesPlugin') }} + {% endif %} + {{ sale.date | api_get_local_time }}{{ sale.payment_type }}{{ sale.total_price }}{{ sale.total_discount }}{{ sale.coupon_code }}{{ sale.product_type }}{{ sale.product_name }}{{ sale.complete_user_name }}{{ sale.email }} + {% if sale.invoice == 1 %} + + {{ 'InvoiceView'|get_plugin_lang('BuyCoursesPlugin') }} +
{{ sale.num_invoice }} + + {% endif %} + 		+ {% if sale.status == sale_status_pending %} +
+ + + + + + +
+ {% endif %} +
+
+ + diff --git a/plugin/buycourses/view/subscriptions.tpl b/plugin/buycourses/view/subscriptions.tpl new file mode 100644 index 000000000..883ba0f2a --- /dev/null +++ b/plugin/buycourses/view/subscriptions.tpl @@ -0,0 +1,152 @@ +{% if sessions_are_included %} + +{% endif %} + +
+
+
+ + + + + + + {% if tax_enable and (tax_applies_to == 1 or tax_applies_to == 2) %} + + {% endif %} + + + + + {% for item in courses %} + + + + + {% if tax_enable and (tax_applies_to == 1 or tax_applies_to == 2) %} + + {% endif %} + + + {% endfor %} + +
{{ 'Title'|get_lang }}{{ 'OfficialCode'|get_lang }}{{ 'HasSubscriptions'|get_plugin_lang('BuyCoursesPlugin') }}{{ tax_name }}{{ 'Options'|get_lang }}
+ {% if item.visibility == 0 %} + {{ 'CourseVisibilityClosed'|get_lang }} + {% elseif item.visibility == 1 %} + {{ 'Private'|get_lang }} + {% elseif item.visibility == 2 %} + {{ 'OpenToThePlatform'|get_lang }} + {% elseif item.visibility == 3 %} + {{ 'OpenToTheWorld'|get_lang }} + {% elseif item.visibility == 4 %} + {{ 'CourseVisibilityHidden'|get_lang }} + {% endif %} + + {{ item.title }} + + {{ item.code }} + + {{ item.code }} + + {% if item.buyCourseData %} + + {% else %} + + {% endif %} + + {{ item.buyCourseData.tax_perc_show }} % + + {% if item.buyCourseData %} + + {{ 'Configure'|get_lang }} + + {% else %} + + {{ 'Configure'|get_lang }} + + {% endif %} +
+
+ {{ course_pagination }} +
+ + {% if sessions_are_included %} +
+
+ + + + + + + + {% if tax_enable and (tax_applies_to == 1 or tax_applies_to == 3) %} + + {% endif %} + + + + + {% for item in sessions %} + + + + + + {% if tax_enable and (tax_applies_to == 1 or tax_applies_to == 3) %} + + {% endif %} + + + {% endfor %} + +
{{ 'Title'|get_lang }}{{ 'StartDate'|get_lang }}{{ 'EndDate'|get_lang }}{{ 'HasSubscriptions'|get_plugin_lang('BuyCoursesPlugin') }}{{ tax_name }}{{ 'Options'|get_lang }}
+ {{ item.name }} + + {{ item.displayStartDate | api_convert_and_format_date(6)}} + + {{ item.displayEndDate |api_convert_and_format_date(6)}} + + {% if item.buyCourseData %} + + {% else %} + + {% endif %} + + {{ item.buyCourseData.tax_perc_show }} % + + {% if item.buyCourseData %} + + {{ 'Configure'|get_lang }} + + {% else %} + + {{ 'Configure'|get_lang }} + + {% endif %} +
+ {{ session_pagination }} +
+
+ {% endif %} +
diff --git a/plugin/buycourses/view/success.tpl b/plugin/buycourses/view/success.tpl new file mode 100644 index 000000000..cc25e8ece --- /dev/null +++ b/plugin/buycourses/view/success.tpl @@ -0,0 +1,70 @@ +
+ {{ 'PayPalPaymentOKPleaseConfirm'|get_plugin_lang('BuyCoursesPlugin') }} +
+
+
+

{{ 'UserInformation'|get_plugin_lang('BuyCoursesPlugin') }}

+
+
{{ 'Name'|get_lang }} +
+
{{ user.complete_name }}
+
{{ 'Username'|get_lang }} +
+
{{ user.username }}
+
{{ 'EmailAddress'|get_lang }} +
+
{{ user.email }}
+
+
+
+ {% if buying_course %} +
+
+

+ {{ course.title }} +

+

{{ course.currency }} {{ course.price }}

+
+
+

{{ course.title }}

+
    + {% for teacher in course.teachers %} +
  • {{ teacher.name }}
    • + {% endfor %} +
+

+ + {{ 'Description'|get_lang }} + +

+
+
+ {% elseif buying_session %} +

{{ session.name }}

+
+
+

+ {{ session.name }} +

+

{{ session.currency }} {{ session.price }}

+
+
+

{{ session.dates.display }}

+
+ {% for course in session.courses %} +
{{ course.title }}
+ {% for coach in course.coaches %} +
{{ coach.name }}
+ {% endfor %} + {% endfor %} +
+
+
+ {% endif %} +
+
+ +{{ form }} diff --git a/plugin/card_game/LICENSE.txt b/plugin/card_game/LICENSE.txt new file mode 100644 index 000000000..9e419e042 --- /dev/null +++ b/plugin/card_game/LICENSE.txt @@ -0,0 +1,674 @@ +GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. \ No newline at end of file diff --git a/plugin/card_game/README.md b/plugin/card_game/README.md new file mode 100644 index 000000000..f7fd5ce33 --- /dev/null +++ b/plugin/card_game/README.md @@ -0,0 +1,26 @@ +Card reveal game Chamilo plugin +=============================== +This plugin adds a little game to the interface to encourage users to connect +every day. + +# Installation + +To install, enable the plugin, then go to "Regions" in the administration panel +and add the region "pre_footer" to the plugin. Save. +The plugin should appear as a little icon in the lower-right side of your user +picture in the left column of the "My courses" list. + +## Migrating from a non-official version +This plugin was initially designed by _Les Compagnons Bâtisseurs_. If you had +used it before its review and integration into Chamilo, you will need to +execute the following changes in your database to update its structure. + +##### Database changes +You need execute these SQL queries in your database if you are upgrading to +Chamilo 1.11.8 and the card_game plugin was already installed in your previous version. + +```sql +ALTER TABLE plugin_card_game CHANGE COLUMN idUser user_id INT NOT NULL; +ALTER TABLE plugin_card_game CHANGE COLUMN dateAcces access_date date default NULL; + +``` \ No newline at end of file diff --git a/plugin/card_game/card_game.php b/plugin/card_game/card_game.php new file mode 100644 index 000000000..d685a9519 --- /dev/null +++ b/plugin/card_game/card_game.php @@ -0,0 +1,51 @@ +'; + $fh .= ''; + + $fh .= ''; + $fh .= ''; + $fh .= ''; + + $fh .= ''; + + $userId = api_get_user_id(); + + // Look if the user can still try playing today + $cardGameSession = Session::read('cardgame'); + if (!empty($cardGameSession)) { + // If we've already loaded the cardgame in this session, then there's + // a chance we've already played + if (isset($userId)) { + $sqlCount = "SELECT access_date FROM plugin_card_game WHERE user_id = $userId"; + $resultCount = Database::query($sqlCount)->rowCount(); + + if ($resultCount === 0) { + // If there is no database entry for this user, insert one + // without the 'parts' field (because he has not played yet) + // @todo change date call + $sql = "INSERT INTO plugin_card_game (user_id, access_date, pan) + VALUES ($userId, DATE_ADD(CURDATE(), INTERVAL -1 DAY), 1);"; + $resultInsert = Database::query($sql); + Session::write('cardgame', 'havedeck'); + } else { + // If there is already one or more records in the database, + // get the number of records for today + // @todo change date call + $sqlDate = "SELECT access_date + FROM plugin_card_game + WHERE access_date = CURDATE() + AND user_id = $userId"; + $resultDate = Database::query($sqlDate)->rowCount(); + + if ($resultDate == 0) { + // If there are records, but none for today, set the + // 'cardgame' session variable and add the + // #havedeckcardgame element to the page (it will get + // picked up by JS later on) + Session::write('cardgame', 'havedeck'); + $fh .= '
'; + } else { + // If the user already played today, set the session + // 'cardgame' variable to 'done' and do not add + // an #havedeckcardgame element + Session::write('cardgame', 'done'); + } + } + } + } else { + Session::write('cardgame', 'havedeck'); + $fh .= '
'; + } + + $parts = '1'; + $pan = '1'; + + if (isset($userId)) { + try { + $sqlParts = "SELECT parts, pan FROM plugin_card_game WHERE user_id = $userId"; + $resultParts = Database::query($sqlParts); + while ($part = Database::fetch_array($resultParts)) { + $parts = $part['parts']; + $pan = $part['pan']; + } + } catch (Exception $e) { + echo 'Exception: ', $e->getMessage(), "\n"; + } + } + + echo ''; + echo ''; + + echo $fh; +} diff --git a/plugin/card_game/install.php b/plugin/card_game/install.php new file mode 100644 index 000000000..5683e4b96 --- /dev/null +++ b/plugin/card_game/install.php @@ -0,0 +1,9 @@ +install(); diff --git a/plugin/card_game/lang/english.php b/plugin/card_game/lang/english.php new file mode 100644 index 000000000..0130a7117 --- /dev/null +++ b/plugin/card_game/lang/english.php @@ -0,0 +1,5 @@ +Plugins). + * + * @package chamilo.plugin card_game + * + * @author Damien Renou + */ +/* Plugin config */ + +// The plugin title. +$plugin_info['title'] = 'Card game'; +// The comments that go with the plugin. +$plugin_info['comment'] = "Show a card game"; +// The plugin version. +$plugin_info['version'] = '1.2'; +// The plugin author. +$plugin_info['author'] = 'Damien Renou'; diff --git a/plugin/card_game/resources/ajax.card.php b/plugin/card_game/resources/ajax.card.php new file mode 100644 index 000000000..7441207a8 --- /dev/null +++ b/plugin/card_game/resources/ajax.card.php @@ -0,0 +1,50 @@ + +image/svg+xml1 + \ No newline at end of file diff --git a/plugin/card_game/resources/css/card-acces.svg b/plugin/card_game/resources/css/card-acces.svg new file mode 100644 index 000000000..13816983f --- /dev/null +++ b/plugin/card_game/resources/css/card-acces.svg @@ -0,0 +1,92 @@ + +image/svg+xml \ No newline at end of file diff --git a/plugin/card_game/resources/css/card-back.png b/plugin/card_game/resources/css/card-back.png new file mode 100644 index 000000000..9b06762ae Binary files /dev/null and b/plugin/card_game/resources/css/card-back.png differ diff --git a/plugin/card_game/resources/css/card1.jpg b/plugin/card_game/resources/css/card1.jpg new file mode 100644 index 000000000..9287dcc15 Binary files /dev/null and b/plugin/card_game/resources/css/card1.jpg differ diff --git a/plugin/card_game/resources/css/card1.pdn b/plugin/card_game/resources/css/card1.pdn new file mode 100644 index 000000000..91d6f0ce9 Binary files /dev/null and b/plugin/card_game/resources/css/card1.pdn differ diff --git a/plugin/card_game/resources/css/cardgame.css b/plugin/card_game/resources/css/cardgame.css new file mode 100644 index 000000000..07115396e --- /dev/null +++ b/plugin/card_game/resources/css/cardgame.css @@ -0,0 +1,238 @@ +/** CSS used to show a 5x3 table of cells hiding a big image */ +#home-card { + overflow: hidden; +} + +.enjoy-cardgame-active { + position: relative; + left: 50%; + top: 90%; + width: 40px; + height: 40px; + margin-top: -35px; + margin-left: 10px; + background-image: url('card-acces-active.svg'); + background-color: transparent; + background-repeat: no-repeat; + background-position: center fixed; + -webkit-background-size: cover; + background-size: cover; + cursor: pointer; + z-index: 1000; +} + +.enjoy-cardgame { + position: relative; + left: 50%; + top: 90%; + width: 40px; + height: 40px; + margin-top: -35px; + margin-left: 10px; + background-image: url('card-acces.svg'); + background-color: transparent; + background-repeat: no-repeat; + background-position: center fixed; + -webkit-background-size: cover; + background-size: cover; + cursor: pointer; + z-index: 1000; +} + +.card-one { + position: absolute; + transform: rotate(160deg); + background-image: url('card1.jpg'); + background-position: center center; + left: 130%; + top: 50px; + width: 220px; + height: 330px; + margin-left: -110px; + background-color: #CECEF6; + border: solid 2px green; + cursor: pointer; + border-radius: 20px; + -webkit-transition: all 1s ease-in-out; + transition: all 1s ease-in-out; + opacity: 0.1; +} + +.card-one-2 { + transform: rotate(0deg); + left: 50%; + opacity: 1; +} + +.cardgame-pack { + position: relative; + width: 100%; + height: 450px; + background-image: url('cardpack450.jpg'); + background-color: transparent; + background-position: -500px bottom; + -webkit-transition: all 1s ease-in-out; + transition: all 1s ease-in-out; +} + +.cardgame-open { + background-position: 0px 0px; +} + +.linescissors { + position: absolute; + left: 60px; + top: 135px; + width: 220px; + height: 6px; + transform: rotate(-26deg); + border-top: dotted 3px gray; +} + +.messagePackDeck { + position: absolute; + text-align: center; + right: 20px; + top: 30px; + width: 200px; + padding: 20px; + font-size: 22px; + border-radius: 15px; + background-color: #8A0886; + color: white; +} + +.viewDeckBottom { + position: absolute; + left: 3px; + bottom: 5px; + width: 73px; + height: 60px; + background-image: url('galerie.png'); + background-color: transparent; + background-repeat: no-repeat; + background-position: center fixed; + -webkit-background-size: cover; + background-size: cover; + display: none; + cursor: pointer; +} + +.messagePackDeckBottom { + position: absolute; + text-align: center; + left: 85px; + bottom: 10px; + right: 20px; + padding: 14px; + font-size: 16px; + border-radius: 15px; + background-color: #8A0886; + color: white; +} + +.scissorsrightinit { + transform: rotate(160deg); + position: absolute; + left: 260px; + top: 50px; + width: 60px; + height: 60px; + background-image: url('scissorsright.gif'); + background-color: transparent; + background-repeat: no-repeat; + background-position: center fixed; + -webkit-background-size: cover; + background-size: cover; + cursor: pointer; + z-index: 1000; + -webkit-transition: all 3s ease-in-out; + transition: all 3s ease-in-out; +} + +.scissorsrightinitfinal { + left: 10px; + top: 170px; +} + +.puzzlecardone { + position: absolute; + display: none; + left: 5%; + top: 2%; + width: 90%; + height: 80%; + background-color: gray; + background-repeat: no-repeat; + background-position: center fixed; + -webkit-background-size: cover; + background-size: cover; + border: solid 1px green; + overflow: hidden; +} + +.puzzleMin { + float: left; + position: relative; + left: 10px; + top: 10px; + margin-right: 10px; + margin-bottom: 10px; + width: 150px; + height: 100px; + -webkit-transition: all 1s ease-in-out; + transition: all 1s ease-in-out; +} + +.puzzleMinOther { + float: left; + position: relative; + left: 10px; + top: 10px; + margin-right: 10px; + margin-bottom: 10px; + width: 150px; + height: 100px; + background-image: url('b-back.jpg'); + background-repeat: no-repeat; + background-position: center center; + -webkit-background-size: cover; + background-size: cover; + display: none; + -webkit-transition: all 1s ease-in-out; + transition: all 1s ease-in-out; +} + +.pimg01 { + background-image: url('img01.jpg'); +} + +.pimg02 { + background-image: url('img02.jpg'); +} + +.pimg03 { + background-image: url('img03.jpg'); +} + +.pimg04 { + background-image: url('img04.jpg'); +} + +.puzzlepart1 { + position: relative; + border-right: dotted 3px green; + border-bottom: dotted 3px green; + float: left; + left: 0%; + top: 0%; + width: 20%; + height: 33.34%; + background-image: url('b-back.jpg'); + background-color: transparent; + background-position: center center; +} + +.puzzlepartstar { + background-image: url('animstar.png'); +} \ No newline at end of file diff --git a/plugin/card_game/resources/css/cardpack.jpg b/plugin/card_game/resources/css/cardpack.jpg new file mode 100644 index 000000000..04e4a56a4 Binary files /dev/null and b/plugin/card_game/resources/css/cardpack.jpg differ diff --git a/plugin/card_game/resources/css/cardpack450.jpg b/plugin/card_game/resources/css/cardpack450.jpg new file mode 100644 index 000000000..389ffbd79 Binary files /dev/null and b/plugin/card_game/resources/css/cardpack450.jpg differ diff --git a/plugin/card_game/resources/css/galerie.png b/plugin/card_game/resources/css/galerie.png new file mode 100644 index 000000000..ddd200aad Binary files /dev/null and b/plugin/card_game/resources/css/galerie.png differ diff --git a/plugin/card_game/resources/css/img01.jpg b/plugin/card_game/resources/css/img01.jpg new file mode 100644 index 000000000..bbdf4ca60 Binary files /dev/null and b/plugin/card_game/resources/css/img01.jpg differ diff --git a/plugin/card_game/resources/css/img02.jpg b/plugin/card_game/resources/css/img02.jpg new file mode 100644 index 000000000..5f4c15387 Binary files /dev/null and b/plugin/card_game/resources/css/img02.jpg differ diff --git a/plugin/card_game/resources/css/img03.jpg b/plugin/card_game/resources/css/img03.jpg new file mode 100644 index 000000000..c2221e448 Binary files /dev/null and b/plugin/card_game/resources/css/img03.jpg differ diff --git a/plugin/card_game/resources/css/img04.jpg b/plugin/card_game/resources/css/img04.jpg new file mode 100644 index 000000000..803271d93 Binary files /dev/null and b/plugin/card_game/resources/css/img04.jpg differ diff --git a/plugin/card_game/resources/css/renderchami.jpg b/plugin/card_game/resources/css/renderchami.jpg new file mode 100644 index 000000000..54e697fa0 Binary files /dev/null and b/plugin/card_game/resources/css/renderchami.jpg differ diff --git a/plugin/card_game/resources/css/scissorsright.gif b/plugin/card_game/resources/css/scissorsright.gif new file mode 100644 index 000000000..e0758d006 Binary files /dev/null and b/plugin/card_game/resources/css/scissorsright.gif differ diff --git a/plugin/card_game/resources/js/cardgame.js b/plugin/card_game/resources/js/cardgame.js new file mode 100644 index 000000000..843c6ef4d --- /dev/null +++ b/plugin/card_game/resources/js/cardgame.js @@ -0,0 +1,237 @@ +/* For license terms, see /license.txt */ +/** + * Whenever the cardgame.js file is included into the loaded JavaScript, + * search for the user picture in the left menu and add a div + * "enjoy-cardgame" to it to show a little drawing cards icon to enable + * this plugin + */ +$(document).ready(function ($) { + + if (!document.getElementById('havedeckcardgame')) { + $('.sidebar .panel-body .img-circle').parent().parent().after('
') + } else { + $('.sidebar .panel-body .img-circle').parent().parent().after('
') + } +}) + +/** + * This function inserts the
element 'home-card' for the card game + * before the .page-content element on the page (the right side of the + * "my courses" page) only if the element with id 'home-card' does not exist + * yet. + */ +function installCardView () { + if (!document.getElementById('home-card')) { + var mess1 = $('#cardgamemessage').html() + var h = '
' + h += '
' + var panClass = 'pimg0' + $('#pancardgame').html() + + // Setup the 3x5 table of images + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + h += '
' + + h += '
' + h += '
' + h += '
' + h += '
' + + h += '
' + h += '
' + + h += '
' + h += '
' + mess1 + '
' + + h += '
' + h += '
' + h += '
' + + $('.page-content').before(h) + + } else { + $('#home-card').fadeToggle() + } + +} + +/** + * Animate the scissors + */ +function animationOpenCardView () { + + $('#scissors').addClass('scissorsrightinitfinal') + + setTimeout(function () { + $('#scissors').fadeOut() + $('.linescissors').fadeOut() + $('#messagePackDeck').css('display', 'none') + $('#messagePackDeck').removeClass('messagePackDeck') + + }, 2600) + + setTimeout(function () { + $('.cardgame-pack').addClass('cardgame-open') + $('.card-one').addClass('card-one-2') + }, 3000) + +} + +function cardOpenCardView () { + + $('.card-one').removeClass('card-one-2') + + setTimeout(function () { + $('.puzzlecardone').fadeIn() + randomOpenCardView() + }, 700) + +} + +function randomOpenCardView () { + + var part = Math.floor(Math.random() * (15 - 1 + 1)) + 1 + + $('.puzzlecardone').css('display', 'block') + $('#scissors').fadeOut() + $('.linescissors').fadeOut() + $('#messagePackDeck').css('display', 'none') + $('#messagePackDeck').removeClass('messagePackDeck') + + var memocardgame = $('#memocardgame').html() + var parts = memocardgame + var arrayOfStrings = parts.split(';') + + var findDouble = false + for (var i = 0; i < arrayOfStrings.length; i++) { + var idpart = arrayOfStrings[i] + idpart = idpart.replace('!!', '') + idpart = idpart.replace('!', '') + idpart = idpart.replace('!', '') + idpart = idpart.replace(';', '') + $('#puzzlepart' + idpart).css('opacity', 0) + + if (part == idpart) { + findDouble = true + } + + } + if (findDouble) { + part = Math.floor(Math.random() * (15 - 1 + 1)) + 1 + } + if (memocardgame.indexOf('!' + part + ';') != -1) { + part = Math.floor(Math.random() * (15 - 1 + 1)) + 1 + } + if (memocardgame.indexOf('!' + part + ';') != -1) { + part = Math.floor(Math.random() * (15 - 1 + 1)) + 1 + } + + if (memocardgame.indexOf('!' + part + ';') != -1) { + var mess2 = $('#cardgameloose').html() + $('#messagePackDeck').html(mess2) + $('#messagePackDeck').css('display', 'block') + $('#messagePackDeck').css('backgroundColor', 'red') + $('#messagePackDeck').addClass('messagePackDeckBottom') + var lk = $('#linkcardgame').html() + $.ajax({ url: lk + '?loose=1' }).done(function () { }) + + } else { + var lk = $('#linkcardgame').html() + $.ajax({ url: lk + '?part=' + part }).done(function () { }) + + setTimeout(function () { + $('#puzzlepart' + part).addClass('puzzlepartstar') + }, 600) + + setTimeout(function () { + $('#puzzlepart' + part).css('opacity', 0) + }, 1200) + + setTimeout(function () { + var mess2 = $('#cardgameengage').html() + $('#messagePackDeck').html(mess2) + $('#messagePackDeck').css('display', 'block') + $('#messagePackDeck').addClass('messagePackDeckBottom') + $('#viewDeckBottom').css('display', 'block') + }, 1500) + + } + $('#plugin-cardgame-icon').removeClass('enjoy-cardgame-active') + $('#plugin-cardgame-icon').addClass('enjoy-cardgame') +} + +/** + * This function adds the cardgame area block (in invisible state), then + * changes the visibility of blocks inside the puzzle area to show them + */ +function onlyOpenCardView () { + + installCardView(); + + var memocardgame = $('#memocardgame').html() + + $('.puzzlecardone').css('display', 'block') + $('#scissors').css('display', 'none') + $('.linescissors').css('display', 'none') + $('#messagePackDeck').css('display', 'none') + $('#messagePackDeck').removeClass('messagePackDeck') + + var lk = $('#linkcardgame').html() + var parts = memocardgame + // alert(parts); + var arrayOfStrings = parts.split(';') + + for (var i = 0; i < arrayOfStrings.length; i++) { + var idpart = arrayOfStrings[i] + idpart = idpart.replace('!!', '') + idpart = idpart.replace('!', '') + idpart = idpart.replace('!', '') + idpart = idpart.replace(';', '') + $('#puzzlepart' + idpart).css('opacity', 0) + } + + var mess2 = $('#cardgameengage').html() + $('#messagePackDeck').html(mess2) + $('#messagePackDeck').css('display', 'block') + $('#messagePackDeck').addClass('messagePackDeckBottom') + $('#viewDeckBottom').css('display', 'block') +} + +function minimizePuzzle () { + + $('.puzzlecardone').addClass('puzzleMin') + setTimeout(function () { + + $('.puzzleMinOther').css('display', 'block') + + var panNumber = parseInt($('#pancardgame').html()) + + if (panNumber > 1) { + $('#puzzleMinOther1').addClass('pimg01') + } + if (panNumber > 2) { + $('#puzzleMinOther2').addClass('pimg02') + } + if (panNumber > 3) { + $('#puzzleMinOther3').addClass('pimg03') + } + if (panNumber > 4) { + $('#puzzleMinOther4').addClass('pimg04') + } + }, 1000) +} + diff --git a/plugin/card_game/uninstall.php b/plugin/card_game/uninstall.php new file mode 100644 index 000000000..5d0bc768e --- /dev/null +++ b/plugin/card_game/uninstall.php @@ -0,0 +1,9 @@ +uninstall(); diff --git a/plugin/check_extra_field_author_company/CheckExtraFieldAuthorsCompanyPlugin.php b/plugin/check_extra_field_author_company/CheckExtraFieldAuthorsCompanyPlugin.php new file mode 100644 index 000000000..3ed6cbb77 --- /dev/null +++ b/plugin/check_extra_field_author_company/CheckExtraFieldAuthorsCompanyPlugin.php @@ -0,0 +1,553 @@ +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; + } +} diff --git a/plugin/check_extra_field_author_company/README.md b/plugin/check_extra_field_author_company/README.md new file mode 100644 index 000000000..0e58972f0 --- /dev/null +++ b/plugin/check_extra_field_author_company/README.md @@ -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. \ No newline at end of file diff --git a/plugin/check_extra_field_author_company/index.php b/plugin/check_extra_field_author_company/index.php new file mode 100644 index 000000000..92a1ce705 --- /dev/null +++ b/plugin/check_extra_field_author_company/index.php @@ -0,0 +1,5 @@ +install(); diff --git a/plugin/check_extra_field_author_company/plugin.php b/plugin/check_extra_field_author_company/plugin.php new file mode 100644 index 000000000..9f110c2fa --- /dev/null +++ b/plugin/check_extra_field_author_company/plugin.php @@ -0,0 +1,17 @@ +Plugins). + * + * @author Carlos Alvarado + */ +$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"
'. + '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'; diff --git a/plugin/check_extra_field_author_company/uninstall.php b/plugin/check_extra_field_author_company/uninstall.php new file mode 100644 index 000000000..13d8d6e56 --- /dev/null +++ b/plugin/check_extra_field_author_company/uninstall.php @@ -0,0 +1,8 @@ +uninstall(); diff --git a/plugin/cleandeletedfiles/README.md b/plugin/cleandeletedfiles/README.md new file mode 100644 index 000000000..781494fda --- /dev/null +++ b/plugin/cleandeletedfiles/README.md @@ -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. \ No newline at end of file diff --git a/plugin/cleandeletedfiles/admin.php b/plugin/cleandeletedfiles/admin.php new file mode 100644 index 000000000..374f59fae --- /dev/null +++ b/plugin/cleandeletedfiles/admin.php @@ -0,0 +1,192 @@ +get_info(); +$isPlatformAdmin = api_is_platform_admin(); + +if ($plugin->isEnabled() && $isPlatformAdmin) { + $htmlHeadXtra[] = ''; + + $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 "
    "; + echo "
  • ".$plugin->get_lang('FilesDeletedMark').": ".count($filesDeletedList).""; + echo "
  • ".$plugin->get_lang('FileDirSize').": "; + if ($sizePath >= 1024) { + echo "".round($sizePath / 1024, 1)." Mb"; + } else { + echo "".$sizePath." Kb"; + } + echo "
"; + + $header = [ + [ + '', + 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 = [ + '', + $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 '
'; + $i++; + } + + if ($sizeTotal >= 1024) { + echo $plugin->get_lang('SizeTotalAllDir').": ".round($sizeTotal / 1024, 1).' Mb'; + } else { + echo $plugin->get_lang('SizeTotalAllDir').": ".$sizeTotal.' Kb'; + } + echo '
'; + echo ''. + $plugin->get_lang("DeleteSelectedFiles"). + ''; + + Display::display_footer(); +} diff --git a/plugin/cleandeletedfiles/config.php b/plugin/cleandeletedfiles/config.php new file mode 100644 index 000000000..0d0df917d --- /dev/null +++ b/plugin/cleandeletedfiles/config.php @@ -0,0 +1,10 @@ +get_info(); diff --git a/plugin/cleandeletedfiles/src/CleanDeletedFilesPlugin.php b/plugin/cleandeletedfiles/src/CleanDeletedFilesPlugin.php new file mode 100644 index 000000000..2c9df77f9 --- /dev/null +++ b/plugin/cleandeletedfiles/src/CleanDeletedFilesPlugin.php @@ -0,0 +1,34 @@ + 'boolean']); + $this->isAdminPlugin = true; + } + + /** + * @return RedirectionPlugin + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } +} diff --git a/plugin/cleandeletedfiles/src/ajax.php b/plugin/cleandeletedfiles/src/ajax.php new file mode 100644 index 000000000..0ede69d3d --- /dev/null +++ b/plugin/cleandeletedfiles/src/ajax.php @@ -0,0 +1,47 @@ + "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; +} diff --git a/plugin/clockworksms/README.md b/plugin/clockworksms/README.md new file mode 100644 index 000000000..7c9138b3a --- /dev/null +++ b/plugin/clockworksms/README.md @@ -0,0 +1,6 @@ +Clockworks SMS plugin +=== + +This plugin enables Chamilo to send SMS messages to Chamilo users when a notification email is sent. + +SMS message types (a new course is created, an account is approved and so on) can be enabled or disabled from it's plugin configuration option. \ No newline at end of file diff --git a/plugin/clockworksms/config.php b/plugin/clockworksms/config.php new file mode 100644 index 000000000..a736ea8c1 --- /dev/null +++ b/plugin/clockworksms/config.php @@ -0,0 +1,15 @@ + + */ +require_once __DIR__.'/../../main/inc/global.inc.php'; + +require_once 'lib/clockworksms.lib.php'; +require_once 'vendor/clockworksms_api.php'; +require_once 'lib/clockworksms_plugin.class.php'; diff --git a/plugin/clockworksms/index.php b/plugin/clockworksms/index.php new file mode 100644 index 000000000..b3d9bbc7f --- /dev/null +++ b/plugin/clockworksms/index.php @@ -0,0 +1 @@ + + */ +require_once __DIR__.'/config.php'; +ClockworksmsPlugin::create()->install(); diff --git a/plugin/clockworksms/lang/english.php b/plugin/clockworksms/lang/english.php new file mode 100644 index 000000000..3f11465d4 --- /dev/null +++ b/plugin/clockworksms/lang/english.php @@ -0,0 +1,102 @@ +Click here to get it."; + +$strings['tool_enable'] = "Enable SMS sending"; +$strings['tool_enable_help'] = "Choose if you want to enable SMS sending tool. + Once enabled, they will be sent along with an email the selected SMS message types to the users who had filled their mobile phone number field in their profile
"; + +$strings['type'] = "Send SMS when"; +$strings['mobile_phone_number'] = "Mobile Phone (include country dialing code only)"; + +$strings['MessageWelcomeXLoginXPasswordX'] = "A user is added to the platform"; +$strings['MessageXNewFileSharedCourseXByX'] = "A file is added to dropbox"; +$strings['MessageXAccountApprovedConnectX'] = "An account is approved"; +$strings['MessageXNewCourseXBeenCreatedX'] = "A new course is created"; +$strings['MessageXNewUserXSubscribedCourseX'] = "A user is subscribed to a course"; +$strings['MessageXNewCourseSuggestedTeacherX'] = "A new course is suggested"; +$strings['MessageXCourseOpeningRequestCodeXRegistered'] = "A new course opening request is registered"; +$strings['MessageXCourseOpeningRequestCourseCodeXApproved'] = "A new course opening request is approved"; +$strings['MessageXRequestOpenCourseCodeXReject'] = "A new course opening request is rejected"; +$strings['MessageXCourseOpeningRequestCourseCodeX'] = "Additional information is required for a new course opening request"; +$strings['MessageXBeenSubscribedCourseX'] = "A user is added to the course but not registered to it yet"; +$strings['MessageXAssignmentBeenCreatedCourseX'] = "Homework is created"; +$strings['MessageXAccountCreatedUpdatedLoginXPasswordX'] = "A user account is created or updated"; +$strings['MessageXPasswordUpdatedLoginXPasswordX'] = "A user password is updated"; +$strings['MessageXRequestedPasswordChange'] = "A user requests a password change"; +$strings['MessageXReceivedNewPersonalMessages'] = "New personal messages are received in user's inbox or forum"; +$strings['MessageXNewUserXPendingApproval'] = "A new user registration is pending for approval"; +$strings['MessageXXPostedForumXCourseX'] = "A user posts in forum"; +$strings['MessageXXXCheckEmailConnectMoreInfo'] = "An announcement is sent"; +$strings['MessageXXStudentXAnsweredTestX'] = "A student solves an exercise"; +$strings['MessageXXStudentXAnsweredTestXOpenQuestion'] = "A student solves an open question"; +$strings['MessageXXStudentXAnsweredTestXVoiceQuestion'] = "A student solves a voice question"; +$strings['MessageXXAnswerOpenQuestionTestXReviewed'] = "An open question answer is reviewed"; +$strings['MessageXXNewThreadXStartedForumX'] = "A new thread is started in forum"; +$strings['MessageXXNewAnswerPostedXForumX'] = "A new answer is posted in forum"; +$strings['MessageXXNewSystemAnnouncementAdded'] = "A new system announcement is added and the user does not want to send a test email"; +$strings['MessageXTestXNewSystemAnnouncementAdded'] = "A new system announcement is added and the user wants to send a test email"; +$strings['MessageXXSystemAnnouncementUpdate'] = "A new system announcement is updated and the user does not want to send a test email"; +$strings['MessageXTestXSystemAnnouncementUpdate'] = "A new system announcement is updated and the user wants to send a test email"; +$strings['MessageXUserXUploadedAssignmentXCourseXStudentSubmitsPaper'] = "An assignment is uploaded and there is no current session (this will be sent only to coaches)"; +$strings['MessageXUserXUploadedAssignmentXCheckXStudentSubmitsPaper'] = "An assignment is uploaded (this will be sent only to teachers)"; +$strings['MessageXUserXUploadedAssignmentXCourseX'] = "... and there is no current session (this will be sent only to coaches)"; +$strings['MessageXUserXUploadedAssignmentXCheckX'] = "... (this will be sent only to teachers)"; +$strings['MessageXSubscribedSessionX'] = "A session is created or updated and new users are subscribed"; +$strings['MessageXSubscribedSessionXCSV'] = "New users are subscribed to a session importing a CSV file"; +$strings['MessageXUserXSuggestedBeFriends'] = "A friendship invitation is received"; +$strings['MessageXUserXAnsweredInboxMessage'] = "A message reply is received in inbox"; +$strings['MessageXBeenInvitedJoinGroupX'] = "A group join invitation is received"; +$strings['MessageXMessagesSentEditedGroupXEdited'] = "A group topic message is updated"; +$strings['MessageXMessagesSentEditedGroupXAdded'] = "A group topic message is added"; +$strings['MessageXBeenInvitedCompleteSurveyXCourseX'] = "A new survey is created"; +$strings['MessageXReminderAssignmentXCourseXDue'] = "A reminder is sent to students who have not uploaded their assignment yet"; +$strings['MessageXUserDetailsModified'] = "User details have been updated"; + +$strings['WelcomeXLoginXPasswordX'] = "Welcome to %s. Here are your user account details: login: %s, password: %s"; +$strings['XNewFileSharedCourseXByX'] = "%s: A new file has been shared with you in course %s by %s"; +$strings['XAccountApprovedConnectX'] = "%s: Your account has been approved by an administrator. You can now connect to %s"; +$strings['XNewCourseXBeenCreatedX'] = "%s: A new course (%s) has been created by %s"; +$strings['XNewUserXSubscribedCourseX'] = "%s: A new user (%s) has just subscribed to your course (%s)"; +$strings['XNewCourseSuggestedTeacherX'] = "%s: A new course has been suggested by teacher (%s). Please connect to the admin page to review it"; +$strings['XCourseOpeningRequestCodeXRegistered'] = "%s: Your course opening request (code %s) has been registered. You will be informed when it is approved"; +$strings['XCourseOpeningRequestCourseCodeXApproved'] = "%s: Your course opening request for course code %s has been approved. Connect to your portal to use it"; +$strings['XRequestOpenCourseCodeXReject'] = "%s: We are sorry to inform you that your request to open course code %s has been rejected"; +$strings['XCourseOpeningRequestCourseCodeX'] = "%s: Your course opening request for course code %s requires more information. Check e-mail for more info"; +$strings['XBeenSubscribedCourseX'] = "%s: You have been subscribed to course %s"; +$strings['XAssignmentBeenCreatedCourseX'] = "%s: A new assignment has been created in course %s. Please connect for more info"; +$strings['XAccountCreatedUpdatedLoginXPasswordX'] = "%s: Your account has been created or updated. You can now login as %s, password: %s"; +$strings['XPasswordUpdatedLoginXPasswordX'] = "%s: Your password has been updated. You can now login as %s, password: %s"; +$strings['XRequestedPasswordChange'] = "%s: You have requested a password change. Please check your e-mail for more information"; +$strings['XReceivedNewPersonalMessages'] = "%s: You have received new personal messages in your inbox or in the forum. Please check your e-mail for more info"; +$strings['XNewUserXPendingApproval'] = "%s: A new user (%s) registration is pending your approval. Please connect to the admin panel to review"; +$strings['XXPostedForumXCourseX'] = "%s: %s just posted on forum %s in course %s"; +$strings['XXXCheckEmailConnectMoreInfo'] = "%s: %s: %s. Check your e-mail or connect for more info"; +$strings['XXStudentXAnsweredTestX'] = "%s: %s: Student %s has just answered test %s"; +$strings['XXStudentXAnsweredTestXOpenQuestion'] = "%s: %s: Student %s answered test %s's open question. Please connect to review"; +$strings['XXStudentXAnsweredTestXVoiceQuestion'] = "%s: %s: Student %s answered test %s's voice question. Please connect to review"; +$strings['XXAnswerOpenQuestionTestXReviewed'] = "%s: %s: Your answer to an open question in test %s has been reviewed"; +$strings['XXNewThreadXStartedForumX'] = "%s: %s: A new thread (%s) has been started in forum %s"; +$strings['XXNewAnswerPostedXForumX'] = "%s: %s: A new answer has been posted to (%s) in forum %s"; +$strings['XXNewSystemAnnouncementAdded'] = "%s: %s"; +$strings['XTestXNewSystemAnnouncementAdded'] = "%s (test): %s"; +$strings['XXSystemAnnouncementUpdate'] = "%s: %s (update)"; +$strings['XTestXSystemAnnouncementUpdate'] = "%s (test): %s"; +$strings['XUserXUploadedAssignmentXCourseXStudentSubmitsPaper'] = "%s: User %s uploaded assignment %s in course %s"; +$strings['XUserXUploadedAssignmentXCheckXStudentSubmitsPaper'] = "%s: User %s uploaded assignment %s. Check %s"; +$strings['XUserXUploadedAssignmentXCourseX'] = "%s: User %s uploaded assignment %s in course %s"; +$strings['XUserXUploadedAssignmentXCheckX'] = "%s: User %s uploaded assignment %s. Check %s"; +$strings['XSubscribedSessionX'] = "%s: You have been subscribed to session %s"; +$strings['XSubscribedSessionXCSV'] = "%s: You have been subscribed to session %s"; +$strings['XUserXSuggestedBeFriends'] = "%s: User %s suggested you should be friends. Check your inbox or e-mail for details"; +$strings['XUserXAnsweredInboxMessage'] = "%s: User %s just answered your Inbox message"; +$strings['XBeenInvitedJoinGroupX'] = "%s: you have been invited to join group %s. Check your Inbox for details"; +$strings['XMessagesSentEditedGroupXEdited'] = "%s: Messages sent or edited in group %s. Check your Inbox for details"; +$strings['XMessagesSentEditedGroupXAdded'] = "%s: Messages sent or edited in group %s. Check your Inbox for details"; +$strings['XBeenInvitedCompleteSurveyXCourseX'] = "%s: You have been invited to complete survey %s in course %s"; +$strings['XReminderAssignmentXCourseXDue'] = "%s: This is a simple reminder that your assignment (%s) in course %s is still due"; +$strings['XUserDetailsModified'] = "%s: Your user details have been modified. Please check your e-mail for more information"; diff --git a/plugin/clockworksms/lang/spanish.php b/plugin/clockworksms/lang/spanish.php new file mode 100644 index 000000000..0d21fe339 --- /dev/null +++ b/plugin/clockworksms/lang/spanish.php @@ -0,0 +1,102 @@ +haga click aquí"; + +$strings['tool_enable'] = "Activar envío de SMS"; +$strings['tool_enable_help'] = "Escoja si desea activar la herramienta de envío de mensajes a celulares Clockwork SMS. + Una vez activada, se enviarán, simultaneamente con los correos, los tipos mensajes SMS seleccionados a los usuarios que hayan especificado un número de celular en su perfil.
"; + +$strings['sms_types'] = "Enviar un SMS cuando"; +$strings['mobile_phone_number'] = "Celular (incluya sólo el código de llamada del país)"; + +$strings['MessageWelcomeXLoginXPasswordX'] = "Se añada un usuario a la plataforma"; +$strings['MessageXNewFileSharedCourseXByX'] = "Un archivo se añada a dropbox"; +$strings['MessageXAccountApprovedConnectX'] = "Se apruebe una cuenta de usuario"; +$strings['MessageXNewCourseXBeenCreatedX'] = "Se cree un curso nuevo"; +$strings['MessageXNewUserXSubscribedCourseX'] = "Un usuario se suscriba a un curso"; +$strings['MessageXNewCourseSuggestedTeacherX'] = "Un profesor sugiera un curso nuevo"; +$strings['MessageXCourseOpeningRequestCodeXRegistered'] = "Se registre una solicitud de apertura de curso"; +$strings['MessageXCourseOpeningRequestCourseCodeXApproved'] = "Se apruebe una solicitud de apertura de curso"; +$strings['MessageXRequestOpenCourseCodeXReject'] = "Se rechace una solicitud de apertura de curso"; +$strings['MessageXCourseOpeningRequestCourseCodeX'] = "Se requiera más información de una solicitud de apertura de curso"; +$strings['MessageXBeenSubscribedCourseX'] = "Se le suscriba a un curso a un usuario que aún no está registrado"; +$strings['MessageXAssignmentBeenCreatedCourseX'] = "Se cree una nueva tarea en un curso"; +$strings['MessageXAccountCreatedUpdatedLoginXPasswordX'] = "Se cree o actualice una cuenta de usuario"; +$strings['MessageXPasswordUpdatedLoginXPasswordX'] = "Se actualice la contraseña de un usuario"; +$strings['MessageXRequestedPasswordChange'] = "Un usuario solicite un cambio de contraseña"; +$strings['MessageXReceivedNewPersonalMessages'] = "Se reciban mensajes personales nuevos en la bandeja de entrada o en el foro"; +$strings['MessageXNewUserXPendingApproval'] = "Una inscripción de un nuevo usuario esté pendiente de aprobación"; +$strings['MessageXXPostedForumXCourseX'] = "Un usuario escriba en el foro"; +$strings['MessageXXXCheckEmailConnectMoreInfo'] = "Se envíe una notificación"; +$strings['MessageXXStudentXAnsweredTestX'] = "Un estudiante resuelva un ejercicio de un examen"; +$strings['MessageXXStudentXAnsweredTestXOpenQuestion'] = "Un estudiante conteste a una pregunta abierta de un examen"; +$strings['MessageXXStudentXAnsweredTestXVoiceQuestion'] = "Un estudiante conteste a una pregunta de voz de un examen"; +$strings['MessageXXAnswerOpenQuestionTestXReviewed'] = "Se revise una pregunta abierta de un examen"; +$strings['MessageXXNewThreadXStartedForumX'] = "Se cree un hilo nuevo en el foro"; +$strings['MessageXXNewAnswerPostedXForumX'] = "Se escriba una respuesta nueva en el foro"; +$strings['MessageXXNewSystemAnnouncementAdded'] = "Se añada una notificación y el usuario no desee enviar un examen por correo electrónico"; +$strings['MessageXTestXNewSystemAnnouncementAdded'] = "Se añada una notificación y el usuario desee enviar un examen por correo electrónico"; +$strings['MessageXXSystemAnnouncementUpdate'] = "Se actualice una notificación y el usuario no desee enviar un examen por correo electrónico"; +$strings['MessageXTestXSystemAnnouncementUpdate'] = "Se actualice una notificación y el usuario desee enviar un examen por correo electrónico"; +$strings['MessageXUserXUploadedAssignmentXCourseXStudentSubmitsPaper'] = "Un estudiante suba su tarea y no exista una sesión (se enviará sólo a coordinadores)"; +$strings['MessageXUserXUploadedAssignmentXCheckXStudentSubmitsPaper'] = "Un estudiante suba su tarea (se enviará sólo a profesores)"; +$strings['MessageXUserXUploadedAssignmentXCourseX'] = "... y no exista una sesión (se enviará sólo a coordinadores)"; +$strings['MessageXUserXUploadedAssignmentXCheckX'] = "... (se enviará sólo a profesores)"; +$strings['MessageXSubscribedSessionX'] = "Se cree o edite una sesión nueva y se suscriban a usuarios nuevos"; +$strings['MessageXSubscribedSessionXCSV'] = "Se suscriban a usuarios nuevos desde un archivo CSV"; +$strings['MessageXUserXSuggestedBeFriends'] = "Se reciba una invitación de amistad"; +$strings['MessageXUserXAnsweredInboxMessage'] = "Se reciba la contestación a un mensaje en la bandeja de entrada"; +$strings['MessageXBeenInvitedJoinGroupX'] = "Se reciba una invitación para unirse a un grupo"; +$strings['MessageXMessagesSentEditedGroupXEdited'] = "Se actualice un mensaje en un tema de grupo"; +$strings['MessageXMessagesSentEditedGroupXAdded'] = "Se añada un mensaje en un tema de grupo"; +$strings['MessageXBeenInvitedCompleteSurveyXCourseX'] = "Se cree una encuesta nueva"; +$strings['MessageXReminderAssignmentXCourseXDue'] = "Se envíe un recordatorio a los estudiantes que no hayan enviado su tarea"; +$strings['MessageXUserDetailsModified'] = "Se actualice información de un usuario"; + +$strings['WelcomeXLoginXPasswordX'] = "Bienvenido a %s. Éstos son sus datos de acceso: usuario: %s, contraseña: %s"; +$strings['XNewFileSharedCourseXByX'] = "%s: Un nuevo archivo ha sido compartido contigo en el curso %s por %s"; +$strings['XAccountApprovedConnectX'] = "%s: Su cuenta ha sido aprobada por un administrador. Ya puede conectarse a %s"; +$strings['XNewCourseXBeenCreatedX'] = "%s: Un nuevo curso (%s) ha sido creado por %s"; +$strings['XNewUserXSubscribedCourseX'] = "%s: Un nuevo usuario (%s) se ha suscrito a su curso (%s)"; +$strings['XNewCourseSuggestedTeacherX'] = "%s: Un nuevo curso ha sido sugerido por el profesor (%s). Por favor, conéctese a la página de administración para revisarlo"; +$strings['XCourseOpeningRequestCodeXRegistered'] = "%s: Su solicitud de apertura de curso (código %s) ha sido registrada. Será informado cuando ésta sea aprobada"; +$strings['XCourseOpeningRequestCourseCodeXApproved'] = "%s: Su solicitud de apertura de curso para el código de curso %s ha sido aprobada. Conéctese a su portal para usarlo"; +$strings['XRequestOpenCourseCodeXReject'] = "%s: Lamentamos informarle que su solicitud de apertura de curso para el código de curso %s ha sido rechazada"; +$strings['XCourseOpeningRequestCourseCodeX'] = "%s: Su solicitud de apertura de curso para el código de curso %s requiere más información. Compruebe su e-mail para más información"; +$strings['XBeenSubscribedCourseX'] = "%s: Ha sido suscrito al curso %s"; +$strings['XAssignmentBeenCreatedCourseX'] = "%s: Una nueva tarea ha sido creada en el curso %s. Por favor, conéctese para más información"; +$strings['XAccountCreatedUpdatedLoginXPasswordX'] = "%s: Su cuenta ha sido creada o actualizada. Ya puede conectarse como %s, contraseña: %s"; +$strings['XPasswordUpdatedLoginXPasswordX'] = "%s: Su contraseña ha sido actualizada. Ya puede conectarse como %s, contraseña: %s"; +$strings['XRequestedPasswordChange'] = "%s: Ha solicitado un cambio de contraseña. Por favor, compruebe su e-mail para más información"; +$strings['XReceivedNewPersonalMessages'] = "%s: Ha recibido mensajes personales nuevos en su bandeja de entrada o en el foro. Por favor, compruebe su e-mail para más información"; +$strings['XNewUserXPendingApproval'] = "%s: Una inscripción de un nuevo usuario (%s) está pendiente de su aprobación. Por favor, conéctese al panel de administración para revisarla"; +$strings['XXPostedForumXCourseX'] = "%s: %s acaba de escribir en el foro %s del curso %s"; +$strings['XXXCheckEmailConnectMoreInfo'] = "%s: %s: %s. Compruebe su e-mail o conéctese para más información"; +$strings['XXStudentXAnsweredTestX'] = "%s: %s: El estudiante %s acaba de contestar al test %s"; +$strings['XXStudentXAnsweredTestXOpenQuestion'] = "%s: %s: El estudiante %s contestó a la pregunta abierta del test %s. Por favor, conéctese para revisarla"; +$strings['XXStudentXAnsweredTestXVoiceQuestion'] = "%s: %s: El estudiante %s contestó a la pregunta de voz del test %s. Por favor, conéctese para revisarla"; +$strings['XXAnswerOpenQuestionTestXReviewed'] = "%s: %s: Su respuesta a la pregunta abierta en el test %s ha sido revisada."; +$strings['XXNewThreadXStartedForumX'] = "%s: %s: Se ha comenzado un nuevo hilo (%s) en el foro %s"; +$strings['XXNewAnswerPostedXForumX'] = "%s: %s: Se ha escrito una nueva respuesta a (%s) en el foro %s"; +$strings['XXNewSystemAnnouncementAdded'] = "%s: %s"; +$strings['XTestXNewSystemAnnouncementAdded'] = "%s (prueba): %s"; +$strings['XXSystemAnnouncementUpdate'] = "%s: %s (actualización)"; +$strings['XTestXSystemAnnouncementUpdate'] = "%s (prueba): %s"; +$strings['XUserXUploadedAssignmentXCourseXStudentSubmitsPaper'] = "%s: El usuario %s subió la tarea %s al curso %s"; +$strings['XUserXUploadedAssignmentXCheckXStudentSubmitsPaper'] = "%s: El usuario %s subió la tarea %s. Compruébelo en %s"; +$strings['XUserXUploadedAssignmentXCourseX'] = "%s: El usuario %s subió la tarea %s al curso %s"; +$strings['XUserXUploadedAssignmentXCheckX'] = "%s: El usuario %s subió la tarea %s. Compruébelo en %s"; +$strings['XSubscribedSessionX'] = "%s: Ha sido suscrito a la sesión %s"; +$strings['XSubscribedSessionXCSV'] = "%s: Ha sido suscrito a la sesión %s"; +$strings['XUserXSuggestedBeFriends'] = "%s: El usuario %s le sugirió que podrían ser amigos. Compruebe su bandeja de entrada o su e-mail para más detalles"; +$strings['XUserXAnsweredInboxMessage'] = "%s: El usuario acaba de contestar a su mensaje de la bandeja de entrada"; +$strings['XBeenInvitedJoinGroupX'] = "%s: Ha sido invitado a unirse al grupo %s. Compruebe su bandeja de entrada para más detalles"; +$strings['XMessagesSentEditedGroupXEdited'] = "%s: Hay mensajes enviados o editados en el grupo %s. Compruebe su bandeja de entrada para más detalles"; +$strings['XMessagesSentEditedGroupXAdded'] = "%s: Hay mensajes enviados o editados en el grupo %s. Compruebe su bandeja de entrada para más detalles"; +$strings['XBeenInvitedCompleteSurveyXCourseX'] = "%s: Ha sido invitado a completar la encuesta %s del curso %s"; +$strings['XReminderAssignmentXCourseXDue'] = "%s: Se le recuerda que su tarea (%s) del curso %s aún está pendiente"; +$strings['XUserDetailsModified'] = "%s: Su información de usuario ha sido modificada. Compruebe su e-mail para más información"; diff --git a/plugin/clockworksms/lib/clockworksms.lib.php b/plugin/clockworksms/lib/clockworksms.lib.php new file mode 100644 index 000000000..fb82367ae --- /dev/null +++ b/plugin/clockworksms/lib/clockworksms.lib.php @@ -0,0 +1,676 @@ + + * + * Clockworksms-Chamilo connector class + */ +class Clockworksms implements SmsPluginLibraryInterface +{ + public $apiKey; + public $api; + public $plugin_enabled = false; + + /** + * Constructor (generates a connection to the API). + * + * @param string Clockworksms API key required to use the plugin + */ + public function __construct($apiKey = null) + { + $plugin = ClockworksmsPlugin::create(); + $clockWorkSMSPlugin = $plugin->get('tool_enable'); + if (empty($apiKey)) { + $clockWorkSMSApiKey = $plugin->get('api_key'); + } else { + $clockWorkSMSApiKey = $apiKey; + } + $this->table = Database::get_main_table('user_field_values'); + if ($clockWorkSMSPlugin == true) { + $this->apiKey = $clockWorkSMSApiKey; + // Setting Clockworksms api + if (!defined('CONFIG_SECURITY_API_KEY')) { + define('CONFIG_SECURITY_API_KEY', $this->apiKey); + } + $trimmedApiKey = trim(CONFIG_SECURITY_API_KEY); + if (!empty($trimmedApiKey)) { + $this->api = new Clockwork(CONFIG_SECURITY_API_KEY); + } else { + $this->api = new Clockwork(' '); + $recipient_name = api_get_person_name( + api_get_setting('administratorName'), + api_get_setting('administratorSurname'), + null, + PERSON_NAME_EMAIL_ADDRESS + ); + $email_form = api_get_setting('emailAdministrator'); + $emailsubject = 'Clockworksms error'; + $emailbody = 'Key cannot be blank'; + $sender_name = $recipient_name; + $email_admin = $email_form; + api_mail_html( + $recipient_name, + $email_form, + $emailsubject, + $emailbody, + $sender_name, + $email_admin + ); + } + $this->plugin_enabled = true; + } + } + + /** + * {@inheritdoc} + */ + public function getMobilePhoneNumberById($userId) + { + $mobilePhoneNumberExtraField = new ExtraField('user'); + $mobilePhoneNumberExtraField = $mobilePhoneNumberExtraField->get_handler_field_info_by_field_variable( + 'mobile_phone_number' + ); + + $mobilePhoneNumberExtraFieldValue = new ExtraFieldValue('user'); + $mobilePhoneNumberExtraFieldValue = $mobilePhoneNumberExtraFieldValue->get_values_by_handler_and_field_id( + $userId, + $mobilePhoneNumberExtraField['id'] + ); + + return $mobilePhoneNumberExtraFieldValue['value']; + } + + /** + * send (sends an SMS to the user). + * + * @param array Data needed to send the SMS. It is mandatory to include the + * 'smsType' and 'userId' (or 'mobilePhoneNumber') fields at least. + * More data may be neccesary depending on the message type + * Example: $additional_parameters = array( + * 'smsType' => EXAMPLE_SMS_TYPE, + * 'userId' => $userId, + * 'moreData' => $moreData + * ); + */ + public function send($additionalParameters) + { + $trimmedKey = trim(CONFIG_SECURITY_API_KEY); + if (!empty($trimmedKey)) { + $phoneExists = array_key_exists('mobilePhoneNumber', $additionalParameters); + $to = $phoneExists ? $additionalParameters['mobilePhoneNumber'] : $this->getMobilePhoneNumberById($additionalParameters['userId']); + + $message = [ + 'to' => $to, + 'message' => $this->getSms($additionalParameters), + ]; + + if (!empty($message['message'])) { + $this->api->send($message); + } + } + } + + /** + * buildSms (builds an SMS from a template and data). + * + * @param ClockworksmsPlugin $plugin + * @param Template $tpl + * @param string Template file name + * @param string $messageKey Text key from lang file + * @param array $parameters Data to fill message variables (if any) + * + * @return string + */ + public function buildSms( + $plugin, + $tpl, + $templateName, + $messageKey, + $parameters = [] + ) { + // Send direct message with out using plugin get_lang + if (isset($parameters['direct_message'])) { + return $parameters['direct_message']; + } + + $message = $plugin->get_lang($messageKey); + if ($parameters !== null) { + $message = vsprintf($message, $parameters); + } + + return $message; + } + + /** + * getSms (returns an SMS message depending of its type). + * + * @param array Data needed to send the SMS. It is mandatory to include the + * 'smsType' and 'userId' (or 'mobilePhoneNumber') fields at least. + * More data may be neccesary depending on the message type + * Example: $additional_parameters = array( + * 'smsType' => EXAMPLE_SMS_TYPE, + * 'userId' => $userId, + * 'moreData' => $moreData + * ); + * + * @return string A ready to be sent SMS + */ + public function getSms($additionalParameters) + { + $plugin = ClockworksmsPlugin::create(); + $tool_name = $plugin->get_lang('plugin_title'); + $tpl = new Template($tool_name); + + switch ($additionalParameters['smsType']) { + case SmsPlugin::WELCOME_LOGIN_PASSWORD: + $userInfo = api_get_user_info($additionalParameters['userId']); + + return $this->buildSms( + $plugin, + $tpl, + 'welcome_login_password.tpl', + 'WelcomeXLoginXPasswordX', + [ + api_get_setting('siteName'), + $userInfo['username'], + $additionalParameters['password'], + ] + ); + break; + case SmsPlugin::NEW_FILE_SHARED_COURSE_BY: + return $this->buildSms( + $plugin, + $tpl, + 'new_file_shared_course_by.tpl', + 'XNewFileSharedCourseXByX', + [ + api_get_setting('siteName'), + $additionalParameters['courseTitle'], + $additionalParameters['userUsername'], + ] + ); + break; + case SmsPlugin::ACCOUNT_APPROVED_CONNECT: + return $this->buildSms( + $plugin, + $tpl, + 'account_approved_connect.tpl', + 'XAccountApprovedConnectX', + [ + api_get_setting('siteName'), + $tpl->params['_p']['web'], + ] + ); + break; + case SmsPlugin::NEW_COURSE_BEEN_CREATED: + return $this->buildSms( + $plugin, + $tpl, + 'new_course_been_created.tpl', + 'XNewCourseXBeenCreatedX', + [ + api_get_setting('siteName'), + $additionalParameters['courseName'], + $additionalParameters['creatorUsername'], + ] + ); + break; + case SmsPlugin::NEW_USER_SUBSCRIBED_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'new_user_subscribed_course.tpl', + 'XNewUserXSubscribedCourseX', + [ + api_get_setting('siteName'), + $additionalParameters['userUsername'], + $additionalParameters['courseCode'], + ] + ); + break; + case SmsPlugin::NEW_COURSE_SUGGESTED_TEACHER: + return $this->buildSms( + $plugin, + $tpl, + 'new_course_suggested_teacher.tpl', + 'XNewCourseSuggestedTeacherX', + [ + api_get_setting('siteName'), + $additionalParameters['userUsername'], + ] + ); + break; + case SmsPlugin::COURSE_OPENING_REQUEST_CODE_REGISTERED: + return $this->buildSms( + $plugin, + $tpl, + 'course_opening_request_code_registered.tpl', + 'XCourseOpeningRequestCodeXRegistered', + [ + api_get_setting('siteName'), + $additionalParameters['courseCode'], + ] + ); + break; + case SmsPlugin::COURSE_OPENING_REQUEST_CODE_APPROVED: + return $this->buildSms( + $plugin, + $tpl, + 'course_opening_request_course_code_approved.tpl', + 'XCourseOpeningRequestCourseCodeXApproved', + [ + api_get_setting('siteName'), + $additionalParameters['courseCode'], + ] + ); + break; + case SmsPlugin::COURSE_OPENING_REQUEST_CODE_REJECTED: + return $this->buildSms( + $plugin, + $tpl, + 'request_open_course_code_rejected.tpl', + 'XRequestOpenCourseCodeXReject', + [ + api_get_setting('siteName'), + $additionalParameters['courseCode'], + ] + ); + break; + case SmsPlugin::COURSE_OPENING_REQUEST_CODE: + return $this->buildSms( + $plugin, + $tpl, + 'course_opening_request_course_code.tpl', + 'XCourseOpeningRequestCourseCodeX', + [ + api_get_setting('siteName'), + $additionalParameters['courseCode'], + ] + ); + break; + case SmsPlugin::BEEN_SUBSCRIBED_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'been_subscribed_course.tpl', + 'XBeenSubscribedCourseX', + [ + api_get_setting('siteName'), + $additionalParameters['courseTitle'], + ] + ); + break; + case SmsPlugin::ASSIGNMENT_BEEN_CREATED_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'assignment_been_created_course.tpl', + 'XAssignmentBeenCreatedCourseX', + [ + api_get_setting('siteName'), + $additionalParameters['courseTitle'], + ] + ); + break; + case SmsPlugin::CERTIFICATE_NOTIFICATION: + return $this->buildSms( + $plugin, + $tpl, + 'certificate_notification.tpl', + '', + $additionalParameters + ); + break; + // Message types to be implemented. Fill the array parameter with arguments. + /*case SmsPlugin::ACCOUNT_CREATED_UPDATED_LOGIN_PASSWORD: + return $this->buildSms( + $plugin, + $tpl, + 'account_created_updated_login_password.tpl', + 'XAccountCreatedUpdatedLoginXPasswordX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::PASSWORD_UPDATED_LOGIN_PASSWORD: + return $this->buildSms( + $plugin, + $tpl, + 'password_updated_login_password.tpl', + 'XPasswordUpdatedLoginXPasswordX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::REQUESTED_PASSWORD_CHANGE: + return $this->buildSms( + $plugin, + $tpl, + 'requested_password_change.tpl', + 'XPasswordUpdatedLoginXPasswordX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::RECEIVED_NEW_PERSONAL_MESSAGES: + return $this->buildSms( + $plugin, + $tpl, + 'received_new_personal_messages.tpl', + 'XReceivedNewPersonalMessages', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::NEW_USER_PENDING_APPROVAL: + return $this->buildSms( + $plugin, + $tpl, + 'new_user_pending_approval.tpl', + 'XNewUserXPendingApproval', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::POSTED_FORUM_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'posted_forum_course.tpl', + 'XXPostedForumXCourseX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::CHECK_EMAIL_CONNECT_MORE_INFO: + return $this->buildSms( + $plugin, + $tpl, + 'check_email_connect_more_info.tpl', + 'XXXCheckEmailConnectMoreInfo', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::STUDENT_ANSWERED_TEST: + return $this->buildSms( + $plugin, + $tpl, + 'student_answered_test.tpl', + 'XXStudentXAnsweredTestX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::STUDENT_ANSWERED_TEST_OPEN_QUESTION: + return $this->buildSms( + $plugin, + $tpl, + 'student_answered_test_open_question.tpl', + 'XXStudentXAnsweredTestXOpenQuestion', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::STUDENT_ANSWERED_TEST_VOICE_QUESTION: + return $this->buildSms( + $plugin, + $tpl, + 'student_answered_test_voice_question.tpl', + 'XXStudentXAnsweredTestXVoiceQuestion', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::ANSWER_OPEN_QUESTION_TEST_REVIEWED: + return $this->buildSms( + $plugin, + $tpl, + 'answer_open_question_test_reviewed.tpl', + 'XXAnswerOpenQuestionTestXReviewed', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::NEW_THREAD_STARTED_FORUM: + return $this->buildSms( + $plugin, + $tpl, + 'new_thread_started_forum.tpl', + 'XXNewThreadXStartedForumX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::NEW_ANSWER_POSTED_FORUM: + return $this->buildSms( + $plugin, + $tpl, + 'new_answer_posted_forum.tpl', + 'XXNewAnswerPostedXForumX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::NEW_SYSTEM_ANNOUNCEMENT_ADDED: + return $this->buildSms( + $plugin, + $tpl, + 'new_system_announcement_added.tpl', + 'XXNewSystemAnnouncementAdded', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::TEST_NEW_SYSTEM_ANNOUNCEMENT_ADDED: + return $this->buildSms( + $plugin, + $tpl, + 'test_new_system_announcement_added.tpl', + 'XTestXNewSystemAnnouncementAdded', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::SYSTEM_ANNOUNCEMENT_UPDATE: + return $this->buildSms( + $plugin, + $tpl, + 'system_announcement_update.tpl', + 'XXSystemAnnouncementUpdate', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::TEST_SYSTEM_ANNOUNCEMENT_UPDATE: + return $this->buildSms( + $plugin, + $tpl, + 'test_system_announcement_update.tpl', + 'XXSystemAnnouncementUpdate', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_COURSE_STUDENT_SUBMITS_PAPER: + return $this->buildSms( + $plugin, + $tpl, + 'user_uploaded_assignment_course_student_submits_paper.tpl', + 'XUserXUploadedAssignmentXCourseXStudentSubmitsPaper', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_CHECK_STUDENT_SUBMITS_PAPER: + return $this->buildSms( + $plugin, + $tpl, + 'user_uploaded_assignment_check_student_submits_paper.tpl', + 'XUserXUploadedAssignmentXCheckXStudentSubmitsPaper', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'user_uploaded_assignment_course.tpl', + 'XUserXUploadedAssignmentXCourseX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_CHECK: + return $this->buildSms( + $plugin, + $tpl, + 'user_uploaded_assignment_check.tpl', + 'XUserXUploadedAssignmentXCheckX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::SUBSCRIBED_SESSION: + return $this->buildSms( + $plugin, + $tpl, + 'subscribed_session.tpl', + 'XSubscribedSessionX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::SUBSCRIBED_SESSION_CSV: + return $this->buildSms( + $plugin, + $tpl, + 'subscribed_session_csv.tpl', + 'XSubscribedSessionXCSV', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_SUGGESTED_BE_FRIENDS: + return $this->buildSms( + $plugin, + $tpl, + 'user_suggested_be_friends.tpl', + 'XUserXSuggestedBeFriends', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_ANSWERED_INBOX_MESSAGE: + return $this->buildSms( + $plugin, + $tpl, + 'user_answered_inbox_message.tpl', + 'XUserXAnsweredInboxMessage', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::BEEN_INVITED_JOIN_GROUP: + return $this->buildSms( + $plugin, + $tpl, + 'been_invited_join_group.tpl', + 'XBeenInvitedJoinGroupX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::MESSAGES_SENT_EDITED_GROUP_EDITED: + return $this->buildSms( + $plugin, + $tpl, + 'messages_sent_edited_group_edited.tpl', + 'XMessagesSentEditedGroupXEdited', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::MESSAGES_SENT_EDITED_GROUP_ADDED: + return $this->buildSms( + $plugin, + $tpl, + 'messages_sent_edited_group_added.tpl', + 'XMessagesSentEditedGroupXAdded', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::BEEN_INVITED_COMPLETE_SURVEY_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'been_invited_complete_survey_course.tpl', + 'XBeenInvitedCompleteSurveyXCourseX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::REMINDER_ASSIGNMENT_COURSE_DUE: + return $this->buildSms( + $plugin, + $tpl, + 'reminder_assignment_course_due.tpl', + 'XReminderAssignmentXCourseXDue', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_DETAILS_MODIFIED: + return $this->buildSms( + $plugin, + $tpl, + 'user_details_modified.tpl', + 'XUserDetailsModified', + array( + api_get_setting('siteName') + ) + ); + break;*/ + default: + return ''; + } + } +} diff --git a/plugin/clockworksms/lib/clockworksms_plugin.class.php b/plugin/clockworksms/lib/clockworksms_plugin.class.php new file mode 100644 index 000000000..257860ae9 --- /dev/null +++ b/plugin/clockworksms/lib/clockworksms_plugin.class.php @@ -0,0 +1,50 @@ + + * @author Julio Montoya - Refactor code + */ +class ClockworksmsPlugin extends SmsPlugin +{ + /** + * Constructor. + */ + public function __construct() + { + $fields = ['tool_enable' => 'boolean', 'api_key' => 'text']; + $smsTypeOptions = $this->getSmsTypeOptions(); + foreach ($smsTypeOptions as $smsTypeOption) { + $fields[$smsTypeOption] = 'checkbox'; + } + parent::__construct('0.1', 'Imanol Losada', $fields); + } + + /** + * create (a singleton function that ensures ClockworksmsPlugin instance is + * created only once. If it is already created, it returns the instance). + * + * @return object ClockworksmsPlugin instance + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * install (uninstalls the plugin and removes all plugin's tables and/or rows). + */ + public function uninstall() + { + $tSettings = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT); + $sql = "DELETE FROM $tSettings WHERE subkey = 'clockworksms'"; + Database::query($sql); + } +} diff --git a/plugin/clockworksms/license.txt b/plugin/clockworksms/license.txt new file mode 100644 index 000000000..b70d65ea2 --- /dev/null +++ b/plugin/clockworksms/license.txt @@ -0,0 +1,5 @@ +This plugin, as the rest of Chamilo, is released under the GNU/GPLv3 license. + +The Clockworks library included is provided under the ICS license, compatible +with GNU/GPLv3. See https://github.com/mediaburst/clockwork-php/issues/3 for +details. \ No newline at end of file diff --git a/plugin/clockworksms/plugin.php b/plugin/clockworksms/plugin.php new file mode 100644 index 000000000..bdc6f9fa4 --- /dev/null +++ b/plugin/clockworksms/plugin.php @@ -0,0 +1,11 @@ + + */ +require_once __DIR__.'/config.php'; + +$plugin_info = ClockworksmsPlugin::create()->get_info(); diff --git a/plugin/clockworksms/sms_templates/account_approved_connect.tpl b/plugin/clockworksms/sms_templates/account_approved_connect.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/account_approved_connect.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/account_created_updated_login_password.tpl b/plugin/clockworksms/sms_templates/account_created_updated_login_password.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/account_created_updated_login_password.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/answer_open_question_test_reviewed.tpl b/plugin/clockworksms/sms_templates/answer_open_question_test_reviewed.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/answer_open_question_test_reviewed.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/assignment_been_created_course.tpl b/plugin/clockworksms/sms_templates/assignment_been_created_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/assignment_been_created_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/been_invited_complete_survey_course.tpl b/plugin/clockworksms/sms_templates/been_invited_complete_survey_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/been_invited_complete_survey_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/been_invited_join_group.tpl b/plugin/clockworksms/sms_templates/been_invited_join_group.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/been_invited_join_group.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/been_subscribed_course.tpl b/plugin/clockworksms/sms_templates/been_subscribed_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/been_subscribed_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/certificate_notification.tpl b/plugin/clockworksms/sms_templates/certificate_notification.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/certificate_notification.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/check_email_connect_more_info.tpl b/plugin/clockworksms/sms_templates/check_email_connect_more_info.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/check_email_connect_more_info.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/course_opening_request_code_registered.tpl b/plugin/clockworksms/sms_templates/course_opening_request_code_registered.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/course_opening_request_code_registered.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/course_opening_request_course_code.tpl b/plugin/clockworksms/sms_templates/course_opening_request_course_code.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/course_opening_request_course_code.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/course_opening_request_course_code_approved.tpl b/plugin/clockworksms/sms_templates/course_opening_request_course_code_approved.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/course_opening_request_course_code_approved.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/messages_sent_edited_group_added.tpl b/plugin/clockworksms/sms_templates/messages_sent_edited_group_added.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/messages_sent_edited_group_added.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/messages_sent_edited_group_edited.tpl b/plugin/clockworksms/sms_templates/messages_sent_edited_group_edited.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/messages_sent_edited_group_edited.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/new_answer_posted_forum.tpl b/plugin/clockworksms/sms_templates/new_answer_posted_forum.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/new_answer_posted_forum.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/new_course_been_created.tpl b/plugin/clockworksms/sms_templates/new_course_been_created.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/new_course_been_created.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/new_course_suggested_teacher.tpl b/plugin/clockworksms/sms_templates/new_course_suggested_teacher.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/new_course_suggested_teacher.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/new_file_shared_course_by.tpl b/plugin/clockworksms/sms_templates/new_file_shared_course_by.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/new_file_shared_course_by.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/new_system_announcement_added.tpl b/plugin/clockworksms/sms_templates/new_system_announcement_added.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/new_system_announcement_added.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/new_thread_started_forum.tpl b/plugin/clockworksms/sms_templates/new_thread_started_forum.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/new_thread_started_forum.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/new_user_pending_approval.tpl b/plugin/clockworksms/sms_templates/new_user_pending_approval.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/new_user_pending_approval.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/new_user_subscribed_course.tpl b/plugin/clockworksms/sms_templates/new_user_subscribed_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/new_user_subscribed_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/password_updated_login_password.tpl b/plugin/clockworksms/sms_templates/password_updated_login_password.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/password_updated_login_password.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/posted_forum_course.tpl b/plugin/clockworksms/sms_templates/posted_forum_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/posted_forum_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/received_new_personal_messages.tpl b/plugin/clockworksms/sms_templates/received_new_personal_messages.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/received_new_personal_messages.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/reminder_assignment_course_due.tpl b/plugin/clockworksms/sms_templates/reminder_assignment_course_due.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/reminder_assignment_course_due.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/request_open_course_code_rejected.tpl b/plugin/clockworksms/sms_templates/request_open_course_code_rejected.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/request_open_course_code_rejected.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/requested_password_change.tpl b/plugin/clockworksms/sms_templates/requested_password_change.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/requested_password_change.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/student_answered_test.tpl b/plugin/clockworksms/sms_templates/student_answered_test.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/student_answered_test.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/student_answered_test_open_question.tpl b/plugin/clockworksms/sms_templates/student_answered_test_open_question.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/student_answered_test_open_question.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/student_answered_test_voice_question.tpl b/plugin/clockworksms/sms_templates/student_answered_test_voice_question.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/student_answered_test_voice_question.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/subscribed_session.tpl b/plugin/clockworksms/sms_templates/subscribed_session.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/subscribed_session.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/subscribed_session_csv.tpl b/plugin/clockworksms/sms_templates/subscribed_session_csv.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/subscribed_session_csv.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/system_announcement_update.tpl b/plugin/clockworksms/sms_templates/system_announcement_update.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/system_announcement_update.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/test_new_system_announcement_added.tpl b/plugin/clockworksms/sms_templates/test_new_system_announcement_added.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/test_new_system_announcement_added.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/test_system_announcement_update.tpl b/plugin/clockworksms/sms_templates/test_system_announcement_update.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/test_system_announcement_update.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/user_answered_inbox_message.tpl b/plugin/clockworksms/sms_templates/user_answered_inbox_message.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/user_answered_inbox_message.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/user_details_modified.tpl b/plugin/clockworksms/sms_templates/user_details_modified.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/user_details_modified.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/user_suggested_be_friends.tpl b/plugin/clockworksms/sms_templates/user_suggested_be_friends.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/user_suggested_be_friends.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/user_uploaded_assignment_check.tpl b/plugin/clockworksms/sms_templates/user_uploaded_assignment_check.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/user_uploaded_assignment_check.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/user_uploaded_assignment_check_student_submits_paper.tpl b/plugin/clockworksms/sms_templates/user_uploaded_assignment_check_student_submits_paper.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/user_uploaded_assignment_check_student_submits_paper.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/user_uploaded_assignment_course.tpl b/plugin/clockworksms/sms_templates/user_uploaded_assignment_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/user_uploaded_assignment_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/user_uploaded_assignment_course_student_submits_paper.tpl b/plugin/clockworksms/sms_templates/user_uploaded_assignment_course_student_submits_paper.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/user_uploaded_assignment_course_student_submits_paper.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/sms_templates/welcome_login_password.tpl b/plugin/clockworksms/sms_templates/welcome_login_password.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/clockworksms/sms_templates/welcome_login_password.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/clockworksms/uninstall.php b/plugin/clockworksms/uninstall.php new file mode 100644 index 000000000..34e9e6f8d --- /dev/null +++ b/plugin/clockworksms/uninstall.php @@ -0,0 +1,14 @@ + + */ +require_once __DIR__.'/config.php'; +ClockworksmsPlugin::create()->uninstall(); diff --git a/plugin/clockworksms/vendor/changelog.md b/plugin/clockworksms/vendor/changelog.md new file mode 100644 index 000000000..bf6023876 --- /dev/null +++ b/plugin/clockworksms/vendor/changelog.md @@ -0,0 +1,22 @@ +# Changelog + +## 1.0 (July 19th, 2012) + +* Initial release. [JI/MS] + +### 1.1 (August 21st, 2012) + +* Added /get_key functionality to translate a legacy Mediaburst username and password into a new Clockwork API key. [JI] +* Deprecated `checkCredit()` and replaced with `checkBalance()` [JI] + +### 1.2 (September 7th, 2012) + +* Added various new Wordpress classes, including the Clockwork_Plugin class for writing plugins based on Clockwork. [JI] + +### 1.3 (September 18th, 2012) + +* Added `is_valid_msisdn()` method. [JI] + +#### 1.3.1 (November 13th, 2012) + +* Updated `is_valid_msisdn()` method to handle 9-digit phone numbers, e.g. Norway. [JI] \ No newline at end of file diff --git a/plugin/clockworksms/vendor/clockworksms_api.php b/plugin/clockworksms/vendor/clockworksms_api.php new file mode 100644 index 000000000..2c3662421 --- /dev/null +++ b/plugin/clockworksms/vendor/clockworksms_api.php @@ -0,0 +1,643 @@ +key = $key; + } + + $this->ssl = (array_key_exists('ssl', $options)) ? $options['ssl'] : null; + $this->proxy_host = (array_key_exists('proxy_host', $options)) ? $options['proxy_host'] : null; + $this->proxy_port = (array_key_exists('proxy_port', $options)) ? $options['proxy_port'] : null; + $this->from = (array_key_exists('from', $options)) ? $options['from'] : null; + $this->long = (array_key_exists('long', $options)) ? $options['long'] : null; + $this->truncate = (array_key_exists('truncate', $options)) ? $options['truncate'] : null; + $this->invalid_char_action = (array_key_exists('invalid_char_action', $options)) ? $options['invalid_char_action'] : null; + $this->log = (array_key_exists('log', $options)) ? $options['log'] : false; + } + + /** + * Send some text messages + * + * + * @author Martin Steel + */ + public function send(array $sms) { + if (!is_array($sms)) { + throw new ClockworkException("sms parameter must be an array"); + } + $single_message = $this->is_assoc($sms); + + if ($single_message) { + $sms = array($sms); + } + + $req_doc = new DOMDocument('1.0', 'UTF-8'); + $root = $req_doc->createElement('Message'); + $req_doc->appendChild($root); + + $user_node = $req_doc->createElement('Key'); + $user_node->appendChild($req_doc->createTextNode($this->key)); + $root->appendChild($user_node); + + for ($i = 0; $i < count($sms); $i++) { + $single = $sms[$i]; + + $sms_node = $req_doc->createElement('SMS'); + + // Phone number + $sms_node->appendChild($req_doc->createElement('To', $single['to'])); + + // Message text + $content_node = $req_doc->createElement('Content'); + $content_node->appendChild($req_doc->createTextNode($single['message'])); + $sms_node->appendChild($content_node); + + // From + if (array_key_exists('from', $single) || isset($this->from)) { + $from_node = $req_doc->createElement('From'); + $from_node->appendChild($req_doc->createTextNode(array_key_exists('from', $single) ? $single['from'] : $this->from)); + $sms_node->appendChild($from_node); + } + + // Client ID + if (array_key_exists('client_id', $single)) { + $client_id_node = $req_doc->createElement('ClientID'); + $client_id_node->appendChild($req_doc->createTextNode($single['client_id'])); + $sms_node->appendChild($client_id_node); + } + + // Long + if (array_key_exists('long', $single) || isset($this->long)) { + $long = array_key_exists('long', $single) ? $single['long'] : $this->long; + $long_node = $req_doc->createElement('Long'); + $long_node->appendChild($req_doc->createTextNode($long ? 1 : 0)); + $sms_node->appendChild($long_node); + } + + // Truncate + if (array_key_exists('truncate', $single) || isset($this->truncate)) { + $truncate = array_key_exists('truncate', $single) ? $single['truncate'] : $this->truncate; + $trunc_node = $req_doc->createElement('Truncate'); + $trunc_node->appendChild($req_doc->createTextNode($truncate ? 1 : 0)); + $sms_node->appendChild($trunc_node); + } + + // Invalid Char Action + if (array_key_exists('invalid_char_action', $single) || isset($this->invalid_char_action)) { + $action = array_key_exists('invalid_char_action', $single) ? $single['invalid_char_action'] : $this->invalid_char_action; + switch (strtolower($action)) { + case 'error': + $sms_node->appendChild($req_doc->createElement('InvalidCharAction', 1)); + break; + case 'remove': + $sms_node->appendChild($req_doc->createElement('InvalidCharAction', 2)); + break; + case 'replace': + $sms_node->appendChild($req_doc->createElement('InvalidCharAction', 3)); + break; + default: + break; + } + } + + // Wrapper ID + $sms_node->appendChild($req_doc->createElement('WrapperID', $i)); + + $root->appendChild($sms_node); + } + + $req_xml = $req_doc->saveXML(); + + $resp_xml = $this->postToClockwork(self::API_SMS_METHOD, $req_xml); + $resp_doc = new DOMDocument(); + $resp_doc->loadXML($resp_xml); + + $response = array(); + $err_no = null; + $err_desc = null; + + foreach($resp_doc->documentElement->childNodes AS $doc_child) { + switch(strtolower($doc_child->nodeName)) { + case 'sms_resp': + $resp = array(); + $wrapper_id = null; + foreach($doc_child->childNodes AS $resp_node) { + switch(strtolower($resp_node->nodeName)) { + case 'messageid': + $resp['id'] = $resp_node->nodeValue; + break; + case 'errno': + $resp['error_code'] = $resp_node->nodeValue; + break; + case 'errdesc': + $resp['error_message'] = $resp_node->nodeValue; + break; + case 'wrapperid': + $wrapper_id = $resp_node->nodeValue; + break; + } + } + if( array_key_exists('error_code', $resp ) ) + { + $resp['success'] = 0; + } else { + $resp['success'] = 1; + } + $resp['sms'] = $sms[$wrapper_id]; + array_push($response, $resp); + break; + case 'errno': + $err_no = $doc_child->nodeValue; + break; + case 'errdesc': + $err_desc = $doc_child->nodeValue; + break; + } + } + + if (isset($err_no)) { + throw new ClockworkException($err_desc, $err_no); + } + + if ($single_message) { + return $response[0]; + } else { + return $response; + } + } + + /** + * Check how many SMS credits you have available + * + * @return integer SMS credits remaining + * @deprecated Use checkBalance() instead + * @author Martin Steel + */ + public function checkCredit() { + // Create XML doc for request + $req_doc = new DOMDocument('1.0', 'UTF-8'); + $root = $req_doc->createElement('Credit'); + $req_doc->appendChild($root); + $root->appendChild($req_doc->createElement('Key', $this->key)); + $req_xml = $req_doc->saveXML(); + + // POST XML to Clockwork + $resp_xml = $this->postToClockwork(self::API_CREDIT_METHOD, $req_xml); + + // Create XML doc for response + $resp_doc = new DOMDocument(); + $resp_doc->loadXML($resp_xml); + + // Parse the response to find credit value + $credit; + $err_no = null; + $err_desc = null; + + foreach ($resp_doc->documentElement->childNodes AS $doc_child) { + switch ($doc_child->nodeName) { + case "Credit": + $credit = $doc_child->nodeValue; + break; + case "ErrNo": + $err_no = $doc_child->nodeValue; + break; + case "ErrDesc": + $err_desc = $doc_child->nodeValue; + break; + default: + break; + } + } + + if (isset($err_no)) { + throw new ClockworkException($err_desc, $err_no); + } + return $credit; + } + + /** + * Check your account balance + * + * @return array Array of account balance: + * @author Martin Steel + */ + public function checkBalance() { + // Create XML doc for request + $req_doc = new DOMDocument('1.0', 'UTF-8'); + $root = $req_doc->createElement('Balance'); + $req_doc->appendChild($root); + $root->appendChild($req_doc->createElement('Key', $this->key)); + $req_xml = $req_doc->saveXML(); + + // POST XML to Clockwork + $resp_xml = $this->postToClockwork(self::API_BALANCE_METHOD, $req_xml); + + // Create XML doc for response + $resp_doc = new DOMDocument(); + $resp_doc->loadXML($resp_xml); + + // Parse the response to find balance value + $balance = null; + $err_no = null; + $err_desc = null; + + foreach ($resp_doc->documentElement->childNodes as $doc_child) { + switch ($doc_child->nodeName) { + case "Balance": + $balance = number_format(floatval($doc_child->nodeValue), 2); + break; + case "Currency": + foreach ($doc_child->childNodes as $resp_node) { + switch ($resp_node->tagName) { + case "Symbol": + $symbol = $resp_node->nodeValue; + break; + case "Code": + $code = $resp_node->nodeValue; + break; + } + } + break; + case "ErrNo": + $err_no = $doc_child->nodeValue; + break; + case "ErrDesc": + $err_desc = $doc_child->nodeValue; + break; + default: + break; + } + } + + if (isset($err_no)) { + throw new ClockworkException($err_desc, $err_no); + } + + return array( 'symbol' => $symbol, 'balance' => $balance, 'code' => $code ); + } + + /** + * Check whether the API Key is valid + * + * @return bool True indicates a valid key + * @author Martin Steel + */ + public function checkKey() { + // Create XML doc for request + $req_doc = new DOMDocument('1.0', 'UTF-8'); + $root = $req_doc->createElement('Authenticate'); + $req_doc->appendChild($root); + $root->appendChild($req_doc->createElement('Key', $this->key)); + $req_xml = $req_doc->saveXML(); + + // POST XML to Clockwork + $resp_xml = $this->postToClockwork(self::API_AUTH_METHOD, $req_xml); + + // Create XML doc for response + $resp_doc = new DOMDocument(); + $resp_doc->loadXML($resp_xml); + + // Parse the response to see if authenticated + $cust_id; + $err_no = null; + $err_desc = null; + + foreach ($resp_doc->documentElement->childNodes AS $doc_child) { + switch ($doc_child->nodeName) { + case "CustID": + $cust_id = $doc_child->nodeValue; + break; + case "ErrNo": + $err_no = $doc_child->nodeValue; + break; + case "ErrDesc": + $err_desc = $doc_child->nodeValue; + break; + default: + break; + } + } + + if (isset($err_no)) { + throw new ClockworkException($err_desc, $err_no); + } + return isset($cust_id); + } + + /** + * Make an HTTP POST to Clockwork + * + * @param string method Clockwork method to call (sms/credit) + * @param string data Content of HTTP POST + * + * @return string Response from Clockwork + * @author Martin Steel + */ + protected function postToClockwork($method, $data) { + if ($this->log) { + $this->logXML("API $method Request XML", $data); + } + + if( isset( $this->ssl ) ) { + $ssl = $this->ssl; + } else { + $ssl = $this->sslSupport(); + } + + $url = $ssl ? 'https://' : 'http://'; + $url .= self::API_BASE_URL . $method; + + $response = $this->xmlPost($url, $data); + + if ($this->log) { + $this->logXML("API $method Response XML", $response); + } + + return $response; + } + + /** + * Make a HTTP POST + * + * cURL will be used if available, otherwise tries the PHP stream functions + * + * @param string url URL to send to + * @param string data Data to POST + * @return string Response returned by server + * @author Martin Steel + */ + protected function xmlPost($url, $data) { + if(extension_loaded('curl')) { + $ch = curl_init($url); + curl_setopt($ch, CURLOPT_POST, 1); + curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); + curl_setopt($ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml")); + curl_setopt($ch, CURLOPT_USERAGENT, 'Clockwork PHP Wrapper/1.0' . self::VERSION); + curl_setopt($ch, CURLOPT_POSTFIELDS, $data); + if (isset($this->proxy_host) && isset($this->proxy_port)) { + curl_setopt($ch, CURLOPT_PROXY, $this->proxy_host); + curl_setopt($ch, CURLOPT_PROXYPORT, $this->proxy_port); + } + + $response = curl_exec($ch); + $info = curl_getinfo($ch); + + if ($response === false || $info['http_code'] != 200) { + throw new Exception('HTTP Error calling Clockwork API - HTTP Status: ' . $info['http_code'] . ' - cURL Erorr: ' . curl_error($ch)); + } elseif (curl_errno($ch) > 0) { + throw new Exception('HTTP Error calling Clockwork API - cURL Error: ' . curl_error($ch)); + } + + curl_close($ch); + + return $response; + } elseif (function_exists('stream_get_contents')) { + // Enable error Track Errors + $track = ini_get('track_errors'); + ini_set('track_errors',true); + + $params = array('http' => array( + 'method' => 'POST', + 'header' => "Content-Type: text/xml\r\nUser-Agent: mediaburst PHP Wrapper/" . self::VERSION . "\r\n", + 'content' => $data + )); + + if (isset($this->proxy_host) && isset($this->proxy_port)) { + $params['http']['proxy'] = 'tcp://'.$this->proxy_host . ':' . $this->proxy_port; + $params['http']['request_fulluri'] = True; + } + + $ctx = stream_context_create($params); + $fp = @fopen($url, 'rb', false, $ctx); + if (!$fp) { + ini_set('track_errors',$track); + throw new Exception("HTTP Error calling Clockwork API - fopen Error: $php_errormsg"); + } + $response = @stream_get_contents($fp); + if ($response === false) { + ini_set('track_errors',$track); + throw new Exception("HTTP Error calling Clockwork API - stream Error: $php_errormsg"); + } + ini_set('track_errors',$track); + return $response; + } else { + throw new Exception("Clockwork requires PHP5 with cURL or HTTP stream support"); + } + } + + /** + * Does the server/HTTP wrapper support SSL + * + * This is a best guess effort, some servers have weird setups where even + * though cURL is compiled with SSL support is still fails to make + * any requests. + * + * @return bool True if SSL is supported + * @author Martin Steel + */ + protected function sslSupport() { + $ssl = false; + // See if PHP is compiled with cURL + if (extension_loaded('curl')) { + $version = curl_version(); + $ssl = ($version['features'] & CURL_VERSION_SSL) ? true : false; + } elseif (extension_loaded('openssl')) { + $ssl = true; + } + return $ssl; + } + + /** + * Log some XML, tidily if possible, in the PHP error log + * + * @param string log_msg The log message to prepend to the XML + * @param string xml An XML formatted string + * + * @return void + * @author Martin Steel + */ + protected function logXML($log_msg, $xml) { + // Tidy if possible + if (class_exists('tidy')) { + $tidy = new tidy; + $config = array( + 'indent' => true, + 'input-xml' => true, + 'output-xml' => true, + 'wrap' => 200 + ); + $tidy->parseString($xml, $config, 'utf8'); + $tidy->cleanRepair(); + $xml = $tidy; + } + // Output + error_log("Clockwork $log_msg: $xml"); + } + + /** + * Check if an array is associative + * + * @param array $array Array to check + * @return bool + * @author Martin Steel + */ + protected function is_assoc($array) { + return (bool)count(array_filter(array_keys($array), 'is_string')); + } + + /** + * Check if a number is a valid MSISDN + * + * @param string $val Value to check + * @return bool True if valid MSISDN + * @author James Inman + * @since 1.3.0 + * @todo Take an optional country code and check that the number starts with it + */ + public static function is_valid_msisdn($val) { + return preg_match( '/^[1-9][0-9]{7,12}$/', $val ); + } + +} diff --git a/plugin/clockworksms/vendor/exception.php b/plugin/clockworksms/vendor/exception.php new file mode 100644 index 000000000..bf8d63ee8 --- /dev/null +++ b/plugin/clockworksms/vendor/exception.php @@ -0,0 +1,27 @@ + + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + diff --git a/plugin/clockworksms/vendor/license.txt~ b/plugin/clockworksms/vendor/license.txt~ new file mode 100644 index 000000000..382c1173e --- /dev/null +++ b/plugin/clockworksms/vendor/license.txt~ @@ -0,0 +1,13 @@ +Copyright (c) 2011 - 2012, Mediaburst Ltd + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. \ No newline at end of file diff --git a/plugin/clockworksms/vendor/readme.md b/plugin/clockworksms/vendor/readme.md new file mode 100644 index 000000000..fc536fb62 --- /dev/null +++ b/plugin/clockworksms/vendor/readme.md @@ -0,0 +1,253 @@ +# Clockwork SMS API Wrapper for PHP + +This wrapper lets you interact with Clockwork without the hassle of having to create any XML or make HTTP calls. + +## What's Clockwork? + +[Clockwork][2] is Mediaburst's SMS API. + +### Prerequisites + +* A [Clockwork][2] account + +## Usage + +Require the Clockwork library: + +```php +require 'class-Clockwork.php'; +``` + +### Sending a message + +```php +$clockwork = new Clockwork( $API_KEY ); +$message = array( 'to' => '441234567891', 'message' => 'This is a test!' ); +$result = $clockwork->send( $message ); +``` + +### Sending multiple messages + +We recommend you use batch sizes of 500 messages or fewer. By limiting the batch size it prevents any timeouts when sending. + +```php +$clockwork = new Clockwork( $API_KEY ); +$messages = array( + array( 'to' => '441234567891', 'message' => 'This is a test!' ), + array( 'to' => '441234567892', 'message' => 'This is a test 2!' ) +); +$results = $clockwork->send( $messages ); +``` + +### Handling the response + +The responses come back as arrays, these contain the unique Clockwork message ID, whether the message worked (`success`), and the original SMS so you can update your database. + + Array + ( + [id] => VE_164732148 + [success] => 1 + [sms] => Array + ( + [to] => 441234567891 + [message] => This is a test! + ) + + ) + +If you send multiple SMS messages in a single send, you'll get back an array of results, one per SMS. + +The result will look something like this: + + Array + ( + [0] => Array + ( + [id] => VI_143228951 + [success] => 1 + [sms] => Array + ( + [to] => 441234567891 + [message] => This is a test! + ) + + ) + + [1] => Array + ( + [id] => VI_143228952 + [success] => 1 + [sms] => Array + ( + [to] => 441234567892 + [message] => This is a test 2! + ) + + ) + + ) + +If a message fails, the reason for failure will be set in `error_code` and `error_message`. + +For example, if you send to invalid phone number "abc": + + Array + ( + [error_code] => 10 + [error_message] => Invalid 'To' Parameter + [success] => 0 + [sms] => Array + ( + [to] => abc + [message] => This is a test! + ) + + ) + +### Checking your balance + +Check your available SMS balance: + +```php +$clockwork = new Clockwork( $API_KEY ); +$clockwork->checkBalance(); +``` + +This will return: + + Array + ( + [symbol] => £ + [balance] => 351.91 + [code] => GBP + ) + +### Handling Errors + +The Clockwork wrapper will throw a `ClockworkException` if the entire call failed. + +```php +try +{ + $clockwork = new Clockwork( 'invalid_key' ); + $message = array( 'to' => 'abc', 'message' => 'This is a test!' ); + $result = $clockwork->send( $message ); +} +catch( ClockworkException $e ) +{ + print $e->getMessage(); + // Invalid API Key +} +``` + +### Advanced Usage + +This class has a few additional features that some users may find useful, if these are not set your account defaults will be used. + +### Optional Parameters + +See the [Clockwork Documentation](http://www.clockworksms.com/doc/clever-stuff/xml-interface/send-sms/) for full details on these options. + +* $from [string] + + The from address displayed on a phone when they receive a message + +* $long [boolean] + + Enable long SMS. A standard text can contain 160 characters, a long SMS supports up to 459. + +* $truncate [nullable boolean] + + Truncate the message payload if it is too long, if this is set to false, the message will fail if it is too long. + +* $invalid_char_action [string] + + What to do if the message contains an invalid character. Possible values are + * error - Fail the message + * remove - Remove the invalid characters then send + * replace - Replace some common invalid characters such as replacing curved quotes with straight quotes + +* $ssl [boolean, default: true] + + Use SSL when making an HTTP request to the Clockwork API + + +### Setting Options + +#### Global Options + +Options set on the API object will apply to all SMS messages unless specifically overridden. + +In this example both messages will be sent from Clockwork: + +```php +$options = array( 'from' => 'Clockwork' ); +$clockwork = new Clockwork( $API_KEY, $options ); +$messages = array( + array( 'to' => '441234567891', 'message' => 'This is a test!' ), + array( 'to' => '441234567892', 'message' => 'This is a test 2!' ) +); +$results = $clockwork->send( $messages ); +``` + +#### Per-message Options + +Set option values individually on each message. + +In this example, one message will be from Clockwork and the other from 84433: + +```php +$clockwork = new Clockwork( $API_KEY, $options ); +$messages = array( + array( 'to' => '441234567891', 'message' => 'This is a test!', 'from' => 'Clockwork' ), + array( 'to' => '441234567892', 'message' => 'This is a test 2!', 'from' => '84433' ) +); +$results = $clockwork->send( $messages ); +``` + +### SSL Errors + +Due to the huge variety of PHP setups out there a small proportion of users may get PHP errors when making API calls due to their SSL configuration. + +The errors will generally look something like this: + +``` +Fatal error: +Uncaught exception 'Exception' with message 'HTTP Error calling Clockwork API +HTTP Status: 0 +cURL Erorr: SSL certificate problem, verify that the CA cert is OK. +Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed' +``` + +If you're seeing this error there are two fixes available, the first is easy, simply disable SSL on Clockwork calls. Alternatively you can setup your PHP install with the correct root certificates. + +#### Disable SSL on Clockwork calls + +```php +$options = array( 'ssl' => false ); +$clockwork = new Clockwork( $API_KEY, $options ); +``` + +#### Setup SSL root certificates on your server + +This is much more complicated as it depends on your setup, however there are many guides available online. +Try a search term like "windows php curl root certificates" or "ubuntu update root certificates". + + +# License + +This project is licensed under the ISC open-source license. + +A copy of this license can be found in license.txt. + +# Contributing + +If you have any feedback on this wrapper drop us an email to [hello@clockworksms.com][1]. + +The project is hosted on GitHub at [https://github.com/mediaburst/clockwork-php][3]. +If you would like to contribute a bug fix or improvement please fork the project +and submit a pull request. + +[1]: mailto:hello@clockworksms.com +[2]: http://www.clockworksms.com/ +[3]: https://github.com/mediaburst/clockwork-php diff --git a/plugin/courseblock/CourseBlockPlugin.php b/plugin/courseblock/CourseBlockPlugin.php new file mode 100644 index 000000000..e38c94cde --- /dev/null +++ b/plugin/courseblock/CourseBlockPlugin.php @@ -0,0 +1,94 @@ + 'course_block_pre_footer', + 'type' => 'textarea', + ], + [ + 'name' => 'course_block_footer_left', + 'type' => 'textarea', + ], + [ + 'name' => 'course_block_footer_center', + 'type' => 'textarea', + ], + [ + 'name' => 'course_block_footer_right', + 'type' => 'textarea', + ], + ]; + + protected function __construct() + { + parent::__construct( + '0.1', + 'Julio Montoya', + [ + 'tool_enable' => 'boolean', + ] + ); + } + + /** + * @return CourseBlockPlugin + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + public function install() + { + // Installing course settings + $this->install_course_fields_in_all_courses(false); + } + + public function uninstall() + { + // Deleting course settings + $this->uninstall_course_fields_in_all_courses(); + } + + /** + * @param string $region + * + * @return string + */ + public function renderRegion($region) + { + $content = ''; + switch ($region) { + case 'footer_left': + $content = api_get_course_setting('course_block_footer_left'); + $content = $content === -1 ? '' : $content; + break; + case 'footer_center': + $content = api_get_course_setting('course_block_footer_center'); + $content = $content === -1 ? '' : $content; + break; + case 'footer_right': + $content = api_get_course_setting('course_block_footer_right'); + $content = $content === -1 ? '' : $content; + break; + case 'pre_footer': + $content = api_get_course_setting('course_block_pre_footer'); + $content = $content === -1 ? '' : $content; + break; + } + + return $content; + } +} diff --git a/plugin/courseblock/README.md b/plugin/courseblock/README.md new file mode 100644 index 000000000..fd5809f14 --- /dev/null +++ b/plugin/courseblock/README.md @@ -0,0 +1,8 @@ +1. Enabled the plugin from the list of plugins. +2. Click "Configure" once the plugin was enabled. +3. Select tool_enable = Yes and save. +4. Go into a *course* (not course session) and enter the Settings tool. +5. In the "Course block" section fill the footer options. +6. Once the form was saved, you will notice that the text you fill in step .5 + will appear in the Chamilo footer. + diff --git a/plugin/courseblock/config.php b/plugin/courseblock/config.php new file mode 100644 index 000000000..46e612525 --- /dev/null +++ b/plugin/courseblock/config.php @@ -0,0 +1,4 @@ +install(); diff --git a/plugin/courseblock/lang/english.php b/plugin/courseblock/lang/english.php new file mode 100644 index 000000000..a63dec4dd --- /dev/null +++ b/plugin/courseblock/lang/english.php @@ -0,0 +1,11 @@ +get_info(); diff --git a/plugin/coursehomenotify/CourseHomeNotifyPlugin.php b/plugin/coursehomenotify/CourseHomeNotifyPlugin.php new file mode 100644 index 000000000..2eedb8f16 --- /dev/null +++ b/plugin/coursehomenotify/CourseHomeNotifyPlugin.php @@ -0,0 +1,202 @@ + '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 = '
'.$link.'
'; + } + + $modal = ''; + + $modal .= ""; + + 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' => '

'.$this->get_comment().'

'.$button.'
', + 'type' => 'html', + ], + ]; + } +} diff --git a/plugin/coursehomenotify/Entity/Notification.php b/plugin/coursehomenotify/Entity/Notification.php new file mode 100644 index 000000000..7d14e9698 --- /dev/null +++ b/plugin/coursehomenotify/Entity/Notification.php @@ -0,0 +1,152 @@ +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; + } +} diff --git a/plugin/coursehomenotify/Entity/NotificationRelUser.php b/plugin/coursehomenotify/Entity/NotificationRelUser.php new file mode 100644 index 000000000..046747376 --- /dev/null +++ b/plugin/coursehomenotify/Entity/NotificationRelUser.php @@ -0,0 +1,99 @@ +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; + } +} diff --git a/plugin/coursehomenotify/README.md b/plugin/coursehomenotify/README.md new file mode 100644 index 000000000..a9827136b --- /dev/null +++ b/plugin/coursehomenotify/README.md @@ -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. diff --git a/plugin/coursehomenotify/configure.php b/plugin/coursehomenotify/configure.php new file mode 100644 index 000000000..58644890d --- /dev/null +++ b/plugin/coursehomenotify/configure.php @@ -0,0 +1,100 @@ +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(); diff --git a/plugin/coursehomenotify/content.php b/plugin/coursehomenotify/content.php new file mode 100644 index 000000000..8de1b1159 --- /dev/null +++ b/plugin/coursehomenotify/content.php @@ -0,0 +1,52 @@ +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()); diff --git a/plugin/coursehomenotify/install.php b/plugin/coursehomenotify/install.php new file mode 100644 index 000000000..d1304ee52 --- /dev/null +++ b/plugin/coursehomenotify/install.php @@ -0,0 +1,8 @@ +install(); diff --git a/plugin/coursehomenotify/lang/english.php b/plugin/coursehomenotify/lang/english.php new file mode 100644 index 000000000..a7f73251c --- /dev/null +++ b/plugin/coursehomenotify/lang/english.php @@ -0,0 +1,17 @@ +get_info(); diff --git a/plugin/coursehomenotify/uninstall.php b/plugin/coursehomenotify/uninstall.php new file mode 100644 index 000000000..038b7147e --- /dev/null +++ b/plugin/coursehomenotify/uninstall.php @@ -0,0 +1,8 @@ +uninstall(); diff --git a/plugin/courselegal/CourseLegalPlugin.php b/plugin/courselegal/CourseLegalPlugin.php new file mode 100644 index 000000000..f4bbb6be0 --- /dev/null +++ b/plugin/courselegal/CourseLegalPlugin.php @@ -0,0 +1,552 @@ + 'courselegal', + 'type' => 'text', + ], + ]; + + protected function __construct() + { + parent::__construct( + '0.1', + 'Julio Montoya', + [ + 'tool_enable' => 'boolean', + ] + ); + } + + /** + * @return CourseLegalPlugin + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * @return string + */ + public function getTeacherLink() + { + $link = null; + if (api_is_allowed_to_edit()) { + $url = api_get_path(WEB_PLUGIN_PATH).'courselegal/start.php?'.api_get_cidreq(); + $link = Display::url( + $this->get_lang('CourseLegal'), + $url, + ['class' => 'btn'] + ); + } + + return $link; + } + + /** + * @param int $userId + * @param int $courseId + * @param int $sessionId + * + * @return array + */ + public function getUserAcceptedLegal($userId, $courseId, $sessionId) + { + $userId = intval($userId); + $courseId = intval($courseId); + $sessionId = intval($sessionId); + + $table = Database::get_main_table('session_rel_course_rel_user_legal'); + $sql = "SELECT * + FROM $table + WHERE user_id = $userId AND c_id = $courseId AND session_id = $sessionId"; + $result = Database::query($sql); + $data = []; + if (Database::num_rows($result) > 0) { + $data = Database::fetch_array($result, 'ASSOC'); + } + + return $data; + } + + /** + * @param int $userId + * @param string $courseCode + * @param int $sessionId + * + * @return bool + */ + public function isUserAcceptedLegal($userId, $courseCode, $sessionId) + { + $courseInfo = api_get_course_info($courseCode); + $courseId = $courseInfo['real_id']; + $result = $this->getUserAcceptedLegal($userId, $courseId, $sessionId); + + if (!empty($result)) { + if ($result['mail_agreement'] == 1 && + $result['web_agreement'] == 1 + ) { + return true; + } + } + + return false; + } + + /** + * @param int $userId + * @param int $courseCode + * @param int $sessionId + * @param bool $sendEmail Optional. Indicate whether the mail must be sent. Default is true + * + * @return mixed + */ + public function saveUserLegal($userId, $courseCode, $sessionId, $sendEmail = true) + { + $courseInfo = api_get_course_info($courseCode); + $courseId = $courseInfo['real_id']; + $data = $this->getUserAcceptedLegal($userId, $courseId, $sessionId); + + $id = false; + if (empty($data)) { + $table = Database::get_main_table( + 'session_rel_course_rel_user_legal' + ); + $uniqueId = api_get_unique_id(); + $values = [ + 'user_id' => $userId, + 'c_id' => $courseId, + 'session_id' => $sessionId, + 'web_agreement' => 1, + 'web_agreement_date' => api_get_utc_datetime(), + 'mail_agreement_link' => $uniqueId, + ]; + $id = Database::insert($table, $values); + + if ($sendEmail) { + $this->sendMailLink($uniqueId, $userId, $courseId, $sessionId); + } + } + + return $id; + } + + /** + * @param int $userId + * @param int $courseId + * @param int $sessionId + */ + public function updateMailAgreementLink($userId, $courseId, $sessionId) + { + $data = $this->getUserAcceptedLegal($userId, $courseId, $sessionId); + if (!empty($data)) { + $table = Database::get_main_table( + 'session_rel_course_rel_user_legal' + ); + $uniqueId = api_get_unique_id(); + Database::update( + $table, + ['mail_agreement_link' => $uniqueId], + ['id = ? ' => [$data['id']]] + ); + $this->sendMailLink($uniqueId, $userId, $courseId, $sessionId); + } + } + + /** + * @param int $userId + * @param int $courseId + * @param int $sessionId + */ + public function deleteUserAgreement($userId, $courseId, $sessionId) + { + $data = $this->getUserAcceptedLegal($userId, $courseId, $sessionId); + if (!empty($data)) { + $table = Database::get_main_table( + 'session_rel_course_rel_user_legal' + ); + Database::delete( + $table, + ['id = ? ' => [$data['id']]] + ); + } + } + + /** + * @param string $uniqueId + * @param int $userId + * @param int $courseId + * @param int $sessionId + */ + public function sendMailLink($uniqueId, $userId, $courseId, $sessionId) + { + $courseInfo = api_get_course_info_by_id($courseId); + $courseCode = $courseInfo['code']; + + $url = api_get_path(WEB_CODE_PATH).'course_info/legal.php?web_agreement_link='.$uniqueId.'&course_code='.Security::remove_XSS($courseCode).'&session_id='.$sessionId; + $courseUrl = Display::url($url, $url); + $sessionInfo = api_get_session_info($sessionId); + $sesstionTitle = null; + + if (!empty($sessionInfo)) { + $sesstionTitle = ' ('.$sessionInfo['name'].')'; + } + + $courseTitle = $courseInfo['title'].$sesstionTitle; + + $subject = $this->get_lang("MailAgreement"); + $message = sprintf($this->get_lang("MailAgreementWasSentWithClickX"), $courseTitle, $courseUrl); + MessageManager::send_message_simple($userId, $subject, $message); + } + + /** + * @param string $link + * @param int $userId + * @param int $courseId + * @param int $sessionId + * + * @return bool + */ + public function saveUserMailLegal($link, $userId, $courseId, $sessionId) + { + $data = $this->getUserAcceptedLegal($userId, $courseId, $sessionId); + + if (empty($data)) { + return null; + } + + if ($data['mail_agreement_link'] == $link) { + $table = Database::get_main_table('session_rel_course_rel_user_legal'); + $id = $data['id']; + $values = [ + 'mail_agreement' => 1, + 'mail_agreement_date' => api_get_utc_datetime(), + ]; + Database::update($table, $values, ['id = ?' => [$id]]); + } + } + + /** + * @param int $courseId + * @param int $sessionId + * @param string $filePath + */ + public function warnUsersByEmail($courseId, $sessionId, $filePath = null) + { + $courseInfo = api_get_course_info_by_id($courseId); + $courseCode = $courseInfo['code']; + + if (empty($sessionId)) { + $students = CourseManager::get_student_list_from_course_code($courseCode, false); + } else { + $students = CourseManager::get_student_list_from_course_code($courseCode, true, $sessionId); + } + + $url = api_get_course_url($courseCode, $sessionId); + $url = Display::url($url, $url); + + $subject = $this->get_lang("AgreementUpdated"); + $message = sprintf($this->get_lang("AgreementWasUpdatedClickHere"), $url); + + $dataFile = []; + if (!empty($filePath)) { + $dataFile = [ + 'path' => $filePath, + 'filename' => basename($filePath), + ]; + $message = sprintf($this->get_lang("AgreementWasUpdatedClickHere"), $url)." \n"; + $message .= $this->get_lang("TheAgreementIsAttachedInThisEmail"); + } + + if (!empty($students)) { + foreach ($students as $student) { + $userInfo = api_get_user_info($student['user_id']); + api_mail_html( + $userInfo['complete_name'], + $userInfo['email'], + $subject, + $message, + null, + null, + null, + $dataFile + ); + //MessageManager::send_message_simple($student['user_id'], $subject, $message); + } + } + } + + /** + * @param int $courseId + * @param int $sessionId + * @param string $order + * + * @return array + */ + public function getUserAgreementList($courseId, $sessionId, $order = null) + { + $courseId = intval($courseId); + $sessionId = intval($sessionId); + + $table = Database::get_main_table('session_rel_course_rel_user_legal'); + $userTable = Database::get_main_table(TABLE_MAIN_USER); + $sql = "SELECT * + FROM $table s INNER JOIN $userTable u + ON u.user_id = s.user_id + WHERE c_id = $courseId AND session_id = $sessionId "; + + if (!empty($order)) { + $sql .= $order; + } + $result = Database::query($sql); + $data = []; + if (Database::num_rows($result) > 0) { + $data = Database::store_result($result, 'ASSOC'); + } + + return $data; + } + + /** + * @param int $courseId + * @param int $sessionId + */ + public function removePreviousAgreements($courseId, $sessionId) + { + $table = Database::get_main_table('session_rel_course_rel_user_legal'); + $sessionId = intval($sessionId); + $courseId = intval($courseId); + $sql = "DELETE FROM $table + WHERE c_id = '$courseId' AND session_id = $sessionId "; + Database::query($sql); + } + + /** + * @param array $values + * @param array $file $_FILES['uploaded_file'] + * @param bool $deleteFile + */ + public function save($values, $file = [], $deleteFile = false) + { + $table = Database::get_main_table('session_rel_course_legal'); + + $courseId = $values['c_id']; + $sessionId = $values['session_id']; + + $conditions = [ + 'c_id' => $courseId, + 'session_id' => $sessionId, + ]; + + $course = api_get_course_info_by_id($courseId); + + $legalData = $this->getData($courseId, $sessionId); + $coursePath = api_get_path(SYS_COURSE_PATH).$course['directory'].'/courselegal'; + $uploadResult = $coursePath.'/'.$legalData['filename']; + + if (!is_dir($coursePath)) { + mkdir($coursePath, api_get_permissions_for_new_directories()); + } + $uploadOk = process_uploaded_file($file, false); + $fileName = null; + + if ($uploadOk) { + $uploadResult = handle_uploaded_document( + $course, + $file, + $coursePath, + '/', + api_get_user_id(), + api_get_group_id(), + null, + false, + false, + false, + true + ); + + if ($uploadResult) { + $fileName = basename($uploadResult); + // Delete old one if exists. + if ($legalData) { + if (!empty($legalData['filename'])) { + $fileToDelete = $coursePath.'/'.$legalData['filename']; + if (file_exists($fileToDelete)) { + unlink($fileToDelete); + } + } + } + } + } + + $conditions['content'] = $values['content']; + $conditions['filename'] = $fileName; + + if (empty($legalData)) { + $id = Database::insert($table, $conditions); + } else { + $id = $legalData['id']; + + $updateParams = [ + 'content' => $values['content'], + ]; + + if (!empty($fileName)) { + $updateParams['filename'] = $fileName; + } + + Database::update( + $table, + $updateParams, + ['id = ? ' => $id] + ); + } + + if ($deleteFile) { + Database::update( + $table, + ['filename' => ''], + ['id = ? ' => $id] + ); + if (!empty($legalData['filename'])) { + $fileToDelete = $coursePath.'/'.$legalData['filename']; + if (file_exists($fileToDelete)) { + unlink($fileToDelete); + } + } + } + + if (isset($values['remove_previous_agreements']) && + !empty($values['remove_previous_agreements']) + ) { + $this->removePreviousAgreements($courseId, $sessionId); + } + + $warnUsers = isset($values['warn_users_by_email']) ? $values['warn_users_by_email'] : null; + + switch ($warnUsers) { + case '1': + // Nothing + break; + case '2': + // Send mail + $this->warnUsersByEmail($courseId, $sessionId); + break; + case '3': + // Send mail + attachment if exists. + if (!empty($legalData['filename'])) { + $this->warnUsersByEmail( + $courseId, + $sessionId, + $uploadResult + ); + } + break; + } + } + + /** + * @param int $courseId + * @param int $sessionId + * + * @return array|mixed + */ + public function getData($courseId, $sessionId) + { + $table = Database::get_main_table('session_rel_course_legal'); + $conditions = [ + 'c_id = ? AND session_id = ? ' => [ + $courseId, + $sessionId, + ], + ]; + + $result = Database::select('*', $table, ['where' => $conditions]); + $legalData = isset($result) && !empty($result) ? current($result) : []; + + return $legalData; + } + + /** + * @param int $courseId + * @param int $sessionId + * + * @return string + */ + public function getCurrentFile($courseId, $sessionId) + { + $data = $this->getData($courseId, $sessionId); + + if (isset($data['filename']) && !empty($data['filename'])) { + $course = api_get_course_info_by_id($courseId); + + $coursePath = api_get_path(SYS_COURSE_PATH).$course['directory'].'/courselegal'; + $file = $coursePath.'/'.$data['filename']; + + if (file_exists($file)) { + return Display::url( + $data['filename'], + api_get_path(WEB_COURSE_PATH).$course['directory'].'/courselegal/'.$data['filename'], + ['target' => '_blank'] + ); + } + } + } + + public function install() + { + $table = Database::get_main_table('session_rel_course_legal'); + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int PRIMARY KEY AUTO_INCREMENT, + c_id int, + session_id int, + content text, + filename varchar(255) + )"; + Database::query($sql); + + $table = Database::get_main_table('session_rel_course_rel_user_legal'); + + $sql = "CREATE TABLE IF NOT EXISTS $table ( + id int PRIMARY KEY AUTO_INCREMENT, + user_id int, + c_id int, + session_id int, + web_agreement varchar(255), + web_agreement_date datetime, + mail_agreement varchar(255), + mail_agreement_date datetime, + mail_agreement_link varchar(255) + )"; + Database::query($sql); + + // Installing course settings + $this->install_course_fields_in_all_courses(false); + } + + public function uninstall() + { + $table = Database::get_main_table('session_rel_course_legal'); + $sql = "DROP TABLE $table "; + Database::query($sql); + + $table = Database::get_main_table('session_rel_course_rel_user_legal'); + $sql = "DROP TABLE $table "; + Database::query($sql); + + // Deleting course settings + $this->uninstall_course_fields_in_all_courses($this->course_settings); + } +} diff --git a/plugin/courselegal/README.md b/plugin/courselegal/README.md new file mode 100644 index 000000000..379049ba5 --- /dev/null +++ b/plugin/courselegal/README.md @@ -0,0 +1,25 @@ +Installation +============ + +1. Enabled the plugin from the list of plugins. +2. Click "Configure" once the plugin was enabled. +3. Select tool_enable = Yes and save. +4. Go into a *course* (not course session) and enter the Settings tool. +5. In the "Course access" section select "Enable legal terms" and + change the course visibility to "Private" and save. +6. Go to a course or a course in a session a new button "Legal" will appear + in the course home. +7. Click the button "Legal". Fill the form with the content and a file you want +to be shown to the students. There are other options in the form, like: + - Send an email to all users. + - Delete all previous agreements + - Delete the file. + + The file are saved in courses/XX/courselegal/ + +8. Once the form was saved, a new form will appear for the registered users. + The student has to accept the form. + When the form is accepted an email will be sent to the user via email and + then Chamilo message tool +9. The user has to click in the URL. Once the user clicked to the URL the user + will have access to the course. diff --git a/plugin/courselegal/config.php b/plugin/courselegal/config.php new file mode 100644 index 000000000..46e612525 --- /dev/null +++ b/plugin/courselegal/config.php @@ -0,0 +1,4 @@ +install(); diff --git a/plugin/courselegal/lang/english.php b/plugin/courselegal/lang/english.php new file mode 100644 index 000000000..61062fc34 --- /dev/null +++ b/plugin/courselegal/lang/english.php @@ -0,0 +1,23 @@ + %s'; +$strings['AgreementUpdated'] = 'Agreement updated'; +$strings['AgreementWasUpdatedClickHere'] = 'The agreement was updated. Click here: %s'; +$strings['YouNeedToConfirmYourAgreementCheckYourEmail'] = 'You need to confirm that you agree. Please check your email.'; +$strings['DeleteFile'] = 'Delete the file attachment'; +$strings['RemoveAllUserAgreements'] = 'Remove all previous user agreements'; +$strings['WarnAllUsersByEmail'] = 'Notify all users by email'; +$strings['WarnAllUsersByEmailAndSendAttachment'] = 'Notify all users by email and send them the attachment.'; +$strings['ReSendMailAgreementLink'] = 'Send e-mail agreement link again'; +$strings['SendOnlyWarning'] = 'Send only notification'; +$strings['SendAgreementFile'] = 'Send notification and attach the agreement'; +$strings['NoSendWarning'] = 'Do not send notification'; +$strings['TheAgreementIsAttachedInThisEmail'] = 'A copy of the agreement document is attached to this email'; diff --git a/plugin/courselegal/lang/french.php b/plugin/courselegal/lang/french.php new file mode 100644 index 000000000..d42bbaec3 --- /dev/null +++ b/plugin/courselegal/lang/french.php @@ -0,0 +1,23 @@ + %s'; +$strings['AgreementUpdated'] = 'Termes mis à jour'; +$strings['AgreementWasUpdatedClickHere'] = 'Les termes d\'utilisation ont été mis à jour. Cliquez ici: %s'; +$strings['YouNeedToConfirmYourAgreementCheckYourEmail'] = 'Veuillez confirmer votre accord. Vérifiez votre e-mail.'; +$strings['DeleteFile'] = 'Éliminez la pièce jointe'; +$strings['RemoveAllUserAgreements'] = 'Supprimer tous les accords utilisateurs antérieurs'; +$strings['WarnAllUsersByEmail'] = 'Avertir tous les utilisateurs par mail'; +$strings['WarnAllUsersByEmailAndSendAttachment'] = 'Avertir tous les utilisateurs par mail avec la pièce jointe.'; +$strings['ReSendMailAgreementLink'] = 'Envoyer le lien d\'accord par mail de nouveau'; +$strings['SendOnlyWarning'] = 'Envoyer seulement l\'avertissement'; +$strings['SendAgreementFile'] = 'Envoyer à nouveau l\'avertissement avec la pièce jointe'; +$strings['NoSendWarning'] = 'Ne pas envoyer l\'avertissement'; +$strings['TheAgreementIsAttachedInThisEmail'] = 'Une copie du document d\'accord est joint à cet e-mail'; diff --git a/plugin/courselegal/lang/spanish.php b/plugin/courselegal/lang/spanish.php new file mode 100644 index 000000000..ffbee3c33 --- /dev/null +++ b/plugin/courselegal/lang/spanish.php @@ -0,0 +1,23 @@ + %s'; +$strings['AgreementUpdated'] = 'Acuerdo actualizado'; +$strings['AgreementWasUpdatedClickHere'] = 'El acuerdo fue actualizado. Haga clic aquí: %s'; +$strings['YouNeedToConfirmYourAgreementCheckYourEmail'] = 'Usted necesita confirmar que está de acuerdo. Revise su correo electrónico, por favor'; +$strings['DeleteFile'] = 'Eliminar archivo adjuntado'; +$strings['RemoveAllUserAgreements'] = 'Eliminar todos los acuerdos de usuarios anteriores'; +$strings['WarnAllUsersByEmail'] = 'Notificar a todos los usuarios por corro electrónico'; +$strings['WarnAllUsersByEmailAndSendAttachment'] = 'Notificar a todos los usuarios por correo electrónico y enviarles el acuerdo adjuntado'; +$strings['ReSendMailAgreementLink'] = 'Enviar un correo electrónico con el enlace al acuerdo de nuevo.'; +$strings['SendOnlyWarning'] = 'Enviar solamente notificación'; +$strings['SendAgreementFile'] = 'Enviar notificación y adjuntar el acuerdo'; +$strings['NoSendWarning'] = 'No enviar notificación'; +$strings['TheAgreementIsAttachedInThisEmail'] = 'Una copia de este documento de acuerdo es adjuntado a este correo electrónico.'; diff --git a/plugin/courselegal/plugin.php b/plugin/courselegal/plugin.php new file mode 100644 index 000000000..36bf3dfb7 --- /dev/null +++ b/plugin/courselegal/plugin.php @@ -0,0 +1,4 @@ +get_info(); diff --git a/plugin/courselegal/start.php b/plugin/courselegal/start.php new file mode 100644 index 000000000..6b7631915 --- /dev/null +++ b/plugin/courselegal/start.php @@ -0,0 +1,64 @@ +addElement('header', $legal->get_lang('CourseLegal')); +$form->addElement('hidden', 'session_id', $sessionId); +$form->addElement('hidden', 'c_id', $courseId); +$form->addHtmlEditor( + 'content', + get_lang('Text'), + true, + false, + ['ToolbarSet' => 'TermsAndConditions'] +); +$form->addElement('file', 'uploaded_file', get_lang('File')); +$file = $legal->getCurrentFile($courseId, $sessionId); + +if (!empty($file)) { + $form->addElement('label', get_lang('File'), $file); +} + +$form->addElement('checkbox', 'delete_file', null, $legal->get_lang('DeleteFile')); +$form->addElement('checkbox', 'remove_previous_agreements', null, $legal->get_lang('RemoveAllUserAgreements')); +$form->addElement('radio', 'warn_users_by_email', null, $legal->get_lang('NoSendWarning'), 1); +$form->addElement('radio', 'warn_users_by_email', $legal->get_lang('WarnAllUsersByEmail'), $legal->get_lang('SendOnlyWarning'), 2); +$form->addElement('radio', 'warn_users_by_email', null, $legal->get_lang('SendAgreementFile'), 3); +$form->addButtonSave(get_lang('Save')); +$defaults = $legal->getData($courseId, $sessionId); +$defaults['warn_users_by_email'] = 1; +$form->setDefaults($defaults); + +if ($form->validate()) { + $values = $form->getSubmitValues(); + $file = isset($_FILES['uploaded_file']) ? $_FILES['uploaded_file'] : []; + $deleteFile = isset($values['delete_file']) ? $values['delete_file'] : false; + $legal->save($values, $file, $deleteFile); + header('Location: '.$url); + exit; +} +Display::display_header($legal->get_lang('CourseLegal')); +$url = api_get_path(WEB_PLUGIN_PATH).'courselegal/user_list.php?'.api_get_cidreq(); +$link = Display::url(Display::return_icon('user.png', get_lang('UserList')), $url); +echo '
'.$link.'
'; +$form->display(); + +Display::display_footer(); diff --git a/plugin/courselegal/user_list.php b/plugin/courselegal/user_list.php new file mode 100644 index 000000000..63b276207 --- /dev/null +++ b/plugin/courselegal/user_list.php @@ -0,0 +1,81 @@ +updateMailAgreementLink($_GET['user_id'], $courseId, $sessionId); + header('Location: '.$url); + exit; + } + break; + case 'delete': + if (isset($_GET['user_id'])) { + $legal->deleteUserAgreement($_GET['user_id'], $courseId, $sessionId); + header('Location: '.$url); + exit; + } + break; +} + +$order = " ORDER BY firstname, lastname"; +$userList = $legal->getUserAgreementList($courseId, $sessionId, $order); +$table = new HTML_Table(['class' => 'table table-hover table-striped data_table']); +$table->setHeaderContents(0, 0, get_lang('User')); +$table->setHeaderContents(0, 1, $legal->get_lang('WebAgreement')); +$table->setHeaderContents(0, 2, $legal->get_lang('MailAgreement')); +$table->setHeaderContents(0, 3, $legal->get_lang('Actions')); +$row = 1; + +$pluginPath = api_get_path(WEB_PLUGIN_PATH).'courselegal/'; +if (!empty($userList)) { + foreach ($userList as $user) { + $userName = api_get_person_name($user['firstname'], $user['lastname']); + + $webDate = !empty($user['web_agreement_date']) ? api_get_local_time($user['web_agreement_date']) : '-'; + $mailDate = !empty($user['mail_agreement_date']) ? api_get_local_time($user['mail_agreement_date']) : '-'; + $url = $pluginPath.'user_list.php?action=resend&user_id='.$user['user_id'].'&'.api_get_cidreq(); + $link = Display::url( + Display::return_icon('inbox.png', $legal->get_lang('ReSendMailAgreementLink')), + $url + ); + + $deleteLink = Display::url( + Display::return_icon('delete.png', $legal->get_lang('Delete')), + $pluginPath.'user_list.php?action=delete&user_id='.$user['user_id'].'&'.api_get_cidreq() + ); + + $table->setCellContents($row, 0, $userName); + $table->setCellContents($row, 1, $webDate); + $table->setCellContents($row, 2, $mailDate); + $table->setCellContents($row, 3, $link.' '.$deleteLink); + $row++; + } +} +$url = $pluginPath.'start.php?'.api_get_cidreq(); + +$interbreadcrumb[] = ["url" => $url, "name" => $legal->get_lang('CourseLegal')]; +Display::display_header($legal->get_lang('UserList')); + +$table->display(); + +Display::display_footer(); diff --git a/plugin/createdrupaluser/README.md b/plugin/createdrupaluser/README.md new file mode 100644 index 000000000..3ee94fff1 --- /dev/null +++ b/plugin/createdrupaluser/README.md @@ -0,0 +1,28 @@ +Create Drupal user plugin +========================= + +This plugin creates a user on a Drupal portal when a user is registered in +Chamilo. + +This uses the Hook mechanism available to Chamilo plugins: when enabling this +plugin, the HookCreateDrupalUser is automatically added to the hooks stack, and +the UserManager::create_user() method calls the HookCreateUser hook and notifies +it, resulting in the plugin code to be executed. + +The Drupal portal settings must be configured in the configuration panel for the +plugin. A SOAP call is then initiated inside the plugin code, that will use the +Drupal's addUser() web service. See src/HookCreateDrupalUser.php for more info +on the call parameters. + +After calling the web service and receiving a positive answer, Chamilo stores +the remote (Drupal) user ID inside the extra_field_values table, as field name +"drupal_user_id". This later serves for updates and other synchronisation +purposes. + +Extending +--------- + +Other plugins could easily be created by copying this one and modifying the +class names and web services to call. Simply review every variable coined with +the "drupal" name and update according to your own portal. + diff --git a/plugin/createdrupaluser/config.php b/plugin/createdrupaluser/config.php new file mode 100644 index 000000000..420022974 --- /dev/null +++ b/plugin/createdrupaluser/config.php @@ -0,0 +1,10 @@ + + * + * @package chamilo.plugin.createDrupalUser + */ +require_once api_get_path(SYS_PATH).'main/inc/global.inc.php'; diff --git a/plugin/createdrupaluser/index.php b/plugin/createdrupaluser/index.php new file mode 100644 index 000000000..f8f4cac73 --- /dev/null +++ b/plugin/createdrupaluser/index.php @@ -0,0 +1,10 @@ + + * + * @package chamilo.plugin.createDrupalUser + */ +require_once __DIR__.'/config.php'; diff --git a/plugin/createdrupaluser/install.php b/plugin/createdrupaluser/install.php new file mode 100644 index 000000000..09536f98a --- /dev/null +++ b/plugin/createdrupaluser/install.php @@ -0,0 +1,12 @@ + + * + * @package chamilo.plugin.createDrupalUser + */ +require_once __DIR__.'/config.php'; + +CreateDrupalUser::create()->install(); diff --git a/plugin/createdrupaluser/lang/english.php b/plugin/createdrupaluser/lang/english.php new file mode 100644 index 000000000..918006910 --- /dev/null +++ b/plugin/createdrupaluser/lang/english.php @@ -0,0 +1,16 @@ + + * + * @package chamilo.plugin.createDrupalUser + */ +$strings['plugin_title'] = 'Create Drupal users'; +$strings['plugin_comment'] = 'This plugin creates users in an associated Drupal website when a user is created in Chamilo LMS. This requires the "chamilo" module to be installed and configured on the Drupal side.'; + +$strings['drupal_domain'] = 'Drupal website URL'; +$strings['drupal_domain_help'] = 'The server domain name should be written with a trailing slash and with the protocol, e.g. http://www.example.com/'; + +$strings['DruaplUserId'] = 'Drupal user ID'; diff --git a/plugin/createdrupaluser/lang/spanish.php b/plugin/createdrupaluser/lang/spanish.php new file mode 100644 index 000000000..0c2b51eac --- /dev/null +++ b/plugin/createdrupaluser/lang/spanish.php @@ -0,0 +1,16 @@ + + * + * @package chamilo.plugin.createDrupalUser + */ +$strings['plugin_title'] = 'Crear usuario Drupal'; +$strings['plugin_comment'] = 'Este plugin permite crear usuarios en un sitio web Drupal cuando un usuario es creado en Chamilo LMS. Este plugin requiere que el módulo "chamilo" de Drupal esté instalado y configurado en el sitio Drupal.'; + +$strings['drupal_domain'] = 'URL del sitio web Drupal'; +$strings['drupal_domain_help'] = 'La dirección del servidor debe escribirse con el protocolo al comienzo y con la barra al final, por ejemplo http://www.example.com/'; + +$strings['DrupalUserId'] = 'ID de usuario Drupal'; diff --git a/plugin/createdrupaluser/plugin.php b/plugin/createdrupaluser/plugin.php new file mode 100644 index 000000000..071fe982c --- /dev/null +++ b/plugin/createdrupaluser/plugin.php @@ -0,0 +1,12 @@ + + * + * @package chamilo.plugin.createDrupalUser + */ +require_once __DIR__.'/config.php'; + +$plugin_info = CreateDrupalUser::create()->get_info(); diff --git a/plugin/createdrupaluser/src/CreateDrupalUser.php b/plugin/createdrupaluser/src/CreateDrupalUser.php new file mode 100644 index 000000000..bf7a14a6f --- /dev/null +++ b/plugin/createdrupaluser/src/CreateDrupalUser.php @@ -0,0 +1,156 @@ + + * + * @package chamilo.plugin.createDrupalUser + */ +class CreateDrupalUser extends Plugin implements HookPluginInterface +{ + public const EXTRAFIELD_VARIABLE_NAME = 'drupal_user_id'; + + /** + * Class constructor. + */ + protected function __construct() + { + $parameters = [ + 'drupal_domain' => 'text', + ]; + + parent::__construct('1.0', 'Angel Fernando Quiroz Campos', $parameters); + } + + /** + * Instance the plugin. + * + * @staticvar null $result + * + * @return CreateDrupalUser + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * Install the plugin. + */ + public function install() + { + $this->createExtraField(); + $this->installHook(); + } + + /** + * Uninstall the plugin. + */ + public function uninstall() + { + $this->uninstallHook(); + $this->deleteExtraField(); + } + + /** + * Install the Create User hook. + */ + public function installHook() + { + /** @var HookCreateDrupalUser $observer */ + $observer = HookCreateDrupalUser::create(); + HookCreateUser::create()->attach($observer); + } + + /** + * Uninstall the Create User hook. + */ + public function uninstallHook() + { + /** @var HookCreateDrupalUser $observer */ + $observer = HookCreateDrupalUser::create(); + $event = HookCreateUser::create(); + + if ($event) { + $event->detach($observer); + } + } + + /** + * Get the drupal_user_id extra field information. + * + * @return array The info + */ + private function getExtraFieldInfo() + { + $extraField = new ExtraField('user'); + $extraFieldHandler = $extraField->get_handler_field_info_by_field_variable( + self::EXTRAFIELD_VARIABLE_NAME + ); + + return $extraFieldHandler; + } + + /** + * Create the drupal_user_id when it not exists. + */ + private function createExtraField() + { + $extraFieldExists = $this->getExtraFieldInfo() !== false; + + if (!$extraFieldExists) { + $extraField = new ExtraField('user'); + $extraField->save( + [ + 'field_type' => ExtraField::FIELD_TYPE_INTEGER, + 'variable' => self::EXTRAFIELD_VARIABLE_NAME, + 'display_text' => get_plugin_lang('DrupalUserId', 'CreateDrupalUser'), + 'default_value' => null, + 'field_order' => null, + 'visible_to_self' => false, + 'changeable' => false, + 'filter' => null, + ] + ); + } + } + + /** + * Delete the drupal_user_id and values. + */ + private function deleteExtraField() + { + $extraFieldInfo = $this->getExtraFieldInfo(); + $extraFieldExists = $extraFieldInfo !== false; + + if ($extraFieldExists) { + $extraField = new ExtraField('user'); + $extraField->delete($extraFieldInfo['id']); + } + } + + /* + public function notifyDocumentAction(HookDocumentActionEventInterface $hook) + { + $data = $hook->getEventData(); + if ($data['type'] === HOOK_EVENT_TYPE_PRE) { + $data['actions'][] = Display::return_icon('edit.png'); + } + + return $data; + } + + public function notifyDocumentItemAction(HookDocumentItemActionEventInterface $hook) + { + $data = $hook->getEventData(); + if ($data['type'] === HOOK_EVENT_TYPE_PRE) { + $data['actions'][] = $data['id'].' - '.$data['title']; + } + + return $data; + }*/ +} diff --git a/plugin/createdrupaluser/src/HookCreateDrupalUser.php b/plugin/createdrupaluser/src/HookCreateDrupalUser.php new file mode 100644 index 000000000..fcf8761d5 --- /dev/null +++ b/plugin/createdrupaluser/src/HookCreateDrupalUser.php @@ -0,0 +1,78 @@ + + * + * @package chamilo.plugin.createDrupalUser + */ +class HookCreateDrupalUser extends HookObserver implements HookCreateUserObserverInterface +{ + /** + * Constructor. + */ + public function __construct() + { + parent::__construct( + 'plugin/createdrupaluser/src/CreateDrupalUser.php', + 'drupaluser' + ); + } + + /** + * Create a Drupal user when the Chamilo user is registered. + * + * @param HookCreateUserEventInterface $hook The hook + */ + public function hookCreateUser(HookCreateUserEventInterface $hook) + { + $data = $hook->getEventData(); + + $drupalDomain = CreateDrupalUser::create()->get('drupal_domain'); + $drupalDomain = rtrim($drupalDomain, '/').'/'; + + if ($data['type'] === HOOK_EVENT_TYPE_POST) { + $return = $data['return']; + $originalPassword = $data['originalPassword']; + + $userInfo = api_get_user_info($return); + $fields = [ + 'name' => $userInfo['username'], + 'pass' => $originalPassword, + 'mail' => $userInfo['email'], + 'status' => 1, + 'init' => $userInfo['email'], + ]; + + $extraFields = [ + 'first_name' => $userInfo['firstname'], + 'last_name' => $userInfo['lastname'], + ]; + + $options = [ + 'location' => $drupalDomain.'sites/all/modules/chamilo/soap.php?wsdl', + 'uri' => $drupalDomain, + ]; + + $client = new SoapClient(null, $options); + $drupalUserId = false; + + if (isset($_SESSION['ws_drupal_user_id'])) { + $drupalUserId = $_SESSION['ws_drupal_user_id']; + + return true; + } + + if ($drupalUserId === false) { + $drupalUserId = $client->addUser($fields, $extraFields); + } + + if ($drupalUserId !== false) { + UserManager::update_extra_field_value($return, 'drupal_user_id', $drupalUserId); + } + } + } +} diff --git a/plugin/createdrupaluser/uninstall.php b/plugin/createdrupaluser/uninstall.php new file mode 100644 index 000000000..b83b73721 --- /dev/null +++ b/plugin/createdrupaluser/uninstall.php @@ -0,0 +1,12 @@ + + * + * @package chamilo.plugin.createDrupalUser + */ +require_once __DIR__.'/config.php'; + +CreateDrupalUser::create()->uninstall(); diff --git a/plugin/customcertificate/README.md b/plugin/customcertificate/README.md new file mode 100644 index 000000000..477533795 --- /dev/null +++ b/plugin/customcertificate/README.md @@ -0,0 +1,26 @@ +CustomCertificate plugin +=============== +Este plugin da la posibilidad al administrador de disponer de una herramienta de certificados alternativa + a la que tiene por defecto la plataforma Chamilo. + +**Instrucciones de puesta en funcionamiento** + +- Habilitar el plugin en la administración de Chamilo. +- Indicar 'menu_administrator' en la configuración de la región del plugin. + +**accesos a la herramienta** + +- Desde la pantalla de Administración para configurar el certificado por defecto. +- Desde las herramientas del curso, para la configuración del diploma especifico. + +**Importante a tener en cuenta** + +Por defecto los certificados utilizados serán los de la plataforma chamilo. Para habilitar el certificado alternativo +en un curso se debe entrar en la configuración del curso y habilitar en la pestaña de "certificados personalizado" la +casilla de verificación de "Habilitar en el curso el certificado alternativo". +Si se desea usar el certificado por defecto se deberá mostrar la segunda casilla de verificación. + + +Credits +------- +Contributed by [Nosolored](https://www.nosolored.com/). \ No newline at end of file diff --git a/plugin/customcertificate/config.php b/plugin/customcertificate/config.php new file mode 100644 index 000000000..c27e28363 --- /dev/null +++ b/plugin/customcertificate/config.php @@ -0,0 +1,11 @@ + + */ +require_once __DIR__.'/../../main/inc/global.inc.php'; diff --git a/plugin/customcertificate/database.php b/plugin/customcertificate/database.php new file mode 100644 index 000000000..a6c93457d --- /dev/null +++ b/plugin/customcertificate/database.php @@ -0,0 +1,68 @@ +getConnection(); +$platform = $connection->getDatabasePlatform(); + +if ($pluginSchema->hasTable(CustomCertificatePlugin::TABLE_CUSTOMCERTIFICATE)) { + return; +} + +//Create tables +$certificateTable = $pluginSchema->createTable(CustomCertificatePlugin::TABLE_CUSTOMCERTIFICATE); +$certificateTable->addColumn('id', Type::INTEGER, ['autoincrement' => true, 'unsigned' => true]); +$certificateTable->addColumn('access_url_id', Type::INTEGER, ['unsigned' => true]); +$certificateTable->addColumn('c_id', Type::INTEGER, ['unsigned' => true]); +$certificateTable->addColumn('session_id', Type::INTEGER, ['unsigned' => true]); +$certificateTable->addColumn('content_course', Type::TEXT); +$certificateTable->addColumn('contents_type', Type::INTEGER, ['unsigned' => true]); +$certificateTable->addColumn('contents', Type::TEXT); +$certificateTable->addColumn('date_change', Type::INTEGER, ['unsigned' => true]); +$certificateTable->addColumn('date_start', Type::DATETIME); +$certificateTable->addColumn('date_end', Type::DATETIME); +$certificateTable->addColumn('type_date_expediction', Type::INTEGER, ['unsigned' => true]); +$certificateTable->addColumn('place', Type::STRING); +$certificateTable->addColumn('day', Type::STRING, ['notnull' => false]); +$certificateTable->addColumn('month', Type::STRING, ['notnull' => false]); +$certificateTable->addColumn('year', Type::STRING, ['notnull' => false]); +$certificateTable->addColumn('logo_left', Type::STRING); +$certificateTable->addColumn('logo_center', Type::STRING); +$certificateTable->addColumn('logo_right', Type::STRING); +$certificateTable->addColumn('seal', Type::STRING); +$certificateTable->addColumn('signature1', Type::STRING); +$certificateTable->addColumn('signature2', Type::STRING); +$certificateTable->addColumn('signature3', Type::STRING); +$certificateTable->addColumn('signature4', Type::STRING); +$certificateTable->addColumn('signature_text1', Type::STRING); +$certificateTable->addColumn('signature_text2', Type::STRING); +$certificateTable->addColumn('signature_text3', Type::STRING); +$certificateTable->addColumn('signature_text4', Type::STRING); +$certificateTable->addColumn('background', Type::STRING); +$certificateTable->addColumn('margin_left', Type::INTEGER, ['unsigned' => true]); +$certificateTable->addColumn('margin_right', Type::INTEGER, ['unsigned' => true]); +$certificateTable->addColumn('certificate_default', Type::INTEGER, ['unsigned' => true]); +$certificateTable->addIndex(['c_id', 'session_id']); +$certificateTable->setPrimaryKey(['id']); + +$queries = $pluginSchema->toSql($platform); + +foreach ($queries as $query) { + Database::query($query); +} diff --git a/plugin/customcertificate/index.php b/plugin/customcertificate/index.php new file mode 100644 index 000000000..e70cd86d1 --- /dev/null +++ b/plugin/customcertificate/index.php @@ -0,0 +1,3 @@ +install(); diff --git a/plugin/customcertificate/lang/english.php b/plugin/customcertificate/lang/english.php new file mode 100644 index 000000000..a3b2a4266 --- /dev/null +++ b/plugin/customcertificate/lang/english.php @@ -0,0 +1,77 @@ + "Contents"'; +$strings['ContentsIndexLearnpath'] = "Use learnpath index"; +$strings['ContentsCustom'] = "Use custom content"; +$strings['ContentsHide'] = "No show contents"; +$strings['Dates'] = "Dates"; +$strings['CourseDeliveryDates'] = "Course delivery dates"; +$strings['Custom'] = "Custom"; +$strings['UseDateSessionAccess'] = "Use access dates to the session"; +$strings['ExpectionPlace'] = "Expection place"; +$strings['DateExpediction'] = "Expediction date"; +$strings['UseDateEndAccessSession'] = "Use end date of session access"; +$strings['UseDateDownloadCertificate'] = "Use certificate download date"; +$strings['UseDateGenerationCertificate'] = "Use certificate generation date"; +$strings['UseCustomDate'] = "Use custom date"; +$strings['LogosSeal'] = "Logos / Seals"; +$strings['LogoLeft'] = "Logo left"; +$strings['LogoCenter'] = "Logo center"; +$strings['LogoRight'] = "Logo right"; +$strings['Seal'] = "Seal"; +$strings['Signature1'] = "Signature 1"; +$strings['Signature2'] = "Signature 2"; +$strings['Signature3'] = "Signature 3"; +$strings['Signature4'] = "Signature 4"; +$strings['SignatureText1'] = "Signature text 1"; +$strings['SignatureText2'] = "Signature text 2"; +$strings['SignatureText3'] = "Signature text 3"; +$strings['SignatureText4'] = "Signature text 4"; +$strings['OtherOptions'] = "Others options"; +$strings['MarginRight'] = "Margin right"; +$strings['MarginLeft'] = "Margin left"; +$strings['SetDefaultTemplate'] = "Set template by default"; +$strings['MessageDefaultTemplate'] = "Save this default customization for courses and sessions without + defined certificates"; +$strings['None'] = "None"; +$strings['ErrorTemplateCertificate'] = "There is no template defined for the certificate. + There is no template by default."; +$strings['DateStartEnd'] = "With Start date and End date: "; +$strings['ExpedictionIn'] = "Expediction in"; +$strings['Signatures'] = "Signatures"; +$strings['BackgroundCertificate'] = "Background image of the certificate"; +$strings['Background'] = "Background"; +$strings['CertificateSetting'] = "Certificate setting"; +$strings['ToolDisabledCourse'] = "Tool disabled in course setting"; +$strings['ToolUseDefaultSettingCourse'] = "Tool configured to use the default certificate.
+ You can edit it from the Administration screen -> Plugins -> Custom Certificate.
+ Or if you want you can disable the option to use certificate by default in the plugin configuration in the course"; +$strings['CertificateSettingDefault'] = "Default certificate settings"; +$strings['InfoFromDefaultCertificate'] = "The content of the certificate is based on the default certificate. + The modifications you make will not affect the default certificate."; +$strings['to'] = " to "; +$strings['formatDownloadDate'] = " to %sth %s, %s"; +$strings['PrintCertificate'] = "Print certificate"; +$strings['QuestionDelete'] = "Do you want to delete the specific diploma and use the default certificate?"; +$strings['SuccessDelete'] = "Successfully deleted"; +$strings['ProblemDelete'] = "Problem deleting the certificate"; +$strings['OnlyCustomCertificates'] = "Only courses with a personalized certificate are exported"; diff --git a/plugin/customcertificate/lang/spanish.php b/plugin/customcertificate/lang/spanish.php new file mode 100644 index 000000000..27b05b74e --- /dev/null +++ b/plugin/customcertificate/lang/spanish.php @@ -0,0 +1,79 @@ + "Contenidos"'; +$strings['ContentsIndexLearnpath'] = "Usar indice de lecciones"; +$strings['ContentsCustom'] = "Usar contenido personalizado"; +$strings['ContentsHide'] = "No mostrar contenidos"; +$strings['Dates'] = "Fechas"; +$strings['CourseDeliveryDates'] = "Fechas de impartición del curso"; +$strings['Custom'] = "Personalizado"; +$strings['UseDateSessionAccess'] = "Usar fechas de acceso a la sesión"; +$strings['ExpectionPlace'] = "Lugar expedición"; +$strings['DateExpediction'] = "Fecha expedición"; +$strings['UseDateEndAccessSession'] = "Usar fecha fin de acceso de la sesión"; +$strings['UseDateDownloadCertificate'] = "Usar fecha de descarga del certificado"; +$strings['UseDateGenerationCertificate'] = "Usar fecha de generación del certificado"; +$strings['UseCustomDate'] = "Usar fechas personalizadas"; +$strings['LogosSeal'] = "Logos / Sellos"; +$strings['LogoLeft'] = "Logo izquierda"; +$strings['LogoCenter'] = "Logo central"; +$strings['LogoRight'] = "Logo derecha"; +$strings['Seal'] = "Sello"; +$strings['Signature1'] = "Firma 1"; +$strings['Signature2'] = "Firma 2"; +$strings['Signature3'] = "Firma 3"; +$strings['Signature4'] = "Firma 4"; +$strings['SignatureText1'] = "Texto firma 1"; +$strings['SignatureText2'] = "Texto firma 2"; +$strings['SignatureText3'] = "Texto firma 3"; +$strings['SignatureText4'] = "Texto firma 4"; +$strings['OtherOptions'] = "Otras opciones"; +$strings['MarginRight'] = "Margen derecho"; +$strings['MarginLeft'] = "Margen izquierdo"; +$strings['SetDefaultTemplate'] = "Establecer plantilla por defecto"; +$strings['MessageDefaultTemplate'] = "Guardar esta personalización por defecto para cursos y + sesiones sin certificados definidos"; +$strings['None'] = "Ninguno"; +$strings['ErrorTemplateCertificate'] = "No hay una plantilla definida para el certificado. + No existe plantilla por defecto."; +$strings['DateStartEnd'] = "Con Fecha de inicio y Fecha fin: "; +$strings['ExpedictionIn'] = "Expedido en"; +$strings['Signatures'] = "Firmas"; +$strings['BackgroundCertificate'] = "Imagen de fondo del certificado"; +$strings['Background'] = "Fondo"; +$strings['CertificateSetting'] = "Configuración Certificado"; +$strings['ToolDisabledCourse'] = "Herramienta desabilitada en el curso"; +$strings['ToolUseDefaultSettingCourse'] = "Herramienta configurada para usar el certificado por defecto.
+ Podrá editarlo desde la pantalla de Administración -> Plugins -> Certificado personalizado.
+ O si lo desea puede desactivar la opción de usar certificado por defecto en la configuración del + plugin en el curso"; +$strings['CertificateSettingDefault'] = "Configuración del certificado por defecto"; +$strings['InfoFromDefaultCertificate'] = "El contenido del certificado está basado en el certificado por defecto. + Las modificaciones que realice no afectará al certificado por defecto."; +$strings['to'] = " a "; +$strings['formatDownloadDate'] = " a %s de %s de %s"; +$strings['MessageUpdate'] = "El proceso de actualización ha terminado"; +$strings['PrintCertificate'] = "Imprimir certificado"; +$strings['QuestionDelete'] = "¿Desea eliminar el diploma específico y volver a usar el certificado por defecto?"; +$strings['SuccessDelete'] = "Borrado con éxito"; +$strings['ProblemDelete'] = "Hubo un problema al borrar el certificado"; +$strings['OnlyCustomCertificates'] = "Solo se exportan los diplomas de cursos con certificado personalizado"; diff --git a/plugin/customcertificate/plugin.php b/plugin/customcertificate/plugin.php new file mode 100644 index 000000000..a4797cc9f --- /dev/null +++ b/plugin/customcertificate/plugin.php @@ -0,0 +1,16 @@ +Plugins). + * + * @package chamilo.plugin.customcertificate + */ + +/** + * Plugin details (must be present). + */ +require_once __DIR__.'/config.php'; +$plugin_info = CustomCertificatePlugin::create()->get_info(); diff --git a/plugin/customcertificate/resources/css/certificate.css b/plugin/customcertificate/resources/css/certificate.css new file mode 100644 index 000000000..912df0948 --- /dev/null +++ b/plugin/customcertificate/resources/css/certificate.css @@ -0,0 +1,11 @@ +body {background-repeat:no-repeat; margin:0; padding: 0;} +td { font-family:arial, sans-serif; font-size:18px; } +.logo {height: 150px; vertical-align: middle; } +.seals { font-size: 16px; text-align:center;} +.logo-seals { height: 100px; text-align:center; vertical-align: middle;} +@page caraA { height: 210mm; margin:0; padding:0; page-break-before:always;} +.caraA {box-decoration-break: slice; page: caraA} +@page caraB { background:#FFFFFF; } +.caraB {box-decoration-break: slice; page: caraB} +.contents-learnpath td {background: #FFFFFF; font-size: 12px; height: 160mm; vertical-align: top;} +ol {margin: 0; padding:0;} diff --git a/plugin/customcertificate/resources/css/form.css b/plugin/customcertificate/resources/css/form.css new file mode 100644 index 000000000..7abb879fd --- /dev/null +++ b/plugin/customcertificate/resources/css/form.css @@ -0,0 +1,18 @@ +.form-control-cert { + background-color: #fff; + background-image: none; + border: 1px solid #ccc; + border-radius: 4px; + box-shadow: inset 0 1px 1px rgba(0,0,0,.075); + color: #555; + font-size: 14px; + line-height: 1.42857143; + padding: 6px 12px; + transition: border-color ease-in-out .15s,box-shadow ease-in-out .15s; +} +.certificado-text-label { + font-weight: 700; + margin: 0 10px 0 10px; +} +input:disabled { background: #eee; } +label { font-size: 13px; } \ No newline at end of file diff --git a/plugin/customcertificate/resources/img/22/customcertificate.png b/plugin/customcertificate/resources/img/22/customcertificate.png new file mode 100644 index 000000000..9e66b6af2 Binary files /dev/null and b/plugin/customcertificate/resources/img/22/customcertificate.png differ diff --git a/plugin/customcertificate/resources/img/64/customcertificate.png b/plugin/customcertificate/resources/img/64/customcertificate.png new file mode 100644 index 000000000..02b8c9a68 Binary files /dev/null and b/plugin/customcertificate/resources/img/64/customcertificate.png differ diff --git a/plugin/customcertificate/resources/img/64/customcertificate_na.png b/plugin/customcertificate/resources/img/64/customcertificate_na.png new file mode 100644 index 000000000..88df798f1 Binary files /dev/null and b/plugin/customcertificate/resources/img/64/customcertificate_na.png differ diff --git a/plugin/customcertificate/resources/js/certificate.js b/plugin/customcertificate/resources/js/certificate.js new file mode 100644 index 000000000..1fc48bdda --- /dev/null +++ b/plugin/customcertificate/resources/js/certificate.js @@ -0,0 +1,38 @@ +function dateCertificateSwitchRadioButton2(){ + $("#date_start").prop("disabled", true).val(""); + $("#date_end").prop("disabled", true).val(""); +} + +function dateCertificateSwitchRadioButton1(){ + $("#date_start").prop("disabled", false); + $("#date_end").prop("disabled", false); +} + +function dateCertificateSwitchRadioButton0(){ + $("#date_start").prop("disabled", true).val(""); + $("#date_end").prop("disabled", true).val(""); +} + +function typeDateExpedictionSwitchRadioButton(){ + $("[name=\"type_date_expediction\"]").each(function( index ) { + if ( $(this).is(":checked") && $(this).val() === "2") { + $("#day, #month, #year").prop("disabled", false); + } else { + $("#day, #month, #year").prop("disabled", true); + } + }); +} + +function contentsTypeSwitchRadioButton(){ + $("[name=\"contents_type\"]").each(function( index ) { + if ( $(this).is(":checked") && $(this).val() === "2") { + $("#contents").prop("disabled", false); + } else { + $("#contents").prop("disabled", true); + } + }); +} + +$(document).ready(function() { + $( ".datepicker" ).datepicker(); +}); diff --git a/plugin/customcertificate/src/CustomCertificatePlugin.php b/plugin/customcertificate/src/CustomCertificatePlugin.php new file mode 100644 index 000000000..92e0e7fdb --- /dev/null +++ b/plugin/customcertificate/src/CustomCertificatePlugin.php @@ -0,0 +1,332 @@ + + */ +class CustomCertificatePlugin extends Plugin +{ + public const TABLE_CUSTOMCERTIFICATE = 'plugin_customcertificate'; + public $isCoursePlugin = true; + + // When creating a new course this settings are added to the course + public $course_settings = [ + [ + 'name' => 'customcertificate_course_enable', + 'type' => 'checkbox', + ], + [ + 'name' => 'use_certificate_default', + 'type' => 'checkbox', + ], + ]; + + /** + * Constructor. + */ + protected function __construct() + { + parent::__construct( + '1.0', + 'Jose Angel Ruiz - NoSoloRed (original author), Julio Montoya', + [ + 'enable_plugin_customcertificate' => 'boolean', + ] + ); + + $this->isAdminPlugin = true; + } + + /** + * Instance the plugin. + * + * @staticvar null $result + * + * @return CustomCertificatePlugin + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * This method creates the tables required to this plugin. + */ + public function install() + { + //Installing course settings + $this->setCourseToolDefaultVisibility(false); + $this->install_course_fields_in_all_courses(); + + $tablesToBeCompared = [self::TABLE_CUSTOMCERTIFICATE]; + $em = Database::getManager(); + $cn = $em->getConnection(); + $sm = $cn->getSchemaManager(); + $tables = $sm->tablesExist($tablesToBeCompared); + + if ($tables) { + return false; + } + + require_once api_get_path(SYS_PLUGIN_PATH).'customcertificate/database.php'; + } + + /** + * This method drops the plugin tables. + */ + public function uninstall() + { + // Deleting course settings. + $this->uninstall_course_fields_in_all_courses(); + + $tablesToBeDeleted = [self::TABLE_CUSTOMCERTIFICATE]; + foreach ($tablesToBeDeleted as $tableToBeDeleted) { + $table = Database::get_main_table($tableToBeDeleted); + $sql = "DROP TABLE IF EXISTS $table"; + Database::query($sql); + } + $this->manageTab(false); + } + + /** + * This method update the previous plugin tables. + */ + public function update() + { + $oldCertificateTable = 'gradebook_certificate_alternative'; + $base = api_get_path(WEB_UPLOAD_PATH); + if (Database::num_rows(Database::query("SHOW TABLES LIKE '$oldCertificateTable'")) == 1) { + $sql = "SELECT * FROM $oldCertificateTable"; + $res = Database::query($sql); + while ($row = Database::fetch_assoc($res)) { + $pathOrigin = $base.'certificates/'.$row['id'].'/'; + $params = [ + 'access_url_id' => api_get_current_access_url_id(), + 'c_id' => $row['c_id'], + 'session_id' => $row['session_id'], + 'content_course' => $row['content_course'], + 'contents_type' => intval($row['contents_type']), + 'contents' => $row['contents'], + 'date_change' => intval($row['date_change']), + 'date_start' => $row['date_start'], + 'date_end' => $row['date_end'], + 'place' => $row['place'], + 'type_date_expediction' => intval($row['type_date_expediction']), + 'day' => $row['day'], + 'month' => $row['month'], + 'year' => $row['year'], + 'logo_left' => $row['logo_left'], + 'logo_center' => $row['logo_center'], + 'logo_right' => $row['logo_right'], + 'seal' => $row['seal'], + 'signature1' => $row['signature1'], + 'signature2' => $row['signature2'], + 'signature3' => $row['signature3'], + 'signature4' => $row['signature4'], + 'signature_text1' => $row['signature_text1'], + 'signature_text2' => $row['signature_text2'], + 'signature_text3' => $row['signature_text3'], + 'signature_text4' => $row['signature_text4'], + 'background' => $row['background'], + 'margin_left' => intval($row['margin']), + 'margin_right' => 0, + 'certificate_default' => 0, + ]; + + $certificateId = Database::insert(self::TABLE_CUSTOMCERTIFICATE, $params); + + // Image manager + $pathDestiny = $base.'certificates/'.$certificateId.'/'; + + if (!file_exists($pathDestiny)) { + mkdir($pathDestiny, api_get_permissions_for_new_directories(), true); + } + + $imgList = [ + 'logo_left', + 'logo_center', + 'logo_right', + 'seal', + 'signature1', + 'signature2', + 'signature3', + 'signature4', + 'background', + ]; + foreach ($imgList as $value) { + if (!empty($row[$value])) { + copy( + $pathOrigin.$row[$value], + $pathDestiny.$row[$value] + ); + } + } + + if ($row['certificate_default'] == 1) { + $params['c_id'] = 0; + $params['session_id'] = 0; + $params['certificate_default'] = 1; + $certificateId = Database::insert(self::TABLE_CUSTOMCERTIFICATE, $params); + $pathOrigin = $base.'certificates/default/'; + $pathDestiny = $base.'certificates/'.$certificateId.'/'; + foreach ($imgList as $value) { + if (!empty($row[$value])) { + copy( + $pathOrigin.$row[$value], + $pathDestiny.$row[$value] + ); + } + } + } + } + + $sql = "DROP TABLE IF EXISTS $oldCertificateTable"; + Database::query($sql); + + echo get_lang('MessageUpdate'); + } + } + + /** + * Get certificate data. + * + * @param int $id The certificate + * @param int $userId + * + * @return array + */ + public static function getCertificateData($id, $userId) + { + $id = (int) $id; + $userId = (int) $userId; + + if (empty($id) || empty($userId)) { + return []; + } + + $certificateTable = Database::get_main_table(TABLE_MAIN_GRADEBOOK_CERTIFICATE); + $categoryTable = Database::get_main_table(TABLE_MAIN_GRADEBOOK_CATEGORY); + $sql = "SELECT cer.user_id AS user_id, cat.session_id AS session_id, cat.course_code AS course_code + FROM $certificateTable cer + INNER JOIN $categoryTable cat + ON (cer.cat_id = cat.id AND cer.user_id = $userId) + WHERE cer.id = $id"; + + $rs = Database::query($sql); + if (Database::num_rows($rs) > 0) { + $row = Database::fetch_assoc($rs); + $courseCode = $row['course_code']; + $sessionId = $row['session_id']; + $userId = $row['user_id']; + if (api_get_course_setting('customcertificate_course_enable', api_get_course_info($courseCode)) == 1) { + return [ + 'course_code' => $courseCode, + 'session_id' => $sessionId, + 'user_id' => $userId, + ]; + } + } + + return []; + } + + /** + * Check if it redirects. + * + * @param certificate $certificate + * @param int $certId + * @param int $userId + */ + public static function redirectCheck($certificate, $certId, $userId) + { + $certId = (int) $certId; + $userId = !empty($userId) ? $userId : api_get_user_id(); + + if (api_get_plugin_setting('customcertificate', 'enable_plugin_customcertificate') === 'true') { + $infoCertificate = self::getCertificateData($certId, $userId); + if (!empty($infoCertificate)) { + if ($certificate->user_id == api_get_user_id() && !empty($certificate->certificate_data)) { + $certificateId = $certificate->certificate_data['id']; + $extraFieldValue = new ExtraFieldValue('user_certificate'); + $value = $extraFieldValue->get_values_by_handler_and_field_variable( + $certificateId, + 'downloaded_at' + ); + if (empty($value)) { + $params = [ + 'item_id' => $certificate->certificate_data['id'], + 'extra_downloaded_at' => api_get_utc_datetime(), + ]; + $extraFieldValue->saveFieldValues($params); + } + } + + $url = api_get_path(WEB_PLUGIN_PATH).'customcertificate/src/print_certificate.php'. + '?student_id='.$infoCertificate['user_id']. + '&course_code='.$infoCertificate['course_code']. + '&session_id='.$infoCertificate['session_id']; + header('Location: '.$url); + exit; + } + } + } + + /** + * Get certificate info. + * + * @param int $courseId + * @param int $sessionId + * @param int $accessUrlId + * + * @return array + */ + public static function getInfoCertificate($courseId, $sessionId, $accessUrlId) + { + $courseId = (int) $courseId; + $sessionId = (int) $sessionId; + $accessUrlId = !empty($accessUrlId) ? (int) $accessUrlId : 1; + + $table = Database::get_main_table(self::TABLE_CUSTOMCERTIFICATE); + $sql = "SELECT * FROM $table + WHERE + c_id = $courseId AND + session_id = $sessionId AND + access_url_id = $accessUrlId"; + $result = Database::query($sql); + $resultArray = []; + if (Database::num_rows($result) > 0) { + $resultArray = Database::fetch_array($result); + } + + return $resultArray; + } + + /** + * Get default certificate info. + * + * @param int $accessUrlId + * + * @return array + */ + public static function getInfoCertificateDefault($accessUrlId) + { + $accessUrlId = !empty($accessUrlId) ? (int) $accessUrlId : 1; + + $table = Database::get_main_table(self::TABLE_CUSTOMCERTIFICATE); + $sql = "SELECT * FROM $table + WHERE certificate_default = 1 AND access_url_id = $accessUrlId"; + $result = Database::query($sql); + $resultArray = []; + if (Database::num_rows($result) > 0) { + $resultArray = Database::fetch_array($result); + } + + return $resultArray; + } +} diff --git a/plugin/customcertificate/src/customcertificate.ajax.php b/plugin/customcertificate/src/customcertificate.ajax.php new file mode 100644 index 000000000..b6e6e6cc8 --- /dev/null +++ b/plugin/customcertificate/src/customcertificate.ajax.php @@ -0,0 +1,51 @@ +get('enable_plugin_customcertificate') == 'true'; + +if ($enable === false) { + api_not_allowed(); +} + +$action = isset($_GET['a']) ? $_GET['a'] : null; + +switch ($action) { + case 'delete_certificate': + $table = Database::get_main_table(CustomCertificatePlugin::TABLE_CUSTOMCERTIFICATE); + $courseId = isset($_POST['courseId']) ? (int) $_POST['courseId'] : 0; + $sessionId = isset($_POST['sessionId']) ? (int) $_POST['sessionId'] : 0; + $accessUrlId = isset($_POST['accessUrlId']) ? (int) $_POST['accessUrlId'] : 1; + + if (!empty($courseId)) { + $sql = "DELETE FROM $table + WHERE + c_id = $courseId AND + session_id = $sessionId AND + access_url_id = $accessUrlId"; + Database::query($sql); + echo Display::return_message( + get_plugin_lang('SuccessDelete', 'CustomCertificatePlugin'), + 'success' + ); + } else { + echo Display::return_message( + get_plugin_lang('ProblemDelete', 'CustomCertificatePlugin'), + 'error', + false + ); + } + + break; +} diff --git a/plugin/customcertificate/src/export_pdf_all_in_one.php b/plugin/customcertificate/src/export_pdf_all_in_one.php new file mode 100644 index 000000000..759cd0f38 --- /dev/null +++ b/plugin/customcertificate/src/export_pdf_all_in_one.php @@ -0,0 +1,708 @@ +get('enable_plugin_customcertificate') === 'true'; +$tblProperty = Database::get_course_table(TABLE_ITEM_PROPERTY); +$tblCourse = Database::get_main_table(TABLE_MAIN_COURSE); +$tblSessionRelCourse = Database::get_main_table(TABLE_MAIN_SESSION_COURSE); +$tblSessionRelAccessUrl = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_SESSION); + +define('NO_DATE_FILTER', 0); +define('DATE_BEGIN_FILTER', 1); +define('DATE_END_FILTER', 2); +define('ALL_DATE_FILTER', 3); + +if (!$enable) { + api_not_allowed(true, $plugin->get_lang('ToolDisabled')); +} + +$currentLocalTime = api_get_local_time(); +$accessUrlId = api_get_current_access_url_id(); + +$sessionId = isset($_GET['session_id']) ? (int) $_GET['session_id'] : null; +$dateBegin = isset($_GET['date_begin']) ? strtotime($_GET['date_begin']) : null; +$dateEnd = isset($_GET['date_end']) ? strtotime($_GET['date_end'].' 23:59:59') : null; + +if (api_is_multiple_url_enabled()) { + if ($accessUrlId != -1) { + $result = Database::select( + '*', + "$tblSessionRelAccessUrl", + [ + 'where' => [ + "access_url_id = ? AND session_id = ?" => [$accessUrlId, $sessionId], + ], + ] + ); + + if (empty($result)) { + api_not_allowed(); + } + } +} + +$exportAllInOne = isset($_GET['export_pdf']) ? (int) $_GET['export_pdf'] : false; +$exportZip = isset($_GET['export_zip']) ? (int) $_GET['export_zip'] : false; + +$filterDate = 0; +if (!empty($dateBegin)) { + $filterDate += DATE_BEGIN_FILTER; +} +if (!empty($dateEnd)) { + $filterDate += DATE_END_FILTER; +} + +$filterCheckList = []; +$extraField = new ExtraField('user'); +$extraFieldsAll = $extraField->get_all(['filter = ?' => 1], 'option_order'); +foreach ($extraFieldsAll as $field) { + if (!empty($_GET['extra_'.$field['variable']])) { + $filterCheckList[$field['id']] = $field; + } +} + +$result = Database::select( + 'c.id, c.code', + "$tblCourse c INNER JOIN $tblSessionRelCourse r ON c.id = r.c_id", + [ + 'where' => [ + "r.session_id = ? " => [$sessionId], + ], + ] +); + +foreach ($result as $value) { + $courseId = $value['id']; + $courseCode = $value['code']; + + $cats = Category::load( + null, + null, + $courseCode, + null, + null, + $sessionId, + 'ORDER BY id' + ); + + if (empty($cats)) { + // first time + $cats = Category::load( + 0, + null, + $courseCode, + null, + null, + $sessionId, + 'ORDER BY id' + ); + } + + $selectCat = (int) $cats[0]->get_id(); + $certificateList = []; + $certificateListAux = GradebookUtils::get_list_users_certificates($selectCat); + + foreach ($certificateListAux as $value) { + $created_at = strtotime(api_get_local_time($value['created_at'])); + $value['category_id'] = $selectCat; + $value['c_id'] = $courseId; + $value['course_code'] = $courseCode; + switch ($filterDate) { + case NO_DATE_FILTER: + $certificateList[] = $value; + break; + case DATE_BEGIN_FILTER: + if ($created_at >= $dateBegin) { + $certificateList[] = $value; + } + break; + case DATE_END_FILTER: + if ($created_at <= $dateEnd) { + $certificateList[] = $value; + } + break; + case ALL_DATE_FILTER: + if ($created_at >= $dateBegin && $created_at <= $dateEnd) { + $certificateList[] = $value; + } + break; + } + } + + // Filter extra field + foreach ($certificateList as $key => $value) { + foreach ($filterCheckList as $fieldId => $field) { + $extraFieldValue = new ExtraFieldValue('user'); + $extraFieldValueData = $extraFieldValue->get_values_by_handler_and_field_id( + $value['user_id'], + $fieldId + ); + + if (empty($extraFieldValueData)) { + unset($certificateList[$key]); + break; + } + + switch ($field['field_type']) { + case ExtraField::FIELD_TYPE_TEXT: + case ExtraField::FIELD_TYPE_ALPHANUMERIC: + $pos = stripos($extraFieldValueData['value'], $_GET['extra_'.$field['variable']]); + if ($pos === false) { + unset($certificateList[$key]); + } + break; + case ExtraField::FIELD_TYPE_RADIO: + $valueRadio = $_GET['extra_'.$field['variable']]['extra_'.$field['variable']]; + if ($extraFieldValueData['value'] != $valueRadio) { + unset($certificateList[$key]); + } + break; + case ExtraField::FIELD_TYPE_SELECT: + if ($extraFieldValueData['value'] != $_GET['extra_'.$field['variable']]) { + unset($certificateList[$key]); + } + break; + } + } + } +} + +$userList = []; +foreach ($certificateList as $index => $value) { + $infoUser = api_get_user_info($value['user_id']); + $infoUser['category_id'] = $value['category_id']; + $infoUser['c_id'] = $value['c_id']; + $infoUser['course_code'] = $value['course_code']; + $userList[] = $infoUser; +} + +$sessionInfo = []; +if ($sessionId > 0) { + $sessionInfo = SessionManager::fetch($sessionId); +} + +$path = api_get_path(WEB_UPLOAD_PATH).'certificates/'; +$htmlList = []; + +foreach ($userList as $userInfo) { + $courseId = $userInfo['c_id']; + $courseCode = $userInfo['course_code']; + $studentId = $userInfo['user_id']; + + $courseInfo = api_get_course_info($courseCode); + $allowCustomCertificate = api_get_course_setting('customcertificate_course_enable', $courseInfo); + if (!$allowCustomCertificate) { + continue; + } + + // Get info certificate + $infoCertificate = CustomCertificatePlugin::getInfoCertificate($courseId, $sessionId, $accessUrlId); + + if (!is_array($infoCertificate)) { + $infoCertificate = []; + } + + if (empty($infoCertificate)) { + $infoCertificate = CustomCertificatePlugin::getInfoCertificateDefault($accessUrlId); + + if (empty($infoCertificate)) { + Display::display_header($plugin->get_lang('PrintCertificate')); + echo Display::return_message($plugin->get_lang('ErrorTemplateCertificate'), 'error'); + Display::display_footer(); + exit; + } + } + + $workSpace = intval(297 - $infoCertificate['margin_left'] - $infoCertificate['margin_right']); + $widthCell = intval($workSpace / 6); + + $htmlText = ''; + if (!$exportAllInOne) { + $htmlText = ''; + $htmlText .= ' + '; + $htmlText .= ' + '; + $htmlText .= ''; + } + $studentId = $userInfo['user_id']; + + if (empty($infoCertificate['background'])) { + $htmlText .= '
'; + } else { + $urlBackground = $path.$infoCertificate['background']; + $htmlText .= '
'; + } + + if (!empty($infoCertificate['logo_left'])) { + $logoLeft = ' + '; + } else { + $logoLeft = ''; + } + + $logoCenter = ''; + if (!empty($infoCertificate['logo_center'])) { + $logoCenter = ' + '; + } + + $logoRight = ''; + if (!empty($infoCertificate['logo_right'])) { + $logoRight = ' + '; + } + + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= '
'; + + $allUserInfo = DocumentManager::get_all_info_to_certificate( + $studentId, + $courseCode, + $sessionId, + false + ); + + $myContentHtml = $infoCertificate['content_course']; + $myContentHtml = str_replace(chr(13).chr(10).chr(13).chr(10), chr(13).chr(10), $myContentHtml); + $infoToBeReplacedInContentHtml = $allUserInfo[0]; + $infoToReplaceInContentHtml = $allUserInfo[1]; + $myContentHtml = str_replace( + $infoToBeReplacedInContentHtml, + $infoToReplaceInContentHtml, + $myContentHtml + ); + + $startDate = ''; + $endDate = ''; + switch ($infoCertificate['date_change']) { + case 0: + if (!empty($sessionInfo['access_start_date'])) { + $startDate = date("d/m/Y", strtotime(api_get_local_time($sessionInfo['access_start_date']))); + } + if (!empty($sessionInfo['access_end_date'])) { + $endDate = date("d/m/Y", strtotime(api_get_local_time($sessionInfo['access_end_date']))); + } + break; + case 1: + $startDate = date("d/m/Y", strtotime($infoCertificate['date_start'])); + $endDate = date("d/m/Y", strtotime($infoCertificate['date_end'])); + break; + } + + $myContentHtml = str_replace( + '((start_date))', + $startDate, + $myContentHtml + ); + + $myContentHtml = str_replace( + '((end_date))', + $endDate, + $myContentHtml + ); + + $dateExpediction = ''; + if ($infoCertificate['type_date_expediction'] != 3) { + $dateExpediction .= $plugin->get_lang('ExpedictionIn').' '.$infoCertificate['place']; + if ($infoCertificate['type_date_expediction'] == 1) { + $dateExpediction .= $plugin->get_lang('to').api_format_date(time(), DATE_FORMAT_LONG); + } elseif ($infoCertificate['type_date_expediction'] == 2) { + $dateFormat = $plugin->get_lang('formatDownloadDate'); + if (!empty($infoCertificate['day']) && + !empty($infoCertificate['month']) && + !empty($infoCertificate['year']) + ) { + $dateExpediction .= sprintf( + $dateFormat, + $infoCertificate['day'], + $infoCertificate['month'], + $infoCertificate['year'] + ); + } else { + $dateExpediction .= sprintf( + $dateFormat, + '......', + '....................', + '............' + ); + } + } elseif ($infoCertificate['type_date_expediction'] == 4) { + $dateExpediction .= $plugin->get_lang('to').$infoToReplaceInContentHtml[9]; //date_certificate_no_time + } else { + if (!empty($sessionInfo)) { + $dateInfo = api_get_local_time($sessionInfo['access_end_date']); + $dateExpediction .= $plugin->get_lang('to').api_format_date($dateInfo, DATE_FORMAT_LONG); + } + } + } + + $myContentHtml = str_replace( + '((date_expediction))', + $dateExpediction, + $myContentHtml + ); + + $myContentHtml = strip_tags( + $myContentHtml, + '

    • '; + + $htmlText .= ''; + $htmlText .= ' + + + + '; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ' + + + + '; + $htmlText .= ''; + $htmlText .= '
    '. + ((!empty($infoCertificate['signature_text1'])) ? $infoCertificate['signature_text1'] : ''). + ''. + ((!empty($infoCertificate['signature_text2'])) ? $infoCertificate['signature_text2'] : ''). + ''. + ((!empty($infoCertificate['signature_text3'])) ? $infoCertificate['signature_text3'] : ''). + ''. + ((!empty($infoCertificate['signature_text4'])) ? $infoCertificate['signature_text4'] : ''). + ' + '.((!empty($infoCertificate['seal'])) ? $plugin->get_lang('Seal') : ''). + '
    '. + ((!empty($infoCertificate['signature1'])) + ? '' + : ''). + ''. + ((!empty($infoCertificate['signature2'])) + ? '' + : ''). + ''. + ((!empty($infoCertificate['signature3'])) + ? '' + : ''). + ''. + ((!empty($infoCertificate['signature4'])) + ? '' + : ''). + ''. + ((!empty($infoCertificate['seal'])) + ? '' + : ''). + '
    '; + $htmlText .= '

    '; + + // Rear certificate + if ($infoCertificate['contents_type'] != 3) { + $htmlText .= '
    '; + if ($infoCertificate['contents_type'] == 0) { + $courseDescription = new CourseDescription(); + $contentDescription = $courseDescription->get_data_by_description_type(3, $courseId, 0); + $domd = new DOMDocument(); + libxml_use_internal_errors(true); + if (isset($contentDescription['description_content'])) { + $domd->loadHTML($contentDescription['description_content']); + } + libxml_use_internal_errors(false); + $domx = new DOMXPath($domd); + $items = $domx->query("//li[@style]"); + foreach ($items as $item) { + $item->removeAttribute("style"); + } + + $items = $domx->query("//span[@style]"); + foreach ($items as $item) { + $item->removeAttribute("style"); + } + + $output = $domd->saveHTML(); + $htmlText .= getIndexFiltered($output); + } + + if ($infoCertificate['contents_type'] == 1) { + $items = []; + $categoriesTempList = learnpath::getCategories($courseId); + $categoryTest = new CLpCategory(); + $categoryTest->setId(0); + $categoryTest->setName($plugin->get_lang('WithOutCategory')); + $categoryTest->setPosition(0); + $categories = [$categoryTest]; + + if (!empty($categoriesTempList)) { + $categories = array_merge($categories, $categoriesTempList); + } + + foreach ($categories as $item) { + $categoryId = $item->getId(); + + if (!learnpath::categoryIsVisibleForStudent($item, api_get_user_entity($studentId))) { + continue; + } + + $sql = "SELECT 1 + FROM $tblProperty + WHERE tool = 'learnpath_category' + AND ref = $categoryId + AND visibility = 0 + AND (session_id = $sessionId OR session_id IS NULL)"; + $res = Database::query($sql); + if (Database::num_rows($res) > 0) { + continue; + } + + $list = new LearnpathList( + $studentId, + $courseCode, + $sessionId, + null, + false, + $categoryId + ); + + $flat_list = $list->get_flat_list(); + + if (empty($flat_list)) { + continue; + } + + if (count($categories) > 1 && count($flat_list) > 0) { + if ($item->getName() != $plugin->get_lang('WithOutCategory')) { + $items[] = '

    '.$item->getName().'

    '; + } + } + + foreach ($flat_list as $learnpath) { + $lpId = $learnpath['lp_old_id']; + $sql = "SELECT 1 + FROM $tblProperty + WHERE tool = 'learnpath' + AND ref = $lpId AND visibility = 0 + AND (session_id = $sessionId OR session_id IS NULL)"; + $res = Database::query($sql); + if (Database::num_rows($res) > 0) { + continue; + } + $lpName = $learnpath['lp_name']; + $items[] = $lpName.'
    '; + } + $items[] = '
    '; + } + + if (count($items) > 0) { + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= '
    '; + $i = 0; + foreach ($items as $value) { + if ($i == 50) { + $htmlText .= ''; + } + $htmlText .= $value; + $i++; + } + $htmlText .= '
    '; + } + $htmlText .= ''; + } + + if ($infoCertificate['contents_type'] == 2) { + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= '
    '; + $myContentHtml = strip_tags( + $infoCertificate['contents'], + '

    '; + $htmlText .= '
    • '; + } + $htmlText .= ''; + } + + if (!$exportAllInOne) { + $htmlText .= ''; + } + $fileName = 'certificate_'.$userInfo['course_code'].'_'.$userInfo['complete_name'].'_'.$currentLocalTime; + $htmlList[$fileName] = $htmlText; +} + +$fileList = []; +$archivePath = api_get_path(SYS_ARCHIVE_PATH).'certificates/'; +if (!is_dir($archivePath)) { + mkdir($archivePath, api_get_permissions_for_new_directories()); +} + +if ($exportAllInOne) { + $params = [ + 'pdf_title' => 'Certificate', + 'pdf_description' => '', + 'format' => 'A4-L', + 'orientation' => 'L', + 'left' => 15, + 'top' => 15, + 'bottom' => 0, + ]; + $pdf = new PDF($params['format'], $params['orientation'], $params); + + $contentAllCertificate = ''; + foreach ($htmlList as $fileName => $content) { + $contentAllCertificate .= $content; + } + + if (!empty($contentAllCertificate)) { + $certificateContent = ''; + $certificateContent .= ' + '; + $certificateContent .= ' + '; + $certificateContent .= ''; + $certificateContent .= $contentAllCertificate; + $certificateContent .= ''; + + $pdf->content_to_pdf( + $certificateContent, + '', + 'certificate'.date('Y_m_d_His'), + null, + 'D', + false, + null, + false, + false, + false + ); + } +} else { + foreach ($htmlList as $fileName => $content) { + $fileName = api_replace_dangerous_char($fileName); + $params = [ + 'filename' => $fileName, + 'pdf_title' => 'Certificate', + 'pdf_description' => '', + 'format' => 'A4-L', + 'orientation' => 'L', + 'left' => 15, + 'top' => 15, + 'bottom' => 0, + ]; + $pdf = new PDF($params['format'], $params['orientation'], $params); + if ($exportZip) { + $filePath = $archivePath.$fileName.'.pdf'; + $pdf->content_to_pdf($content, '', $fileName, null, 'F', true, $filePath, false, false, false); + $fileList[] = $filePath; + } else { + $pdf->content_to_pdf($content, '', $fileName, null, 'D', false, null, false, false, false); + } + } + + if (!empty($fileList)) { + $zipFile = $archivePath.'certificates_'.api_get_unique_id().'.zip'; + $zipFolder = new PclZip($zipFile); + foreach ($fileList as $file) { + $zipFolder->add($file, PCLZIP_OPT_REMOVE_ALL_PATH); + } + $name = 'certificates_'.$currentLocalTime.'.zip'; + DocumentManager::file_send_for_download($zipFile, true, $name); + exit; + } +} + +function getIndexFiltered($index) +{ + $txt = strip_tags($index, ""); + $txt = str_replace(chr(13).chr(10).chr(13).chr(10), chr(13).chr(10), $txt); + $lines = explode(chr(13).chr(10), $txt); + $text1 = ''; + for ($x = 0; $x < 47; $x++) { + if (isset($lines[$x])) { + $text1 .= $lines[$x].chr(13).chr(10); + } + } + + $text2 = ''; + for ($x = 47; $x < 94; $x++) { + if (isset($lines[$x])) { + $text2 .= $lines[$x].chr(13).chr(10); + } + } + + $showLeft = str_replace(chr(13).chr(10), "
    ", $text1); + $showRight = str_replace(chr(13).chr(10), "
    ", $text2); + $result = ''; + $result .= ''; + $result .= ''; + $result .= ''; + $result .= ''; + $result .= '
    '.$showLeft.''.$showRight.'
    '; + + return $result; +} diff --git a/plugin/customcertificate/src/index.php b/plugin/customcertificate/src/index.php new file mode 100644 index 000000000..c8cdf4f50 --- /dev/null +++ b/plugin/customcertificate/src/index.php @@ -0,0 +1,978 @@ +get_lang('CertificateSetting'); +$enable = $plugin->get('enable_plugin_customcertificate') == 'true'; +$accessUrlId = api_get_current_access_url_id(); +$course_info = api_get_course_info(); + +if ($isDefault === 1) { + $courseId = 0; + $courseCode = ''; + $sessionId = 0; + $enableCourse = false; + $useDefault = true; + $defaultCertificate = 1; + $nameTools = $plugin->get_lang('CertificateSettingDefault'); + $urlParams = '?default=1'; +} else { + $courseId = api_get_course_int_id(); + $courseCode = api_get_course_id(); + $sessionId = api_get_session_id(); + $enableCourse = api_get_course_setting('customcertificate_course_enable', $course_info) == 1 ? true : false; + $useDefault = api_get_course_setting('use_certificate_default', $course_info) == 1 ? true : false; + $defaultCertificate = 0; + $urlParams = '?'.api_get_cidreq(); +} + +if (!$enable) { + api_not_allowed(true, $plugin->get_lang('ToolDisabled')); +} + +if (!$enableCourse && !$useDefault) { + api_not_allowed(true, $plugin->get_lang('ToolDisabledCourse')); +} + +if ($enableCourse && $useDefault) { + api_not_allowed(true, $plugin->get_lang('ToolUseDefaultSettingCourse')); +} + +$allow = api_is_platform_admin() || api_is_teacher(); +if (!$allow) { + api_not_allowed(true); +} + +$table = Database::get_main_table(CustomCertificatePlugin::TABLE_CUSTOMCERTIFICATE); +$htmlHeadXtra[] = api_get_js_simple( + api_get_path(WEB_PLUGIN_PATH).'customcertificate/resources/js/certificate.js' +); +$htmlHeadXtra[] = api_get_css_asset('cropper/dist/cropper.min.css'); +$htmlHeadXtra[] = api_get_asset('cropper/dist/cropper.min.js'); +$htmlHeadXtra[] = api_get_css( + api_get_path(WEB_PLUGIN_PATH).'customcertificate/resources/css/form.css' +); +$htmlHeadXtra[] = ''; + +// Get info certificate +$infoCertificate = CustomCertificatePlugin::getInfoCertificate($courseId, $sessionId, $accessUrlId); + +$form = new FormValidator( + 'formEdit', + 'post', + api_get_self().$urlParams, + null, + ['class' => 'form-vertical'] +); + +if ($form->validate()) { + $formValues = $form->getSubmitValues(); + if (empty($formValues['contents'])) { + $contents = ''; + } else { + $contents = $formValues['contents']; + } + $check = Security::check_token('post'); + if ($check) { + $date_start = str_replace('/', '-', $formValues['date_start']); + $date_end = str_replace('/', '-', $formValues['date_end']); + $params = [ + 'access_url_id' => api_get_current_access_url_id(), + 'c_id' => $formValues['c_id'], + 'session_id' => $formValues['session_id'], + 'content_course' => $formValues['content_course'], + 'contents_type' => (int) $formValues['contents_type'], + 'contents' => $contents, + 'date_change' => intval($formValues['date_change']), + 'date_start' => date("Y-m-d", strtotime($date_start)), + 'date_end' => date("Y-m-d", strtotime($date_end)), + 'place' => $formValues['place'], + 'type_date_expediction' => (int) $formValues['type_date_expediction'], + 'day' => $formValues['day'], + 'month' => $formValues['month'], + 'year' => $formValues['year'], + 'signature_text1' => $formValues['signature_text1'], + 'signature_text2' => $formValues['signature_text2'], + 'signature_text3' => $formValues['signature_text3'], + 'signature_text4' => $formValues['signature_text4'], + 'margin_left' => (int) $formValues['margin_left'], + 'margin_right' => (int) $formValues['margin_right'], + 'certificate_default' => 0, + ]; + + if (intval($formValues['default_certificate'] == 1)) { + $params['certificate_default'] = 1; + } + + // Insert or Update + if ($infoCertificate['id'] > 0) { + $certificateId = $infoCertificate['id']; + Database::update($table, $params, ['id = ?' => $certificateId]); + } else { + $certificateId = Database::insert($table, $params); + } + + // Image manager + $fieldList = [ + 'logo_left', + 'logo_center', + 'logo_right', + 'seal', + 'signature1', + 'signature2', + 'signature3', + 'signature4', + 'background', + ]; + + foreach ($fieldList as $field) { + $checkLogo[$field] = false; + if (!empty($formValues['remove_'.$field]) || $_FILES[$field]['size']) { + checkInstanceImage( + $certificateId, + $infoCertificate[$field], + $field + ); + } + + if ($_FILES[$field]['size']) { + $newPicture = api_upload_file( + 'certificates', + $_FILES[$field], + $certificateId, + $formValues[$field.'_crop_result'] + ); + if ($newPicture) { + $sql = "UPDATE $table + SET $field = '".$newPicture['path_to_save']."' + WHERE id = $certificateId"; + Database::query($sql); + $checkLogo[$field] = true; + } + } + } + + // Certificate Default + if (intval($formValues['use_default'] == 1)) { + $infoCertificateDefault = CustomCertificatePlugin::getInfoCertificateDefault($accessUrlId); + if (!empty($infoCertificateDefault)) { + foreach ($fieldList as $field) { + if (!empty($infoCertificateDefault[$field]) && !$checkLogo[$field]) { + $sql = "UPDATE $table + SET $field = '".$infoCertificateDefault[$field]."' + WHERE id = $certificateId"; + Database::query($sql); + } + } + } + } + + Display::addFlash(Display::return_message(get_lang('Saved'))); + + Security::clear_token(); + header('Location: '.api_get_self().$urlParams); + exit; + } +} + +if (empty($infoCertificate)) { + $infoCertificate = CustomCertificatePlugin::getInfoCertificateDefault($accessUrlId); + + if (empty($infoCertificate)) { + $infoCertificate = [ + 'type_date_expediction' => '', + 'year' => '', + 'month' => '', + 'day' => '', + 'date_change' => '', + ]; + } + $useDefault = true; +} + +// Display the header +Display::display_header($nameTools); +$actionsLeft = Display::url( + Display::return_icon('certificate.png', get_lang('Certificate'), '', ICON_SIZE_MEDIUM), + 'print_certificate.php'.$urlParams +); +if (!empty($courseId) && !$useDefault) { + $actionsLeft .= Display::url( + Display::return_icon('delete.png', $plugin->get_lang('DeleteCertificate'), '', ICON_SIZE_MEDIUM), + 'delete_certificate.php'.$urlParams, + ['id' => 'delete_certificate'] + ); +} + +echo Display::toolbarAction( + 'toolbar-document', + [$actionsLeft] +); + +if ($useDefault && $courseId > 0) { + echo Display::return_message(get_lang('InfoFromDefaultCertificate'), 'info'); +} + +// Student and course section +$form->addHtml('

    '.strtoupper(get_lang('StudentCourseInfo')).''); +$form->addHtml('
    '); +$dir = '/'; +$courseInfo = api_get_course_info(); +$isAllowedToEdit = api_is_allowed_to_edit(null, true); +$editorConfig = [ + 'ToolbarSet' => $isAllowedToEdit ? 'Documents' : 'DocumentsStudent', + 'Width' => '100%', + 'Height' => '300', + 'cols-size' => [0, 12, 0], + 'FullPage' => true, + 'InDocument' => true, + 'CreateDocumentDir' => api_get_path(WEB_COURSE_PATH).$courseInfo['path'].'/document/', + 'CreateDocumentWebDir' => api_get_path(WEB_COURSE_PATH).$courseInfo['path'].'/document/', + 'BaseHref' => api_get_path(WEB_COURSE_PATH).$courseInfo['path'].'/document'.$dir, +]; +$form->addHtmlEditor( + 'content_course', + '', + false, + true, + $editorConfig, + true +); +$form->addHtml('
    '); +$form->addHtml('
    '); +$strInfo = '((user_firstname))
    '; +$strInfo .= '((user_lastname))
    '; +$strInfo .= '((gradebook_institution))
    '; +$strInfo .= '((gradebook_sitename))
    '; +$strInfo .= '((teacher_firstname))
    '; +$strInfo .= '((teacher_lastname))
    '; +$strInfo .= '((official_code))
    '; +$strInfo .= '((date_certificate))
    '; +$strInfo .= '((date_certificate_no_time))
    '; +$strInfo .= '((date_simple_certificate))
    '; +$strInfo .= '((course_code))
    '; +$strInfo .= '((course_title))
    '; +$strInfo .= '((gradebook_grade))
    '; +$strInfo .= '((external_style))
    '; +$strInfo .= '((start_date))
    '; +$strInfo .= '((end_date))
    '; +$strInfo .= '((date_expediction))'; + +$createCertificate = get_lang('CreateCertificateWithTags'); +$form->addElement( + 'html', + Display::return_message($createCertificate.':
    '.$strInfo, 'normal', false) +); +$form->addHtml('
    '); +$form->addHtml('
    '); +$form->addHtml('
    '); + +// Contents section +$form->addHtml('
    '.strtoupper(get_lang('Contents')).''); +$extra = ''; +if (empty($infoCertificate['contents_type'])) { + $infoCertificate['contents_type'] = 0; + $extra = 'disabled'; +} + +$group = []; +$element = &$form->createElement( + 'radio', + 'contents_type', + '', + get_lang('ContentsCourseDescription'), + 0, + ['id' => 'contents_type_0', 'onclick' => 'javascript: contentsTypeSwitchRadioButton();'] +); + +$group[] = $element; + +$element = &$form->createElement( + 'radio', + 'contents_type', + '', + get_lang('ContentsIndexLearnpath'), + 1, + ['id' => 'contents_type_1', 'onclick' => 'javascript: contentsTypeSwitchRadioButton();'] +); +$group[] = $element; + +$element = &$form->createElement( + 'radio', + 'contents_type', + '', + get_lang('ContentsHide'), + 3, + ['id' => 'contents_type_3', 'onclick' => 'javascript: contentsTypeSwitchRadioButton();'] +); +$group[] = $element; + +$element = &$form->createElement( + 'radio', + 'contents_type', + '', + get_lang('ContentsCustom'), + 2, + ['id' => 'contents_type_2', 'onclick' => 'javascript: contentsTypeSwitchRadioButton();'] +); +$group[] = $element; + +$form->addGroup( + $group, + 'contents_type', + get_lang('ContentsToShow'), + null, + false +); + +$form->addHtml('
    '); +$editorConfig = [ + 'ToolbarSet' => ($isAllowedToEdit ? 'Documents' : 'DocumentsStudent'), + 'Width' => '100%', + 'Height' => '200', + 'cols-size' => [2, 10, 0], + 'FullPage' => true, + 'InDocument' => true, + 'CreateDocumentDir' => api_get_path(WEB_COURSE_PATH).$courseInfo['path'].'/document/', + 'CreateDocumentWebDir' => api_get_path(WEB_COURSE_PATH).$courseInfo['path'].'/document/', + 'BaseHref' => api_get_path(WEB_COURSE_PATH).$courseInfo['path'].'/document'.$dir, + 'id' => 'contents', + $extra, +]; +$form->addHtmlEditor( + 'contents', + get_lang('Contents'), + false, + true, + $editorConfig, + true +); +$form->addHtml('
    '); + +// Dates section +$form->addHtml('
    '.strtoupper(get_lang("Dates")).''); + +$group = []; +$option1 = &$form->createElement( + 'radio', + 'date_change', + '', + get_lang('UseDateSessionAccess'), + 0, + ['id' => 'date_change_0', 'onclick' => 'javascript: dateCertificateSwitchRadioButton0();'] +); +$group[] = $option1; + +$option2 = &$form->createElement( + 'radio', + 'date_change', + '', + get_lang('None'), + 2, + ['id' => 'date_change_2', 'onclick' => 'javascript: dateCertificateSwitchRadioButton2();'] +); +$group[] = $option2; + +$option3 = &$form->createElement( + 'radio', + 'date_change', + '', + get_lang('Custom'), + 1, + ['id' => 'date_change_1', 'onclick' => 'javascript: dateCertificateSwitchRadioButton1();'] +); +$group[] = $option3; + +$form->addGroup( + $group, + 'date_change', + get_lang('CourseDeliveryDates'), + null, + false +); +$form->addHtml('
    + +
    +
    + '.get_lang('From').' + + '.get_lang('Until').' + +
    +
    +
    '); + +$form->addText( + 'place', + get_lang('ExpectionPlace'), + false, + ['id' => 'place', 'cols-size' => [2, 5, 5], 'autofocus'] +); + +$group = []; +$option = &$form->createElement( + 'radio', + 'type_date_expediction', + '', + get_lang('UseDateEndAccessSession'), + 0, + [ + 'id' => 'type_date_expediction_0', + 'onclick' => 'javascript: dateCertificateSwitchRadioButton0();', + (($sessionId == 0) ? 'disabled' : ''), + ] +); +$group[] = $option; + +$option = &$form->createElement( + 'radio', + 'type_date_expediction', + '', + get_lang('UseDateDownloadCertificate'), + 1, + [ + 'id' => 'type_date_expediction_1', + 'onclick' => 'javascript: typeDateExpedictionSwitchRadioButton();', + ] +); +$group[] = $option; + +$option = &$form->createElement( + 'radio', + 'type_date_expediction', + '', + get_lang('UseDateGenerationCertificate'), + 4, + [ + 'id' => 'type_date_expediction_4', + 'onclick' => 'javascript: typeDateExpedictionSwitchRadioButton();', + ] +); +$group[] = $option; + +$option = &$form->createElement( + 'radio', + 'type_date_expediction', + '', + get_lang('None'), + 3, + [ + 'id' => 'type_date_expediction_3', + 'onclick' => 'javascript: typeDateExpedictionSwitchRadioButton();', + ] +); +$group[] = $option; + +$option = &$form->createElement( + 'radio', + 'type_date_expediction', + '', + get_lang('UseCustomDate'), + 2, + [ + 'id' => 'type_date_expediction_2', + 'onclick' => 'javascript: typeDateExpedictionSwitchRadioButton();', + ] +); +$group[] = $option; + +$form->addGroup( + $group, + 'type_date_expediction', + get_lang('DateExpediction'), + null, + false +); + +$form->addHtml( + '
    + +
    +
    + a + + de + + de + +
    +
    +
    ' +); +$form->addHtml('
    '); + +// Signature section +$base = api_get_path(WEB_UPLOAD_PATH); +$path = $base.'certificates/'; +$form->addHtml('
    '.strtoupper(get_lang('LogosSeal')).''); +// Logo 1 +$form->addHtml('
    '); +$form->addFile( + 'logo_left', + get_lang('LogoLeft'), + [ + 'id' => 'logo_left', + 'class' => 'picture-form', + 'crop_image' => true, + 'crop_scalable' => 'true', + ] +); +$form->addProgress(); +if (!empty($infoCertificate['logo_left'])) { + $form->addElement('checkbox', 'remove_logo_left', null, get_lang('DelImage')); + $form->addElement( + 'html', + ' + +

    ' + ); +} +$allowedPictureTypes = api_get_supported_image_extensions(false); +$form->addRule( + 'logo_left', + get_lang('OnlyImagesAllowed').' ('.implode(', ', $allowedPictureTypes).')', + 'filetype', + $allowedPictureTypes +); +$form->addHtml('
    '); +// Logo 2 +$form->addHtml('
    '); +$form->addFile( + 'logo_center', + get_lang('LogoCenter'), + [ + 'id' => 'logo_center', + 'class' => 'picture-form', + 'crop_image' => true, + 'crop_scalable' => 'true', + ] +); +$form->addProgress(); +if (!empty($infoCertificate['logo_center'])) { + $form->addElement('checkbox', 'remove_logo_center', null, get_lang('DelImage')); + $form->addElement( + 'html', + ' + +

    ' + ); +} +$allowedPictureTypes = api_get_supported_image_extensions(false); +$form->addRule( + 'logo_center', + get_lang('OnlyImagesAllowed').' ('.implode(', ', $allowedPictureTypes).')', + 'filetype', + $allowedPictureTypes +); +$form->addHtml('
    '); +// Logo 3 +$form->addHtml('
    '); +$form->addFile( + 'logo_right', + get_lang('LogoRight'), + [ + 'id' => 'logo_right', + 'class' => 'picture-form', + 'crop_image' => true, + 'crop_scalable' => 'true', + ] +); +$form->addProgress(); +if (!empty($infoCertificate['logo_right'])) { + $form->addElement('checkbox', 'remove_logo_right', null, get_lang('DelImage')); + $form->addElement( + 'html', + ' + +

    ' + ); +} +$tblProperty = api_get_supported_image_extensions(false); +$form->addRule( + 'logo_right', + get_lang('OnlyImagesAllowed').' ('.implode(', ', $allowedPictureTypes).')', + 'filetype', + $allowedPictureTypes +); +$form->addHtml('
    '); +$form->addHtml('
    '); +$form->addFile( + 'seal', + get_lang('Seal'), + [ + 'id' => 'seal', + 'class' => 'picture-form', + 'crop_image' => true, + 'crop_scalable' => 'true', + ] +); +$form->addProgress(); +if (!empty($infoCertificate['seal'])) { + $form->addElement('checkbox', 'remove_seal', null, get_lang('DelImage')); + $form->addElement( + 'html', + ' + +

    ' + ); +} +$allowedPictureTypes = api_get_supported_image_extensions(false); +$form->addRule( + 'seal', + get_lang('OnlyImagesAllowed').' ('.implode(', ', $allowedPictureTypes).')', + 'filetype', + $allowedPictureTypes +); +$form->addHtml('
    '); +$form->addHtml('
    '); +$form->addHtml('
    '.strtoupper(get_lang('Signatures')).''); +// signature 1 +$form->addHtml('
    '); +$form->addText( + 'signature_text1', + get_lang('SignatureText1'), + false, + ['cols-size' => [2, 10, 0], 'autofocus'] +); +$form->addFile( + 'signature1', + get_lang('Signature1'), + [ + 'id' => 'signature1', + 'class' => 'picture-form', + 'crop_image' => true, + 'crop_scalable' => 'true', + ] +); +$form->addProgress(); +if (!empty($infoCertificate['signature1'])) { + $form->addElement('checkbox', 'remove_signature1', null, get_lang('DelImage')); + $form->addElement( + 'html', + ' + +

    ' + ); +} +$allowedPictureTypes = api_get_supported_image_extensions(false); +$form->addRule( + 'signature1', + get_lang('OnlyImagesAllowed').' ('.implode(', ', $allowedPictureTypes).')', + 'filetype', + $allowedPictureTypes +); +$form->addHtml('
    '); +// signature 2 +$form->addHtml('
    '); +$form->addText( + 'signature_text2', + get_lang('SignatureText2'), + false, + ['cols-size' => [2, 10, 0], 'autofocus'] +); +$form->addFile( + 'signature2', + get_lang('Signature2'), + [ + 'id' => 'signature2', + 'class' => 'picture-form', + 'crop_image' => true, + 'crop_scalable' => 'true', + ] +); +$form->addProgress(); +if (!empty($infoCertificate['signature2'])) { + $form->addElement('checkbox', 'remove_signature2', null, get_lang('DelImage')); + $form->addElement( + 'html', + ' + +

    ' + ); +} +$allowedPictureTypes = api_get_supported_image_extensions(false); +$form->addRule( + 'signature2', + get_lang('OnlyImagesAllowed').' ('.implode(', ', $allowedPictureTypes).')', + 'filetype', + $allowedPictureTypes +); +$form->addHtml('
    '); +// signature 3 +$form->addHtml('
    '); +$form->addText( + 'signature_text3', + get_lang('SignatureText3'), + false, + ['cols-size' => [2, 10, 0], 'autofocus'] +); +$form->addFile( + 'signature3', + get_lang('Signature3'), + [ + 'id' => 'signature3', + 'class' => 'picture-form', + 'crop_image' => true, + 'crop_scalable' => 'true', + ] +); +$form->addProgress(); +if (!empty($infoCertificate['signature3'])) { + $form->addElement('checkbox', 'remove_signature3', null, get_lang('DelImage')); + $form->addElement( + 'html', + ' + +

    ' + ); +} +$allowedPictureTypes = api_get_supported_image_extensions(false); +$form->addRule( + 'signature3', + get_lang('OnlyImagesAllowed').' ('.implode(', ', $allowedPictureTypes).')', + 'filetype', + $allowedPictureTypes +); +$form->addHtml('
    '); +// signature 4 +$form->addHtml('
    '); +$form->addText( + 'signature_text4', + get_lang('SignatureText4'), + false, + ['cols-size' => [2, 10, 0], 'autofocus'] +); +$form->addFile( + 'signature4', + get_lang('Signature4'), + [ + 'id' => 'signature4', + 'class' => 'picture-form', + 'crop_image' => true, + 'crop_scalable' => 'true', + ] +); +$form->addProgress(); +if (!empty($infoCertificate['signature4'])) { + $form->addElement('checkbox', 'remove_signature4', null, get_lang('DelImage')); + $form->addElement( + 'html', + ' + +

    ' + ); +} +$allowedPictureTypes = api_get_supported_image_extensions(false); +$form->addRule( + 'signature4', + get_lang('OnlyImagesAllowed').' ('.implode(', ', $allowedPictureTypes).')', + 'filetype', + $allowedPictureTypes +); +$form->addHtml('
    '); +$form->addHtml('

    '); +$form->addHtml('
    '); +$form->addHtml('
    '.strtoupper(get_lang('BackgroundCertificate')).''); +// background +$form->addFile( + 'background', + get_lang('Background'), + [ + 'id' => 'background', + 'class' => 'picture-form', + 'crop_image' => true, + 'crop_ratio' => '297 / 210', + ] +); +$form->addProgress(); +if (!empty($infoCertificate['background'])) { + $form->addElement('checkbox', 'remove_background', null, get_lang('DelImage')); + $form->addElement( + 'html', + ' + +

    ' + ); +} +$allowedPictureTypes = api_get_supported_image_extensions(false); +$form->addRule( + 'background', + get_lang('OnlyImagesAllowed').' ('.implode(', ', $allowedPictureTypes).')', + 'filetype', + $allowedPictureTypes +); +$form->addHtml('
    '); +$form->addHtml('
    '); +$form->addHtml('
    '); +$form->addHtml('
    '.strtoupper(get_lang('OtherOptions')).''); +$marginOptions = []; +$i = 0; +while ($i < 298) { + $marginOptions[$i] = $i.' mm'; + $i++; +} +$form->addElement( + 'select', + 'margin_left', + get_lang('MarginLeft'), + $marginOptions, + ['cols-size' => [4, 8, 0]] +); +$form->addElement( + 'select', + 'margin_right', + get_lang('MarginRight'), + $marginOptions, + ['cols-size' => [4, 8, 0]] +); +$form->addHtml('
    '); +$form->addHtml('
    '); +$form->addHtml('
    '); + +$form->addButton( + 'submit', + get_lang('SaveCertificate'), + 'check', + 'primary', + null, + null, + ['cols-size' => [5, 2, 5]], + false +); + +$form->addElement('hidden', 'formSent'); +$infoCertificate['formSent'] = 1; +$form->setDefaults($infoCertificate); +$token = Security::get_token(); +$form->addElement('hidden', 'sec_token'); +$form->addElement('hidden', 'use_default'); +$form->addElement('hidden', 'default_certificate'); +$form->addElement('hidden', 'c_id'); +$form->addElement('hidden', 'session_id'); +$form->setConstants( + [ + 'sec_token' => $token, + 'use_default' => $useDefault, + 'default_certificate' => $defaultCertificate, + 'c_id' => $courseId, + 'session_id' => $sessionId, + ] +); +echo '
    '; +echo '
    '; +echo '
    '; +echo $form->returnForm(); +echo '
    '; +echo '
    '; +echo '
    '; +Display::display_footer(); + +/** + * Delete the file if there is only one instance. + * + * @param int $certificateId + * @param string $imagePath + * @param string $field + * @param string $type + */ +function checkInstanceImage($certificateId, $imagePath, $field, $type = 'certificates') +{ + $table = Database::get_main_table(CustomCertificatePlugin::TABLE_CUSTOMCERTIFICATE); + $imagePath = Database::escape_string($imagePath); + $field = Database::escape_string($field); + $certificateId = (int) $certificateId; + + $sql = "SELECT * FROM $table WHERE $field = '$imagePath'"; + $res = Database::query($sql); + if (Database::num_rows($res) == 1) { + api_remove_uploaded_file($type, $imagePath); + } + + $sql = "UPDATE $table SET $field = '' WHERE id = $certificateId"; + Database::query($sql); +} diff --git a/plugin/customcertificate/src/print_certificate.php b/plugin/customcertificate/src/print_certificate.php new file mode 100644 index 000000000..75d2c42df --- /dev/null +++ b/plugin/customcertificate/src/print_certificate.php @@ -0,0 +1,598 @@ +get('enable_plugin_customcertificate') == 'true'; +$tblProperty = Database::get_course_table(TABLE_ITEM_PROPERTY); +$categoryId = isset($_GET['cat_id']) ? (int) $_GET['cat_id'] : 0; + +if (!$enable) { + api_not_allowed(true, $plugin->get_lang('ToolDisabled')); +} + +if ($default == 1) { + $courseId = 0; + $courseCode = ''; + $sessionId = 0; + $enableCourse = false; + $useDefault = true; +} else { + $courseId = api_get_course_int_id(); + $courseCode = api_get_course_id(); + $sessionId = api_get_session_id(); + $enableCourse = api_get_course_setting('customcertificate_course_enable') == 1 ? true : false; + $useDefault = api_get_course_setting('use_certificate_default') == 1 ? true : false; +} + +if (empty($courseCode)) { + $courseCode = isset($_REQUEST['course_code']) ? Database::escape_string($_REQUEST['course_code']) : ''; + $courseInfo = api_get_course_info($courseCode); + if (!empty($courseInfo)) { + $courseId = $courseInfo['real_id']; + } +} else { + $courseInfo = api_get_course_info($courseCode); +} + +if (empty($sessionId)) { + $sessionId = isset($_REQUEST['session_id']) ? (int) $_REQUEST['session_id'] : 0; +} + +$accessUrlId = api_get_current_access_url_id(); + +$userList = []; +$exportZip = false; +$exportAllInOne = false; +if (empty($_GET['export_all']) && empty($_GET['export_all_in_one'])) { + if (!isset($_GET['student_id'])) { + $studentId = api_get_user_id(); + } else { + $studentId = intval($_GET['student_id']); + } + $userList[] = api_get_user_info($studentId); +} else { + if (!empty($_GET['export_all'])) { + $exportZip = true; + } + if (!empty($_GET['export_all_in_one'])) { + $exportAllInOne = true; + } + $certificate_list = GradebookUtils::get_list_users_certificates($categoryId); + foreach ($certificate_list as $index => $value) { + $userList[] = api_get_user_info($value['user_id']); + } +} + +$sessionInfo = []; +if ($sessionId > 0) { + $sessionInfo = SessionManager::fetch($sessionId); +} + +$table = Database::get_main_table(CustomCertificatePlugin::TABLE_CUSTOMCERTIFICATE); +$useDefault = false; +$path = api_get_path(WEB_UPLOAD_PATH).'certificates/'; + +// Get info certificate +$infoCertificate = CustomCertificatePlugin::getInfoCertificate($courseId, $sessionId, $accessUrlId); + +if (!is_array($infoCertificate)) { + $infoCertificate = []; +} + +if (empty($infoCertificate)) { + $infoCertificate = CustomCertificatePlugin::getInfoCertificateDefault($accessUrlId); + + if (empty($infoCertificate)) { + Display::display_header($plugin->get_lang('PrintCertificate')); + echo Display::return_message($plugin->get_lang('ErrorTemplateCertificate'), 'error'); + Display::display_footer(); + exit; + } else { + $useDefault = true; + } +} + +$workSpace = intval(297 - $infoCertificate['margin_left'] - $infoCertificate['margin_right']); +$widthCell = intval($workSpace / 6); +$htmlList = []; + +$currentLocalTime = api_get_local_time(); + +foreach ($userList as $userInfo) { + $htmlText = ''; + if (!$exportAllInOne) { + $htmlText = ''; + $htmlText .= ' + '; + $htmlText .= ' + '; + $htmlText .= ''; + } + $studentId = $userInfo['user_id']; + + if (empty($infoCertificate['background'])) { + $htmlText .= '
    '; + } else { + $urlBackground = $path.$infoCertificate['background']; + $htmlText .= '
    '; + } + + if (!empty($infoCertificate['logo_left'])) { + $logoLeft = ' + '; + } else { + $logoLeft = ''; + } + + $logoCenter = ''; + if (!empty($infoCertificate['logo_center'])) { + $logoCenter = ' + '; + } + + $logoRight = ''; + if (!empty($infoCertificate['logo_right'])) { + $logoRight = ' + '; + } + + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= '
    '; + + $myContentHtml = $infoCertificate['content_course']; + $myContentHtml = str_replace(chr(13).chr(10).chr(13).chr(10), chr(13).chr(10), $myContentHtml); + + if (!empty($courseCode)) { + $allUserInfo = DocumentManager::get_all_info_to_certificate( + $studentId, + $courseCode, + $sessionId, + false + ); + + $infoToBeReplacedInContentHtml = $allUserInfo[0]; + $infoToReplaceInContentHtml = $allUserInfo[1]; + $myContentHtml = str_replace( + $infoToBeReplacedInContentHtml, + $infoToReplaceInContentHtml, + $myContentHtml + ); + } + + $startDate = ''; + $endDate = ''; + switch ($infoCertificate['date_change']) { + case 0: + if (!empty($sessionInfo['access_start_date'])) { + $startDate = date("d/m/Y", strtotime(api_get_local_time($sessionInfo['access_start_date']))); + } + if (!empty($sessionInfo['access_end_date'])) { + $endDate = date("d/m/Y", strtotime(api_get_local_time($sessionInfo['access_end_date']))); + } + break; + case 1: + $startDate = date("d/m/Y", strtotime($infoCertificate['date_start'])); + $endDate = date("d/m/Y", strtotime($infoCertificate['date_end'])); + break; + } + + $myContentHtml = str_replace( + '((start_date))', + $startDate, + $myContentHtml + ); + + $myContentHtml = str_replace( + '((end_date))', + $endDate, + $myContentHtml + ); + + $dateExpediction = ''; + if ($infoCertificate['type_date_expediction'] != 3) { + $dateExpediction .= $plugin->get_lang('ExpedictionIn').' '.$infoCertificate['place']; + if ($infoCertificate['type_date_expediction'] == 1) { + $dateExpediction .= $plugin->get_lang('to').api_format_date(time(), DATE_FORMAT_LONG); + } elseif ($infoCertificate['type_date_expediction'] == 2) { + $dateFormat = $plugin->get_lang('formatDownloadDate'); + if (!empty($infoCertificate['day']) && + !empty($infoCertificate['month']) && + !empty($infoCertificate['year']) + ) { + $dateExpediction .= sprintf( + $dateFormat, + $infoCertificate['day'], + $infoCertificate['month'], + $infoCertificate['year'] + ); + } else { + $dateExpediction .= sprintf( + $dateFormat, + '......', + '....................', + '............' + ); + } + } elseif ($infoCertificate['type_date_expediction'] == 4) { + $dateExpediction .= $plugin->get_lang('to').$infoToReplaceInContentHtml[9]; //date_certificate_no_time + } else { + if (!empty($sessionInfo)) { + $dateInfo = api_get_local_time($sessionInfo['access_end_date']); + $dateExpediction .= $plugin->get_lang('to').api_format_date($dateInfo, DATE_FORMAT_LONG); + } + } + } + + $myContentHtml = str_replace( + '((date_expediction))', + $dateExpediction, + $myContentHtml + ); + + $myContentHtml = strip_tags( + $myContentHtml, + '

    • '; + + $htmlText .= ''; + $htmlText .= ' + + + + '; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ' + + + + '; + $htmlText .= ''; + $htmlText .= '
    '. + ((!empty($infoCertificate['signature_text1'])) ? $infoCertificate['signature_text1'] : ''). + ''. + ((!empty($infoCertificate['signature_text2'])) ? $infoCertificate['signature_text2'] : ''). + ''. + ((!empty($infoCertificate['signature_text3'])) ? $infoCertificate['signature_text3'] : ''). + ''. + ((!empty($infoCertificate['signature_text4'])) ? $infoCertificate['signature_text4'] : ''). + ' + '.((!empty($infoCertificate['seal'])) ? $plugin->get_lang('Seal') : ''). + '
    '. + ((!empty($infoCertificate['signature1'])) + ? '' + : ''). + ''. + ((!empty($infoCertificate['signature2'])) + ? '' + : ''). + ''. + ((!empty($infoCertificate['signature3'])) + ? '' + : ''). + ''. + ((!empty($infoCertificate['signature4'])) + ? '' + : ''). + ''. + ((!empty($infoCertificate['seal'])) + ? '' + : ''). + '
    '; + $htmlText .= '

    '; + + // Rear certificate + if ($infoCertificate['contents_type'] != 3) { + $htmlText .= '
    '; + if ($infoCertificate['contents_type'] == 0) { + $courseDescription = new CourseDescription(); + $contentDescription = $courseDescription->get_data_by_description_type(3, $courseId, 0); + $domd = new DOMDocument(); + libxml_use_internal_errors(true); + if (isset($contentDescription['description_content'])) { + $domd->loadHTML($contentDescription['description_content']); + } + libxml_use_internal_errors(false); + $domx = new DOMXPath($domd); + $items = $domx->query("//li[@style]"); + foreach ($items as $item) { + $item->removeAttribute("style"); + } + + $items = $domx->query("//span[@style]"); + foreach ($items as $item) { + $item->removeAttribute("style"); + } + + $output = $domd->saveHTML(); + $htmlText .= getIndexFiltered($output); + } + + if ($infoCertificate['contents_type'] == 1) { + $items = []; + $categoriesTempList = learnpath::getCategories($courseId); + $categoryTest = new CLpCategory(); + $categoryTest->setId(0); + $categoryTest->setName($plugin->get_lang('WithOutCategory')); + $categoryTest->setPosition(0); + $categories = [$categoryTest]; + + if (!empty($categoriesTempList)) { + $categories = array_merge($categories, $categoriesTempList); + } + + foreach ($categories as $item) { + $categoryId = $item->getId(); + + if (!learnpath::categoryIsVisibleForStudent($item, api_get_user_entity($studentId))) { + continue; + } + + $sql = "SELECT 1 + FROM $tblProperty + WHERE tool = 'learnpath_category' + AND ref = $categoryId + AND visibility = 0 + AND (session_id = $sessionId OR session_id IS NULL)"; + $res = Database::query($sql); + if (Database::num_rows($res) > 0) { + continue; + } + + $list = new LearnpathList( + $studentId, + $courseInfo, + $sessionId, + null, + false, + $categoryId + ); + + $flat_list = $list->get_flat_list(); + + if (empty($flat_list)) { + continue; + } + + if (count($categories) > 1 && count($flat_list) > 0) { + if ($item->getName() != $plugin->get_lang('WithOutCategory')) { + $items[] = '

    '.$item->getName().'

    '; + } + } + + foreach ($flat_list as $learnpath) { + $lpId = $learnpath['lp_old_id']; + $sql = "SELECT 1 + FROM $tblProperty + WHERE tool = 'learnpath' + AND ref = $lpId AND visibility = 0 + AND (session_id = $sessionId OR session_id IS NULL)"; + $res = Database::query($sql); + if (Database::num_rows($res) > 0) { + continue; + } + $lpName = $learnpath['lp_name']; + $items[] = $lpName.'
    '; + } + $items[] = '
    '; + } + + if (count($items) > 0) { + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= '
    '; + $i = 0; + foreach ($items as $value) { + if ($i == 50) { + $htmlText .= ''; + } + $htmlText .= $value; + $i++; + } + $htmlText .= '
    '; + } + $htmlText .= '
    '; + } + + if ($infoCertificate['contents_type'] == 2) { + $htmlText .= ''; + $htmlText .= ''; + $htmlText .= ' + + {% if not is_child %} + + {% endif %} + + + +{% endmacro %} + +{{ 'ImsLtiDescription'|get_plugin_lang('ImsLtiPlugin') }} + +{% autoescape 'html' %} +
    + + {{ 'PlatformKeys'|get_plugin_lang('ImsLtiPlugin') }} + + + {{ 'AddExternalTool'|get_plugin_lang('ImsLtiPlugin') }} + +
    +
    +
    '; + $myContentHtml = strip_tags( + $infoCertificate['contents'], + '

    '; + $htmlText .= '
    • '; + } + $htmlText .= ''; + } + + if (!$exportAllInOne) { + $htmlText .= ''; + } + $fileName = 'certificate_'.$courseInfo['code'].'_'.$userInfo['complete_name'].'_'.$currentLocalTime; + $htmlList[$fileName] = $htmlText; +} + +$fileList = []; +$archivePath = api_get_path(SYS_ARCHIVE_PATH).'certificates/'; +if (!is_dir($archivePath)) { + mkdir($archivePath, api_get_permissions_for_new_directories()); +} + +if ($exportAllInOne) { + $params = [ + 'pdf_title' => 'Certificate', + 'pdf_description' => '', + 'format' => 'A4-L', + 'orientation' => 'L', + 'left' => 15, + 'top' => 15, + 'bottom' => 0, + ]; + $pdf = new PDF($params['format'], $params['orientation'], $params); + + $contentAllCertificate = ''; + foreach ($htmlList as $fileName => $content) { + $contentAllCertificate .= $content; + } + + if (!empty($contentAllCertificate)) { + $certificateContent = ''; + $certificateContent .= ' + '; + $certificateContent .= ' + '; + $certificateContent .= ''; + $certificateContent .= $contentAllCertificate; + $certificateContent .= ''; + + $pdf->content_to_pdf( + $certificateContent, + '', + 'certificate'.date("Y_m_d_His"), + null, + 'D', + false, + null, + false, + false, + false + ); + } +} else { + foreach ($htmlList as $fileName => $content) { + $fileName = api_replace_dangerous_char($fileName); + $params = [ + 'filename' => $fileName, + 'pdf_title' => 'Certificate', + 'pdf_description' => '', + 'format' => 'A4-L', + 'orientation' => 'L', + 'left' => 15, + 'top' => 15, + 'bottom' => 0, + ]; + $pdf = new PDF($params['format'], $params['orientation'], $params); + if ($exportZip) { + $filePath = $archivePath.$fileName.'.pdf'; + $pdf->content_to_pdf($content, '', $fileName, null, 'F', true, $filePath, false, false, false); + $fileList[] = $filePath; + } else { + $pdf->content_to_pdf($content, '', $fileName, null, 'D', false, null, false, false, false); + } + } + + if (!empty($fileList)) { + $zipFile = $archivePath.'certificates_'.api_get_unique_id().'.zip'; + $zipFolder = new PclZip($zipFile); + foreach ($fileList as $file) { + $zipFolder->add($file, PCLZIP_OPT_REMOVE_ALL_PATH); + } + $name = 'certificates_'.$courseInfo['code'].'_'.$currentLocalTime.'.zip'; + DocumentManager::file_send_for_download($zipFile, true, $name); + exit; + } +} + +function getIndexFiltered($index) +{ + $txt = strip_tags($index, ""); + $txt = str_replace(chr(13).chr(10).chr(13).chr(10), chr(13).chr(10), $txt); + $lines = explode(chr(13).chr(10), $txt); + $text1 = ''; + for ($x = 0; $x < 47; $x++) { + if (isset($lines[$x])) { + $text1 .= $lines[$x].chr(13).chr(10); + } + } + + $text2 = ''; + for ($x = 47; $x < 94; $x++) { + if (isset($lines[$x])) { + $text2 .= $lines[$x].chr(13).chr(10); + } + } + + $showLeft = str_replace(chr(13).chr(10), "
    ", $text1); + $showRight = str_replace(chr(13).chr(10), "
    ", $text2); + $result = ''; + $result .= ''; + $result .= ''; + $result .= ''; + $result .= ''; + $result .= '
    '.$showLeft.''.$showRight.'
    '; + + return $result; +} diff --git a/plugin/customcertificate/start.php b/plugin/customcertificate/start.php new file mode 100644 index 000000000..3cd81e99c --- /dev/null +++ b/plugin/customcertificate/start.php @@ -0,0 +1,34 @@ +get('enable_plugin_customcertificate') == 'true'; + +if ($enable) { + if (api_is_platform_admin() || api_is_teacher()) { + $url = 'src/index.php?'; + $url .= (isset($_GET['cidReq']) ? api_get_cidreq() : 'default=1'); + header('Location: '.$url); + exit; + } else { + $session = api_get_session_entity(api_get_session_id()); + $_course = api_get_course_info(); + $webCoursePath = api_get_path(WEB_COURSE_PATH); + $url = $webCoursePath.$_course['path'].'/index.php'.($session ? '?id_session='.$session->getId() : ''); + + Display::addFlash( + Display::return_message($plugin->get_lang('OnlyAdminPlatform')) + ); + + header('Location: '.$url); + exit; + } +} else { + api_not_allowed(true, $plugin->get_lang('ToolDisabled')); +} diff --git a/plugin/customcertificate/uninstall.php b/plugin/customcertificate/uninstall.php new file mode 100644 index 000000000..e75e6e0a9 --- /dev/null +++ b/plugin/customcertificate/uninstall.php @@ -0,0 +1,12 @@ +uninstall(); diff --git a/plugin/customcertificate/update.php b/plugin/customcertificate/update.php new file mode 100644 index 000000000..510a60e1b --- /dev/null +++ b/plugin/customcertificate/update.php @@ -0,0 +1,14 @@ +update(); diff --git a/plugin/customfooter/index.php b/plugin/customfooter/index.php new file mode 100644 index 000000000..ca91de53d --- /dev/null +++ b/plugin/customfooter/index.php @@ -0,0 +1,14 @@ + + */ +class CustomFooterPlugin extends Plugin +{ + protected function __construct() + { + parent::__construct('1.1', 'Valery Fremaux'); + } + + /** + * @return CustomFooterPlugin + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + public function get_name() + { + return 'customfooter'; + } + + public function pix_url($pixname, $size = 16) + { + global $_configuration; + + if (file_exists( + $_configuration['root_sys'].'/plugin/customplugin/pix/'.$pixname.'.png' + )) { + return $_configuration['root_web'].'/plugin/customplugin/pix/'.$pixname.'.png'; + } + if (file_exists( + $_configuration['root_sys'].'/plugin/customplugin/pix/'.$pixname.'.jpg' + )) { + return $_configuration['root_web'].'/plugin/customplugin/pix/'.$pixname.'.jpg'; + } + if (file_exists( + $_configuration['root_sys'].'/plugin/customplugin/pix/'.$pixname.'.gif' + )) { + return $_configuration['root_web'].'/plugin/customplugin/pix/'.$pixname.'.gif'; + } + + return $_configuration['root_web'].'/main/img/icons/'.$size.'/'.$pixname.'.png'; + } +} diff --git a/plugin/customfooter/plugin.php b/plugin/customfooter/plugin.php new file mode 100644 index 000000000..28bed27af --- /dev/null +++ b/plugin/customfooter/plugin.php @@ -0,0 +1,56 @@ + + */ + +/** + * Plugin details (must be present). + */ + +/* Plugin config */ +$plugin_info = CustomFooterPlugin::create()->get_info(); + +//the plugin title +$plugin_info['title'] = 'Custom Footer'; +//the comments that go with the plugin +$plugin_info['comment'] = "Drives configuration parameters that plugs custom footer notes"; +//the plugin version +$plugin_info['version'] = '1.0'; +//the plugin author +$plugin_info['author'] = 'Valery Fremaux, Julio Montoya'; + +/* Plugin optional settings */ + +/* + * This form will be showed in the plugin settings once the plugin was installed + * in the plugin/hello_world/index.php you can have access to the value: $plugin_info['settings']['hello_world_show_type'] +*/ + +$form = new FormValidator('customfooter_form'); + +$plugininstance = CustomFooterPlugin::create(); + +$config = api_get_settings_params( + ['subkey = ? ' => 'customfooter', ' AND category = ? ' => 'Plugins'] +); +$form_settings = []; + +foreach ($config as $fooid => $configrecord) { + $canonic = preg_replace('/^customfooter_/', '', $configrecord['variable']); + if (in_array($canonic, ['footer_left', 'footer_right'])) { + $form_settings[$canonic] = $configrecord['selected_value']; + } +} + +// A simple select. +$form->addElement('text', 'footer_left', $plugininstance->get_lang('footerleft')); +$form->addElement('text', 'footer_right', $plugininstance->get_lang('footerright')); +$form->addButtonSave($plugininstance->get_lang('Save')); +$form->setDefaults($form_settings); + +$plugin_info['settings_form'] = $form; diff --git a/plugin/dashboard/block_course/block_course.class.php b/plugin/dashboard/block_course/block_course.class.php new file mode 100644 index 000000000..ad998b43d --- /dev/null +++ b/plugin/dashboard/block_course/block_course.class.php @@ -0,0 +1,209 @@ +user_id = $user_id; + $this->path = 'block_course'; + if ($this->is_block_visible_for_user($user_id)) { + $this->courses = CourseManager::get_courses_followed_by_drh($user_id); + } + } + + /** + * This method check if a user is allowed to see the block inside dashboard interface. + * + * @param int User id + * + * @return bool Is block visible for user + */ + public function is_block_visible_for_user($user_id) + { + $user_info = api_get_user_info($user_id); + $user_status = $user_info['status']; + $is_block_visible_for_user = false; + if (UserManager::is_admin($user_id) || in_array( + $user_status, + $this->permission + ) + ) { + $is_block_visible_for_user = true; + } + + return $is_block_visible_for_user; + } + + /** + * This method return content html containing information + * about courses and its position for showing it inside dashboard interface + * it's important to use the name 'get_block' for beeing used from dashboard controller. + * + * @return array column and content html + */ + public function get_block() + { + global $charset; + $column = 2; + $data = []; + $content = $this->get_content_html(); + $html = ' +

    +
    '.get_lang('CoursesInformation').' +
    + +
    +
    +
    + '.$content.' +
    +
    + '; + $data['column'] = $column; + $data['content_html'] = $html; + + return $data; + } + + /** + * This method return a content html, it's used inside get_block method for showing it inside dashboard interface. + * + * @return string content html + */ + public function get_content_html() + { + $course_data = $this->get_course_information_data(); + $content = '

    '.get_lang('YourCourseList').'

    '; + $data_table = null; + if (!empty($course_data)) { + $data_table .= ''; + $data_table .= ' + + + + + '; + $i = 1; + foreach ($course_data as $course) { + if ($i % 2 == 0) { + $class_tr = 'row_odd'; + } else { + $class_tr = 'row_even'; + } + $data_table .= ''; + if (!isset($course[2])) { + $course[2] = '0:00:00'; + } + foreach ($course as $cell) { + $data_table .= ''; + } + $data_table .= ''; + $i++; + } + $data_table .= '
    '.get_lang('CourseTitle').''.get_lang('NbStudents').''.get_lang('AvgTimeSpentInTheCourse').''.get_lang('ThematicAdvance').'
    '.$cell.'
    '; + } else { + $data_table .= get_lang('ThereIsNoInformationAboutYourCourses'); + } + $content .= $data_table; + if (!empty($course_data)) { + $content .= ''; + } + //$content .= ''; + + return $content; + } + + /** + * Get number of courses. + * + * @return int + */ + public function get_number_of_courses() + { + return count($this->courses); + } + + /** + * Get course information data. + * + * @return array + */ + public function get_course_information_data() + { + $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER); + $course_data = []; + $courses = $this->courses; + $thematic = new Thematic(); + + foreach ($courses as $row_course) { + $course_code = $row_course['code']; + $courseInfo = api_get_course_info($course_code); + $courseId = $courseInfo['real_id']; + $nb_students_in_course = $avg_progress_in_course = $avg_score_in_course = $avg_time_spent_in_course = $avg_score_in_exercise = 0; + + // students directly subscribed to the course + $sql = "SELECT user_id FROM $tbl_course_user as course_rel_user + WHERE course_rel_user.status=".STUDENT." AND course_rel_user.c_id='$courseId'"; + $rs = Database::query($sql); + $users = []; + while ($row = Database::fetch_array($rs)) { + $users[] = $row['user_id']; + } + if (count($users) > 0) { + $nb_students_in_course = count($users); + $avg_time_spent_in_course = api_time_to_hms( + Tracking::get_time_spent_on_the_course($users, $courseId) / $nb_students_in_course + ); + } else { + $avg_time_spent_in_course = null; + } + $tematic_advance = $thematic->get_total_average_of_thematic_advances( + $course_code, + 0 + ); + + if (!empty($tematic_advance)) { + $tematic_advance_progress = ''.$tematic_advance.'%'; + } else { + $tematic_advance_progress = '0%'; + } + + $table_row = []; + $table_row[] = $row_course['title']; + $table_row[] = $nb_students_in_course; + $table_row[] = $avg_time_spent_in_course; + $table_row[] = $tematic_advance_progress; + $course_data[] = $table_row; + } + + return $course_data; + } +} diff --git a/plugin/dashboard/block_course/block_course.info b/plugin/dashboard/block_course/block_course.info new file mode 100644 index 000000000..c4c68a515 --- /dev/null +++ b/plugin/dashboard/block_course/block_course.info @@ -0,0 +1,6 @@ +name = "Course Block" +controller = "BlockCourse" +description = "Display information about courses inside platform" +package = Dashboard +version = 1.0 +author = Christian Fasanando diff --git a/plugin/dashboard/block_course/index.html b/plugin/dashboard/block_course/index.html new file mode 100644 index 000000000..8e464d8ce --- /dev/null +++ b/plugin/dashboard/block_course/index.html @@ -0,0 +1,8 @@ + + + + + +
    + + \ No newline at end of file diff --git a/plugin/dashboard/block_daily/block_daily.class.php b/plugin/dashboard/block_daily/block_daily.class.php new file mode 100644 index 000000000..243ccc520 --- /dev/null +++ b/plugin/dashboard/block_daily/block_daily.class.php @@ -0,0 +1,269 @@ +user_id = $user_id; + $this->path = 'block_daily'; + if ($this->is_block_visible_for_user($user_id)) { + $this->courses = CourseManager::get_courses_followed_by_drh( + $user_id + ); + } + } + + /** + * This method check if a user is allowed to see the block inside dashboard interface. + * + * @param int User id + * + * @return bool Is block visible for user + */ + public function is_block_visible_for_user($user_id) + { + $user_info = api_get_user_info($user_id); + $user_status = $user_info['status']; + $is_block_visible_for_user = false; + if (UserManager::is_admin($user_id) || in_array( + $user_status, + $this->permission + ) + ) { + $is_block_visible_for_user = true; + } + + return $is_block_visible_for_user; + } + + /** + * This method return content html containing information about courses and its position for showing it inside dashboard interface + * it's important to use the name 'get_block' for beeing used from dashboard controller. + * + * @return array column and content html + */ + public function get_block() + { + global $charset; + $column = 2; + $data = []; + $content = $this->get_content_html(); + $html = '
    +
    '.get_lang('GradebookAndAttendances').' +
    + +
    +
    +
    + '.$content.' +
    +
    + '; + $data['column'] = $column; + $data['content_html'] = $html; + + return $data; + } + + /** + * This method return a content html, it's used inside get_block method for showing it inside dashboard interface. + * + * @return string content html + */ + public function get_content_html() + { + $course_data = $this->get_course_information_data(); + $content = '

    '.get_lang('YourCourseList').'

    '; + $data_table = null; + if (!empty($course_data)) { + $data_table .= ''; + $data_table .= ' + + + + + '; + $i = 1; + foreach ($course_data as $course) { + if ($i % 2 == 0) { + $class_tr = 'row_odd'; + } else { + $class_tr = 'row_even'; + } + $data_table .= ''; + if (!isset($course[3])) { + $course[3] = get_lang('NotAvailable'); + } + foreach ($course as $cell) { + $data_table .= ''; + } + $data_table .= ''; + $i++; + } + $data_table .= '
    '.get_lang('CourseTitle').''.get_lang('NbStudents').''.get_lang('Evaluation').''.get_lang('ToolAttendance').'
    '.$cell.'
    '; + } else { + $data_table .= get_lang('ThereIsNoInformationAboutYourCourses'); + } + $content .= $data_table; + if (!empty($course_data)) { + $content .= ''; + } + //$content .= ''; + return $content; + } + + /** + * Get number of courses. + * + * @return int + */ + public function get_number_of_courses() + { + return count($this->courses); + } + + /** + * Get course information data. + * + * @return array + */ + public function get_course_information_data() + { + $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER); + $course_data = []; + $courses = $this->courses; + + foreach ($courses as $row_course) { + $score = null; + $courseId = $row_course['c_id']; + $course_info = api_get_course_info_by_id($courseId); + $course_code = $course_info['code']; + if (empty($course_info)) { + continue; + } + + // Attendance table + $table_course = Database::get_course_table(TABLE_ATTENDANCE); + + $sql = "SELECT id, name, attendance_qualify_max FROM $table_course + WHERE c_id = ".$course_info['real_id']." AND active = 1 AND session_id = 0"; + $rs = Database::query($sql); + $attendance = []; + $attendances = []; + + while ($row = Database::fetch_array($rs, 'ASSOC')) { + $attendance['done'] = $row['attendance_qualify_max']; + $attendance['id'] = $row['id']; + //$attendance['name'] = $row['name']; + $attendance['course_code'] = $course_info['code']; + + if ($attendance['done'] != '0') { + $attendances[] = ''.Display::return_icon('printmgr.gif', get_lang('Print')).''; + } else { + $attendances[] = get_lang("NotAvailable"); + } + } + if (count($attendances) == 0) { + $attendances[] = get_lang("NotAvailable"); + } + + // Number of students + + $sql = "SELECT user_id FROM $tbl_course_user as course_rel_user + WHERE course_rel_user.status=".STUDENT." AND course_rel_user.c_id=$courseId"; + $rs = Database::query($sql); + $users = []; + while ($row = Database::fetch_array($rs)) { + $users[] = $row['user_id']; + } + if (count($users) > 0) { + $nb_students_in_course = count($users); + } + + if (!empty($tematic_advance)) { + $tematic_advance_progress = ''.$tematic_advance.'%'; + } else { + $tematic_advance_progress = '0%'; + } + + // Score + $tbl_grade_categories = Database::get_main_table( + TABLE_MAIN_GRADEBOOK_CATEGORY + ); + $sql = "SELECT id from ".$tbl_grade_categories." + WHERE course_code ='".$course_code."'"; + $rs = Database::query($sql); + $category = null; + while ($row = Database::fetch_array($rs)) { + $category = $row['id']; + } + + if (!empty($category)) { + $cat = Category::load($category); + $eval = $cat[0]->get_evaluations(); + if (count($eval) > 0) { + $i = 0; + foreach ($eval as $item) { + $score .= ''.$item->get_name().''; + if (count($eval) - 1 != $i) { + $score .= ', '; + } + $i++; + } + } else { + $score = get_lang("NotAvailable"); + } + } else { + $score = get_lang("NotAvailable"); + } + + $table_row = []; + $table_row[] = $row_course['title']; + $table_row[] = $nb_students_in_course; + $table_row[] = $score; + $table_row[] = $attendances[0]; + $course_data[] = $table_row; + } + + return $course_data; + } +} diff --git a/plugin/dashboard/block_daily/block_daily.info b/plugin/dashboard/block_daily/block_daily.info new file mode 100644 index 000000000..f1a604589 --- /dev/null +++ b/plugin/dashboard/block_daily/block_daily.info @@ -0,0 +1,6 @@ +name = "Gradebook & Attendances" +controller = "BlockDaily" +description = "Access to attendances in a Gradebook" +package = Dashboard +version = 1.0 +author = Marco Antonio Firmino de Sousa diff --git a/plugin/dashboard/block_daily/index.html b/plugin/dashboard/block_daily/index.html new file mode 100644 index 000000000..8e464d8ce --- /dev/null +++ b/plugin/dashboard/block_daily/index.html @@ -0,0 +1,8 @@ + + + + + +
    + + \ No newline at end of file diff --git a/plugin/dashboard/block_evaluation_graph/block_evaluation_graph.class.php b/plugin/dashboard/block_evaluation_graph/block_evaluation_graph.class.php new file mode 100644 index 000000000..d5fb8c17e --- /dev/null +++ b/plugin/dashboard/block_evaluation_graph/block_evaluation_graph.class.php @@ -0,0 +1,489 @@ +path = 'block_evaluation_graph'; + $this->user_id = $user_id; + $this->bg_width = 450; + $this->bg_height = 350; + if ($this->is_block_visible_for_user($user_id)) { + if (!api_is_session_admin()) { + $this->courses = CourseManager::get_courses_followed_by_drh($user_id); + } + $this->sessions = SessionManager::get_sessions_followed_by_drh($user_id); + } + } + + /** + * This method check if a user is allowed to see the block inside dashboard interface. + * + * @param int User id + * + * @return bool Is block visible for user + */ + public function is_block_visible_for_user($user_id) + { + $user_info = api_get_user_info($user_id); + $user_status = $user_info['status']; + $is_block_visible_for_user = false; + if (UserManager::is_admin($user_id) || in_array($user_status, $this->permission)) { + $is_block_visible_for_user = true; + } + + return $is_block_visible_for_user; + } + + /** + * This method return content html containing + * information about sessions and its position for showing it inside dashboard interface + * it's important to use the name 'get_block' for beeing used from dashboard controller. + * + * @return array column and content html + */ + public function get_block() + { + global $charset; + $column = 1; + $data = []; + $evaluations_base_courses_graph = $this->get_evaluations_base_courses_graph(); + $evaluations_courses_in_sessions_graph = $this->get_evaluations_courses_in_sessions_graph(); + + $html = '
    +
    + '.get_lang('EvaluationsGraph').' +
    + +
    +
    +
    '; + if (empty($evaluations_base_courses_graph) && empty($evaluations_courses_in_sessions_graph)) { + $html .= '

    '.api_convert_encoding(get_lang('GraphicNotAvailable'), 'UTF-8').'

    '; + } else { + // display evaluations base courses graph + if (!empty($evaluations_base_courses_graph)) { + foreach ($evaluations_base_courses_graph as $course_code => $img_html) { + $html .= '
    '.$course_code.'
    '; + $html .= $img_html; + } + } + // display evaluations base courses graph + if (!empty($evaluations_courses_in_sessions_graph)) { + foreach ($evaluations_courses_in_sessions_graph as $session_id => $courses) { + $session_name = api_get_session_name($session_id); + $html .= '
    '.$session_name.':'.get_lang('Evaluations').'
    '; + foreach ($courses as $course_code => $img_html) { + $html .= '
    '.$course_code.'
    '; + $html .= $img_html; + } + } + } + } + $html .= '
    +
    '; + + $data['column'] = $column; + $data['content_html'] = $html; + + return $data; + } + + /** + * This method return a graph containing informations about evaluations + * inside base courses, it's used inside get_block method for showing + * it inside dashboard interface. + * + * @return string img html + */ + public function get_evaluations_base_courses_graph() + { + $graphs = []; + if (!empty($this->courses)) { + $courses_code = array_keys($this->courses); + foreach ($courses_code as $course_code) { + $cats = Category::load( + null, + null, + $course_code, + null, + null, + null, + false + ); + + if (isset($cats) && isset($cats[0])) { + $alleval = $cats[0]->get_evaluations(null, true, $course_code); + $alllinks = $cats[0]->get_links(null, true); + $users = GradebookUtils::get_all_users($alleval, $alllinks); + $datagen = new FlatViewDataGenerator($users, $alleval, $alllinks); + $evaluation_sumary = $datagen->getEvaluationSummaryResults(); + if (!empty($evaluation_sumary)) { + $items = array_keys($evaluation_sumary); + $max = $min = $avg = []; + foreach ($evaluation_sumary as $evaluation) { + $max[] = $evaluation['max']; + $min[] = !empty($evaluation['min']) ? $evaluation['min'] : 0; + $avg[] = $evaluation['avg']; + } + // Dataset definition + $dataSet = new pData(); + $dataSet->addPoints($min, 'Serie3'); + $dataSet->addPoints($avg, 'Serie2'); + $dataSet->addPoints($max, 'Serie1'); + $dataSet->addPoints($items, 'Labels'); + + $dataSet->setSerieDescription('Serie1', get_lang('Max')); + $dataSet->setSerieDescription('Serie2', get_lang('Avg')); + $dataSet->setSerieDescription('Serie3', get_lang('Min')); + $dataSet->setAbscissa('Labels'); + + $dataSet->setAbscissaName(get_lang('EvaluationName')); + + $dataSet->normalize(100, '%'); + + $dataSet->loadPalette(api_get_path(SYS_CODE_PATH).'palettes/pchart/default.color', true); + + // Cache definition + $cachePath = api_get_path(SYS_ARCHIVE_PATH); + $myCache = new pCache(['CacheFolder' => substr($cachePath, 0, strlen($cachePath) - 1)]); + $chartHash = $myCache->getHash($dataSet); + if ($myCache->isInCache($chartHash)) { + $imgPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash; + $myCache->saveFromCache($chartHash, $imgPath); + $imgPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash; + } else { + /* Create the pChart object */ + $widthSize = $this->bg_width; + $heightSize = $this->bg_height; + $fontSize = 8; + $angle = 50; + + $myPicture = new pImage($widthSize, $heightSize, $dataSet); + + /* Turn of Antialiasing */ + $myPicture->Antialias = false; + + /* Add a border to the picture */ + $myPicture->drawRectangle( + 0, + 0, + $widthSize - 1, + $heightSize - 1, + [ + 'R' => 0, + 'G' => 0, + 'B' => 0, + ] + ); + + /* Set the default font */ + $myPicture->setFontProperties( + [ + 'FontName' => api_get_path(SYS_FONTS_PATH).'opensans/OpenSans-Regular.ttf', + 'FontSize' => 10, + ] + ); + + /* Do NOT Write the chart title */ + + /* Define the chart area */ + $myPicture->setGraphArea( + 50, + 30, + $widthSize - 20, + $heightSize - 100 + ); + + /* Draw the scale */ + $scaleSettings = [ + 'GridR' => 200, + 'GridG' => 200, + 'GridB' => 200, + 'DrawSubTicks' => true, + 'CycleBackground' => true, + 'Mode' => SCALE_MODE_MANUAL, + 'ManualScale' => [ + '0' => [ + 'Min' => 0, + 'Max' => 100, + ], + ], + 'LabelRotation' => $angle, + ]; + $myPicture->drawScale($scaleSettings); + + /* Turn on shadow computing */ + $myPicture->setShadow( + true, + [ + 'X' => 1, + 'Y' => 1, + 'R' => 0, + 'G' => 0, + 'B' => 0, + 'Alpha' => 10, + ] + ); + + /* Draw the chart */ + $myPicture->setShadow( + true, + [ + 'X' => 1, + 'Y' => 1, + 'R' => 0, + 'G' => 0, + 'B' => 0, + 'Alpha' => 10, + ] + ); + $settings = [ + 'DisplayValues' => true, + 'DisplaySize' => $fontSize, + 'DisplayR' => 0, + 'DisplayG' => 0, + 'DisplayB' => 0, + 'DisplayOrientation' => ORIENTATION_HORIZONTAL, + 'Gradient' => false, + 'Surrounding' => 30, + 'InnerSurrounding' => 25, + ]; + $myPicture->drawStackedBarChart($settings); + + $legendSettings = [ + 'Mode' => LEGEND_HORIZONTAL, + 'Style' => LEGEND_NOBORDER, + ]; + $myPicture->drawLegend($widthSize / 2, 15, $legendSettings); + + /* Write and save into cache */ + + $myCache->writeToCache($chartHash, $myPicture); + $imgPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash; + $myCache->saveFromCache($chartHash, $imgPath); + $imgPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash; + } + if (!empty($imgPath)) { + $courses_graph[$course_code] = ''; + } + } + } + } // end for + } + + return $graphs; + } + + /** + * This method return a graph containing information about evaluations + * inside courses in sessions, it's used inside get_block method for + * showing it inside dashboard interface. + * + * @return string img html + */ + public function get_evaluations_courses_in_sessions_graph() + { + $graphs = []; + if (!empty($this->sessions)) { + $session_ids = array_keys($this->sessions); + foreach ($session_ids as $session_id) { + $courses_code = array_keys(Tracking::get_courses_list_from_session($session_id)); + $courses_graph = []; + foreach ($courses_code as $course_code) { + $cats = Category::load(null, null, $course_code, null, null, $session_id); + if (isset($cats) && isset($cats[0])) { + $alleval = $cats[0]->get_evaluations(null, true, $course_code); + $alllinks = $cats[0]->get_links(null, true); + $users = GradebookUtils::get_all_users($alleval, $alllinks); + $datagen = new FlatViewDataGenerator($users, $alleval, $alllinks); + $evaluation_sumary = $datagen->getEvaluationSummaryResults(); + if (!empty($evaluation_sumary)) { + $items = array_keys($evaluation_sumary); + $max = $min = $avg = []; + foreach ($evaluation_sumary as $evaluation) { + $max[] = $evaluation['max']; + $min[] = $evaluation['min']; + $avg[] = $evaluation['avg']; + } + // Dataset definition + $dataSet = new pData(); + $dataSet->addPoints($min, 'Serie3'); + $dataSet->addPoints($avg, 'Serie2'); + $dataSet->addPoints($max, 'Serie1'); + $dataSet->addPoints($items, 'Labels'); + + $dataSet->setSerieDescription('Serie1', get_lang('Max')); + $dataSet->setSerieDescription('Serie2', get_lang('Avg')); + $dataSet->setSerieDescription('Serie3', get_lang('Min')); + $dataSet->setAbscissa('Labels'); + $dataSet->setAbscissaName(get_lang('EvaluationName')); + $dataSet->normalize(100, '%'); + $dataSet->loadPalette(api_get_path(SYS_CODE_PATH).'palettes/pchart/default.color', true); + + // Cache definition + $cachePath = api_get_path(SYS_ARCHIVE_PATH); + $myCache = new pCache( + [ + 'CacheFolder' => substr( + $cachePath, + 0, + strlen($cachePath) - 1 + ), + ] + ); + $chartHash = $myCache->getHash($dataSet); + if ($myCache->isInCache($chartHash)) { + $imgPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash; + $myCache->saveFromCache($chartHash, $imgPath); + $imgPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash; + } else { + /* Create the pChart object */ + $widthSize = $this->bg_width; + $heightSize = $this->bg_height; + $fontSize = 8; + $angle = 50; + + $myPicture = new pImage($widthSize, $heightSize, $dataSet); + + /* Turn of Antialiasing */ + $myPicture->Antialias = false; + + /* Add a border to the picture */ + $myPicture->drawRectangle( + 0, + 0, + $widthSize - 1, + $heightSize - 1, + [ + 'R' => 0, + 'G' => 0, + 'B' => 0, + ] + ); + + /* Set the default font */ + $myPicture->setFontProperties( + [ + 'FontName' => api_get_path(SYS_FONTS_PATH).'opensans/OpenSans-Regular.ttf', + 'FontSize' => 10, + ] + ); + + /* Do NOT Write the chart title */ + + /* Define the chart area */ + $myPicture->setGraphArea(50, 30, $widthSize - 20, $heightSize - 100); + + /* Draw the scale */ + $scaleSettings = [ + 'GridR' => 200, + 'GridG' => 200, + 'GridB' => 200, + 'DrawSubTicks' => true, + 'CycleBackground' => true, + 'Mode' => SCALE_MODE_MANUAL, + 'ManualScale' => [ + '0' => [ + 'Min' => 0, + 'Max' => 100, + ], + ], + 'LabelRotation' => $angle, + ]; + $myPicture->drawScale($scaleSettings); + + /* Turn on shadow computing */ + $myPicture->setShadow( + true, + [ + 'X' => 1, + 'Y' => 1, + 'R' => 0, + 'G' => 0, + 'B' => 0, + 'Alpha' => 10, + ] + ); + + /* Draw the chart */ + $myPicture->setShadow( + true, + [ + 'X' => 1, + 'Y' => 1, + 'R' => 0, + 'G' => 0, + 'B' => 0, + 'Alpha' => 10, + ] + ); + $settings = [ + 'DisplayValues' => true, + 'DisplaySize' => $fontSize, + 'DisplayR' => 0, + 'DisplayG' => 0, + 'DisplayB' => 0, + 'DisplayOrientation' => ORIENTATION_HORIZONTAL, + 'Gradient' => false, + 'Surrounding' => 30, + 'InnerSurrounding' => 25, + ]; + $myPicture->drawStackedBarChart($settings); + + $legendSettings = [ + 'Mode' => LEGEND_HORIZONTAL, + 'Style' => LEGEND_NOBORDER, + ]; + $myPicture->drawLegend($widthSize / 2, 15, $legendSettings); + + /* Write and save into cache */ + $myCache->writeToCache($chartHash, $myPicture); + $imgPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash; + $myCache->saveFromCache($chartHash, $imgPath); + $imgPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash; + } + if (!empty($imgPath)) { + $courses_graph[$course_code] = ''; + } + } + } + } + if (!empty($courses_graph)) { + $graphs[$session_id] = $courses_graph; + } + } + } + + return $graphs; + } +} diff --git a/plugin/dashboard/block_evaluation_graph/block_evaluation_graph.info b/plugin/dashboard/block_evaluation_graph/block_evaluation_graph.info new file mode 100644 index 000000000..3607f570a --- /dev/null +++ b/plugin/dashboard/block_evaluation_graph/block_evaluation_graph.info @@ -0,0 +1,6 @@ +name = "Evaluation Graph Block" +controller = "BlockEvaluationGraph" +description = "Display maximum, minimum and average evaluations about links inside assessments tool" +package = Dashboard +version = 1.0 +author = Christian Fasanando \ No newline at end of file diff --git a/plugin/dashboard/block_global_info/block_global_info.class.php b/plugin/dashboard/block_global_info/block_global_info.class.php new file mode 100644 index 000000000..a393b8b50 --- /dev/null +++ b/plugin/dashboard/block_global_info/block_global_info.class.php @@ -0,0 +1,152 @@ +user_id = $user_id; + $this->path = 'block_global_info'; + if ($this->is_block_visible_for_user($user_id)) { + //$this->courses = CourseManager::get_courses_followed_by_drh($user_id); + } + } + + /** + * This method check if a user is allowed to see the block inside dashboard interface. + * + * @param int User id + * + * @return bool Is block visible for user + */ + public function is_block_visible_for_user($user_id) + { + $user_info = api_get_user_info($user_id); + $user_status = $user_info['status']; + $is_block_visible_for_user = false; + if (UserManager::is_admin($user_id) || in_array($user_status, $this->permission)) { + $is_block_visible_for_user = true; + } + + return $is_block_visible_for_user; + } + + /** + * This method return content html containing information + * about courses and its position for showing it inside dashboard interface + * it's important to use the name 'get_block' for beeing used from dashboard controller. + * + * @return array column and content html + */ + public function get_block() + { + global $charset; + $column = 2; + $data = []; + $content = $this->get_content_html(); + $html = '
    +
    '.get_lang('GlobalPlatformInformation').' +
    + +
    +
    +
    + '.$content.' +
    +
    + '; + $data['column'] = $column; + $data['content_html'] = $html; + + return $data; + } + + /** + * This method return a content html, it's used inside get_block method for showing it inside dashboard interface. + * + * @return string content html + */ + public function get_content_html() + { + $global_data = $this->get_global_information_data(); + $content = '

    '.get_lang('GlobalPlatformInformation').'

    '; + $data_table = null; + if (!empty($global_data)) { + $data_table = ''; + $i = 1; + foreach ($global_data as $data) { + if ($i % 2 == 0) { + $class_tr = 'row_odd'; + } else { + $class_tr = 'row_even'; + } + $data_table .= ''; + foreach ($data as $cell) { + $data_table .= ''; + } + $data_table .= ''; + $i++; + } + $data_table .= '
    '.$cell.'
    '; + } else { + $data_table .= get_lang('ThereIsNoInformationAboutThePlatform'); + } + $content .= $data_table; + + return $content; + } + + /** + * Get global information data. + * + * @return array + */ + public function get_global_information_data() + { + // Two-dimensional array with data about the system + $path = api_get_path(WEB_CODE_PATH); + // Check total number of users + $global_info = [ + [get_lang('CountUsers'), ''.Statistics::countUsers().''], + // Check only active users + [get_lang('NumberOfUsersActive'), ''.Statistics::countUsers(null, null, null, true).''], + // Check number of courses + [get_lang('NumberOfCoursesTotal'), ''.Statistics::countCourses().''], + [get_lang('NumberOfCoursesPublic'), ''.Statistics::countCoursesByVisibility([COURSE_VISIBILITY_OPEN_WORLD]).''], + [get_lang('NumberOfCoursesOpen'), ''.Statistics::countCoursesByVisibility([COURSE_VISIBILITY_OPEN_PLATFORM]).''], + [get_lang('NumberOfCoursesPrivate'), ''.Statistics::countCoursesByVisibility([COURSE_VISIBILITY_REGISTERED]).''], + [get_lang('NumberOfCoursesClosed'), ''.Statistics::countCoursesByVisibility([COURSE_VISIBILITY_CLOSED]).''], + [get_lang('NumberOfCoursesHidden'), ''.Statistics::countCoursesByVisibility([COURSE_VISIBILITY_HIDDEN]).''], + ]; + + return $global_info; + } +} diff --git a/plugin/dashboard/block_global_info/block_global_info.info b/plugin/dashboard/block_global_info/block_global_info.info new file mode 100644 index 000000000..13ea3295e --- /dev/null +++ b/plugin/dashboard/block_global_info/block_global_info.info @@ -0,0 +1,6 @@ +name = "Global info Block" +controller = "BlockGlobalInfo" +description = "Display global platform information" +package = Dashboard +version = 1.0 +author = Yannick Warnier diff --git a/plugin/dashboard/block_global_info/index.html b/plugin/dashboard/block_global_info/index.html new file mode 100644 index 000000000..8e464d8ce --- /dev/null +++ b/plugin/dashboard/block_global_info/index.html @@ -0,0 +1,8 @@ + + + + + +
    + + \ No newline at end of file diff --git a/plugin/dashboard/block_session/block_session.class.php b/plugin/dashboard/block_session/block_session.class.php new file mode 100644 index 000000000..2cef1ef4b --- /dev/null +++ b/plugin/dashboard/block_session/block_session.class.php @@ -0,0 +1,164 @@ +user_id = $user_id; + $this->path = 'block_session'; + if ($this->is_block_visible_for_user($user_id)) { + $this->sessions = SessionManager::get_sessions_followed_by_drh($user_id); + } + } + + /** + * This method check if a user is allowed to see the block inside dashboard interface. + * + * @param int User id + * + * @return bool Is block visible for user + */ + public function is_block_visible_for_user($user_id) + { + $user_info = api_get_user_info($user_id); + $user_status = $user_info['status']; + $is_block_visible_for_user = false; + if (UserManager::is_admin($user_id) || in_array($user_status, $this->permission)) { + $is_block_visible_for_user = true; + } + + return $is_block_visible_for_user; + } + + /** + * This method return content html containing + * information about sessions and its position for showing it inside dashboard interface + * it's important to use the name 'get_block' for beeing used from dashboard controller. + * + * @return array column and content html + */ + public function get_block() + { + global $charset; + $column = 2; + $data = []; + $content = $this->get_content_html(); + $content_html = '
    +
    + '.get_lang('SessionsInformation').' +
    + +
    +
    +
    + '.$content.' +
    +
    + '; + + $data['column'] = $column; + $data['content_html'] = $content_html; + + return $data; + } + + /** + * This method return a content html, it's used inside get_block method for showing it inside dashboard interface. + * + * @return string content html + */ + public function get_content_html() + { + $content = ''; + $sessions = $this->sessions; + $content .= '

    '.get_lang('YourSessionsList').'

    '; + if (count($sessions) > 0) { + $sessions_table = ''; + $sessions_table .= ' + + + + '; + $i = 1; + foreach ($sessions as $session) { + $session_id = intval($session['id']); + $title = $session['name']; + + if (!empty($session['access_start_date'])) { + $dateFrom = api_convert_and_format_date( + $session['access_start_date'], + DATE_FORMAT_SHORT, + date_default_timezone_get() + ); + $dateUntil = api_convert_and_format_date( + $session['access_end_date'], + DATE_FORMAT_SHORT, + date_default_timezone_get() + ); + + $date = vsprintf(get_lang('FromDateXToDateY'), [$dateFrom, $dateUntil]); + } else { + $date = ' - '; + } + + $count_courses_in_session = count(Tracking::get_courses_list_from_session($session_id)); + + if ($i % 2 == 0) { + $class_tr = 'row_odd'; + } else { + $class_tr = 'row_even'; + } + + $sessions_table .= ' + + + + '; + $i++; + } + $sessions_table .= '
    '.get_lang('Title').''.get_lang('Date').''.get_lang('NbCoursesPerSession').'
    '.$title.''.$date.''.$count_courses_in_session.'
    '; + $content .= $sessions_table; + } else { + $content .= get_lang('ThereIsNoInformationAboutYourSessions'); + } + + if (count($sessions) > 0) { + $content .= ''; + } + + return $content; + } + + /** + * Get number of sessions. + * + * @return int + */ + public function get_number_of_sessions() + { + return count($this->sessions); + } +} diff --git a/plugin/dashboard/block_session/block_session.info b/plugin/dashboard/block_session/block_session.info new file mode 100644 index 000000000..1aef7a03a --- /dev/null +++ b/plugin/dashboard/block_session/block_session.info @@ -0,0 +1,6 @@ +name = "Session Block" +controller = "BlockSession" +description = "Display information about sessions inside platform" +package = Dashboard +version = 1.0 +author = Christian Fasanando \ No newline at end of file diff --git a/plugin/dashboard/block_session/index.html b/plugin/dashboard/block_session/index.html new file mode 100644 index 000000000..8e464d8ce --- /dev/null +++ b/plugin/dashboard/block_session/index.html @@ -0,0 +1,8 @@ + + + + + +
    + + \ No newline at end of file diff --git a/plugin/dashboard/block_student/block_student.class.php b/plugin/dashboard/block_student/block_student.class.php new file mode 100644 index 000000000..ec61fe1dd --- /dev/null +++ b/plugin/dashboard/block_student/block_student.class.php @@ -0,0 +1,259 @@ +user_id = $user_id; + $this->path = 'block_student'; + if ($this->is_block_visible_for_user($user_id)) { + $this->students = UserManager::get_users_followed_by_drh($user_id, STUDENT); + } + } + + /** + * This method check if a user is allowed to see the block inside dashboard interface. + * + * @param int User id + * + * @return bool Is block visible for user + */ + public function is_block_visible_for_user($user_id) + { + $user_info = api_get_user_info($user_id); + $user_status = $user_info['status']; + $is_block_visible_for_user = false; + if (UserManager::is_admin($user_id) || in_array($user_status, $this->permission)) { + $is_block_visible_for_user = true; + } + + return $is_block_visible_for_user; + } + + /** + * This method return content html containing information + * about students and its position for showing it inside dashboard interface + * it's important to use the name 'get_block' for beeing used from dashboard controller. + * + * @return array column and content html + */ + public function get_block() + { + global $charset; + $column = 1; + $data = []; + $student_content_html = $this->get_students_content_html_for_drh(); + $html = '
    +
    + '.get_lang('StudentsInformationsList').' +
    + + +
    +
    +
    + '.$student_content_html.' +
    +
    '; + $data['column'] = $column; + $data['content_html'] = $html; + + return $data; + } + + /** + * This method return a content html, it's used inside get_block method for showing it inside dashboard interface. + * + * @return string content html + */ + public function get_students_content_html_for_platform_admin() + { + $students = $this->students; + $content = '

    '.get_lang('YourStudents').'

    '; + $students_table = null; + if (count($students) > 0) { + $students_table .= ''; + $students_table .= ' + + + + + + + + '; + + $i = 1; + foreach ($students as $student) { + $courses_by_user = CourseManager::get_courses_list_by_user_id($student['user_id'], true); + $count_courses = count($courses_by_user); + $rowspan = $count_courses ? $count_courses + 1 : 2; + + if ($i % 2 == 0) { + $style = ' style="background-color:#F2F2F2" '; + } else { + $style = ' style="background-color:#FFF" '; + } + + $students_table .= ' + + + '; + + // courses information about the student + if (!empty($courses_by_user)) { + foreach ($courses_by_user as $course) { + $course_code = $course['code']; + $courseInfo = api_get_course_info($course_code); + $courseId = $courseInfo['real_id']; + $course_title = $course['title']; + $time = api_time_to_hms(Tracking::get_time_spent_on_the_course($student['user_id'], $courseId)); + $students_table .= ' + + + '; + } + } else { + $students_table .= ' + + '; + } + $i++; + } + $students_table .= '
    '.get_lang('FirstName').''.get_lang('LastName').''.get_lang('CourseInformation').'
    '.get_lang('Courses').''.get_lang('Time').'
    '.$student['firstname'].''.$student['lastname'].'
    '.$course_title.''.$time.'
    '.get_lang('Empty').'
    '; + } else { + $students_table .= get_lang('ThereIsNoInformationAboutYourStudents'); + } + + $content .= $students_table; + + if (count($students) > 0) { + $content .= ''; + } + //$content .= ''; + + return $content; + } + + /** + * @return string + */ + public function get_students_content_html_for_drh() + { + $attendance = new Attendance(); + $students = $this->students; + $content = '

    '.get_lang('YourStudents').'

    '; + $students_table = null; + if (count($students) > 0) { + $students_table .= ''; + $students_table .= ' + + + + '; + $i = 1; + foreach ($students as $student) { + $student_id = $student['user_id']; + $firstname = $student['firstname']; + $lastname = $student['lastname']; + $username = $student['username']; + // get average of faults in attendances by student + $results_faults_avg = $attendance->get_faults_average_inside_courses($student_id); + if (!empty($results_faults_avg)) { + $attendances_faults_avg = ''.$results_faults_avg['faults'].'/'.$results_faults_avg['total'].' ('.$results_faults_avg['porcent'].'%)'; + } else { + $attendances_faults_avg = '0%'; + } + + $courses_by_user = CourseManager::get_courses_list_by_user_id($student_id, true); + $evaluations_avg = 0; + $score = $weight = 0; + foreach ($courses_by_user as $course) { + $course_code = $course['code']; + $cats = Category::load( + null, + null, + $course_code, + null, + null, + null, + false + ); + $scoretotal = []; + if (isset($cats) && isset($cats[0])) { + $scoretotal = $cats[0]->calc_score($student_id, null, $course_code); + } + + if (!empty($scoretotal)) { + $score += $scoretotal[0]; + $weight += $scoretotal[1]; + } + } + + if (!empty($weight)) { + $evaluations_avg = ''.round($score, 2).'/'.round($weight, 2).'('.round(($score / $weight) * 100, 2).' %)'; + } + + if ($i % 2 == 0) { + $class_tr = 'row_odd'; + } else { + $class_tr = 'row_even'; + } + $students_table .= ' + + + + '; + + $i++; + } + $students_table .= '
    '.get_lang('User').''.get_lang('AttendancesFaults').''.get_lang('Evaluations').'
    '.api_get_person_name($firstname, $lastname).' ('.$username.')'.$attendances_faults_avg.''.$evaluations_avg.'
    '; + } else { + $students_table .= get_lang('ThereIsNoInformationAboutYourStudents'); + } + + $content .= $students_table; + + if (count($students) > 0) { + $content .= ''; + } + //$content .= ''; + + return $content; + } + + /** + * Get number of students. + * + * @return int + */ + public function get_number_of_students() + { + return count($this->students); + } +} diff --git a/plugin/dashboard/block_student/block_student.info b/plugin/dashboard/block_student/block_student.info new file mode 100644 index 000000000..65897b9ce --- /dev/null +++ b/plugin/dashboard/block_student/block_student.info @@ -0,0 +1,6 @@ +name = "Student Block" +controller = "BlockStudent" +description = "Display information about students inside platform" +package = Dashboard +version = 1.0 +author = Christian Fasanando \ No newline at end of file diff --git a/plugin/dashboard/block_student/index.html b/plugin/dashboard/block_student/index.html new file mode 100644 index 000000000..8e464d8ce --- /dev/null +++ b/plugin/dashboard/block_student/index.html @@ -0,0 +1,8 @@ + + + + + +
    + + \ No newline at end of file diff --git a/plugin/dashboard/block_student_graph/block_student_graph.class.php b/plugin/dashboard/block_student_graph/block_student_graph.class.php new file mode 100644 index 000000000..560e9404c --- /dev/null +++ b/plugin/dashboard/block_student_graph/block_student_graph.class.php @@ -0,0 +1,263 @@ + + */ +use CpChart\Cache as pCache; +use CpChart\Data as pData; +use CpChart\Image as pImage; + +/** + * This class is used like controller for student graph block plugin, + * the class name must be registered inside path.info file + * (e.g: controller = "BlockStudentGraph"), so dashboard controller will be instantiate it. + * + * @package chamilo.dashboard + */ +class BlockStudentGraph extends Block +{ + private $user_id; + private $students; + private $path; + private $permission = [DRH]; + + /** + * Constructor. + */ + public function __construct($user_id) + { + $this->user_id = $user_id; + $this->path = 'block_student_graph'; + if ($this->is_block_visible_for_user($user_id)) { + /*if (api_is_platform_admin()) { + $this->students = UserManager::get_user_list(array('status' => STUDENT)); + } else if (api_is_drh()) {*/ + $this->students = UserManager::get_users_followed_by_drh($user_id, STUDENT); + //} + } + } + + /** + * This method check if a user is allowed to see the block inside dashboard interface. + * + * @param int User id + * + * @return bool Is block visible for user + */ + public function is_block_visible_for_user($user_id) + { + $user_info = api_get_user_info($user_id); + $user_status = $user_info['status']; + $is_block_visible_for_user = false; + if (UserManager::is_admin($user_id) || in_array($user_status, $this->permission)) { + $is_block_visible_for_user = true; + } + + return $is_block_visible_for_user; + } + + /** + * This method return content html containing information about students + * and its position for showing it inside dashboard interface + * it's important to use the name 'get_block' for being used from dashboard controller. + * + * @return array column and content html + */ + public function get_block() + { + global $charset; + $column = 1; + $data = []; + $students_attendance_graph = $this->get_students_attendance_graph(); + + $html = '
    +
    + '.get_lang('StudentsInformationsGraph').' +
    + +
    +
    +
    +
    '.get_lang('AttendancesFaults').'
    + '.$students_attendance_graph.' +
    +
    '; + $data['column'] = $column; + $data['content_html'] = $html; + + return $data; + } + + /** + * This method return a graph containing information about students evaluation, + * it's used inside get_block method for showing it inside dashboard interface. + * + * @return string img html + */ + public function get_students_attendance_graph() + { + $students = $this->students; + $attendance = new Attendance(); + + // get data + $attendances_faults_avg = []; + if (is_array($students) && count($students) > 0) { + foreach ($students as $student) { + $student_id = $student['user_id']; + //$student_info = api_get_user_info($student_id); + // get average of faults in attendances by student + $results_faults_avg = $attendance->get_faults_average_inside_courses($student_id); + + if (!empty($results_faults_avg)) { + $attendances_faults_avg[$student['lastname']] = $results_faults_avg['porcent']; + } else { + $attendances_faults_avg[$student['lastname']] = 0; + } + } + } + + arsort($attendances_faults_avg); + $usernames = array_keys($attendances_faults_avg); + + $faults = []; + foreach ($usernames as $username) { + $faults[] = $attendances_faults_avg[$username]; + } + + $graph = ''; + $img_file = ''; + if (is_array($usernames) && count($usernames) > 0) { + // Defining data + $dataSet = new pData(); + $dataSet->addPoints($faults, 'Serie1'); + $dataSet->addPoints($usernames, 'Labels'); + $dataSet->setSerieDescription('Series1', get_lang('Average')); + $dataSet->setSerieDescription('Labels', get_lang('User')); + $dataSet->setAbscissa('Labels'); + $dataSet->setAbscissaName(get_lang('User')); + $dataSet->setAxisName(0, get_lang('Attendance')); + $palette = [ + '0' => ['R' => 186, 'G' => 206, 'B' => 151, 'Alpha' => 100], + '1' => ['R' => 210, 'G' => 148, 'B' => 147, 'Alpha' => 100], + '2' => ['R' => 148, 'G' => 170, 'B' => 208, 'Alpha' => 100], + '3' => ['R' => 221, 'G' => 133, 'B' => 61, 'Alpha' => 100], + '4' => ['R' => 65, 'G' => 153, 'B' => 176, 'Alpha' => 100], + '5' => ['R' => 114, 'G' => 88, 'B' => 144, 'Alpha' => 100], + '6' => ['R' => 138, 'G' => 166, 'B' => 78, 'Alpha' => 100], + '7' => ['R' => 171, 'G' => 70, 'B' => 67, 'Alpha' => 100], + '8' => ['R' => 69, 'G' => 115, 'B' => 168, 'Alpha' => 100], + ]; + // Cache definition + $cachePath = api_get_path(SYS_ARCHIVE_PATH); + $myCache = new pCache( + [ + 'CacheFolder' => substr( + $cachePath, + 0, + strlen($cachePath) - 1 + ), + ] + ); + $chartHash = $myCache->getHash($dataSet); + if ($myCache->isInCache($chartHash)) { + $imgPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash; + $myCache->saveFromCache($chartHash, $imgPath); + $imgPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash; + } else { + $maxCounts = max(count($usernames), count($faults)); + if ($maxCounts < 5) { + $heightSize = 200; + } else { + $heightSize = $maxCounts * 40; + } + + /* Create the pChart object */ + $widthSize = 480; + $angle = 40; + + $myPicture = new pImage($widthSize, $heightSize, $dataSet); + + /* Turn of Antialiasing */ + $myPicture->Antialias = false; + + /* Add a border to the picture */ + $myPicture->drawRectangle(0, 0, $widthSize - 1, $heightSize - 1, ['R' => 0, 'G' => 0, 'B' => 0]); + + /* Set the default font */ + $myPicture->setFontProperties( + [ + 'FontName' => api_get_path(SYS_FONTS_PATH).'opensans/OpenSans-Regular.ttf', + 'FontSize' => 10, + ] + ); + + /* Do NOT Write the chart title */ + + /* Define the chart area */ + $myPicture->setGraphArea(80, 40, $widthSize - 20, $heightSize - 40); + + /* Draw the scale */ + $scaleSettings = [ + 'GridR' => 200, + 'GridG' => 200, + 'GridB' => 200, + 'DrawSubTicks' => true, + 'CycleBackground' => true, + 'Mode' => SCALE_MODE_ADDALL_START0, + 'Pos' => SCALE_POS_TOPBOTTOM, + 'DrawXLines' => false, + 'LabelRotation' => $angle, + ]; + + $myPicture->drawScale($scaleSettings); + + /* Turn on shadow computing */ + $myPicture->setShadow(true, ['X' => 1, 'Y' => 1, 'R' => 0, 'G' => 0, 'B' => 0, 'Alpha' => 10]); + + /* Draw the chart */ + $myPicture->setShadow(true, ['X' => 1, 'Y' => 1, 'R' => 0, 'G' => 0, 'B' => 0, 'Alpha' => 10]); + $settings = [ + 'OverrideColors' => $palette, + 'Gradient' => false, + 'GradientMode' => GRADIENT_SIMPLE, + 'DisplayPos' => LABEL_POS_TOP, + 'DisplayValues' => true, + 'DisplayR' => 0, + 'DisplayG' => 0, + 'DisplayB' => 0, + 'DisplayShadow' => true, + 'Surrounding' => 10, + ]; + $myPicture->drawBarChart($settings); + + /* Write and save into cache */ + $myCache->writeToCache($chartHash, $myPicture); + $imgPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash; + $myCache->saveFromCache($chartHash, $imgPath); + $imgPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash; + } + $graph = ''; + } else { + $graph = '

    '.api_convert_encoding(get_lang('GraphicNotAvailable'), 'UTF-8').'

    '; + } + + return $graph; + } + + /** + * Get number of students. + * + * @return int + */ + public function get_number_of_students() + { + return count($this->students); + } +} diff --git a/plugin/dashboard/block_student_graph/block_student_graph.info b/plugin/dashboard/block_student_graph/block_student_graph.info new file mode 100644 index 000000000..e4d29bc3f --- /dev/null +++ b/plugin/dashboard/block_student_graph/block_student_graph.info @@ -0,0 +1,6 @@ +name = "Student Graph Block" +controller = "BlockStudentGraph" +description = "Display information about students inside platform with graph" +package = Dashboard +version = 1.0 +author = Christian Fasanando \ No newline at end of file diff --git a/plugin/dashboard/block_teacher/block_teacher.class.php b/plugin/dashboard/block_teacher/block_teacher.class.php new file mode 100644 index 000000000..f22aa86f2 --- /dev/null +++ b/plugin/dashboard/block_teacher/block_teacher.class.php @@ -0,0 +1,212 @@ +user_id = $user_id; + $this->path = 'block_teacher'; + if ($this->is_block_visible_for_user($user_id)) { + $this->teachers = UserManager::get_users_followed_by_drh($user_id, COURSEMANAGER); + } + } + + /** + * This method check if a user is allowed to see the block inside dashboard interface. + * + * @param int User id + * + * @return bool Is block visible for user + */ + public function is_block_visible_for_user($user_id) + { + $user_info = api_get_user_info($user_id); + $user_status = $user_info['status']; + $is_block_visible_for_user = false; + if (UserManager::is_admin($user_id) || in_array($user_status, $this->permission)) { + $is_block_visible_for_user = true; + } + + return $is_block_visible_for_user; + } + + /** + * This method return content html containing information about + * teachers and its position for showing it inside dashboard interface + * it's important to use the name 'get_block' for beeing used from + * dashboard controller. + * + * @return array column and content html + */ + public function get_block() + { + global $charset; + $column = 1; + $data = []; + $teacher_content_html = $this->get_teachers_content_html_for_drh(); + $html = ' +
    +
    + '.get_lang('TeachersInformationsList').' +
    + +
    +
    +
    + '.$teacher_content_html.' +
    +
    + '; + + $data['column'] = $column; + $data['content_html'] = $html; + + return $data; + } + + /** + * This method return a content html, it's used inside get_block method + * for showing it inside dashboard interface. + * + * @return string content html + */ + public function get_teachers_content_html_for_platform_admin() + { + $teachers = $this->teachers; + $content = '

    '.get_lang('YourTeachers').'

    '; + + $teachers_table = null; + if (count($teachers) > 0) { + $teachers_table .= ''; + $teachers_table .= ' + + + + + + '; + $i = 1; + foreach ($teachers as $teacher) { + $teacher_id = $teacher['user_id']; + $firstname = $teacher['firstname']; + $lastname = $teacher['lastname']; + $username = $teacher['username']; + + $time_on_platform = api_time_to_hms(Tracking::get_time_spent_on_the_platform($teacher_id)); + $last_connection = Tracking::get_last_connection_date($teacher_id); + + if ($i % 2 == 0) { + $class_tr = 'row_odd'; + } else { + $class_tr = 'row_even'; + } + $teachers_table .= ' + + + + + + '; + $i++; + } + $teachers_table .= '
    '.get_lang('User').''.get_lang('TimeSpentOnThePlatform').''.get_lang('LastConnexion').'
    '.api_get_person_name($firstname, $lastname).' ('.$username.')'.$time_on_platform.''.$last_connection.'
    '; + } else { + $teachers_table .= get_lang('ThereIsNoInformationAboutYourTeachers'); + } + + $content .= $teachers_table; + + if (count($teachers) > 0) { + $content .= ''; + } + + return $content; + } + + public function get_teachers_content_html_for_drh() + { + $teachers = $this->teachers; + $content = '

    '.get_lang('YourTeachers').'

    '; + $teachers_table = null; + if (count($teachers) > 0) { + $a_last_week = get_last_week(); + $last_week = date('Y-m-d', $a_last_week[0]).' '.get_lang('To').' '.date('Y-m-d', $a_last_week[6]); + + $teachers_table .= ''; + $teachers_table .= ' + + + + + '; + + $i = 1; + foreach ($teachers as $teacher) { + $teacher_id = $teacher['user_id']; + $firstname = $teacher['firstname']; + $lastname = $teacher['lastname']; + $username = $teacher['username']; + $time_on_platform = api_time_to_hms( + Tracking::get_time_spent_on_the_platform($teacher_id, true) + ); + + if ($i % 2 == 0) { + $class_tr = 'row_odd'; + } else { + $class_tr = 'row_even'; + } + $teachers_table .= ' + + + '; + + $i++; + } + $teachers_table .= '
    '.get_lang('User').''.get_lang('TimeSpentLastWeek').'
    '.$last_week.'
    '.api_get_person_name($firstname, $lastname).' ('.$username.')'.$time_on_platform.'
    '; + } else { + $teachers_table .= get_lang('ThereIsNoInformationAboutYourTeachers'); + } + $content .= $teachers_table; + if (count($teachers) > 0) { + $content .= ''; + } + + return $content; + } + + /** + * Get number of teachers. + * + * @return int + */ + public function get_number_of_teachers() + { + return count($this->teachers); + } +} diff --git a/plugin/dashboard/block_teacher/block_teacher.info b/plugin/dashboard/block_teacher/block_teacher.info new file mode 100644 index 000000000..af4394aa5 --- /dev/null +++ b/plugin/dashboard/block_teacher/block_teacher.info @@ -0,0 +1,6 @@ +name = "Teacher Block" +controller = "BlockTeacher" +description = "Display information about teachers inside platform" +package = Dashboard +version = 1.0 +author = Christian Fasanando \ No newline at end of file diff --git a/plugin/dashboard/block_teacher/index.html b/plugin/dashboard/block_teacher/index.html new file mode 100644 index 000000000..8e464d8ce --- /dev/null +++ b/plugin/dashboard/block_teacher/index.html @@ -0,0 +1,8 @@ + + + + + +
    + + \ No newline at end of file diff --git a/plugin/dashboard/block_teacher_graph/block_teacher_graph.class.php b/plugin/dashboard/block_teacher_graph/block_teacher_graph.class.php new file mode 100644 index 000000000..9dfbc629b --- /dev/null +++ b/plugin/dashboard/block_teacher_graph/block_teacher_graph.class.php @@ -0,0 +1,221 @@ +user_id = $user_id; + $this->path = 'block_teacher_graph'; + if ($this->is_block_visible_for_user($user_id)) { + $this->teachers = UserManager::get_users_followed_by_drh($user_id, COURSEMANAGER); + } + } + + /** + * This method check if a user is allowed to see the block inside dashboard interface. + * + * @param int User id + * + * @return bool Is block visible for user + */ + public function is_block_visible_for_user($user_id) + { + $user_info = api_get_user_info($user_id); + $user_status = $user_info['status']; + $is_block_visible_for_user = false; + if (UserManager::is_admin($user_id) || in_array($user_status, $this->permission)) { + $is_block_visible_for_user = true; + } + + return $is_block_visible_for_user; + } + + /** + * This method return content html containing information about teachers and its position for showing it inside dashboard interface + * it's important to use the name 'get_block' for beeing used from dashboard controller. + * + * @return array column and content html + */ + public function get_block() + { + global $charset; + $column = 1; + $data = []; + $teacher_information_graph = $this->get_teachers_information_graph(); + $html = ' +
    +
    '.get_lang('TeachersInformationsGraph').' +
    + +
    +
    +
    +
    '.get_lang('TimeSpentOnThePlatformLastWeekByDay').'
    + '.$teacher_information_graph.' +
    +
    + '; + + $data['column'] = $column; + $data['content_html'] = $html; + + return $data; + } + + /** + * This method return a content html, it's used inside get_block method for showing it inside dashboard interface. + * + * @return string content html + */ + public function get_teachers_information_graph() + { + $teachers = $this->teachers; + $graph = ''; + $user_ids = array_keys($teachers); + $a_last_week = get_last_week(); + + if (is_array($user_ids) && count($user_ids) > 0) { + $dataSet = new pData(); + foreach ($user_ids as $user_id) { + $teacher_info = api_get_user_info($user_id); + $username = $teacher_info['username']; + $time_by_days = []; + foreach ($a_last_week as $day) { + // day is received as y-m-d 12:00:00 + $start_date = api_get_utc_datetime($day); + $end_date = api_get_utc_datetime($day + (3600 * 24 - 1)); + + $time_on_platform_by_day = Tracking::get_time_spent_on_the_platform( + $user_id, + 'custom', + $start_date, + $end_date + ); + $hours = floor($time_on_platform_by_day / 3600); + $min = floor(($time_on_platform_by_day - ($hours * 3600)) / 60); + $time_by_days[] = $min; + } + $dataSet->addPoints($time_by_days, $username); + } + + $last_week = date('Y-m-d', $a_last_week[0]).' '.get_lang('To').' '.date('Y-m-d', $a_last_week[6]); + $days_on_week = []; + foreach ($a_last_week as $weekday) { + $days_on_week[] = date('d/m', $weekday); + } + + $dataSet->addPoints($days_on_week, 'Days'); + $dataSet->setAbscissaName($last_week); + $dataSet->setAxisName(0, get_lang('Minutes')); + $dataSet->setAbscissa('Days'); + $dataSet->loadPalette(api_get_path(SYS_CODE_PATH).'palettes/pchart/default.color', true); + + // Cache definition + $cachePath = api_get_path(SYS_ARCHIVE_PATH); + $myCache = new pCache(['CacheFolder' => substr($cachePath, 0, strlen($cachePath) - 1)]); + $chartHash = $myCache->getHash($dataSet); + if ($myCache->isInCache($chartHash)) { + $imgPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash; + $myCache->saveFromCache($chartHash, $imgPath); + $imgPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash; + } else { + /* Create the pChart object */ + $widthSize = 440; + $heightSize = 350; + $angle = 50; + $myPicture = new pImage($widthSize, $heightSize, $dataSet); + + /* Turn of Antialiasing */ + $myPicture->Antialias = false; + + /* Add a border to the picture */ + $myPicture->drawRectangle(0, 0, $widthSize - 1, $heightSize - 1, ['R' => 0, 'G' => 0, 'B' => 0]); + + /* Set the default font */ + $myPicture->setFontProperties(['FontName' => api_get_path(SYS_FONTS_PATH).'opensans/OpenSans-Regular.ttf', 'FontSize' => 10]); + + /* Do NOT Write the chart title */ + + /* Define the chart area */ + $myPicture->setGraphArea(40, 40, $widthSize - 20, $heightSize - 80); + + /* Draw the scale */ + $scaleSettings = [ + 'GridR' => 200, + 'GridG' => 200, + 'GridB' => 200, + 'DrawSubTicks' => true, + 'CycleBackground' => true, + 'Mode' => SCALE_MODE_ADDALL_START0, + 'LabelRotation' => $angle, + ]; + + $myPicture->drawScale($scaleSettings); + + /* Turn on shadow computing */ + $myPicture->setShadow(true, ['X' => 1, 'Y' => 1, 'R' => 0, 'G' => 0, 'B' => 0, 'Alpha' => 10]); + + /* Draw the chart */ + $myPicture->setShadow(true, ['X' => 1, 'Y' => 1, 'R' => 0, 'G' => 0, 'B' => 0, 'Alpha' => 10]); + $settings = [ + 'DisplayValues' => true, + 'DisplayR' => 0, + 'DisplayG' => 0, + 'DisplayB' => 0, + ]; + $myPicture->drawFilledSplineChart($settings); + $myPicture->drawLegend(40, 20, ['Mode' => LEGEND_HORIZONTAL]); + + /* Write and save into cache */ + $myCache->writeToCache($chartHash, $myPicture); + $imgPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash; + $myCache->saveFromCache($chartHash, $imgPath); + $imgPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash; + } + $graph = ''; + } else { + $graph = '

    '.api_convert_encoding(get_lang('GraphicNotAvailable'), 'UTF-8').'

    '; + } + + return $graph; + } + + /** + * Get number of teachers. + * + * @return int + */ + public function get_number_of_teachers() + { + return count($this->teachers); + } +} diff --git a/plugin/dashboard/block_teacher_graph/block_teacher_graph.info b/plugin/dashboard/block_teacher_graph/block_teacher_graph.info new file mode 100644 index 000000000..b0ffc7f20 --- /dev/null +++ b/plugin/dashboard/block_teacher_graph/block_teacher_graph.info @@ -0,0 +1,6 @@ +name = "Teacher Graph Block" +controller = "BlockTeacherGraph" +description = "Display information about teachers inside platform with graph" +package = Dashboard +version = 1.0 +author = Christian Fasanando \ No newline at end of file diff --git a/plugin/dashboard/css/default.css b/plugin/dashboard/css/default.css new file mode 100644 index 000000000..26533e3ae --- /dev/null +++ b/plugin/dashboard/css/default.css @@ -0,0 +1,80 @@ +/* Colors */ +.color-yellow {background:#f2bc00;} +.color-red {background:#dd0000;} +.color-blue {background:#00A9E0;} +.color-white {background:#dfdfdf;} +.color-orange {background:#f66e00;} +.color-green {background:#8dc100;} +.color-yellow h3, +.color-white h3, +.color-green h3 + {color:#000;} +.color-red h3, +.color-blue h3, +.color-orange h3 { + color: #FFF; +} + +/* End Colors */ + +.widget { + margin: 30px 20px 0 20px; + padding: 2px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; +} +.widget .widget-head { + color: #000; + overflow: hidden; + width: 100%; + height: 30px; + line-height: 30px; +} +.widget .widget-head h3 { + padding: 0 5px; + float: left; +} +.widget .widget-content { + background: #FFF url(img/widget-content-bg.png) repeat-x; + padding: 0 5px; + color: #000; + -moz-border-radius-bottomleft: 2px; + -moz-border-radius-bottomright: 2px; + -webkit-border-bottom-left-radius: 2px; + -webkit-border-bottom-right-radius: 2px; + line-height: 1.2em; + overflow: hidden; +} +.widget .widget-content p { + padding: 0.8em 0; + border-bottom: 1px solid #666; +} +.widget .widget-content pre { + padding: 0.5em 5px; + color: #EEE; + font-size: 12px; +} +.widget .widget-content ul { + padding: 5px 0 5px 20px; + list-style: disc; +} +.widget .widget-content ul li {padding: 3px 0;} +.widget .widget-content ul.images { + padding: 7px 0 0 0; + list-style: none; + height: 1%; +} +.widget .widget-content ul.images li { + display: inline; + float: left; +} +.widget .widget-content ul.images img { + display: inline; + float: left; + margin: 0 0 7px 7px; +} + +.widget-actions {text-align:right;margin-right:5px;margin-top:5px;} +.widget-actions img { + margin-bottom: 15px; +} diff --git a/plugin/dashboard/index.html b/plugin/dashboard/index.html new file mode 100644 index 000000000..8e464d8ce --- /dev/null +++ b/plugin/dashboard/index.html @@ -0,0 +1,8 @@ + + + + + +
    + + \ No newline at end of file diff --git a/plugin/date/README.md b/plugin/date/README.md new file mode 100644 index 000000000..2290eb9b1 --- /dev/null +++ b/plugin/date/README.md @@ -0,0 +1,8 @@ +Date plugin +=== + +This plugin is more of a demo and a plugin example than a real, functional plugin. + +It will show the current date in an area of your choice. + +The .act.php and .dsp.php files are just remains of a time where we didn't use the Twig templating system. \ No newline at end of file diff --git a/plugin/date/index.act.php b/plugin/date/index.act.php new file mode 100644 index 000000000..6438e6828 --- /dev/null +++ b/plugin/date/index.act.php @@ -0,0 +1,22 @@ + "en_US", + "french" => "fr_BE", + "dutch" => "nl_NL", + "german" => "de_DE", + "japanese" => "ja_JP", + "danish" => "da_DK", +]; +if (!empty($_SESSION['user_language_choice']) && !empty($convert_lang_to_code[$_SESSION['user_language_choice']])) { + $code = $convert_lang_to_code[$_SESSION['user_language_choice']]; + $locale = setlocale(LC_TIME, $code); +} +$date = strftime('%c'); diff --git a/plugin/date/index.dsp.php b/plugin/date/index.dsp.php new file mode 100644 index 000000000..2b2223ad9 --- /dev/null +++ b/plugin/date/index.dsp.php @@ -0,0 +1,10 @@ +'.strip_tags($date).''; diff --git a/plugin/date/index.php b/plugin/date/index.php new file mode 100644 index 000000000..000eb2690 --- /dev/null +++ b/plugin/date/index.php @@ -0,0 +1,11 @@ +Plugins). + * + * @package chamilo.plugin + * + * @author Yannick Warnier + */ +/** + * Plugin details (must be present). + */ +//the plugin title +$plugin_info['title'] = 'Date'; +//the comments that go with the plugin +$plugin_info['comment'] = "Multinational date display"; +//the plugin version +$plugin_info['version'] = '1.0'; +//the plugin author +$plugin_info['author'] = 'Yannick Warnier'; diff --git a/plugin/date/start.php b/plugin/date/start.php new file mode 100644 index 000000000..fda112586 --- /dev/null +++ b/plugin/date/start.php @@ -0,0 +1,10 @@ + 'boolean', + ] + ); + } + + /** + * @return DictionaryPlugin|null + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * Installation process. + */ + public function install() + { + $sql = "CREATE TABLE IF NOT EXISTS plugin_dictionary ( + id INT NOT NULL AUTO_INCREMENT, + term VARCHAR(255) NOT NULL, + definition LONGTEXT NOT NULL, + PRIMARY KEY (id)); + "; + Database::query($sql); + } + + /** + * Uninstall process. + */ + public function uninstall() + { + $sql = "DROP TABLE IF EXISTS plugin_dictionary"; + Database::query($sql); + } +} diff --git a/plugin/dictionary/index.php b/plugin/dictionary/index.php new file mode 100644 index 000000000..6ee8d4ba2 --- /dev/null +++ b/plugin/dictionary/index.php @@ -0,0 +1,2 @@ +install(); diff --git a/plugin/dictionary/lang/english.php b/plugin/dictionary/lang/english.php new file mode 100644 index 000000000..2786b5758 --- /dev/null +++ b/plugin/dictionary/lang/english.php @@ -0,0 +1,6 @@ +get_info(); diff --git a/plugin/dictionary/terms.php b/plugin/dictionary/terms.php new file mode 100644 index 000000000..cdfb3f248 --- /dev/null +++ b/plugin/dictionary/terms.php @@ -0,0 +1,82 @@ +addText('term', $plugin->get_lang('Term'), true); +$form->addTextarea('definition', $plugin->get_lang('Definition'), [], true); +//$form->addHtmlEditor('definition', get_lang('Definition'), true); +$form->addButtonSave(get_lang('Save')); + +switch ($action) { + case 'add': + if ($form->validate()) { + $values = $form->getSubmitValues(); + $params = [ + 'term' => $values['term'], + 'definition' => $values['definition'], + ]; + $result = Database::insert($table, $params); + if ($result) { + Display::addFlash(Display::return_message(get_lang('Added'))); + } + header('Location: '.api_get_self()); + exit; + } + break; + case 'edit': + $form->setDefaults($term); + if ($form->validate()) { + $values = $form->getSubmitValues(); + $params = [ + 'term' => $values['term'], + 'definition' => $values['definition'], + ]; + Database::update($table, $params, ['id = ?' => $id]); + Display::addFlash(Display::return_message(get_lang('Updated'))); + + header('Location: '.api_get_self()); + exit; + } + break; + case 'delete': + if (!empty($term)) { + Database::delete($table, ['id = ?' => $id]); + Display::addFlash(Display::return_message(get_lang('Deleted'))); + header('Location: '.api_get_self()); + exit; + } + break; +} + +$tpl = new Template($plugin->get_lang('plugin_title')); +$tpl->assign('terms', $terms); +$tpl->assign('form', $form->returnForm()); +$content = $tpl->fetch('/'.$plugin->get_name().'/view/terms.html.twig'); +// Assign into content +$tpl->assign('content', $content); +// Display +$tpl->display_one_col_template(); diff --git a/plugin/dictionary/view/terms.html.twig b/plugin/dictionary/view/terms.html.twig new file mode 100644 index 000000000..99d28fdfe --- /dev/null +++ b/plugin/dictionary/view/terms.html.twig @@ -0,0 +1,34 @@ + +{{ form }} + + + + + + + +{% for term in terms %} + + + + + +{% endfor %} +
    + {{ 'Term' | get_plugin_lang('DictionaryPlugin') }} + + {{ 'Definition' | get_plugin_lang('DictionaryPlugin') }} + + {{ 'Actions' | get_lang }} +
    + {{ term.term }} + + {{ term.definition }} + + + {{ 'Edit'|get_lang }} + + + {{ 'Delete'|get_lang }} + +
    \ No newline at end of file diff --git a/plugin/embedregistry/EmbedRegistryPlugin.php b/plugin/embedregistry/EmbedRegistryPlugin.php new file mode 100644 index 000000000..d79a64e32 --- /dev/null +++ b/plugin/embedregistry/EmbedRegistryPlugin.php @@ -0,0 +1,250 @@ + '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( + '', + $embed->getDisplayStartDate()->format(DateTime::W3C), + api_convert_and_format_date($embed->getDisplayStartDate()) + ); + $endDate = sprintf( + '', + $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%']); + } +} diff --git a/plugin/embedregistry/Entity/Embed.php b/plugin/embedregistry/Entity/Embed.php new file mode 100644 index 000000000..313305b28 --- /dev/null +++ b/plugin/embedregistry/Entity/Embed.php @@ -0,0 +1,198 @@ +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; + } +} diff --git a/plugin/embedregistry/README.md b/plugin/embedregistry/README.md new file mode 100644 index 000000000..386cd450d --- /dev/null +++ b/plugin/embedregistry/README.md @@ -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. diff --git a/plugin/embedregistry/install.php b/plugin/embedregistry/install.php new file mode 100644 index 000000000..19b924077 --- /dev/null +++ b/plugin/embedregistry/install.php @@ -0,0 +1,4 @@ +install(); diff --git a/plugin/embedregistry/lang/english.php b/plugin/embedregistry/lang/english.php new file mode 100644 index 000000000..a6129f035 --- /dev/null +++ b/plugin/embedregistry/lang/english.php @@ -0,0 +1,22 @@ +get_info(); diff --git a/plugin/embedregistry/start.php b/plugin/embedregistry/start.php new file mode 100644 index 000000000..5704fb00a --- /dev/null +++ b/plugin/embedregistry/start.php @@ -0,0 +1,309 @@ +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(); diff --git a/plugin/embedregistry/uninstall.php b/plugin/embedregistry/uninstall.php new file mode 100644 index 000000000..5906ba3cc --- /dev/null +++ b/plugin/embedregistry/uninstall.php @@ -0,0 +1,4 @@ +uninstall(); diff --git a/plugin/embedregistry/view.php b/plugin/embedregistry/view.php new file mode 100644 index 000000000..1b4ca43d3 --- /dev/null +++ b/plugin/embedregistry/view.php @@ -0,0 +1,72 @@ +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', + '

    '.$plugin->formatDisplayDate($embed).'

    ' + .PHP_EOL + .Security::remove_XSS($embed->getHtmlCode(), COURSEMANAGERLOWSECURITY) +); +$view->display_one_col_template(); diff --git a/plugin/embedregistry/view/start.tpl b/plugin/embedregistry/view/start.tpl new file mode 100644 index 000000000..c53f63aa8 --- /dev/null +++ b/plugin/embedregistry/view/start.tpl @@ -0,0 +1,37 @@ +{% if is_allowed_to_edit %} + {% if external_url is defined %} +
    +

    + {{ 'YouNeedCreateContent'|get_plugin_lang('EmbedRegistryPlugin') }} + {{ 'CreateContent'|get_plugin_lang('EmbedRegistryPlugin') }} +

    +
    + {% endif %} + + {% if form is defined %} + {{ form }} + {% endif %} +{% endif %} + +{% if current_embed is defined %} + {% set start_date %} + + {% endset %} + {% set end_date %} + + {% endset %} + +
    +

    {{ current_embed.title }}

    +

    + {{ 'FromDateXToDateY'|get_lang|format(start_date, end_date) }} +

    +

    {{ current_link }}

    +
    +{% endif %} + +{{ table }} diff --git a/plugin/exercise_signature/README.md b/plugin/exercise_signature/README.md new file mode 100644 index 000000000..2664c08e3 --- /dev/null +++ b/plugin/exercise_signature/README.md @@ -0,0 +1,15 @@ +# Exercises signature + +This plugin allows the teacher to check a box in any exercise configuration to request a signature from the user at the end of the exercise attempt. + +A modal window, a bit like a mini-whiteboard, will then appear to students asking them to sign. The signature can be done through the mouse (unpractical), through a touch device (ideal with tablets) or through a touch-sensitive laptop screen. + +Teachers will see the signature when they review the attempt details. + +## Installation + +This plugin creates extra fields for exercises automatically. + +Signatures are saved as a drawing in the database. + +Uninstalling this plugin will remove the extra fields, so all signatures will disappear (instantly) if you uninstall this. Consider using the "disable" option inside the plugin configuration instead. \ No newline at end of file diff --git a/plugin/exercise_signature/index.php b/plugin/exercise_signature/index.php new file mode 100644 index 000000000..b3d9bbc7f --- /dev/null +++ b/plugin/exercise_signature/index.php @@ -0,0 +1 @@ +install(); diff --git a/plugin/exercise_signature/lang/english.php b/plugin/exercise_signature/lang/english.php new file mode 100644 index 000000000..5dc0bb89c --- /dev/null +++ b/plugin/exercise_signature/lang/english.php @@ -0,0 +1,12 @@ + 'boolean', + ] + ); + $this->isAdminPlugin = true; + } + + /** + * @return $this + */ + public static function create() + { + static $instance = null; + + return $instance ? $instance : $instance = new self(); + } + + public static function exerciseHasSignatureActivated(Exercise $exercise) + { + if (empty($exercise->iid)) { + return false; + } + + if ('true' === api_get_plugin_setting('exercise_signature', 'tool_enable')) { + $extraFieldValue = new ExtraFieldValue('exercise'); + $result = $extraFieldValue->get_values_by_handler_and_field_variable($exercise->iid, 'signature_activated'); + if ($result && isset($result['value']) && 1 === (int) $result['value']) { + return true; + } + } + + return false; + } + + public static function saveSignature($userId, $trackInfo, $file) + { + if (false === self::validateSignatureAccess($userId, $trackInfo)) { + return false; + } + + $signature = self::getSignature($userId, $trackInfo); + if (false !== $signature) { + return false; + } + + if (empty($file)) { + return false; + } + + $params = [ + 'item_id' => $trackInfo['exe_id'], + 'extra_signature' => $file, + ]; + $extraFieldValue = new ExtraFieldValue('track_exercise'); + $extraFieldValue->saveFieldValues( + $params, + true + ); + + $signature = self::getSignature($userId, $trackInfo); + if (false !== $signature) { + return true; + } + + return true; + } + + public static function validateSignatureAccess($userId, $trackInfo) + { + $userId = (int) $userId; + if (isset($trackInfo['exe_id']) && isset($trackInfo['exe_user_id']) && + !empty($trackInfo['exe_id']) && !empty($trackInfo['exe_user_id']) && + $trackInfo['status'] !== 'incomplete' + ) { + if ($userId === (int) $trackInfo['exe_user_id']) { + return true; + } + } + + return false; + } + + public static function getSignature($userId, $trackInfo) + { + if (false === self::validateSignatureAccess($userId, $trackInfo)) { + return false; + } + + $extraFieldValue = new ExtraFieldValue('track_exercise'); + $result = $extraFieldValue->get_values_by_handler_and_field_variable($trackInfo['exe_id'], 'signature'); + + if ($result && isset($result['value']) && !empty($result['value'])) { + return $result['value']; + } + + return false; + } + + /** + * Get the plugin Name. + * + * @return string + */ + public function get_name() + { + return 'exercise_signature'; + } + + /** + * Creates this plugin's related tables in the internal database. + * Installs course fields in all courses. + */ + public function install() + { + $extraField = new ExtraField('exercise'); + $extraFieldHandler = $extraField->get_handler_field_info_by_field_variable('signature_activated'); + $exists = $extraFieldHandler !== false; + + if (!$exists) { + $extraField->save( + [ + 'field_type' => 13, // checkbox yes/no + 'variable' => 'signature_activated', + 'display_text' => get_plugin_lang('SignatureActivated', 'ExerciseSignaturePlugin'), + 'default_value' => null, + 'field_order' => null, + 'visible_to_self' => 1, + 'changeable' => 1, + 'filter' => null, + ] + ); + } + + $extraFieldHandler = $extraField->get_handler_field_info_by_field_variable('signature_mandatory'); + $exists = $extraFieldHandler !== false; + + if (!$exists) { + $extraField->save( + [ + 'field_type' => 13, // checkbox yes/no + 'variable' => 'signature_mandatory', + 'display_text' => get_plugin_lang('SignatureMandatory', 'ExerciseSignaturePlugin'), + 'default_value' => null, + 'field_order' => null, + 'visible_to_self' => 1, + 'changeable' => 1, + 'filter' => null, + ] + ); + } + + $extraField = new ExtraField('track_exercise'); + $extraFieldHandler = $extraField->get_handler_field_info_by_field_variable('signature'); + $exists = $extraFieldHandler !== false; + + if (!$exists) { + $extraField->save( + [ + 'field_type' => 2, // textarea + 'variable' => 'signature', + 'display_text' => get_plugin_lang('Signature', 'ExerciseSignaturePlugin'), + 'default_value' => null, + 'field_order' => null, + 'visible_to_self' => 1, + 'changeable' => 1, + 'filter' => null, + ] + ); + } + + $table = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES); + $sql = "ALTER TABLE $table MODIFY COLUMN value LONGTEXT null;"; + Database::query($sql); + } + + /** + * Drops this plugins' related tables from the internal database. + * Uninstalls course fields in all courses(). + */ + public function uninstall() + { + $extraField = new ExtraField('track_exercise'); + $fieldInfo = $extraField->get_handler_field_info_by_field_variable('signature_activated'); + + if ($fieldInfo) { + $extraField->delete($fieldInfo['id']); + } + + $extraField = new ExtraField('exercise'); + $fieldInfo = $extraField->get_handler_field_info_by_field_variable('signature'); + if ($fieldInfo) { + $extraField->delete($fieldInfo['id']); + } + } +} diff --git a/plugin/exercise_signature/plugin.php b/plugin/exercise_signature/plugin.php new file mode 100644 index 000000000..67dec73fe --- /dev/null +++ b/plugin/exercise_signature/plugin.php @@ -0,0 +1,5 @@ +get_info(); diff --git a/plugin/exercise_signature/uninstall.php b/plugin/exercise_signature/uninstall.php new file mode 100644 index 000000000..393069c52 --- /dev/null +++ b/plugin/exercise_signature/uninstall.php @@ -0,0 +1,9 @@ +uninstall(); diff --git a/plugin/exercisefocused/admin.php b/plugin/exercisefocused/admin.php new file mode 100644 index 000000000..e2078618b --- /dev/null +++ b/plugin/exercisefocused/admin.php @@ -0,0 +1,32 @@ +getRepository(Log::class); + +$reportingController = new AdminController( + ExerciseFocusedPlugin::create(), + HttpRequest::createFromGlobals(), + $em, + $logRepository +); + +try { + $response = $reportingController(); +} catch (Exception $e) { + $response = HttpResponse::create('', HttpResponse::HTTP_FORBIDDEN); +} + +$response->send(); diff --git a/plugin/exercisefocused/index.php b/plugin/exercisefocused/index.php new file mode 100644 index 000000000..cfe8e1c38 --- /dev/null +++ b/plugin/exercisefocused/index.php @@ -0,0 +1,48 @@ +isEnableForExercise($exerciseId); + +if ($renderRegion) { + $_template['show_region'] = true; + + $em = Database::getManager(); + + $existingExeId = (int) ChamiloSession::read('exe_id'); + $trackingExercise = null; + + if ($existingExeId) { + $trackingExercise = $em->find(TrackEExercises::class, $existingExeId); + } + + $_template['sec_token'] = Security::get_token('exercisefocused'); + + if ('true' === $plugin->get(ExerciseFocusedPlugin::SETTING_ENABLE_OUTFOCUSED_LIMIT)) { + $logRepository = $em->getRepository(Log::class); + + if ($trackingExercise) { + $countOutfocused = $logRepository->countByActionInExe($trackingExercise, Log::TYPE_OUTFOCUSED); + } else { + $countOutfocused = 0; + } + + $_template['count_outfocused'] = $countOutfocused; + $_template['remaining_outfocused'] = (int) $plugin->get(ExerciseFocusedPlugin::SETTING_OUTFOCUSED_LIMIT) - $countOutfocused; + } + + if ($trackingExercise) { + $exercise = new Exercise($trackingExercise->getCId()); + + if ($exercise->read($trackingExercise->getExeExoId())) { + $_template['exercise_type'] = (int) $exercise->selectType(); + } + } +} diff --git a/plugin/exercisefocused/install.php b/plugin/exercisefocused/install.php new file mode 100644 index 000000000..f66dfb8ec --- /dev/null +++ b/plugin/exercisefocused/install.php @@ -0,0 +1,5 @@ +install(); diff --git a/plugin/exercisefocused/lang/english.php b/plugin/exercisefocused/lang/english.php new file mode 100644 index 000000000..96433f165 --- /dev/null +++ b/plugin/exercisefocused/lang/english.php @@ -0,0 +1,39 @@ +
    You must return and complete it."; +$strings['YouHaveXTimeToReturn'] = "You have %s seconds to return"; +$strings['YouAreAllowedXOutfocused'] = "You are allowed %d outfocused"; +$strings['OutfocusedLimitExceeded'] = "You have exceeded the allowed limit of outfocused"; +$strings['SelectExercise'] = "Select exercise"; +$strings['UnselectExercise'] = "Unselect exercise"; +$strings['Returns'] = "Returns"; +$strings['MaxOutfocusedReached'] = "Max outfocused reached"; +$strings['TimeLimitReached'] = "Time limit reached"; +$strings['Outfocused'] = "Outfocused"; +$strings['Return'] = "Return"; +$strings['Motive'] = "Motive"; +$strings['AlertBeforeLeaving'] = "Please stay within the exam"; +$strings['RandomSampling'] = "Random sampling"; +$strings['WindowTitleOutfocused'] = '🚨 Stay within the exam!'; +$strings['LevelReached'] = 'Level reached'; +$strings['ExerciseStartDateAndTime'] = "Exercise start date and time"; +$strings['ExerciseEndDateAndTime'] = "Exercise end date and time"; +$strings['MotiveExerciseFinished'] = "Successfully completed the exam"; diff --git a/plugin/exercisefocused/lang/spanish.php b/plugin/exercisefocused/lang/spanish.php new file mode 100644 index 000000000..d2348a664 --- /dev/null +++ b/plugin/exercisefocused/lang/spanish.php @@ -0,0 +1,39 @@ +
    Debes retornar y culminarlo."; +$strings['YouHaveXTimeToReturn'] = "Tienes %s segundos para regresar"; +$strings['YouAreAllowedXOutfocused'] = "Se te permite %d desenfoques"; +$strings['OutfocusedLimitExceeded'] = "Has excedido el límite permitido de desenfoques"; +$strings['SelectExercise'] = "Seleccionar ejercicio"; +$strings['UnselectExercise'] = "Deseleccionar ejercicio"; +$strings['Returns'] = "Regresos"; +$strings['MaxOutfocusedReached'] = "Se ha alcanzado el máximo de desenfoques"; +$strings['TimeLimitReached'] = "Se ha alcanzado el límite de tiempo"; +$strings['Outfocused'] = "Desenfoques"; +$strings['Return'] = "Regresos"; +$strings['Motive'] = "Motivo"; +$strings['AlertBeforeLeaving'] = "Por favor, mantente dentro del examen."; +$strings['RandomSampling'] = "Muestreo Aleatorio"; +$strings['WindowTitleOutfocused'] = '🚨 Retorna y culmina tu examen'; +$strings['LevelReached'] = 'Nivel alcanzado'; +$strings['ExerciseStartDateAndTime'] = "Fecha y hora de inicio del ejercicio"; +$strings['ExerciseEndDateAndTime'] = "Fecha y hora de finalización del ejercicio"; +$strings['MotiveExerciseFinished'] = "Culminó exitosamente el examen"; diff --git a/plugin/exercisefocused/pages/detail.php b/plugin/exercisefocused/pages/detail.php new file mode 100644 index 000000000..b258392b7 --- /dev/null +++ b/plugin/exercisefocused/pages/detail.php @@ -0,0 +1,32 @@ +getRepository(Log::class); + +$detailController = new DetailController( + ExerciseFocusedPlugin::create(), + HttpRequest::createFromGlobals(), + $em, + $logRepository +); + +try { + $response = $detailController(); +} catch (Exception $e) { + $response = HttpResponse::create('', HttpResponse::HTTP_FORBIDDEN); +} + +$response->send(); diff --git a/plugin/exercisefocused/pages/export.php b/plugin/exercisefocused/pages/export.php new file mode 100644 index 000000000..2b0b27144 --- /dev/null +++ b/plugin/exercisefocused/pages/export.php @@ -0,0 +1,298 @@ +isEnabled(true); +$request = HttpRequest::createFromGlobals(); +$em = Database::getManager(); +$focusedLogRepository = $em->getRepository(FocusedLog::class); +$attempsRepository = $em->getRepository(TrackEAttempt::class); + +if (!$plugin->isEnabled(true)) { + api_not_allowed(true); +} + +$params = $request->query->all(); + +$results = findResults($params, $em, $plugin); + +$data = []; + +/** @var array $result */ +foreach ($results as $result) { + /** @var TrackEExercises $trackExe */ + $trackExe = $result['exe']; + $user = api_get_user_entity($trackExe->getExeUserId()); + + $outfocusedLimitCount = $focusedLogRepository->countByActionInExe($trackExe, FocusedLog::TYPE_OUTFOCUSED_LIMIT); + $timeLimitCount = $focusedLogRepository->countByActionInExe($trackExe, FocusedLog::TYPE_TIME_LIMIT); + + $exercise = new Exercise($trackExe->getCId()); + $exercise->read($trackExe->getExeExoId()); + + $quizType = (int) $exercise->selectType(); + + $data[] = [ + get_lang('LoginName'), + $user->getUsername(), + ]; + $data[] = [ + get_lang('Student'), + $user->getFirstname(), + $user->getLastname(), + ]; + + if ($monitoringPluginIsEnabled + && 'true' === $monitoringPlugin->get(ExerciseMonitoringPlugin::SETTING_INSTRUCTION_AGE_DISTINCTION_ENABLE) + ) { + $fieldVariable = $monitoringPlugin->get(ExerciseMonitoringPlugin::SETTING_EXTRAFIELD_BIRTHDATE); + $birthdateValue = UserManager::get_extra_user_data_by_field($user->getId(), $fieldVariable); + + $data[] = [ + $monitoringPlugin->get_lang('Birthdate'), + $birthdateValue ? $birthdateValue[$fieldVariable] : '----', + $monitoringPlugin->isAdult($user->getId()) + ? $monitoringPlugin->get_lang('AdultStudent') + : $monitoringPlugin->get_lang('MinorStudent'), + ]; + } + + if ($trackExe->getSessionId()) { + $data[] = [ + get_lang('SessionName'), + api_get_session_entity($trackExe->getSessionId())->getName(), + ]; + } + + $data[] = [ + get_lang('CourseTitle'), + api_get_course_entity($trackExe->getCId())->getTitle(), + ]; + $data[] = [ + get_lang('ExerciseName'), + $exercise->getUnformattedTitle(), + ]; + $data[] = [ + $plugin->get_lang('ExerciseStartDateAndTime'), + api_get_local_time($result['exe']->getStartDate(), null, null, true, true, true), + ]; + $data[] = [ + $plugin->get_lang('ExerciseEndDateAndTime'), + api_get_local_time($result['exe']->getExeDate(), null, null, true, true, true), + ]; + $data[] = [ + get_lang('IP'), + $result['exe']->getUserIp(), + ]; + $data[] = [ + $plugin->get_lang('Motive'), + $plugin->calculateMotive($outfocusedLimitCount, $timeLimitCount), + ]; + $data[] = []; + + $data[] = [ + $plugin->get_lang('LevelReached'), + get_lang('DateExo'), + get_lang('Score'), + $plugin->get_lang('Outfocused'), + $plugin->get_lang('Returns'), + $monitoringPluginIsEnabled ? $monitoringPlugin->get_lang('Snapshots') : '', + ]; + + if (ONE_PER_PAGE === $quizType) { + $questionList = explode(',', $trackExe->getDataTracking()); + + foreach ($questionList as $idx => $questionId) { + $attempt = $attempsRepository->findOneBy( + ['exeId' => $trackExe->getExeId(), 'questionId' => $questionId], + ['tms' => 'DESC'] + ); + + if (!$attempt) { + continue; + } + + $result = $exercise->manage_answer( + $trackExe->getExeId(), + $questionId, + null, + 'exercise_result', + false, + false, + true, + false, + $exercise->selectPropagateNeg() + ); + + $row = [ + get_lang('QuestionNumber').' '.($idx + 1), + api_get_local_time($attempt->getTms()), + $result['score'].' / '.$result['weight'], + $focusedLogRepository->countByActionAndLevel($trackExe, FocusedLog::TYPE_OUTFOCUSED, $questionId), + $focusedLogRepository->countByActionAndLevel($trackExe, FocusedLog::TYPE_RETURN, $questionId), + getSnapshotListForLevel($questionId, $trackExe), + ]; + + $data[] = $row; + } + } elseif (ALL_ON_ONE_PAGE === $quizType) { + } + + $data[] = []; + $data[] = []; + $data[] = []; +} + +Export::arrayToXls($data); + +function getSessionIdFromFormValues(array $formValues, array $fieldVariableList): array +{ + $fieldItemIdList = []; + $objFieldValue = new ExtraFieldValue('session'); + + foreach ($fieldVariableList as $fieldVariable) { + if (!isset($formValues["extra_$fieldVariable"])) { + continue; + } + + $itemValues = $objFieldValue->get_item_id_from_field_variable_and_field_value( + $fieldVariable, + $formValues["extra_$fieldVariable"], + false, + false, + true + ); + + foreach ($itemValues as $itemValue) { + $fieldItemIdList[] = (int) $itemValue['item_id']; + } + } + + return array_unique($fieldItemIdList); +} + +function findResults(array $formValues, EntityManagerInterface $em, ExerciseFocusedPlugin $plugin) +{ + $cId = api_get_course_int_id(); + $sId = api_get_session_id(); + + $qb = $em->createQueryBuilder(); + $qb + ->select('te AS exe, q.title, te.startDate , u.firstname, u.lastname, u.username') + ->from(TrackEExercises::class, 'te') + ->innerJoin(CQuiz::class, 'q', Join::WITH, 'te.exeExoId = q.iid') + ->innerJoin(User::class, 'u', Join::WITH, 'te.exeUserId = u.id'); + + $params = []; + + if ($cId) { + $qb->andWhere($qb->expr()->eq('te.cId', ':cId')); + + $params['cId'] = $cId; + + $sessionItemIdList = $sId ? [$sId] : []; + } else { + $sessionItemIdList = getSessionIdFromFormValues( + $formValues, + $plugin->getSessionFieldList() + ); + } + + if ($sessionItemIdList) { + $qb->andWhere($qb->expr()->in('te.sessionId', ':sessionItemIdList')); + + $params['sessionItemIdList'] = $sessionItemIdList; + } + + if (!empty($formValues['username'])) { + $qb->andWhere($qb->expr()->eq('u.username', ':username')); + + $params['username'] = $formValues['username']; + } + + if (!empty($formValues['firstname'])) { + $qb->andWhere($qb->expr()->eq('u.firstname', ':firstname')); + + $params['firstname'] = $formValues['firstname']; + } + + if (!empty($formValues['lastname'])) { + $qb->andWhere($qb->expr()->eq('u.lastname', ':lastname')); + + $params['lastname'] = $formValues['lastname']; + } + + if (!empty($formValues['start_date'])) { + $qb->andWhere( + $qb->expr()->andX( + $qb->expr()->gte('te.startDate', ':start_date'), + $qb->expr()->lte('te.exeDate', ':end_date') + ) + ); + + $params['start_date'] = api_get_utc_datetime($formValues['start_date'].' 00:00:00', false, true); + $params['end_date'] = api_get_utc_datetime($formValues['start_date'].' 23:59:59', false, true); + } + + if (empty($params)) { + return []; + } + + if ($cId && !empty($formValues['id'])) { + $qb->andWhere($qb->expr()->eq('q.iid', ':q_id')); + + $params['q_id'] = $formValues['id']; + } + + $qb->setParameters($params); + + $query = $qb->getQuery(); + + return $query->getResult(); +} + +function getSnapshotListForLevel(int $level, TrackEExercises $trackExe): string +{ + $monitoringPluginIsEnabled = ExerciseMonitoringPlugin::create()->isEnabled(true); + + if (!$monitoringPluginIsEnabled) { + return ''; + } + + $user = api_get_user_entity($trackExe->getExeUserId()); + $monitoringLogRepository = Database::getManager()->getRepository(MonitoringLog::class); + + $monitoringLogsByQuestion = $monitoringLogRepository->findByLevelAndExe($level, $trackExe); + $snapshotList = []; + + /** @var MonitoringLog $logByQuestion */ + foreach ($monitoringLogsByQuestion as $logByQuestion) { + $snapshotUrl = ExerciseMonitoringPlugin::generateSnapshotUrl( + $user->getId(), + $logByQuestion->getImageFilename() + ); + $snapshotList[] = api_get_local_time($logByQuestion->getCreatedAt()).' '.$snapshotUrl; + } + + return implode(PHP_EOL, $snapshotList); +} diff --git a/plugin/exercisefocused/pages/log.php b/plugin/exercisefocused/pages/log.php new file mode 100644 index 000000000..b6b98e94a --- /dev/null +++ b/plugin/exercisefocused/pages/log.php @@ -0,0 +1,30 @@ +getRepository(Log::class); + +$logController = new LogController( + ExerciseFocusedPlugin::create(), + HttpRequest::createFromGlobals(), + $em, + $logRepository +); + +try { + $response = $logController(); +} catch (Exception $e) { + $response = HttpResponse::create('', HttpResponse::HTTP_FORBIDDEN); +} + +$response->send(); diff --git a/plugin/exercisefocused/pages/reporting.php b/plugin/exercisefocused/pages/reporting.php new file mode 100644 index 000000000..06c962518 --- /dev/null +++ b/plugin/exercisefocused/pages/reporting.php @@ -0,0 +1,34 @@ +getRepository(Log::class); + +$startController = new ReportingController( + ExerciseFocusedPlugin::create(), + HttpRequest::createFromGlobals(), + $em, + $logRepository +); + +//try { + $response = $startController(); +//} catch (Exception $e) { + //$response = HttpResponse::create('', HttpResponse::HTTP_FORBIDDEN); +//} + +$response->send(); diff --git a/plugin/exercisefocused/plugin.php b/plugin/exercisefocused/plugin.php new file mode 100644 index 000000000..905029d99 --- /dev/null +++ b/plugin/exercisefocused/plugin.php @@ -0,0 +1,10 @@ +get_info(); + +$plugin_info['templates'] = [ + 'templates/script.html.twig', + 'templates/block.html.twig', +]; diff --git a/plugin/exercisefocused/src/Controller/AdminController.php b/plugin/exercisefocused/src/Controller/AdminController.php new file mode 100644 index 000000000..c28d3ec18 --- /dev/null +++ b/plugin/exercisefocused/src/Controller/AdminController.php @@ -0,0 +1,52 @@ +createForm(); + + $results = []; + + if ($form->validate()) { + $results = $this->findResults( + $form->exportValues() + ); + } + + $table = $this->createTable($results); + + $content = $form->returnForm() + .Display::page_subheader2($this->plugin->get_lang('ReportByAttempts')) + .$table->toHtml(); + + $this->setBreadcrumb(); + + return $this->renderView( + $this->plugin->get_title(), + $content + ); + } + + private function setBreadcrumb() + { + $codePath = api_get_path(WEB_CODE_PATH); + + $GLOBALS['interbreadcrumb'][] = [ + 'url' => $codePath.'admin/index.php', + 'name' => get_lang('Administration'), + ]; + } +} diff --git a/plugin/exercisefocused/src/Controller/BaseController.php b/plugin/exercisefocused/src/Controller/BaseController.php new file mode 100644 index 000000000..61e26e9ff --- /dev/null +++ b/plugin/exercisefocused/src/Controller/BaseController.php @@ -0,0 +1,86 @@ +plugin = $plugin; + $this->request = $request; + $this->em = $em; + $this->logRepository = $logRepository; + } + + /** + * @throws Exception + */ + public function __invoke(): HttpResponse + { + if (!$this->plugin->isEnabled(true)) { + throw new Exception(); + } + + return HttpResponse::create(); + } + + protected function renderView( + string $title, + string $content, + ?string $header = null, + array $actions = [] + ): HttpResponse { + if (!$header) { + $header = $title; + } + + $this->template = new Template($title); + $this->template->assign('header', $header); + $this->template->assign('actions', implode(PHP_EOL, $actions)); + $this->template->assign('content', $content); + + ob_start(); + $this->template->display_one_col_template(); + $html = ob_get_contents(); + ob_end_clean(); + + return HttpResponse::create($html); + } +} diff --git a/plugin/exercisefocused/src/Controller/DetailController.php b/plugin/exercisefocused/src/Controller/DetailController.php new file mode 100644 index 000000000..9d2f2c60e --- /dev/null +++ b/plugin/exercisefocused/src/Controller/DetailController.php @@ -0,0 +1,98 @@ +request->query->getInt('id'); + $exe = $this->em->find(TrackEExercises::class, $exeId); + + if (!$exe) { + throw new Exception(); + } + + $user = api_get_user_entity($exe->getExeUserId()); + + $objExercise = new Exercise($exe->getCId()); + $objExercise->read($exe->getExeExoId()); + + $logs = $this->logRepository->findBy(['exe' => $exe], ['updatedAt' => 'ASC']); + $table = $this->getTable($objExercise, $logs); + + $content = $this->generateHeader($objExercise, $user, $exe) + .'
    ' + .$table->toHtml(); + + return HttpResponse::create($content); + } + + /** + * @param array $logs + * + * @return void + */ + private function getTable(Exercise $objExercise, array $logs): HTML_Table + { + $table = new HTML_Table(['class' => 'table table-hover table-striped data_table']); + $table->setHeaderContents(0, 0, get_lang('Action')); + $table->setHeaderContents(0, 1, get_lang('DateTime')); + $table->setHeaderContents(0, 2, $this->plugin->get_lang('LevelReached')); + + $row = 1; + + foreach ($logs as $log) { + $strLevel = ''; + + if (ONE_PER_PAGE == $objExercise->selectType()) { + try { + $question = $this->em->find(CQuizQuestion::class, $log->getLevel()); + + $strLevel = $question->getQuestion(); + } catch (Exception $exception) { + } + } + + $table->setCellContents( + $row, + 0, + $this->plugin->getActionTitle($log->getAction()) + ); + $table->setCellContents( + $row, + 1, + api_get_local_time($log->getCreatedAt(), null, null, true, true, true) + ); + $table->setCellContents($row, 2, $strLevel); + + $row++; + } + + return $table; + } +} diff --git a/plugin/exercisefocused/src/Controller/LogController.php b/plugin/exercisefocused/src/Controller/LogController.php new file mode 100644 index 000000000..380c276ef --- /dev/null +++ b/plugin/exercisefocused/src/Controller/LogController.php @@ -0,0 +1,97 @@ +request->query->get('action'); + $levelId = $this->request->query->getInt('level_id'); + + $exeId = (int) ChamiloSession::read('exe_id'); + + if (!in_array($action, self::VALID_ACTIONS)) { + throw new Exception('action invalid'); + } + + $trackingExercise = $this->em->find(TrackEExercises::class, $exeId); + + if (!$trackingExercise) { + throw new Exception('no exercise attempt'); + } + + $objExercise = new Exercise($trackingExercise->getCId()); + $objExercise->read($trackingExercise->getExeExoId()); + + $level = 0; + + if (ONE_PER_PAGE == $objExercise->selectType()) { + $question = $this->em->find(CQuizQuestion::class, $levelId); + + if (!$question) { + throw new Exception('Invalid level'); + } + + $level = $question->getIid(); + } + + $log = new Log(); + $log + ->setAction($action) + ->setExe($trackingExercise) + ->setLevel($level); + + $this->em->persist($log); + $this->em->flush(); + + $remainingOutfocused = -1; + + if ('true' === $this->plugin->get(ExerciseFocusedPlugin::SETTING_ENABLE_OUTFOCUSED_LIMIT)) { + $countOutfocused = $this->logRepository->countByActionInExe($trackingExercise, Log::TYPE_OUTFOCUSED); + + $remainingOutfocused = (int) $this->plugin->get(ExerciseFocusedPlugin::SETTING_OUTFOCUSED_LIMIT) - $countOutfocused; + } + + $exercise = new Exercise(api_get_course_int_id()); + $exercise->read($trackingExercise->getExeExoId()); + + $json = [ + 'sec_token' => Security::get_token('exercisefocused'), + 'remainingOutfocused' => $remainingOutfocused, + ]; + + return JsonResponse::create($json); + } +} diff --git a/plugin/exercisefocused/src/Controller/ReportingController.php b/plugin/exercisefocused/src/Controller/ReportingController.php new file mode 100644 index 000000000..1c29ad1cd --- /dev/null +++ b/plugin/exercisefocused/src/Controller/ReportingController.php @@ -0,0 +1,138 @@ +em->find( + CQuiz::class, + $this->request->query->getInt('id') + ); + + if (!$exercise) { + throw new Exception(); + } + + $courseCode = api_get_course_id(); + $sessionId = api_get_session_id(); + + $tab1 = $this->generateTabResume($exercise); + + $tab2 = $this->generateTabSearch($exercise, $courseCode, $sessionId); + + $tab3 = $this->generateTabSampling($exercise); + + $content = Display::tabs( + [ + $this->plugin->get_lang('ReportByAttempts'), + get_lang('Search'), + $this->plugin->get_lang('RandomSampling'), + ], + [$tab1, $tab2, $tab3], + 'exercise-focused-tabs', + [], + [], + isset($_GET['submit']) ? 2 : 1 + ); + + $this->setBreadcrumb($exercise->getId()); + + return $this->renderView( + $this->plugin->get_lang('ReportByAttempts'), + $content, + $exercise->getTitle() + ); + } + + private function generateTabResume(CQuiz $exercise): string + { + $results = $this->findResultsInCourse($exercise->getId()); + + return $this->createTable($results)->toHtml(); + } + + /** + * @throws Exception + */ + private function generateTabSearch(CQuiz $exercise, string $courseCode, int $sessionId): string + { + $form = $this->createForm(); + $form->updateAttributes(['action' => api_get_self().'?'.api_get_cidreq().'&id='.$exercise->getId()]); + $form->addHidden('cidReq', $courseCode); + $form->addHidden('id_session', $sessionId); + $form->addHidden('gidReq', 0); + $form->addHidden('gradebook', 0); + $form->addHidden('origin', api_get_origin()); + $form->addHidden('id', $exercise->getId()); + + $tableHtml = ''; + $actions = ''; + + if ($form->validate()) { + $formValues = $form->exportValues(); + + $actionLeft = Display::url( + Display::return_icon('export_excel.png', get_lang('ExportExcel'), [], ICON_SIZE_MEDIUM), + api_get_path(WEB_PLUGIN_PATH).'exercisefocused/pages/export.php?'.http_build_query($formValues) + ); + $actionRight = Display::toolbarButton( + get_lang('Clean'), + api_get_path(WEB_PLUGIN_PATH) + .'exercisefocused/pages/reporting.php?' + .api_get_cidreq().'&'.http_build_query(['id' => $exercise->getId(), 'submit' => '']), + 'search' + ); + + $actions = Display::toolbarAction( + 'em-actions', + [$actionLeft, $actionRight] + ); + + $results = $this->findResults($formValues); + + $tableHtml = $this->createTable($results)->toHtml(); + } + + return $form->returnForm().$actions.$tableHtml; + } + + private function generateTabSampling(CQuiz $exercise): string + { + $results = $this->findRandomResults($exercise->getId()); + + return $this->createTable($results)->toHtml(); + } + + /** + * @return array + */ + private function setBreadcrumb($exerciseId): void + { + $codePath = api_get_path('WEB_CODE_PATH'); + $cidReq = api_get_cidreq(); + + $GLOBALS['interbreadcrumb'][] = [ + 'url' => $codePath."exercise/exercise.php?$cidReq", + 'name' => get_lang('Exercises'), + ]; + $GLOBALS['interbreadcrumb'][] = [ + 'url' => $codePath."exercise/exercise_report.php?$cidReq&".http_build_query(['exerciseId' => $exerciseId]), + 'name' => get_lang('StudentScore'), + ]; + } +} diff --git a/plugin/exercisefocused/src/Entity/Log.php b/plugin/exercisefocused/src/Entity/Log.php new file mode 100644 index 000000000..8fa8ed650 --- /dev/null +++ b/plugin/exercisefocused/src/Entity/Log.php @@ -0,0 +1,99 @@ +id; + } + + public function getExe(): TrackEExercises + { + return $this->exe; + } + + public function setExe(TrackEExercises $exe): Log + { + $this->exe = $exe; + + return $this; + } + + public function getLevel(): int + { + return $this->level; + } + + public function setLevel(int $level): self + { + $this->level = $level; + + return $this; + } + + public function getAction(): string + { + return $this->action; + } + + public function setAction(string $action): Log + { + $this->action = $action; + + return $this; + } +} diff --git a/plugin/exercisefocused/src/ExerciseFocusedPlugin.php b/plugin/exercisefocused/src/ExerciseFocusedPlugin.php new file mode 100644 index 000000000..62feda2d1 --- /dev/null +++ b/plugin/exercisefocused/src/ExerciseFocusedPlugin.php @@ -0,0 +1,213 @@ + 'boolean', + self::SETTING_ENABLE_TIME_LIMIT => 'boolean', + self::SETTING_TIME_LIMIT => 'text', + self::SETTING_ENABLE_OUTFOCUSED_LIMIT => 'boolean', + self::SETTING_OUTFOCUSED_LIMIT => 'text', + self::SETTING_SESSION_FIELD_FILTERS => 'text', + self::SETTING_PERCENTAGE_SAMPLING => 'text', + ]; + + parent::__construct( + "0.0.1", + "Angel Fernando Quiroz Campos ", + $settings + ); + } + + public static function create(): ?ExerciseFocusedPlugin + { + static $result = null; + + return $result ?: $result = new self(); + } + + /** + * @throws ToolsException + */ + public function install() + { + $em = Database::getManager(); + + if ($em->getConnection()->getSchemaManager()->tablesExist([self::TABLE_LOG])) { + return; + } + + $schemaTool = new SchemaTool($em); + $schemaTool->createSchema( + [ + $em->getClassMetadata(Log::class), + ] + ); + + $objField = new ExtraField('exercise'); + $objField->save([ + 'variable' => self::FIELD_SELECTED, + 'field_type' => ExtraField::FIELD_TYPE_CHECKBOX, + 'display_text' => $this->get_title(), + 'visible_to_self' => true, + 'changeable' => true, + 'filter' => false, + ]); + } + + public function uninstall() + { + $em = Database::getManager(); + + if (!$em->getConnection()->getSchemaManager()->tablesExist([self::TABLE_LOG])) { + return; + } + + $schemaTool = new SchemaTool($em); + $schemaTool->dropSchema( + [ + $em->getClassMetadata(Log::class), + ] + ); + + $objField = new ExtraField('exercise'); + $extraFieldInfo = $objField->get_handler_field_info_by_field_variable(self::FIELD_SELECTED); + + if ($extraFieldInfo) { + $objField->delete($extraFieldInfo['id']); + } + } + + public function getAdminUrl(): string + { + $name = $this->get_name(); + $webPath = api_get_path(WEB_PLUGIN_PATH).$name; + + return "$webPath/admin.php"; + } + + public function getActionTitle($action): string + { + switch ($action) { + case Log::TYPE_OUTFOCUSED: + return $this->get_lang('Outfocused'); + case Log::TYPE_RETURN: + return $this->get_lang('Return'); + case Log::TYPE_OUTFOCUSED_LIMIT: + return $this->get_lang('MaxOutfocusedReached'); + case Log::TYPE_TIME_LIMIT: + return $this->get_lang('TimeLimitReached'); + } + + return ''; + } + + public function getLinkReporting(int $exerciseId): string + { + if (!$this->isEnabled(true)) { + return ''; + } + + $values = (new ExtraFieldValue('exercise')) + ->get_values_by_handler_and_field_variable($exerciseId, self::FIELD_SELECTED); + + if (!$values || !$values['value']) { + return ''; + } + + $icon = Display::return_icon( + 'window_list_slide.png', + $this->get_lang('ReportByAttempts'), + [], + ICON_SIZE_MEDIUM + ); + + $url = api_get_path(WEB_PLUGIN_PATH) + .'exercisefocused/pages/reporting.php?' + .api_get_cidreq().'&'.http_build_query(['id' => $exerciseId]); + + return Display::url($icon, $url); + } + + public function getSessionFieldList(): array + { + $settingField = $this->get(self::SETTING_SESSION_FIELD_FILTERS); + + $fields = explode(',', $settingField); + + return array_map('trim', $fields); + } + + public function isEnableForExercise(int $exerciseId): bool + { + $renderRegion = $this->isEnabled(true) + && strpos($_SERVER['SCRIPT_NAME'], '/main/exercise/exercise_submit.php') !== false; + + if (!$renderRegion) { + return false; + } + + $objFieldValue = new ExtraFieldValue('exercise'); + $values = $objFieldValue->get_values_by_handler_and_field_variable( + $exerciseId, + self::FIELD_SELECTED + ); + + return $values && (bool) $values['value']; + } + + public function calculateMotive(int $outfocusedLimitCount, int $timeLimitCount) + { + $motive = $this->get_lang('MotiveExerciseFinished'); + + if ($outfocusedLimitCount > 0) { + $motive = $this->get_lang('MaxOutfocusedReached'); + } + + if ($timeLimitCount > 0) { + $motive = $this->get_lang('TimeLimitReached'); + } + + return $motive; + } + + protected function createLinkToCourseTool($name, $courseId, $iconName = null, $link = null, $sessionId = 0, $category = 'plugin'): ?CTool + { + $tool = parent::createLinkToCourseTool($name, $courseId, $iconName, $link, $sessionId, $category); + + if (!$tool) { + return null; + } + + $tool->setName( + $tool->getName().':teacher' + ); + + $em = Database::getManager(); + $em->persist($tool); + $em->flush(); + + return $tool; + } +} diff --git a/plugin/exercisefocused/src/Repository/LogRepository.php b/plugin/exercisefocused/src/Repository/LogRepository.php new file mode 100644 index 000000000..01fb4d190 --- /dev/null +++ b/plugin/exercisefocused/src/Repository/LogRepository.php @@ -0,0 +1,28 @@ +count([ + 'exe' => $exe, + 'action' => $action, + ]); + } + + public function countByActionAndLevel(TrackEExercises $exe, string $action, int $level): int + { + return $this->count([ + 'exe' => $exe, + 'action' => $action, + 'level' => $level, + ]); + } +} diff --git a/plugin/exercisefocused/src/Traits/DetailControllerTrait.php b/plugin/exercisefocused/src/Traits/DetailControllerTrait.php new file mode 100644 index 000000000..95a5166d9 --- /dev/null +++ b/plugin/exercisefocused/src/Traits/DetailControllerTrait.php @@ -0,0 +1,28 @@ +getStartDate(), null, null, true, true, true); + $endDate = api_get_local_time($trackExe->getExeDate(), null, null, true, true, true); + + return Display::page_subheader2($objExercise->selectTitle()) + .Display::tag('p', $student->getCompleteNameWithUsername(), ['class' => 'lead']) + .Display::tag( + 'p', + sprintf(get_lang('QuizRemindStartDate'), $startDate) + .sprintf(get_lang('QuizRemindEndDate'), $endDate) + .sprintf(get_lang('QuizRemindDuration'), api_format_time($trackExe->getExeDuration())) + ); + } +} diff --git a/plugin/exercisefocused/src/Traits/ReportingFilterTrait.php b/plugin/exercisefocused/src/Traits/ReportingFilterTrait.php new file mode 100644 index 000000000..ad8126d73 --- /dev/null +++ b/plugin/exercisefocused/src/Traits/ReportingFilterTrait.php @@ -0,0 +1,393 @@ +plugin->getSessionFieldList(); + $cId = api_get_course_int_id(); + $sessionId = api_get_session_id(); + + $form = new FormValidator('exercisefocused', 'get'); + $form->addText('username', get_lang('LoginName'), false); + $form->addText('firstname', get_lang('FirstName'), false); + $form->addText('lastname', get_lang('LastName'), false); + + if ($extraFieldNameList && ($sessionId || !$cId)) { + (new ExtraField('session')) + ->addElements( + $form, + $sessionId, + [], + false, + false, + $extraFieldNameList + ); + + $extraNames = []; + + foreach ($extraFieldNameList as $key => $value) { + $extraNames[$key] = "extra_$value"; + } + + if ($sessionId) { + $form->freeze($extraNames); + } + } + + $form->addDatePicker('start_date', get_lang('StartDate')); + $form->addButtonSearch(get_lang('Search')); + //$form->protect(); + + return $form; + } + + /** + * @throws Exception + */ + protected function findResults(array $formValues = []): array + { + $cId = api_get_course_int_id(); + $sId = api_get_session_id(); + + $qb = $this->em->createQueryBuilder(); + $qb + ->select('te AS exe, q.title, te.startDate, u.id AS user_id, u.firstname, u.lastname, u.username, te.sessionId, te.cId') + ->from(TrackEExercises::class, 'te') + ->innerJoin(CQuiz::class, 'q', Join::WITH, 'te.exeExoId = q.iid') + ->innerJoin(User::class, 'u', Join::WITH, 'te.exeUserId = u.id'); + + $params = []; + + if ($cId) { + $qb->andWhere($qb->expr()->eq('te.cId', ':cId')); + + $params['cId'] = $cId; + + $sessionItemIdList = $sId ? [$sId] : []; + } else { + $sessionItemIdList = $this->getSessionIdFromFormValues( + $formValues, + $this->plugin->getSessionFieldList() + ); + } + + if ($sessionItemIdList) { + $qb->andWhere($qb->expr()->in('te.sessionId', ':sessionItemIdList')); + + $params['sessionItemIdList'] = $sessionItemIdList; + } + + if (!empty($formValues['username'])) { + $qb->andWhere($qb->expr()->eq('u.username', ':username')); + + $params['username'] = $formValues['username']; + } + + if (!empty($formValues['firstname'])) { + $qb->andWhere($qb->expr()->like('u.firstname', ':firstname')); + + $params['firstname'] = $formValues['firstname'].'%'; + } + + if (!empty($formValues['lastname'])) { + $qb->andWhere($qb->expr()->like('u.lastname', ':lastname')); + + $params['lastname'] = $formValues['lastname'].'%'; + } + + if (!empty($formValues['start_date'])) { + $qb->andWhere( + $qb->expr()->andX( + $qb->expr()->gte('te.startDate', ':start_date'), + $qb->expr()->lte('te.exeDate', ':end_date') + ) + ); + + $params['start_date'] = api_get_utc_datetime($formValues['start_date'].' 00:00:00', false, true); + $params['end_date'] = api_get_utc_datetime($formValues['start_date'].' 23:59:59', false, true); + } + + if (empty($params)) { + return []; + } + + if ($cId && !empty($formValues['id'])) { + $qb->andWhere($qb->expr()->eq('q.iid', ':q_id')); + + $params['q_id'] = $formValues['id']; + } + + $qb->setParameters($params); + + return $this->formatResults( + $qb->getQuery()->getResult() + ); + } + + protected function formatResults(array $queryResults): array + { + $results = []; + + foreach ($queryResults as $value) { + $outfocusedCount = $this->logRepository->countByActionInExe($value['exe'], Log::TYPE_OUTFOCUSED); + $returnCount = $this->logRepository->countByActionInExe($value['exe'], Log::TYPE_RETURN); + $outfocusedLimitCount = $this->logRepository->countByActionInExe($value['exe'], Log::TYPE_OUTFOCUSED_LIMIT); + $timeLimitCount = $this->logRepository->countByActionInExe($value['exe'], Log::TYPE_TIME_LIMIT); + + $class = 'success'; + $motive = $this->plugin->get_lang('MotiveExerciseFinished'); + + if ($outfocusedCount > 0 || $returnCount > 0) { + $class = 'warning'; + } + + if ($outfocusedLimitCount > 0 || $timeLimitCount > 0) { + $class = 'danger'; + + if ($outfocusedLimitCount > 0) { + $motive = $this->plugin->get_lang('MaxOutfocusedReached'); + } + + if ($timeLimitCount > 0) { + $motive = $this->plugin->get_lang('TimeLimitReached'); + } + } + + $session = api_get_session_entity($value['sessionId']); + $course = api_get_course_entity($value['cId']); + + $results[] = [ + 'id' => $value['exe']->getExeId(), + 'quiz_title' => $value['title'], + 'user_id' => $value['user_id'], + 'username' => $value['username'], + 'firstname' => $value['firstname'], + 'lastname' => $value['lastname'], + 'start_date' => $value['exe']->getStartDate(), + 'end_date' => $value['exe']->getExeDate(), + 'count_outfocused' => $outfocusedCount, + 'count_return' => $returnCount, + 'motive' => Display::span($motive, ['class' => "text-$class"]), + 'class' => $class, + 'session_name' => $session ? $session->getName() : null, + 'course_title' => $course->getTitle(), + ]; + } + + return $results; + } + + protected function createTable(array $resultData): HTML_Table + { + $courseId = api_get_course_int_id(); + + $pluginMonitoring = ExerciseMonitoringPlugin::create(); + $isPluginMonitoringEnabled = $pluginMonitoring->isEnabled(true); + + $detailIcon = Display::return_icon('forum_listview.png', get_lang('Detail')); + + $urlDetail = api_get_path(WEB_PLUGIN_PATH).'exercisefocused/pages/detail.php?'.api_get_cidreq().'&'; + + $tableHeaders = []; + $tableHeaders[] = get_lang('LoginName'); + $tableHeaders[] = get_lang('FirstName'); + $tableHeaders[] = get_lang('LastName'); + + if (!$courseId) { + $tableHeaders[] = get_lang('SessionName'); + $tableHeaders[] = get_lang('CourseTitle'); + $tableHeaders[] = get_lang('ExerciseName'); + } + + $tableHeaders[] = $this->plugin->get_lang('ExerciseStartDateAndTime'); + $tableHeaders[] = $this->plugin->get_lang('ExerciseEndDateAndTime'); + $tableHeaders[] = $this->plugin->get_lang('Outfocused'); + $tableHeaders[] = $this->plugin->get_lang('Returns'); + $tableHeaders[] = $this->plugin->get_lang('Motive'); + $tableHeaders[] = get_lang('Actions'); + + $tableData = []; + + foreach ($resultData as $result) { + $actionLinks = Display::url( + $detailIcon, + $urlDetail.http_build_query(['id' => $result['id']]), + [ + 'class' => 'ajax', + 'data-title' => get_lang('Detail'), + ] + ); + + if ($isPluginMonitoringEnabled) { + $actionLinks .= $pluginMonitoring->generateDetailLink( + (int) $result['id'], + $result['user_id'] + ); + } + + $row = []; + + $row[] = $result['username']; + $row[] = $result['firstname']; + $row[] = $result['lastname']; + + if (!$courseId) { + $row[] = $result['session_name']; + $row[] = $result['course_title']; + $row[] = $result['quiz_title']; + } + + $row[] = api_get_local_time($result['start_date'], null, null, true, true, true); + $row[] = api_get_local_time($result['end_date'], null, null, true, true, true); + $row[] = $result['count_outfocused']; + $row[] = $result['count_return']; + $row[] = $result['motive']; + $row[] = $actionLinks; + + $tableData[] = $row; + } + + $table = new HTML_Table(['class' => 'table table-hover table-striped data_table']); + $table->setHeaders($tableHeaders); + $table->setData($tableData); + $table->setColAttributes($courseId ? 3 : 6, ['class' => 'text-center']); + $table->setColAttributes($courseId ? 4 : 7, ['class' => 'text-center']); + $table->setColAttributes($courseId ? 5 : 8, ['class' => 'text-right']); + $table->setColAttributes($courseId ? 6 : 9, ['class' => 'text-right']); + $table->setColAttributes($courseId ? 7 : 10, ['class' => 'text-center']); + $table->setColAttributes($courseId ? 8 : 11, ['class' => 'text-right']); + + foreach ($resultData as $idx => $result) { + $table->setRowAttributes($idx + 1, ['class' => $result['class']], true); + } + + return $table; + } + + protected function findResultsInCourse(int $exerciseId, bool $randomResults = false): array + { + $exeIdList = $this->getAttemptsIdForExercise($exerciseId); + + if ($randomResults) { + $exeIdList = $this->pickRandomAttempts($exeIdList) ?: $exeIdList; + } + + if (empty($exeIdList)) { + return []; + } + + $qb = $this->em->createQueryBuilder(); + $qb + ->select('te AS exe, q.title, te.startDate, u.id AS user_id, u.firstname, u.lastname, u.username, te.sessionId, te.cId') + ->from(TrackEExercises::class, 'te') + ->innerJoin(CQuiz::class, 'q', Join::WITH, 'te.exeExoId = q.iid') + ->innerJoin(User::class, 'u', Join::WITH, 'te.exeUserId = u.id') + ->andWhere( + $qb->expr()->in('te.exeId', $exeIdList) + ) + ->addOrderBy('te.startDate'); + + return $this->formatResults( + $qb->getQuery()->getResult() + ); + } + + protected function findRandomResults(int $exerciseId): array + { + return $this->findResultsInCourse($exerciseId, true); + } + + private function getSessionIdFromFormValues(array $formValues, array $fieldVariableList): array + { + $fieldItemIdList = []; + $objFieldValue = new ExtraFieldValue('session'); + + foreach ($fieldVariableList as $fieldVariable) { + if (!isset($formValues["extra_$fieldVariable"])) { + continue; + } + + $itemValues = $objFieldValue->get_item_id_from_field_variable_and_field_value( + $fieldVariable, + $formValues["extra_$fieldVariable"], + false, + false, + true + ); + + foreach ($itemValues as $itemValue) { + $fieldItemIdList[] = (int) $itemValue['item_id']; + } + } + + return array_unique($fieldItemIdList); + } + + private function getAttemptsIdForExercise(int $exerciseId): array + { + $cId = api_get_course_int_id(); + $sId = api_get_session_id(); + + $tblTrackExe = Database::get_main_table(TABLE_STATISTIC_TRACK_E_EXERCISES); + + $sessionCondition = api_get_session_condition($sId); + + $result = Database::query( + "SELECT exe_id FROM $tblTrackExe + WHERE c_id = $cId + AND exe_exo_id = $exerciseId + $sessionCondition + ORDER BY exe_id" + ); + + return array_column( + Database::store_result($result), + 'exe_id' + ); + } + + private function pickRandomAttempts(array $attemptIdList): array + { + $settingPercentage = (int) $this->plugin->get(ExerciseFocusedPlugin::SETTING_PERCENTAGE_SAMPLING); + + if (!$settingPercentage) { + return []; + } + + $percentage = count($attemptIdList) * ($settingPercentage / 100); + $round = round($percentage) ?: 1; + + $random = (array) array_rand($attemptIdList, $round); + + $selection = []; + + foreach ($random as $rand) { + $selection[] = $attemptIdList[$rand]; + } + + return $selection; + } +} diff --git a/plugin/exercisefocused/templates/block.html.twig b/plugin/exercisefocused/templates/block.html.twig new file mode 100644 index 000000000..f86f72bd0 --- /dev/null +++ b/plugin/exercisefocused/templates/block.html.twig @@ -0,0 +1,105 @@ +{% if exercisefocused.show_region %} + {% set enable_time_limit = 'true' == exercisefocused.plugin_info.obj.get('enable_time_limit') %} + {% set time_limit = exercisefocused.plugin_info.obj.get('time_limit') %} + {% set enable_outfocused_limit = 'true' == exercisefocused.plugin_info.obj.get('enable_outfocused_limit') %} + {% set outfocused_limit = exercisefocused.plugin_info.obj.get('outfocused_limit') %} + + + +{% endif %} \ No newline at end of file diff --git a/plugin/exercisefocused/templates/script.html.twig b/plugin/exercisefocused/templates/script.html.twig new file mode 100644 index 000000000..d849c6cc5 --- /dev/null +++ b/plugin/exercisefocused/templates/script.html.twig @@ -0,0 +1,163 @@ +{% if exercisefocused.show_region %} + {% set enable_time_limit = 'true' == exercisefocused.plugin_info.obj.get('enable_time_limit') %} + {% set time_limit = exercisefocused.plugin_info.obj.get('time_limit') %} + {% set enable_outfocused_limit = 'true' == exercisefocused.plugin_info.obj.get('enable_outfocused_limit') %} + {% set outfocused_limit = exercisefocused.plugin_info.obj.get('outfocused_limit') %} + + {% set ALL_ON_ONE_PAGE = exercisefocused.exercise_type == 1 %} + {% set ONE_PER_PAGE = exercisefocused.exercise_type == 2 %} + + +{% endif %} \ No newline at end of file diff --git a/plugin/exercisefocused/uninstall.php b/plugin/exercisefocused/uninstall.php new file mode 100644 index 000000000..7a0396b9f --- /dev/null +++ b/plugin/exercisefocused/uninstall.php @@ -0,0 +1,5 @@ +uninstall(); diff --git a/plugin/exercisemonitoring/admin.php b/plugin/exercisemonitoring/admin.php new file mode 100644 index 000000000..4210e607a --- /dev/null +++ b/plugin/exercisemonitoring/admin.php @@ -0,0 +1,3 @@ +getRepository(Log::class); +$trackExeRepo = $em->getRepository(TrackEExercises::class); + +$lifetimeDays = (int) $plugin->get(ExerciseMonitoringPlugin::SETTING_SNAPSHOTS_LIFETIME); + +if (empty($lifetimeDays)) { + logging("There is no set time limit"); + exit; +} + +$timeLimit = api_get_utc_datetime(null, false, true); +$timeLimit->modify("-$lifetimeDays day"); + +logging( + sprintf("Deleting snapshots taken before than %s", $timeLimit->format('Y-m-d H:i:s')) +); + +$fs = new Filesystem(); + +$logs = findLogsBeforeThan($timeLimit); + +foreach ($logs as $log) { + $sysPath = ExerciseMonitoringPlugin::generateSnapshotUrl( + $log['exe_user_id'], + $log['image_filename'], + SYS_UPLOAD_PATH + ); + + if (!file_exists($sysPath)) { + logging( + sprintf("File %s not exists", $sysPath) + ); + + continue; + } + + $fs->remove($sysPath); + + Database::update( + 'plugin_exercisemonitoring_log', + ['removed' => true], + ['id = ?' => $log['log_id']] + ); + + logging( + sprintf( + "From exe_id %s; deleting filename %s created at %s", + $log['exe_id'], + $sysPath, + $log['created_at'] + ) + ); +} + +function findLogsBeforeThan(DateTime $timeLimit): array +{ + $sql = "SELECT tee.exe_id, l.id AS log_id, l.image_filename, tee.exe_user_id + FROM plugin_exercisemonitoring_log l + INNER JOIN chamilo.track_e_exercises tee on l.exe_id = tee.exe_id + WHERE l.created_at <= '".$timeLimit->format('Y-m-d H:i:s')."' + AND l.removed IS FALSE"; + + $result = Database::query($sql); + + $rows = []; + + while ($row = Database::fetch_assoc($result)) { + $rows[] = $row; + } + + return $rows; +} + +function logging(string $message) +{ + $time = time(); + + printf("[%s] %s \n", $time, $message); +} diff --git a/plugin/exercisemonitoring/index.php b/plugin/exercisemonitoring/index.php new file mode 100644 index 000000000..2e7af8ad1 --- /dev/null +++ b/plugin/exercisemonitoring/index.php @@ -0,0 +1,61 @@ +isEnabled(true); +$showOverviewRegion = $isEnabled && strpos($_SERVER['SCRIPT_NAME'], '/main/exercise/overview.php') !== false; +$showSubmitRegion = $isEnabled && strpos($_SERVER['SCRIPT_NAME'], '/main/exercise/exercise_submit.php') !== false; + +$_template['enabled'] = false; +$_template['show_overview_region'] = $showOverviewRegion; +$_template['show_submit_region'] = $showSubmitRegion; + +if ($showOverviewRegion || $showSubmitRegion) { + $exerciseId = (int) $_GET['exerciseId']; + + $objFieldValue = new ExtraFieldValue('exercise'); + $values = $objFieldValue->get_values_by_handler_and_field_variable( + $exerciseId, + ExerciseMonitoringPlugin::FIELD_SELECTED + ); + + $_template['enabled'] = $values && (bool) $values['value']; + $_template['exercise_id'] = $exerciseId; +} + +$_template['enable_snapshots'] = true; + +$isAdult = $plugin->isAdult(); + +if ($showOverviewRegion && $_template['enabled']) { + $_template['instructions'] = $plugin->get(ExerciseMonitoringPlugin::SETTING_INSTRUCTIONS); + + if ('true' === $plugin->get(ExerciseMonitoringPlugin::SETTING_INSTRUCTION_AGE_DISTINCTION_ENABLE)) { + $_template['instructions'] = $plugin->get(ExerciseMonitoringPlugin::SETTING_INSTRUCTIONS_MINORS); + + if ($isAdult) { + $_template['instructions'] = $plugin->get(ExerciseMonitoringPlugin::SETTING_INSTRUCTIONS_ADULTS); + } else { + $_template['enable_snapshots'] = false; + } + } + + $_template['instructions'] = Security::remove_XSS($_template['instructions']); +} + +if ($showSubmitRegion && $_template['enabled']) { + $exercise = new Exercise(api_get_course_int_id()); + + if ($exercise->read($_template['exercise_id'])) { + $_template['exercise_type'] = (int) $exercise->selectType(); + + if ('true' === $plugin->get(ExerciseMonitoringPlugin::SETTING_INSTRUCTION_AGE_DISTINCTION_ENABLE) + && !$isAdult + ) { + $_template['enable_snapshots'] = false; + } + } +} diff --git a/plugin/exercisemonitoring/install.php b/plugin/exercisemonitoring/install.php new file mode 100644 index 000000000..a9af675a7 --- /dev/null +++ b/plugin/exercisemonitoring/install.php @@ -0,0 +1,5 @@ +install(); diff --git a/plugin/exercisemonitoring/lang/english.php b/plugin/exercisemonitoring/lang/english.php new file mode 100644 index 000000000..25a1ee89e --- /dev/null +++ b/plugin/exercisemonitoring/lang/english.php @@ -0,0 +1,32 @@ +birthdate'; +$strings['instructions_adults'] = 'Intructions for adults students'; +$strings['instructions_minors'] = 'Intrucctions for minors students'; +$strings['snapshots_lifetime'] = 'Life time of photos taken'; +$strings['snapshots_lifetime_help'] = 'Number of days that taken photos can remain stored on the server.
    The cleanup script is located in plugin/exercisemonitoring/cron/cleanup.php'; + +$strings['ExerciseMonitored'] = "Exercise monitored"; +$strings['Retry'] = "Retry"; +$strings['IdDocumentSnapshot'] = "Validated photo of the ID document"; +$strings['StudentSnapshot'] = "Validated photo of the student"; + +$strings['ImageIdDocumentCameraInstructions'] = "Place your ID document in front of the camera and place it in the marked box. Click the Capture button or press the space bar on your keyboard."; +$strings['ImageStudentCameraInstructions'] = "Place your face in front of the camera and place it within the marked circle. Click the Capture button or press the space bar on your keyboard"; + +$strings['Snapshots'] = "Snapshots"; + +$strings['ExerciseUnmonitored'] = "Exercise unmonitored"; +$strings['Birthdate'] = "Birthdate"; +$strings['AdultStudent'] = "Adult student"; +$strings['MinorStudent'] = "Minor student"; diff --git a/plugin/exercisemonitoring/lang/spanish.php b/plugin/exercisemonitoring/lang/spanish.php new file mode 100644 index 000000000..0f5ff8c2c --- /dev/null +++ b/plugin/exercisemonitoring/lang/spanish.php @@ -0,0 +1,32 @@ +birthdate'; +$strings['instructions_adults'] = 'Intrucciones para estudiantes adultos'; +$strings['instructions_minors'] = 'Intrucciones para estudiantes menores de edad'; +$strings['snapshots_lifetime'] = 'Tiempo de vida de las fotos tomadas'; +$strings['snapshots_lifetime_help'] = 'Cantidad de días que las fotos tomadas pueden permanecer almacenadas en el servidor.
    El script de limpieza está ubicado en plugin/exercisemonitoring/cron/cleanup.php'; + +$strings['ExerciseMonitored'] = "Ejercicio monitoreado"; +$strings['Retry'] = "Reintentar"; +$strings['IdDocumentSnapshot'] = "Foto validada del documento de identidad"; +$strings['StudentSnapshot'] = "Foto validada del estudiante"; + +$strings['ImageIdDocumentCameraInstructions'] = "Coloca tu DNI o documento de identidad frente a la cámara y ubícalo en el recuadro marcado. Dale clic al botón Capturar o presiona la barra de espacio de tu teclado."; +$strings['ImageStudentCameraInstructions'] = "Coloca tu rostro frente a la cámara y ubícalo dentro del círculo marcado. Dale click al botón Capturar o presiona la barra de espacio de tu teclado"; + +$strings['Snapshots'] = "Fotos tomadas"; + +$strings['ExerciseUnmonitored'] = "Ejercicio no monitoreado"; +$strings['Birthdate'] = "Fecha de nacimiento"; +$strings['AdultStudent'] = "Estudiante adulto"; +$strings['MinorStudent'] = "Estudiante menor de edad"; diff --git a/plugin/exercisemonitoring/pages/detail.php b/plugin/exercisemonitoring/pages/detail.php new file mode 100644 index 000000000..33b471f94 --- /dev/null +++ b/plugin/exercisemonitoring/pages/detail.php @@ -0,0 +1,32 @@ +getRepository(Log::class); + +$detailController = new DetailController( + ExerciseMonitoringPlugin::create(), + HttpRequest::createFromGlobals(), + $em, + $logRepository +); + +try { + $response = $detailController(); +} catch (Exception $e) { + $response = HttpResponse::create('', HttpResponse::HTTP_FORBIDDEN); +} + +$response->send(); diff --git a/plugin/exercisemonitoring/pages/exercise_submit.ajax.php b/plugin/exercisemonitoring/pages/exercise_submit.ajax.php new file mode 100644 index 000000000..471f90868 --- /dev/null +++ b/plugin/exercisemonitoring/pages/exercise_submit.ajax.php @@ -0,0 +1,18 @@ +send(); diff --git a/plugin/exercisemonitoring/pages/start.ajax.php b/plugin/exercisemonitoring/pages/start.ajax.php new file mode 100644 index 000000000..3832106e8 --- /dev/null +++ b/plugin/exercisemonitoring/pages/start.ajax.php @@ -0,0 +1,18 @@ +send(); diff --git a/plugin/exercisemonitoring/plugin.php b/plugin/exercisemonitoring/plugin.php new file mode 100644 index 000000000..391c44e50 --- /dev/null +++ b/plugin/exercisemonitoring/plugin.php @@ -0,0 +1,10 @@ +get_info(); + +$plugin_info['templates'] = [ + 'templates/modal.html.twig', + 'templates/exercise_submit.html.twig', +]; diff --git a/plugin/exercisemonitoring/src/Controller/DetailController.php b/plugin/exercisemonitoring/src/Controller/DetailController.php new file mode 100644 index 000000000..e9c5b05e7 --- /dev/null +++ b/plugin/exercisemonitoring/src/Controller/DetailController.php @@ -0,0 +1,111 @@ +plugin = $plugin; + $this->request = $request; + $this->em = $em; + $this->logRepository = $logRepository; + } + + /** + * @throws Exception + */ + public function __invoke(): HttpResponse + { + if (!$this->plugin->isEnabled(true)) { + throw new Exception(); + } + + $trackExe = $this->em->find( + TrackEExercises::class, + $this->request->query->getInt('id') + ); + + if (!$trackExe) { + throw new Exception(); + } + + $exercise = $this->em->find(CQuiz::class, $trackExe->getExeExoId()); + $user = api_get_user_entity($trackExe->getExeUserId()); + + $objExercise = new Exercise($trackExe->getCId()); + $objExercise->read($trackExe->getExeExoId()); + + $logs = $this->logRepository->findSnapshots($objExercise, $trackExe); + + $content = $this->generateHeader($objExercise, $user, $trackExe) + .'
    ' + .$this->generateSnapshotList($logs, $trackExe->getExeUserId()); + + return HttpResponse::create($content); + } + + private function generateSnapshotList(array $logs, int $userId): string + { + $html = ''; + + foreach ($logs as $i => $log) { + $date = api_get_local_time($log['createdAt'], null, null, true, true, true); + + $html .= '
    '; + $html .= '
    '; + $html .= Display::img( + ExerciseMonitoringPlugin::generateSnapshotUrl($userId, $log['imageFilename']), + $date + ); + $html .= '
    '; + $html .= Display::tag('p', $date, ['class' => 'text-center']); + $html .= Display::tag('div', $log['log_level'], ['class' => 'text-center']); + $html .= '
    '; + $html .= '
    '; + $html .= '
    '; + } + + return '
    '.$html.'
    '; + } +} diff --git a/plugin/exercisemonitoring/src/Controller/ExerciseSubmitController.php b/plugin/exercisemonitoring/src/Controller/ExerciseSubmitController.php new file mode 100644 index 000000000..94e54aa43 --- /dev/null +++ b/plugin/exercisemonitoring/src/Controller/ExerciseSubmitController.php @@ -0,0 +1,119 @@ +plugin = $plugin; + $this->request = $request; + $this->em = $em; + } + + /** + * @throws \Doctrine\ORM\OptimisticLockException + * @throws \Doctrine\ORM\ORMException + * @throws \Doctrine\ORM\TransactionRequiredException + */ + public function __invoke(): HttpResponse + { + $userDirName = $this->createDirectory(); + + $existingExeId = (int) ChamiloSession::read('exe_id'); + + $levelId = $this->request->request->getInt('level_id'); + $exerciseId = $this->request->request->getInt('exercise_id'); + + $exercise = $this->em->find(CQuiz::class, $exerciseId); + + $objExercise = new Exercise(); + $objExercise->read($exerciseId); + + $trackingExercise = $this->em->find(TrackEExercises::class, $existingExeId); + + $newFilename = ''; + $level = 0; + + /** @var UploadedFile $imgSubmit */ + if ($imgSubmit = $this->request->files->get('snapshot')) { + $newFilename = uniqid().'_submit.jpg'; + + $imgSubmit->move($userDirName, $newFilename); + } + + if (ONE_PER_PAGE == $objExercise->selectType()) { + $question = $this->em->find(CQuizQuestion::class, $levelId); + $level = $question->getIid(); + } + + $log = new Log(); + $log + ->setExercise($exercise) + ->setExe($trackingExercise) + ->setLevel($level) + ->setImageFilename($newFilename) + ; + + $this->em->persist($log); + + $this->updateOrphanSnapshots($exercise, $trackingExercise); + + $this->em->flush(); + + return HttpResponse::create(); + } + + private function createDirectory(): string + { + $user = api_get_user_entity(api_get_user_id()); + + $pluginDirName = api_get_path(SYS_UPLOAD_PATH).'plugins/exercisemonitoring'; + $userDirName = $pluginDirName.'/'.$user->getId(); + + $fs = new Filesystem(); + $fs->mkdir( + [$pluginDirName, $userDirName], + api_get_permissions_for_new_directories() + ); + + return $userDirName; + } + + private function updateOrphanSnapshots(CQuiz $exercise, TrackEExercises $trackingExe) + { + $repo = $this->em->getRepository(Log::class); + + $fileNamesToUpdate = ChamiloSession::read($this->plugin->get_name().'_orphan_snapshots', []); + + if (empty($fileNamesToUpdate)) { + return; + } + + foreach ($fileNamesToUpdate as $filename) { + $log = $repo->findOneBy(['imageFilename' => $filename, 'exercise' => $exercise, 'exe' => null]); + + if (!$log) { + continue; + } + + $log->setExe($trackingExe); + } + + ChamiloSession::erase($this->plugin->get_name().'_orphan_snapshots'); + } +} diff --git a/plugin/exercisemonitoring/src/Controller/StartController.php b/plugin/exercisemonitoring/src/Controller/StartController.php new file mode 100644 index 000000000..408a551d4 --- /dev/null +++ b/plugin/exercisemonitoring/src/Controller/StartController.php @@ -0,0 +1,93 @@ +plugin = $plugin; + $this->request = $request; + $this->em = $em; + } + + public function __invoke(): HttpResponse + { + $userDirName = $this->createDirectory(); + + /** @var UploadedFile $imgIddoc */ + $imgIddoc = $this->request->files->get('iddoc'); + /** @var UploadedFile $imgLearner */ + $imgLearner = $this->request->files->get('learner'); + + $exercise = $this->em->find(CQuiz::class, $this->request->request->getInt('exercise_id')); + + $fileNamesToUpdate = []; + + if ($imgIddoc) { + $newFilename = uniqid().'_iddoc.jpg'; + $fileNamesToUpdate[] = $newFilename; + + $imgIddoc->move($userDirName, $newFilename); + + $log = new Log(); + $log + ->setExercise($exercise) + ->setLevel(-1) + ->setImageFilename($newFilename) + ; + + $this->em->persist($log); + } + + if ($imgLearner) { + $newFilename = uniqid().'_learner.jpg'; + $fileNamesToUpdate[] = $newFilename; + + $imgLearner->move($userDirName, $newFilename); + + $log = new Log(); + $log + ->setExercise($exercise) + ->setLevel(-1) + ->setImageFilename($newFilename) + ; + + $this->em->persist($log); + } + + $this->em->flush(); + + ChamiloSession::write($this->plugin->get_name().'_orphan_snapshots', $fileNamesToUpdate); + + return HttpResponse::create(); + } + + private function createDirectory(): string + { + $user = api_get_user_entity(api_get_user_id()); + + $pluginDirName = api_get_path(SYS_UPLOAD_PATH).'plugins/exercisemonitoring'; + $userDirName = $pluginDirName.'/'.$user->getId(); + + $fs = new Filesystem(); + $fs->mkdir( + [$pluginDirName, $userDirName], + api_get_permissions_for_new_directories() + ); + + return $userDirName; + } +} diff --git a/plugin/exercisemonitoring/src/Entity/Log.php b/plugin/exercisemonitoring/src/Entity/Log.php new file mode 100644 index 000000000..81a629168 --- /dev/null +++ b/plugin/exercisemonitoring/src/Entity/Log.php @@ -0,0 +1,133 @@ +removed = false; + } + + public function getId(): int + { + return $this->id; + } + + public function getExercise(): CQuiz + { + return $this->exercise; + } + + public function setExercise(CQuiz $exercise): Log + { + $this->exercise = $exercise; + + return $this; + } + + public function getExe(): ?TrackEExercises + { + return $this->exe; + } + + public function setExe(?TrackEExercises $exe): Log + { + $this->exe = $exe; + + return $this; + } + + public function getLevel(): int + { + return $this->level; + } + + public function setLevel(int $level): Log + { + $this->level = $level; + + return $this; + } + + public function getImageFilename(): string + { + return $this->imageFilename; + } + + public function setImageFilename(string $imageFilename): Log + { + $this->imageFilename = $imageFilename; + + return $this; + } + + public function isRemoved(): bool + { + return $this->removed; + } + + public function setRemoved(bool $removed): void + { + $this->removed = $removed; + } +} diff --git a/plugin/exercisemonitoring/src/ExerciseMonitoringPlugin.php b/plugin/exercisemonitoring/src/ExerciseMonitoringPlugin.php new file mode 100644 index 000000000..997885e96 --- /dev/null +++ b/plugin/exercisemonitoring/src/ExerciseMonitoringPlugin.php @@ -0,0 +1,185 @@ + 'boolean', + self::SETTING_INSTRUCTIONS => 'wysiwyg', + self::SETTING_INSTRUCTION_AGE_DISTINCTION_ENABLE => 'boolean', + self::SETTING_INSTRUCTION_LEGAL_AGE => 'text', + self::SETTING_EXTRAFIELD_BIRTHDATE => 'text', + self::SETTING_INSTRUCTIONS_ADULTS => 'wysiwyg', + self::SETTING_INSTRUCTIONS_MINORS => 'wysiwyg', + self::SETTING_SNAPSHOTS_LIFETIME => 'text', + ]; + + parent::__construct( + $version, + "Angel Fernando Quiroz Campos ", + $settings + ); + } + + public static function create(): self + { + static $result = null; + + return $result ?: $result = new self(); + } + + /** + * @throws ToolsException + */ + public function install() + { + $em = Database::getManager(); + + if ($em->getConnection()->getSchemaManager()->tablesExist([self::TABLE_LOG])) { + return; + } + + $schemaTool = new SchemaTool($em); + $schemaTool->createSchema( + [ + $em->getClassMetadata(Log::class), + ] + ); + + $pluginDirName = api_get_path(SYS_UPLOAD_PATH).'plugins/exercisemonitoring'; + + $fs = new Filesystem(); + $fs->mkdir( + $pluginDirName, + api_get_permissions_for_new_directories() + ); + + $objField = new ExtraField('exercise'); + $objField->save([ + 'variable' => self::FIELD_SELECTED, + 'field_type' => ExtraField::FIELD_TYPE_CHECKBOX, + 'display_text' => $this->get_title(), + 'visible_to_self' => true, + 'changeable' => true, + 'filter' => false, + ]); + } + + public function uninstall() + { + $em = Database::getManager(); + + if (!$em->getConnection()->getSchemaManager()->tablesExist([self::TABLE_LOG])) { + return; + } + + $schemaTool = new SchemaTool($em); + $schemaTool->dropSchema( + [ + $em->getClassMetadata(Log::class), + ] + ); + + $objField = new ExtraField('exercise'); + $extraFieldInfo = $objField->get_handler_field_info_by_field_variable(self::FIELD_SELECTED); + + if ($extraFieldInfo) { + $objField->delete($extraFieldInfo['id']); + } + } + + public function getAdminUrl(): string + { + $name = $this->get_name(); + $webPath = api_get_path(WEB_PLUGIN_PATH).$name; + + return "$webPath/admin.php"; + } + + public function generateDetailLink(int $exeId, int $userId): string + { + $title = $this->get_lang('ExerciseMonitored'); + $webcamIcon = Display::return_icon('webcam.png', $title); + $webcamNaIcon = Display::return_icon('webcam_na.png', $this->get_lang('ExerciseUnmonitored')); + + $monitoringDetailUrl = api_get_path(WEB_PLUGIN_PATH).'exercisemonitoring/pages/detail.php?'.api_get_cidreq() + .'&'.http_build_query(['id' => $exeId]); + + $url = Display::url( + $webcamIcon, + $monitoringDetailUrl, + [ + 'class' => 'ajax', + 'data-title' => $title, + 'data-size' => 'lg', + ] + ); + + $showLink = true; + + if ('true' === $this->get(self::SETTING_INSTRUCTION_AGE_DISTINCTION_ENABLE) && !$this->isAdult($userId)) { + $showLink = false; + } + + return $showLink ? $url : $webcamNaIcon; + } + + public static function generateSnapshotUrl( + int $userId, + string $imageFileName, + string $path = WEB_UPLOAD_PATH + ): string { + $pluginDirName = api_get_path($path).'plugins/exercisemonitoring'; + + return $pluginDirName.'/'.$userId.'/'.$imageFileName; + } + + /** + * @throws Exception + */ + public function isAdult(int $userId = 0): bool + { + $userId = $userId ?: api_get_user_id(); + $fieldVariable = $this->get(self::SETTING_EXTRAFIELD_BIRTHDATE); + $legalAge = (int) $this->get(self::SETTING_INSTRUCTION_LEGAL_AGE); + + $value = UserManager::get_extra_user_data_by_field($userId, $fieldVariable); + + if (empty($value)) { + return false; + } + + if (empty($value[$fieldVariable])) { + return false; + } + + $birthdate = new DateTime($value[$fieldVariable]); + $now = new DateTime(); + $diff = $birthdate->diff($now); + + return !$diff->invert && $diff->y >= $legalAge; + } +} diff --git a/plugin/exercisemonitoring/src/Repository/LogRepository.php b/plugin/exercisemonitoring/src/Repository/LogRepository.php new file mode 100644 index 000000000..f307f97d0 --- /dev/null +++ b/plugin/exercisemonitoring/src/Repository/LogRepository.php @@ -0,0 +1,47 @@ +findBy( + [ + 'level' => $level, + 'exe' => $exe, + ], + ['createdAt' => 'ASC'] + ); + } + + public function findSnapshots(Exercise $objExercise, TrackEExercises $trackExe) + { + $qb = $this->createQueryBuilder('l'); + + $qb->select(['l.imageFilename', 'l.createdAt']); + + if (ONE_PER_PAGE == $objExercise->selectType()) { + $qb + ->addSelect(['qq.question AS log_level']) + ->leftJoin(CQuizQuestion::class, 'qq', Join::WITH, 'l.level = qq.iid'); + } + + $query = $qb + ->andWhere( + $qb->expr()->eq('l.exe', $trackExe->getExeId()) + ) + ->addOrderBy('l.createdAt') + ->getQuery(); + + return $query->getResult(); + } +} diff --git a/plugin/exercisemonitoring/templates/exercise_submit.html.twig b/plugin/exercisemonitoring/templates/exercise_submit.html.twig new file mode 100644 index 000000000..6430d8a45 --- /dev/null +++ b/plugin/exercisemonitoring/templates/exercise_submit.html.twig @@ -0,0 +1,84 @@ +{% if exercisemonitoring.show_submit_region and exercisemonitoring.enabled and exercisemonitoring.enable_snapshots %} + {% set ALL_ON_ONE_PAGE = exercisemonitoring.exercise_type == 1 %} + {% set ONE_PER_PAGE = exercisemonitoring.exercise_type == 2 %} + +
    + + + + +{% endif %} diff --git a/plugin/exercisemonitoring/templates/modal.html.twig b/plugin/exercisemonitoring/templates/modal.html.twig new file mode 100644 index 000000000..18a14c831 --- /dev/null +++ b/plugin/exercisemonitoring/templates/modal.html.twig @@ -0,0 +1,314 @@ +{% if exercisemonitoring.show_overview_region and exercisemonitoring.enabled %} + {% if exercisemonitoring.enable_snapshots %} + + + + + + {% else %} + + + {% endif %} +{% endif %} \ No newline at end of file diff --git a/plugin/exercisemonitoring/uninstall.php b/plugin/exercisemonitoring/uninstall.php new file mode 100644 index 000000000..4201e82f9 --- /dev/null +++ b/plugin/exercisemonitoring/uninstall.php @@ -0,0 +1,5 @@ +uninstall(); diff --git a/plugin/ext_auth_chamilo_logout_button_behaviour/README.md b/plugin/ext_auth_chamilo_logout_button_behaviour/README.md new file mode 100644 index 000000000..ce6532f1a --- /dev/null +++ b/plugin/ext_auth_chamilo_logout_button_behaviour/README.md @@ -0,0 +1,20 @@ +External Authentication Logout button behaviour plugin +=== + +If you use some other authentication than local Chamilo authentication, you may want to disable the Chamilo logout button and display information about your SSO logout. + +With this plugin, you can: + +* change the logout URL of the button +* disable the logout button +* display it in grey style +* change the button tooltip on mouseover +* add an alert message if user click on the button + +Related plugins +--- + +Add a button to login using CAS
    +Add a button to logout from CAS
    +Add a button to login using FACEBOOK account
    +Add a button to login using Shibboleth
    diff --git a/plugin/ext_auth_chamilo_logout_button_behaviour/index.php b/plugin/ext_auth_chamilo_logout_button_behaviour/index.php new file mode 100644 index 000000000..690fc3119 --- /dev/null +++ b/plugin/ext_auth_chamilo_logout_button_behaviour/index.php @@ -0,0 +1,42 @@ +Plugins). + * + * @package chamilo.plugin + * + * @author Julio Montoya + */ +/** + * Plugin details (must be present). + */ + +//the plugin title +$plugin_info['title'] = 'Enable or disable logout button'; + +//the comments that go with the plugin +$plugin_info['comment'] = "If you use some other authentication than local Chamilo authentication, you may have to disable the Chamilo logout button and give users information about your SSO logout."; +//the plugin version +$plugin_info['version'] = '1.0'; +//the plugin author +$plugin_info['author'] = 'Hubert Borderiou'; +//the plugin configuration +$form = new FormValidator('eaclbb_form'); +$form->addElement("html", "
    Fill the text boxes below to overwrite the default values used in this plugin
    "); +$form->addElement('text', 'eaclbb_form_link_url', 'Page to load when clicking on the logout button'); +$form->addElement('text', 'eaclbb_form_link_infobulle', 'Tooltip text for the logout button (displayed on mouseover)'); +$form->addElement('checkbox', 'eaclbb_form_link_image', "Display the logout button disabled (black and white)", "", ['checked' => true]); +$form->addElement('checkbox', 'eaclbb_form_alert_onoff', "Display an alert when clicking on the logout button", "", ['checked' => true]); +$form->addElement('text', 'eaclbb_form_alert_text', "Text displayed in the alert box when clickng on the logout button (if checkbox above has been checked)."); + +$form->addButtonSave(get_lang('Save'), 'submit_button'); +//get default value for form +$tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_url = api_get_setting('ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_url'); +$tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_infobulle = api_get_setting('ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_infobulle'); +$tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_image = api_get_setting('ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_image'); +$tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_alert_onoff = api_get_setting('ext_auth_chamilo_logout_button_behaviour_eaclbb_form_alert_onoff'); +$tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_alert_text = api_get_setting('ext_auth_chamilo_logout_button_behaviour_eaclbb_form_alert_text'); +if ($tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_url) { + $defaults['eaclbb_form_link_url'] = $tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_url['eaclbb_form_link_url']; +} + +if ($tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_infobulle) { + $defaults['eaclbb_form_link_infobulle'] = $tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_infobulle['eaclbb_form_link_infobulle']; +} + +if ($tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_image) { + $defaults['eaclbb_form_link_image'] = $tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_link_image['eaclbb_form_link_image']; +} +if ($tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_alert_onoff) { + $defaults['eaclbb_form_alert_onoff'] = $tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_alert_onoff['eaclbb_form_alert_onoff']; +} +if ($tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_alert_text) { + $defaults['eaclbb_form_alert_text'] = $tab_default_ext_auth_chamilo_logout_button_behaviour_eaclbb_form_alert_text['eaclbb_form_alert_text']; +} +$form->setDefaults($defaults); +//display form +$plugin_info['settings_form'] = $form; + +// Set the templates that are going to be used +$plugin_info['templates'] = ['template.tpl']; diff --git a/plugin/ext_auth_chamilo_logout_button_behaviour/template.tpl b/plugin/ext_auth_chamilo_logout_button_behaviour/template.tpl new file mode 100644 index 000000000..c9352e9f4 --- /dev/null +++ b/plugin/ext_auth_chamilo_logout_button_behaviour/template.tpl @@ -0,0 +1,12 @@ +{% if ext_auth_chamilo_logout_button_behaviour.show_message %} + +{% endif %} diff --git a/plugin/externalnotificationconnect/README.md b/plugin/externalnotificationconnect/README.md new file mode 100644 index 000000000..01db07625 --- /dev/null +++ b/plugin/externalnotificationconnect/README.md @@ -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' diff --git a/plugin/externalnotificationconnect/install.php b/plugin/externalnotificationconnect/install.php new file mode 100644 index 000000000..357e861b3 --- /dev/null +++ b/plugin/externalnotificationconnect/install.php @@ -0,0 +1,5 @@ +install(); diff --git a/plugin/externalnotificationconnect/lang/english.php b/plugin/externalnotificationconnect/lang/english.php new file mode 100644 index 000000000..02b2ada68 --- /dev/null +++ b/plugin/externalnotificationconnect/lang/english.php @@ -0,0 +1,18 @@ +Yes     to activate external notification for Portfolio tool actions'; +$strings['notify_learnpath'] = 'Learning path'; +$strings['notify_learnpath_help'] = 'Put it to Yes to activate external notification for learning path creation'; diff --git a/plugin/externalnotificationconnect/lang/french.php b/plugin/externalnotificationconnect/lang/french.php new file mode 100644 index 000000000..c60bfb2f8 --- /dev/null +++ b/plugin/externalnotificationconnect/lang/french.php @@ -0,0 +1,18 @@ +Oui pour activer les notifications pour les actions du Portfolio'; +$strings['notify_learnpath'] = 'Parcours'; +$strings['notify_learnpath_help'] = 'Mettre à Oui pour activer les notifications pour la création de parcours'; diff --git a/plugin/externalnotificationconnect/lang/spanish.php b/plugin/externalnotificationconnect/lang/spanish.php new file mode 100644 index 000000000..443fabbae --- /dev/null +++ b/plugin/externalnotificationconnect/lang/spanish.php @@ -0,0 +1,18 @@ +Sí para activar la notificación externa para las acciones de la herramienta Portafolio'; +$strings['notify_learnpath'] = 'Lecciones'; +$strings['notify_learnpath_help'] = 'Ponerlo a Sí para activar la notificación externa para la creación de lecciones'; diff --git a/plugin/externalnotificationconnect/plugin.php b/plugin/externalnotificationconnect/plugin.php new file mode 100644 index 000000000..c64e35c95 --- /dev/null +++ b/plugin/externalnotificationconnect/plugin.php @@ -0,0 +1,5 @@ +get_info(); diff --git a/plugin/externalnotificationconnect/src/Entity/AccessToken.php b/plugin/externalnotificationconnect/src/Entity/AccessToken.php new file mode 100644 index 000000000..fc47960e6 --- /dev/null +++ b/plugin/externalnotificationconnect/src/Entity/AccessToken.php @@ -0,0 +1,71 @@ +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; + } +} diff --git a/plugin/externalnotificationconnect/src/ExternalNotificationConnectPlugin.php b/plugin/externalnotificationconnect/src/ExternalNotificationConnectPlugin.php new file mode 100644 index 000000000..1cb1f52c4 --- /dev/null +++ b/plugin/externalnotificationconnect/src/ExternalNotificationConnectPlugin.php @@ -0,0 +1,241 @@ +', + ]; + + $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']; + } +} diff --git a/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectHookObserver.php b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectHookObserver.php new file mode 100644 index 000000000..56e46d875 --- /dev/null +++ b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectHookObserver.php @@ -0,0 +1,21 @@ +plugin = ExternalNotificationConnectPlugin::create(); + } +} diff --git a/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectLearningPathCreatedHookObserver.php b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectLearningPathCreatedHookObserver.php new file mode 100644 index 000000000..2f99843de --- /dev/null +++ b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectLearningPathCreatedHookObserver.php @@ -0,0 +1,56 @@ +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']); + } +} diff --git a/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemAddedHookObserver.php b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemAddedHookObserver.php new file mode 100644 index 000000000..aa8fc11aa --- /dev/null +++ b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemAddedHookObserver.php @@ -0,0 +1,50 @@ +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']); + } +} diff --git a/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemDeletedHookObserver.php b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemDeletedHookObserver.php new file mode 100644 index 000000000..102f25f34 --- /dev/null +++ b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemDeletedHookObserver.php @@ -0,0 +1,33 @@ +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'])); + } +} diff --git a/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemEditedHookObserver.php b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemEditedHookObserver.php new file mode 100644 index 000000000..cc32a5187 --- /dev/null +++ b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemEditedHookObserver.php @@ -0,0 +1,50 @@ +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'])); + } +} diff --git a/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemVisibilityHookObserver.php b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemVisibilityHookObserver.php new file mode 100644 index 000000000..97cf7ed9e --- /dev/null +++ b/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemVisibilityHookObserver.php @@ -0,0 +1,44 @@ +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']); + } +} diff --git a/plugin/externalnotificationconnect/src/Traits/RequestTrait.php b/plugin/externalnotificationconnect/src/Traits/RequestTrait.php new file mode 100644 index 000000000..f440e6614 --- /dev/null +++ b/plugin/externalnotificationconnect/src/Traits/RequestTrait.php @@ -0,0 +1,191 @@ +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( + '
    ', + 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; + } +} diff --git a/plugin/externalnotificationconnect/uninstall.php b/plugin/externalnotificationconnect/uninstall.php new file mode 100644 index 000000000..d16927ded --- /dev/null +++ b/plugin/externalnotificationconnect/uninstall.php @@ -0,0 +1,5 @@ +uninstall(); diff --git a/plugin/extramenufromwebservice/LICENSE.txt b/plugin/extramenufromwebservice/LICENSE.txt new file mode 100644 index 000000000..9e419e042 --- /dev/null +++ b/plugin/extramenufromwebservice/LICENSE.txt @@ -0,0 +1,674 @@ +GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. \ No newline at end of file diff --git a/plugin/extramenufromwebservice/README.md b/plugin/extramenufromwebservice/README.md new file mode 100644 index 000000000..eddfbff1c --- /dev/null +++ b/plugin/extramenufromwebservice/README.md @@ -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). diff --git a/plugin/extramenufromwebservice/config.php b/plugin/extramenufromwebservice/config.php new file mode 100644 index 000000000..46e612525 --- /dev/null +++ b/plugin/extramenufromwebservice/config.php @@ -0,0 +1,4 @@ +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 = ''; + $fh .= ''; + 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 .= '
    '; + $fh .= ''; + $fh .= ''; + $fh .= ''; + $fh .= '
    '; + + echo $fh; + } + } +} diff --git a/plugin/extramenufromwebservice/install.php b/plugin/extramenufromwebservice/install.php new file mode 100644 index 000000000..550dfcbf6 --- /dev/null +++ b/plugin/extramenufromwebservice/install.php @@ -0,0 +1,7 @@ +install(); diff --git a/plugin/extramenufromwebservice/lang/english.php b/plugin/extramenufromwebservice/lang/english.php new file mode 100644 index 000000000..961a29249 --- /dev/null +++ b/plugin/extramenufromwebservice/lang/english.php @@ -0,0 +1,15 @@ + '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; + } +} diff --git a/plugin/extramenufromwebservice/plugin.php b/plugin/extramenufromwebservice/plugin.php new file mode 100644 index 000000000..856a8271d --- /dev/null +++ b/plugin/extramenufromwebservice/plugin.php @@ -0,0 +1,5 @@ +get_info(); diff --git a/plugin/extramenufromwebservice/resources/css/extramenufromwebservice.css b/plugin/extramenufromwebservice/resources/css/extramenufromwebservice.css new file mode 100644 index 000000000..3b8a4e7cd --- /dev/null +++ b/plugin/extramenufromwebservice/resources/css/extramenufromwebservice.css @@ -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; +} diff --git a/plugin/extramenufromwebservice/resources/js/extramenufromwebservice.js b/plugin/extramenufromwebservice/resources/js/extramenufromwebservice.js new file mode 100644 index 000000000..17f801d0d --- /dev/null +++ b/plugin/extramenufromwebservice/resources/js/extramenufromwebservice.js @@ -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(); +}); diff --git a/plugin/extramenufromwebservice/uninstall.php b/plugin/extramenufromwebservice/uninstall.php new file mode 100644 index 000000000..a96e3423a --- /dev/null +++ b/plugin/extramenufromwebservice/uninstall.php @@ -0,0 +1,5 @@ +uninstall(); diff --git a/plugin/follow_buttons/README.md b/plugin/follow_buttons/README.md new file mode 100644 index 000000000..57a460093 --- /dev/null +++ b/plugin/follow_buttons/README.md @@ -0,0 +1,6 @@ +Follow buttons (or AddThis icons) +=== + +Edit the main/plugin/follow_buttons/index.php file in order to add your settings. + +It can slow down your website because it will load a javascript file from the addthis.com server \ No newline at end of file diff --git a/plugin/follow_buttons/index.php b/plugin/follow_buttons/index.php new file mode 100644 index 000000000..61c30b777 --- /dev/null +++ b/plugin/follow_buttons/index.php @@ -0,0 +1,20 @@ +Plugins). + * + * @package chamilo.plugin + * + * @author Julio Montoya + */ +/** + * Plugin details (must be present). + */ + +/* Plugin config */ + +//the plugin title +$plugin_info['title'] = 'Follow icons'; +//the comments that go with the plugin +$plugin_info['comment'] = "Add social icons (implemented using addthis.com)"; +//the plugin version +$plugin_info['version'] = '1.0'; +//the plugin author +$plugin_info['author'] = 'Julio Montoya'; + +$plugin_info['templates'] = ['template.tpl']; + +//For bigger icons change this value to addthis_32x32_style +$plugin_info['icon_class'] = ''; + +//To use vertical alignment change this value to +$plugin_info['position'] = 'addthis_default_style'; //addthis_vertical_style diff --git a/plugin/follow_buttons/template.tpl b/plugin/follow_buttons/template.tpl new file mode 100644 index 000000000..cbf43fc13 --- /dev/null +++ b/plugin/follow_buttons/template.tpl @@ -0,0 +1,35 @@ +
    + +{% if follow_buttons.message is not empty %} +

    {{ follow_buttons.message }}

    +{% endif %} + + + + +
    \ No newline at end of file diff --git a/plugin/formLogin_hide_unhide/README.md b/plugin/formLogin_hide_unhide/README.md new file mode 100644 index 000000000..7493ed5bf --- /dev/null +++ b/plugin/formLogin_hide_unhide/README.md @@ -0,0 +1,7 @@ +Hide/Show login form plugin +=== + +If you use another way of authentication than local, you may want to hide the Login/Password default Form to avoid user mistakes. +This plugin replaces the Login/Password form with a text that shows the Login/Password form if you click on it. + +This plugin has been done to be added in the login_top region. \ No newline at end of file diff --git a/plugin/formLogin_hide_unhide/css.css b/plugin/formLogin_hide_unhide/css.css new file mode 100644 index 000000000..d6b83ebe7 --- /dev/null +++ b/plugin/formLogin_hide_unhide/css.css @@ -0,0 +1,3 @@ +.formLogin_hide_unhide_div { + cursor:pointer; +} diff --git a/plugin/formLogin_hide_unhide/index.php b/plugin/formLogin_hide_unhide/index.php new file mode 100644 index 000000000..9fa1f0926 --- /dev/null +++ b/plugin/formLogin_hide_unhide/index.php @@ -0,0 +1,13 @@ +Plugins). + * + * @package chamilo.plugin + * + * @author Julio Montoya + */ +/** + * Plugin details (must be present). + */ + +//the plugin title +$plugin_info['title'] = 'Hide/Unhide the Login/Password default form'; + +//the comments that go with the plugin +$plugin_info['comment'] = "If you use another way of authentication than local, you may want to hide the Login/Password default Form to avoid users mistakes. This plugin replace the Login/Password form with a text that unhide the Login/Password form if you click on it."; +//the plugin version +$plugin_info['version'] = '1.0'; +//the plugin author +$plugin_info['author'] = 'Hubert Borderiou'; + +//the plugin configuration +$form = new FormValidator('add_cas_button_form'); +$form->addElement('text', 'label', 'Text label', ''); +//get default value +$tab_default_formLogin_hide_unhide_label = api_get_setting('formLogin_hide_unhide_label'); +$defaults = []; +if ($tab_default_formLogin_hide_unhide_label) { + $defaults['label'] = $tab_default_formLogin_hide_unhide_label['formLogin_hide_unhide']; +} + +$form->setDefaults($defaults); +//display form +$plugin_info['settings_form'] = $form; + +//set the templates that are going to be used +$plugin_info['templates'] = ['template.tpl']; diff --git a/plugin/formLogin_hide_unhide/template.tpl b/plugin/formLogin_hide_unhide/template.tpl new file mode 100644 index 000000000..d79c0ca07 --- /dev/null +++ b/plugin/formLogin_hide_unhide/template.tpl @@ -0,0 +1,11 @@ +{% if formLogin_hide_unhide.show_message %} + +
    + {{ formLogin_hide_unhide.label }} +
    + +{% endif %} diff --git a/plugin/google_maps/README.md b/plugin/google_maps/README.md new file mode 100644 index 000000000..bdf1c3012 --- /dev/null +++ b/plugin/google_maps/README.md @@ -0,0 +1,4 @@ +Google Maps Plugin +=================== + +Activa la funcionalidad de mostrar mapas usando el api de google maps diff --git a/plugin/google_maps/config.php b/plugin/google_maps/config.php new file mode 100644 index 000000000..0f06c6dc9 --- /dev/null +++ b/plugin/google_maps/config.php @@ -0,0 +1,10 @@ + + * + * @package chamilo.plugin.google_maps + */ +define('TABLE_GOOGLE_MAPS', 'plugin_google_maps'); diff --git a/plugin/google_maps/index.php b/plugin/google_maps/index.php new file mode 100644 index 000000000..00635519c --- /dev/null +++ b/plugin/google_maps/index.php @@ -0,0 +1,12 @@ + + * + * @package chamilo.plugin.google_maps + */ +require_once __DIR__.'/config.php'; + +$googleMapsPlugin = GoogleMapsPlugin::create(); diff --git a/plugin/google_maps/install.php b/plugin/google_maps/install.php new file mode 100644 index 000000000..678729ca6 --- /dev/null +++ b/plugin/google_maps/install.php @@ -0,0 +1,12 @@ + + * + * @package chamilo.plugin.google_maps + */ +require_once __DIR__.'/config.php'; + +GoogleMapsPlugin::create()->install(); diff --git a/plugin/google_maps/lang/english.php b/plugin/google_maps/lang/english.php new file mode 100644 index 000000000..3172443a1 --- /dev/null +++ b/plugin/google_maps/lang/english.php @@ -0,0 +1,13 @@ +
    + +

    +Follow the link below to see the map : ".api_get_path(WEB_PLUGIN_PATH)."google_maps/src/map_coordinates.php"; +$strings['enable_api'] = "Enable API"; +$strings['api_key'] = "Api Key"; +$strings['extra_field_name'] = "Extra field name"; +$strings['UsersCoordinatesMap'] = "Users location Map"; diff --git a/plugin/google_maps/lang/french.php b/plugin/google_maps/lang/french.php new file mode 100644 index 000000000..0fb12d582 --- /dev/null +++ b/plugin/google_maps/lang/french.php @@ -0,0 +1,13 @@ +
    + +

    +Suivez le lien pour voir la carte : ".api_get_path(WEB_PLUGIN_PATH)."google_maps/src/map_coordinates.php"; +$strings['enable_api'] = "Enable API"; +$strings['api_key'] = "Api Key"; +$strings['extra_field_name'] = "Nom de champ supplémentaire"; +$strings['UsersCoordinatesMap'] = "Carte des emplacements des utilisateurs"; diff --git a/plugin/google_maps/lang/spanish.php b/plugin/google_maps/lang/spanish.php new file mode 100644 index 000000000..790a53a54 --- /dev/null +++ b/plugin/google_maps/lang/spanish.php @@ -0,0 +1,13 @@ +
    + +

    +siga el siguiente link para ver el mapa : ".api_get_path(WEB_PLUGIN_PATH)."google_maps/src/map_coordinates.php"; +$strings['enable_api'] = "Activar API"; +$strings['api_key'] = "Api Key"; +$strings['extra_field_name'] = "Nombre del campo extra"; +$strings['UsersCoordinatesMap'] = "Mapa de localización de Usuarios"; diff --git a/plugin/google_maps/plugin.php b/plugin/google_maps/plugin.php new file mode 100644 index 000000000..52ed6874f --- /dev/null +++ b/plugin/google_maps/plugin.php @@ -0,0 +1,12 @@ + + * + * @package chamilo.plugin.google_maps + */ +require_once __DIR__.'/config.php'; + +$plugin_info = GoogleMapsPlugin::create()->get_info(); diff --git a/plugin/google_maps/src/GoogleMapsPlugin.php b/plugin/google_maps/src/GoogleMapsPlugin.php new file mode 100644 index 000000000..2d11d57cf --- /dev/null +++ b/plugin/google_maps/src/GoogleMapsPlugin.php @@ -0,0 +1,70 @@ + + * + * @package chamilo.plugin.google_maps + */ +class GoogleMapsPlugin extends Plugin +{ + public $javascriptIncluded; + + /** + * Class constructor. + */ + protected function __construct() + { + $parameters = [ + 'enable_api' => 'boolean', + 'api_key' => 'text', + 'extra_field_name' => 'text', + ]; + + $this->javascriptIncluded = false; + + parent::__construct('1.0', 'José Loguercio Silva', $parameters); + } + + /** + * Get the plugin Name. + * + * @return string + */ + public function get_name() + { + return 'google_maps'; + } + + /** + * Instance the plugin. + * + * @staticvar null $result + * + * @return GoogleMapsPlugin + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * Install the plugin. + */ + public function install() + { + return true; + } + + /** + * Uninstall the plugin. + */ + public function uninstall() + { + return true; + } +} diff --git a/plugin/google_maps/src/map_coordinates.php b/plugin/google_maps/src/map_coordinates.php new file mode 100644 index 000000000..0222aaedd --- /dev/null +++ b/plugin/google_maps/src/map_coordinates.php @@ -0,0 +1,68 @@ + + * + * @package chamilo.plugin.google_maps + */ +$cidReset = true; + +require_once __DIR__.'/../../../main/inc/global.inc.php'; + +api_protect_admin_script(); + +$plugin = GoogleMapsPlugin::create(); + +$apiIsEnable = $plugin->get('enable_api') === 'true'; +$extraFieldName = $plugin->get('extra_field_name'); + +$extraFieldName = array_map('trim', explode(',', $extraFieldName)); + +if ($apiIsEnable) { + $gmapsApiKey = $plugin->get('api_key'); + $htmlHeadXtra[] = ''; +} + +$em = Database::getManager(); +$extraField = $em->getRepository('ChamiloCoreBundle:ExtraField'); + +$extraFieldNames = []; + +foreach ($extraFieldName as $field) { + $extraFieldNames[] = $extraField->findOneBy(['variable' => $field]); +} + +$extraFieldValues = []; + +foreach ($extraFieldNames as $index => $fieldName) { + if ($fieldName) { + $extraFieldRepo = $em->getRepository('ChamiloCoreBundle:ExtraFieldValues'); + $extraFieldValues[] = $extraFieldRepo->findBy(['field' => $fieldName->getId()]); + } +} + +$templateName = $plugin->get_lang('UsersCoordinatesMap'); + +$tpl = new Template($templateName); + +$formattedExtraFieldValues = []; + +foreach ($extraFieldValues as $index => $extra) { + foreach ($extra as $yandex => $field) { + $thisUserExtraField = api_get_user_info($field->getItemId()); + $formattedExtraFieldValues[$index][$yandex]['address'] = $field->getValue(); + $formattedExtraFieldValues[$index][$yandex]['user_complete_name'] = $thisUserExtraField['complete_name']; + } +} + +$tpl->assign('extra_field_values_formatted', $formattedExtraFieldValues); +$tpl->assign('extra_field_values', $extraFieldValues); + +$content = $tpl->fetch('google_maps/view/map_coordinates.tpl'); + +$tpl->assign('header', $templateName); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/google_maps/uninstall.php b/plugin/google_maps/uninstall.php new file mode 100644 index 000000000..366e035ba --- /dev/null +++ b/plugin/google_maps/uninstall.php @@ -0,0 +1,12 @@ + + * + * @package chamilo.plugin.google_maps + */ +require_once __DIR__.'/config.php'; + +GoogleMapsPlugin::create()->uninstall(); diff --git a/plugin/google_maps/view/map_coordinates.tpl b/plugin/google_maps/view/map_coordinates.tpl new file mode 100644 index 000000000..c4064190b --- /dev/null +++ b/plugin/google_maps/view/map_coordinates.tpl @@ -0,0 +1,105 @@ +
    + +
    + \ No newline at end of file diff --git a/plugin/google_meet/README.md b/plugin/google_meet/README.md new file mode 100644 index 000000000..ffe69462b --- /dev/null +++ b/plugin/google_meet/README.md @@ -0,0 +1,18 @@ +Google Meet plugin +============================ +This plugin allows you to have videoconference rooms in each course using Google Meet. +This is only a light integration, meaning you will still need to go to Google Meet and +have a Google account in order to create a meeting *and* students will need to be +connected to their Google account to connect. However, we believe there is still value +in making this plugin available for our community at large. + +# Changelog + +## Version 1.1 - 2020-11-29 + +Add sessions management + +## Version 1.0 - 2020-07-09 + +Initial release. Includes the possibility to create meetings manually, through +a link to https://meet.google.com/ \ No newline at end of file diff --git a/plugin/google_meet/config.php b/plugin/google_meet/config.php new file mode 100644 index 000000000..52bded383 --- /dev/null +++ b/plugin/google_meet/config.php @@ -0,0 +1,10 @@ + + * + * @package chamilo.plugin.google_meet + */ +require_once __DIR__.'/../../main/inc/global.inc.php'; +require_once 'src/google_meet_plugin.class.php'; diff --git a/plugin/google_meet/install.php b/plugin/google_meet/install.php new file mode 100644 index 000000000..922bcf4fe --- /dev/null +++ b/plugin/google_meet/install.php @@ -0,0 +1,10 @@ +install(); diff --git a/plugin/google_meet/lang/english.php b/plugin/google_meet/lang/english.php new file mode 100644 index 000000000..42a17c6db --- /dev/null +++ b/plugin/google_meet/lang/english.php @@ -0,0 +1,22 @@ +click here to create one, then save the URL and put it in this field.'; +$strings['AccessMeeting'] = 'Access the meeting'; +$strings['MeetingDescription'] = 'Description'; +$strings['MeetingDescriptionHelp'] = '(Optional) Add a short description for the meeting.'; +$strings['MeetColor'] = 'Color of Meet'; +$strings['MeetColorHelp'] = '(Optional)'; diff --git a/plugin/google_meet/lang/french.php b/plugin/google_meet/lang/french.php new file mode 100644 index 000000000..92b914362 --- /dev/null +++ b/plugin/google_meet/lang/french.php @@ -0,0 +1,22 @@ +cliquez ici pour en créer une, puis copiez son URL et collez-la dans ce champs.'; +$strings['AccessMeeting'] = 'Accéder à la réunion'; +$strings['MeetingDescription'] = 'Description'; +$strings['MeetingDescriptionHelp'] = '(Optionnel) Ajouter une brève description.'; +$strings['MeetColor'] = 'Couleur de la réunion'; +$strings['MeetColorHelp'] = '(Optionnel)'; diff --git a/plugin/google_meet/lang/spanish.php b/plugin/google_meet/lang/spanish.php new file mode 100644 index 000000000..90d0f2e25 --- /dev/null +++ b/plugin/google_meet/lang/spanish.php @@ -0,0 +1,22 @@ +haga clic aquí para crear una, luego guarde la URL y colóquela en el campo arriba.'; +$strings['AccessMeeting'] = 'Acceder a la reunión'; +$strings['MeetingDescription'] = 'Descripción'; +$strings['MeetingDescriptionHelp'] = '(Opcional) Añada una breve descripción sobre la reunión.'; +$strings['MeetColor'] = 'Color de Meet'; +$strings['MeetColorHelp'] = '(Opcional)'; diff --git a/plugin/google_meet/meets.php b/plugin/google_meet/meets.php new file mode 100644 index 000000000..00920f6f6 --- /dev/null +++ b/plugin/google_meet/meets.php @@ -0,0 +1,226 @@ +'; + +$plugin = GoogleMeetPlugin::create(); + +$userId = api_get_user_id(); +$tool_name = $plugin->get_lang('tool_title'); +$tpl = new Template($tool_name); + +$isAdmin = api_is_platform_admin(); +$isTeacher = api_is_teacher(); +$message = null; + +$action = isset($_GET['action']) ? $_GET['action'] : null; +$enable = $plugin->get('google_meet_enabled') == 'true'; +$actionLinks = ''; + +if ($enable) { + if ($isAdmin || $isTeacher) { + if ($action) { + switch ($action) { + case 'delete': + $idMeet = isset($_GET['id_meet']) ? $_GET['id_meet'] : null; + $res = $plugin->deleteMeet($idMeet); + if ($res) { + $url = api_get_path(WEB_PLUGIN_PATH).'google_meet/start.php?'.api_get_cidreq(); + header('Location: '.$url); + } + + break; + case 'add': + $actionLinks .= Display::url( + Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM), + api_get_path(WEB_PLUGIN_PATH).'google_meet/start.php?'.api_get_cidreq() + ); + //create form + $form = new FormValidator( + 'add_meet', + 'post', + api_get_self().'?action='.Security::remove_XSS($_GET['action']).'&'.api_get_cidreq() + ); + + $form->addHeader(get_lang('AddMeet')); + $form->addText( + 'meet_name', + [ + $plugin->get_lang('MeetName'), + $plugin->get_lang('MeetNameHelp'), + ], + true, + [ + 'title' => $plugin->get_lang('MeetNameHelp'), + ] + ); + + $form->addText( + 'meet_url', + [ + $plugin->get_lang('GoogleMeetURL'), + sprintf($plugin->get_lang('GoogleMeetURLHelp'), GoogleMeetPlugin::GOOGLE_MEET_URL), + ], + true, + [ + 'title' => sprintf($plugin->get_lang('GoogleMeetURLHelp'), GoogleMeetPlugin::GOOGLE_MEET_URL), + ] + ); + + try { + $form->addElement( + 'color', + 'meet_color', + [ + $plugin->get_lang('MeetColor'), + $plugin->get_lang('MeetColorHelp'), + ], + [ + 'value' => '#1CC88A', + ] + ); + } catch (HTML_QuickForm_Error $e) { + echo $e; + } + + $form->addHtmlEditor( + 'meet_description', + [ + $plugin->get_lang('MeetingDescription'), + $plugin->get_lang('MeetingDescriptionHelp'), + ], + false, + false, + [ + 'ToolbarSet' => 'Minimal', + ] + ); + + $form->addHidden('type_meet', 1); + + $form->addButtonSave($plugin->get_lang('Add')); + + if (!empty($defaults)) { + $form->setDefaults($defaults); + } + + try { + if ($form->validate()) { + $values = $form->exportValues(); + $res = $plugin->saveMeet($values); + if ($res) { + $url = api_get_path(WEB_PLUGIN_PATH).'google_meet/start.php?'.api_get_cidreq(); + header('Location: '.$url); + } + } + } catch (HTML_QuickForm_Error $e) { + echo $e; + } + + $tpl->assign('form_room', $form->returnForm()); + + break; + case 'edit': + $actionLinks .= Display::url( + Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM), + api_get_path(WEB_PLUGIN_PATH).'google_meet/start.php?'.api_get_cidreq() + ); + + $idMeet = isset($_GET['id_meet']) ? (int) $_GET['id_meet'] : 0; + $dataMeet = $plugin->getMeet($idMeet); + + //create form + $form = new FormValidator( + 'edit_meet', + 'post', + api_get_self().'?action='.Security::remove_XSS($_GET['action']).'&'.api_get_cidreq() + ); + + $form->addHeader(get_lang('EditMeet')); + + $form->addText( + 'meet_name', + [ + $plugin->get_lang('MeetName'), + $plugin->get_lang('MeetNameHelp'), + ], + true, + [ + 'title' => $plugin->get_lang('MeetNameHelp'), + ] + ); + + $form->addText( + 'meet_url', + [ + $plugin->get_lang('GoogleMeetURL'), + sprintf($plugin->get_lang('GoogleMeetURLHelp'), GoogleMeetPlugin::GOOGLE_MEET_URL), + ], + true, + [ + 'title' => sprintf($plugin->get_lang('GoogleMeetURLHelp'), GoogleMeetPlugin::GOOGLE_MEET_URL), + ] + ); + $form->addElement( + 'color', + 'meet_color', + [ + $plugin->get_lang('MeetColor'), + $plugin->get_lang('MeetColorHelp'), + ] + ); + $form->addHtmlEditor( + 'meet_description', + [ + $plugin->get_lang('MeetingDescription'), + $plugin->get_lang('MeetingDescriptionHelp'), + ], + false, + false, + [ + 'ToolbarSet' => 'Minimal', + ] + ); + + $form->addHidden('id', $idMeet); + $form->addButtonSave($plugin->get_lang('Save')); + + $form->setDefaults($dataMeet); + + if ($form->validate()) { + $values = $form->exportValues(); + $res = $plugin->updateMeet($values); + + if ($res) { + $url = api_get_path(WEB_PLUGIN_PATH).'google_meet/start.php?'.api_get_cidreq(); + header('Location: '.$url); + } + } + + $tpl->assign('form_room', $form->returnForm()); + + break; + } + } + } +} + +if ($isAdmin || $isTeacher) { + $tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$actionLinks]) + ); +} + +$tpl->assign('message', $message); +$content = $tpl->fetch('google_meet/view/meets.tpl'); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/google_meet/plugin.php b/plugin/google_meet/plugin.php new file mode 100644 index 000000000..c1fac9daf --- /dev/null +++ b/plugin/google_meet/plugin.php @@ -0,0 +1,4 @@ +get_info(); diff --git a/plugin/google_meet/resources/css/style.css b/plugin/google_meet/resources/css/style.css new file mode 100644 index 000000000..02db1506c --- /dev/null +++ b/plugin/google_meet/resources/css/style.css @@ -0,0 +1,148 @@ +.plugin_logo{ + text-align: center; + padding-top: 1rem; + padding-bottom: 1rem; +} +.plugin_logo .img-responsive{ + margin: auto; +} +.tools{ + margin-bottom: 2rem; + margin-top: 1rem; +} +.card{ + position: relative; + display: flex; + flex-direction: column; + min-width: 0; + word-wrap: break-word; + border: 1px solid rgba(0,0,0,.05); + border-radius: .375rem; + background-color: #fff; + background-clip: border-box; +} +.card-meet{ + margin-bottom: 30px; + border: 0; + box-shadow: 0 0 2rem 0 rgba(136,152,170,.15); +} +.card-meet:hover{ + border-left: .25rem solid #cdcdcd !important; +} +.card-meet .card-body { + padding: 1rem 1.5rem; +} +.row-meet { + display: block; +} + +.description{ + padding-left: 1rem; + padding-right: 1rem; + padding-top: 2rem; + font-size: 12px; + color: #666666; + display: grid; +} +.description .title{ + font-size: 1.45rem; + font-weight: 600!important; + color: #32325d; + overflow:hidden; + white-space:nowrap; + text-overflow: ellipsis; + width: 100%; + display: inline-block; +} +.description .text{ + display: grid; + padding-bottom: 1rem; +} +.rounded-circle { + border-radius: 50%!important; +} +.shadow { + box-shadow: 0 0 2rem 0 rgba(136,152,170,.15)!important; +} +.icon { + width: 5rem; + height: 5rem; +} +.icon-shape { + display: inline-flex; + padding: 12px; + text-align: center; + border-radius: 50%; + align-items: center; + justify-content: center; + position: absolute; + right: 40%; + top: -20px; +} +.icon-shape .fa{ + font-size: 20px; +} + +.text-white { + color: #fff!important; +} +.btn-meet{ + color: #fff; + border-color: #5e72e4; + background-color: #5e72e4; + box-shadow: 0 4px 6px rgba(50,50,93,.11), 0 1px 3px rgba(0,0,0,.08); +} +.btn-meet:hover { + color: #fff; + border-color: #5e72e4; + background-color: #5e72e4; +} +.btn:hover { + transform: translateY(-1px); + box-shadow: 0 7px 14px rgba(50,50,93,.1), 0 3px 6px rgba(0,0,0,.08); +} +.float-right { + position: absolute; + top: 5px; + right: 5px; +} +.btn-add-meet{ + color: #fff; + border-color: #1cc88a; + background-color: #1cc88a; + font-weight: bold; +} +.btn-add-meet:hover { + color: #fff; + border-color: #17a673; + background-color: #169b6b; +} +.meet-list{ + display: grid; + grid-template-columns: repeat(3, 1fr); +} +.meet-list .meet-item{ + margin: 10px; +} +.meet-list .meet-item .card-meet{ + min-height: 220px; +} +@media (min-width: 768px) and (max-width: 979px) { + .meet-list { + display: grid; + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 767px) { + .meet-list { + display: grid; + grid-template-columns: repeat(2, 1fr); + } +} +/* Landscape phones and down */ +@media (max-width: 480px) { + .meet-list { + display: grid; + grid-template-columns: repeat(1, 1fr); + } +} \ No newline at end of file diff --git a/plugin/google_meet/resources/img/22/google_meet.png b/plugin/google_meet/resources/img/22/google_meet.png new file mode 100644 index 000000000..4d19baa2c Binary files /dev/null and b/plugin/google_meet/resources/img/22/google_meet.png differ diff --git a/plugin/google_meet/resources/img/22/google_meet_na.png b/plugin/google_meet/resources/img/22/google_meet_na.png new file mode 100644 index 000000000..5c51623e6 Binary files /dev/null and b/plugin/google_meet/resources/img/22/google_meet_na.png differ diff --git a/plugin/google_meet/resources/img/32/google_meet.png b/plugin/google_meet/resources/img/32/google_meet.png new file mode 100644 index 000000000..2407ccd77 Binary files /dev/null and b/plugin/google_meet/resources/img/32/google_meet.png differ diff --git a/plugin/google_meet/resources/img/32/google_meet_na.png b/plugin/google_meet/resources/img/32/google_meet_na.png new file mode 100644 index 000000000..4eee5a797 Binary files /dev/null and b/plugin/google_meet/resources/img/32/google_meet_na.png differ diff --git a/plugin/google_meet/resources/img/64/google_meet.png b/plugin/google_meet/resources/img/64/google_meet.png new file mode 100644 index 000000000..96a160ac2 Binary files /dev/null and b/plugin/google_meet/resources/img/64/google_meet.png differ diff --git a/plugin/google_meet/resources/img/64/google_meet_na.png b/plugin/google_meet/resources/img/64/google_meet_na.png new file mode 100644 index 000000000..00a764135 Binary files /dev/null and b/plugin/google_meet/resources/img/64/google_meet_na.png differ diff --git a/plugin/google_meet/resources/img/svg/googlemeet.svg b/plugin/google_meet/resources/img/svg/googlemeet.svg new file mode 100644 index 000000000..b46790b04 --- /dev/null +++ b/plugin/google_meet/resources/img/svg/googlemeet.svg @@ -0,0 +1,304 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugin/google_meet/resources/img/svg/meet_room.svg b/plugin/google_meet/resources/img/svg/meet_room.svg new file mode 100644 index 000000000..fe12d4e85 --- /dev/null +++ b/plugin/google_meet/resources/img/svg/meet_room.svg @@ -0,0 +1,1413 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugin/google_meet/src/google_meet_plugin.class.php b/plugin/google_meet/src/google_meet_plugin.class.php new file mode 100644 index 000000000..be87472b9 --- /dev/null +++ b/plugin/google_meet/src/google_meet_plugin.class.php @@ -0,0 +1,396 @@ + + */ +class GoogleMeetPlugin extends Plugin +{ + public const TABLE_MEET_LIST = 'plugin_google_meet_room'; + public const SETTING_TITLE = 'tool_title'; + public const SETTING_ENABLED = 'google_meet_enabled'; + public const GOOGLE_MEET_URL = 'https://meet.google.com/'; + + public $isCoursePlugin = true; + + protected function __construct() + { + parent::__construct( + '1.0', + ' + Alex Aragón Calixto', + [ + self::SETTING_ENABLED => 'boolean', + self::SETTING_TITLE => 'text', + ] + ); + + $this->isAdminPlugin = true; + } + + /** + * @return string + */ + public function getTitle() + { + $title = $this->get(self::SETTING_TITLE); + + if (!empty($title)) { + return $title; + } + + return $this->get_title(); + } + + /** + * {@inheritdoc} + */ + public function get_name() + { + return 'google_meet'; + } + + /** + * Create a plugin instance. + * + * @return GoogleMeetPlugin + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * This method creates the tables required to this plugin and copies icons + * to the right places. + */ + public function install() + { + $sql = "CREATE TABLE IF NOT EXISTS ".self::TABLE_MEET_LIST." ( + id INT unsigned NOT NULL auto_increment PRIMARY KEY, + meet_name VARCHAR(250) NULL, + meet_url VARCHAR(250) NULL, + meet_description VARCHAR(250) NULL, + meet_color VARCHAR(7) NULL, + type_meet INT NOT NULL, + start_time DATETIME NULL, + end_time DATETIME NULL, + c_id INT NULL NOT NULL, + session_id INT, + activate INT + )"; + + Database::query($sql); + + // Copy icons into the main/img/icons folder + $iconName = 'google_meet'; + $iconsList = [ + '64/'.$iconName.'.png', + '64/'.$iconName.'_na.png', + '32/'.$iconName.'.png', + '32/'.$iconName.'_na.png', + '22/'.$iconName.'.png', + '22/'.$iconName.'_na.png', + ]; + $sourceDir = api_get_path(SYS_PLUGIN_PATH).'google_meet/resources/img/'; + $destinationDir = api_get_path(SYS_CODE_PATH).'img/icons/'; + foreach ($iconsList as $icon) { + $src = $sourceDir.$icon; + $dest = $destinationDir.$icon; + copy($src, $dest); + } + } + + /** + * This method drops the plugin tables and icons. + */ + public function uninstall() + { + $this->deleteCourseToolLinks(); + + $tablesToBeDeleted = [ + self::TABLE_MEET_LIST, + ]; + + foreach ($tablesToBeDeleted as $tableToBeDeleted) { + $table = Database::get_main_table($tableToBeDeleted); + $sql = "DROP TABLE IF EXISTS $table"; + Database::query($sql); + } + $dest1 = api_get_path(SYS_CODE_PATH).'img/icons/64/google_meet.png'; + $dest2 = api_get_path(SYS_CODE_PATH).'img/icons/64/google_meet_na.png'; + if (file_exists($dest1)) { + @unlink($dest1); + } + if (file_exists($dest2)) { + @unlink($dest2); + } + + $this->manageTab(false); + + // Remove icons from the main/img/icons folder + $iconName = 'google_meet'; + $iconsList = [ + '64/'.$iconName.'.png', + '64/'.$iconName.'_na.png', + '32/'.$iconName.'.png', + '32/'.$iconName.'_na.png', + '22/'.$iconName.'.png', + '22/'.$iconName.'_na.png', + ]; + $destinationDir = api_get_path(SYS_CODE_PATH).'img/icons/'; + foreach ($iconsList as $icon) { + $dest = $destinationDir.$icon; + if (is_file($dest)) { + @unlink($dest); + } + } + } + + /** + * {@inheritdoc} + * + * @return GoogleMeetPlugin + */ + 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->getTitle(), $course['id']); + } + } + + return $this; + } + + public function saveMeet($values) + { + if (!is_array($values) || empty($values['meet_name'])) { + return false; + } + $table = Database::get_main_table(self::TABLE_MEET_LIST); + + $courseId = api_get_course_int_id(); + $sessionId = api_get_session_id(); + $url = self::filterUrl($values['meet_url']); + if (!isset($values['type_meet'])) { + $values['type_meet'] = 1; + } + + $params = [ + 'meet_name' => $values['meet_name'], + 'meet_url' => $url, + 'type_meet' => $values['type_meet'], + 'meet_description' => $values['meet_description'], + 'meet_color' => $values['meet_color'], + 'c_id' => $courseId, + 'start_time' => null, + 'end_time' => null, + 'session_id' => $sessionId, + 'activate' => 1, + ]; + + $id = Database::insert($table, $params); + + if ($id > 0) { + return $id; + } + } + + public function listMeets($courseId, $sessionId = 0) + { + $list = []; + $tableMeetList = Database::get_main_table(self::TABLE_MEET_LIST); + $courseId = (int) $courseId; + $sessionId = (int) $sessionId; + + $sql = "SELECT * FROM $tableMeetList WHERE c_id = $courseId AND session_id = $sessionId AND activate = 1"; + + $result = Database::query($sql); + + if (Database::num_rows($result) > 0) { + while ($row = Database::fetch_array($result)) { + $action = Display::url( + Display::return_icon( + 'delete.png', + get_lang('Delete'), + [], + ICON_SIZE_SMALL + ), + 'meets.php?action=delete&id_room='.$row['id'], + [ + 'onclick' => 'javascript:if(!confirm('."'". + addslashes(api_htmlentities(get_lang("ConfirmYourChoice"))) + ."'".')) return false;', + ] + ); + $active = Display::return_icon('accept.png', null, [], ICON_SIZE_TINY); + if (intval($row['activate']) != 1) { + $active = Display::return_icon('error.png', null, [], ICON_SIZE_TINY); + } + + $list[] = [ + 'id' => $row['id'], + 'meet_name' => $row['meet_name'], + 'meet_url' => $row['meet_url'], + 'meet_description' => $row['meet_description'], + 'meet_color' => $row['meet_color'], + 'type_meet' => $row['type_meet'], + 'c_id' => $row['c_id'], + 'start_time' => $row['start_time'], + 'end_time' => $row['end_time'], + 'session_id' => $row['session_id'], + 'activate' => $active, + 'actions' => $action, + ]; + } + } + + return $list; + } + + public function getMeet($idMeet) + { + if (empty($idMeet)) { + return false; + } + $meet = []; + $tableMeetList = Database::get_main_table(self::TABLE_MEET_LIST); + $idMeet = (int) $idMeet; + $sql = "SELECT * FROM $tableMeetList WHERE id = $idMeet"; + + $result = Database::query($sql); + if (Database::num_rows($result) > 0) { + while ($row = Database::fetch_array($result)) { + $meet = [ + 'id' => $row['id'], + 'meet_name' => $row['meet_name'], + 'meet_url' => $row['meet_url'], + 'meet_description' => $row['meet_description'], + 'meet_color' => $row['meet_color'], + 'type_meet' => $row['type_meet'], + 'c_id' => $row['c_id'], + 'start_time' => $row['start_time'], + 'end_time' => $row['end_time'], + 'session_id' => $row['session_id'], + 'activate' => $row['activate'], + ]; + } + } + + return $meet; + } + + public function updateMeet($values) + { + if (!is_array($values) || empty($values['meet_name'])) { + return false; + } + $table = Database::get_main_table(self::TABLE_MEET_LIST); + + $courseId = api_get_course_int_id(); + $sessionId = api_get_session_id(); + $url = self::filterUrl($values['meet_url']); + if (!isset($values['type_meet'])) { + $values['type_meet'] = 1; + } + + $params = [ + 'meet_name' => $values['meet_name'], + 'meet_url' => $url, + 'type_meet' => $values['type_meet'], + 'meet_description' => $values['meet_description'], + 'meet_color' => $values['meet_color'], + 'c_id' => $courseId, + 'start_time' => null, + 'end_time' => null, + 'session_id' => $sessionId, + 'activate' => 1, + ]; + + Database::update( + $table, + $params, + [ + 'id = ?' => [ + $values['id'], + ], + ] + ); + + return true; + } + + /** + * Delete a given meeting. + * + * @param int $idMeet Chamilo's internal ID of the meeting + * + * @return bool True on success, false on failure + */ + public function deleteMeet($idMeet) + { + if (empty($idMeet)) { + return false; + } + $idMeet = (int) $idMeet; + $tableMeetList = Database::get_main_table(self::TABLE_MEET_LIST); + $sql = "DELETE FROM $tableMeetList WHERE id = $idMeet"; + $result = Database::query($sql); + + if (Database::affected_rows($result) != 1) { + return false; + } + + return true; + } + + /** + * Delete links to the tool from the c_tool table. + */ + private function deleteCourseToolLinks() + { + Database::getManager() + ->createQuery('DELETE FROM ChamiloCourseBundle:CTool t WHERE t.category = :category AND t.link LIKE :link') + ->execute(['category' => 'plugin', 'link' => 'google_meet/start.php%']); + } + + /** + * Do a bit of prevention on the meeting URL format. + * + * @param string $url The URL received from the user + * + * @return string Reformatted URL + */ + private function filterUrl($url) + { + if (!empty($url)) { + if (preg_match('#^'.self::GOOGLE_MEET_URL.'#', $url)) { + // The URL starts with the right Google Meet protocol and domain, do nothing + } elseif (preg_match('#^'.substr(self::GOOGLE_MEET_URL, 8).'#', $url)) { + // The URL starts with meet.google.com without the protocol. Add it + $url = 'https://'.$url; + } else { + // We assume it's just the meeting code. Add the full Google Meet prefix + if (substr($url, 0, 1) === '/') { + // Remove prefixing slash, if any + $url = substr($url, 1); + } + $url = self::GOOGLE_MEET_URL.$url; + } + } + + return $url; + } +} diff --git a/plugin/google_meet/start.php b/plugin/google_meet/start.php new file mode 100644 index 000000000..109b14437 --- /dev/null +++ b/plugin/google_meet/start.php @@ -0,0 +1,44 @@ +'; + +$plugin = GoogleMeetPlugin::create(); + +$tool_name = $plugin->get_lang('plugin_title'); +$tpl = new Template($tool_name); +$message = null; +$userId = api_get_user_id(); + +$courseInfo = api_get_course_info(); +$isTeacher = api_is_teacher(); +$isAdmin = api_is_platform_admin(); +$isStudent = api_is_student(); + +$action = isset($_GET['action']) ? $_GET['action'] : null; +$enable = $plugin->get('google_meet_enabled') == 'true'; + +$urlAddMeet = api_get_path(WEB_PLUGIN_PATH).'google_meet/meets.php?action=add&'.api_get_cidreq(); + +if ($enable) { + if ($isAdmin || $isTeacher || $isStudent) { + $meets = $plugin->listMeets($courseInfo['real_id'], api_get_session_id()); + } +} + +$tpl->assign('url_add_room', $urlAddMeet); +$tpl->assign('meets', $meets); +$tpl->assign('is_admin', $isAdmin); +$tpl->assign('is_student', $isStudent); +$tpl->assign('is_teacher', $isTeacher); +$content = $tpl->fetch('google_meet/view/home.tpl'); +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/google_meet/uninstall.php b/plugin/google_meet/uninstall.php new file mode 100644 index 000000000..1d8196f31 --- /dev/null +++ b/plugin/google_meet/uninstall.php @@ -0,0 +1,4 @@ +uninstall(); diff --git a/plugin/google_meet/view/home.tpl b/plugin/google_meet/view/home.tpl new file mode 100644 index 000000000..4fe2080c6 --- /dev/null +++ b/plugin/google_meet/view/home.tpl @@ -0,0 +1,70 @@ +
    +
    +
    +
    + +
    + {% if is_admin or is_teacher %} + + + {{ 'ManageMeetAccounts'|get_plugin_lang('GoogleMeetPlugin') }} + + {% endif %} +
    + {% if meets %} +
    + {% for meet in meets %} +
    +
    +
    +
    +
    +
    +
    + +
    +
    +

    {{ meet.meet_name }}

    +
    + {{ meet.meet_description }} +
    + + + {{ 'AccessMeeting'|get_plugin_lang('GoogleMeetPlugin') }} + +
    +
    + {% if is_admin or is_teacher %} +
    + + + + + + +
    + {% endif %} +
    + +
    +
    +
    +
    +
    +
    + {% endfor %} +
    + + {% else %} + + {% endif %} +
    +
    +
    +
    \ No newline at end of file diff --git a/plugin/google_meet/view/meets.tpl b/plugin/google_meet/view/meets.tpl new file mode 100644 index 000000000..972b5abf3 --- /dev/null +++ b/plugin/google_meet/view/meets.tpl @@ -0,0 +1,15 @@ +
    +
    +
    +
    + + {% if form_room %} + + {{ form_room }} + + {% endif %} + +
    +
    +
    +
    \ No newline at end of file diff --git a/plugin/grading_electronic/README.md b/plugin/grading_electronic/README.md new file mode 100644 index 000000000..dfeab49cb --- /dev/null +++ b/plugin/grading_electronic/README.md @@ -0,0 +1,16 @@ +# Electronic Grading Form +v0.8 + +Generates a file for a specific grades registration form. +This plugin is more to be viewed as a template for similar exports, as it will +create very specific extra fields and allow you to export very specific reports +with those extra fields. + +* Install the plugin +* Assign the `content_top` region to the plugin +* Enable the tool in the plugin configuration page + +> During the installation this plugin creates three course extra fields +> (`plugin_gradingelectronic_provider_id`, `plugin_gradingelectronic_course_id`, `plugin_gradingelectronic_coursehours`) +> and one user extra field +> (`fcdice_or_acadis_student_id`) diff --git a/plugin/grading_electronic/generate.php b/plugin/grading_electronic/generate.php new file mode 100644 index 000000000..1322ec762 --- /dev/null +++ b/plugin/grading_electronic/generate.php @@ -0,0 +1,184 @@ +get('tool_enable') === 'true'; + + if (!$toolIsEnabled) { + throw new Exception($gradingElectronic->get_lang('PluginDisabled')); + } + + $form = $gradingElectronic->getForm(); + + if (!$form->validate()) { + throw new Exception(implode('
    ', $form->_errors)); + } + + $em = Database::getManager(); + + /** @var Course $course */ + $course = $em->find('ChamiloCoreBundle:Course', api_get_course_int_id()); + /** @var Session $session */ + $session = $em->find('ChamiloCoreBundle:Session', api_get_session_id()); + + $values = $form->exportValues(); + + $cFieldValue = new ExtraFieldValue('course'); + $uFieldValue = new ExtraFieldValue('user'); + + $cFieldValue->save([ + 'variable' => GradingElectronicPlugin::EXTRAFIELD_COURSE_ID, + 'item_id' => $course->getId(), + 'value' => $values['course'], + ]); + + $item = $cFieldValue->get_item_id_from_field_variable_and_field_value( + GradingElectronicPlugin::EXTRAFIELD_COURSE_ID, + $values['course'] + ); + + $fieldProvider = $cFieldValue->get_values_by_handler_and_field_variable( + $course->getId(), + GradingElectronicPlugin::EXTRAFIELD_COURSE_PROVIDER_ID + ); + $fieldHours = $cFieldValue->get_values_by_handler_and_field_variable( + $course->getId(), + GradingElectronicPlugin::EXTRAFIELD_COURSE_HOURS + ); + + $students = []; + + if ($session) { + $criteria = Criteria::create()->where( + Criteria::expr()->eq('relationType', Session::STUDENT) + ); + + $subscriptions = $session->getUsers()->matching($criteria); + + /** @var SessionRelUser $subscription */ + foreach ($subscriptions as $subscription) { + $students[] = $subscription->getUser(); + } + } else { + $subscriptions = $course->getStudents(); + + /** @var CourseRelUser $subscription */ + foreach ($subscriptions as $subscription) { + $students[] = $subscription->getUser(); + } + } + + $cats = Category::load( + null, + null, + $course->getCode(), + null, + null, + $session ? $session->getId() : 0, + 'ORDER By id' + ); + + /** @var \Category $gradebook */ + $gradebook = $cats[0]; + /** @var \ExerciseLink $exerciseLink */ + /** commented until we get clear understanding of how to use the dates refs BT#12404. + $exerciseInfo = ExerciseLib::get_exercise_by_id($exerciseId, $course->getId()); + */ + $dateStart = new DateTime($values['range_start'].' 00:00:00', new DateTimeZone('UTC')); + $dateEnd = new DateTime($values['range_end'].' 23:59:59', new DateTimeZone('UTC')); + + $fileData = []; + $fileData[] = sprintf( + '1 %s %s%s', + $fieldProvider ? $fieldProvider['value'] : null, + $values['course'], + $dateStart->format('m/d/Y') + ); + + /** @var User $student */ + foreach ($students as $student) { + $userFinishedCourse = Category::userFinishedCourse( + $student->getId(), + $gradebook, + true + ); + if (!$userFinishedCourse) { + continue; + } + /** commented until we get clear understanding of how to use the dates refs BT#12404. + } + */ + $fieldStudent = $uFieldValue->get_values_by_handler_and_field_variable( + $student->getId(), + GradingElectronicPlugin::EXTRAFIELD_STUDENT_ID + ); + $scoretotal = $gradebook->calc_score($student->getId()); + $scoredisplay = ScoreDisplay::instance(); + $score = $scoredisplay->display_score( + $scoretotal, + SCORE_SIMPLE + ); + + /** old method to get the score. + ); + */ + $fileData[] = sprintf( + "2 %sPASS%s %s %s", + $fieldStudent ? $fieldStudent['value'] : null, + $fieldHours ? $fieldHours['value'] : null, + $score, + $dateEnd->format('m/d/Y') + ); + + if (!$gradebook->getGenerateCertificates()) { + continue; + } + + Category::generateUserCertificate( + $gradebook->get_id(), + $student->getId(), + true + ); + } + + $fileName = implode('_', [ + $gradingElectronic->get_title(), + $values['course'], + $values['range_start'], + $values['range_end'], + ]); + $fileName = api_replace_dangerous_char($fileName).'.txt'; + $fileData[] = null; + + file_put_contents( + api_get_path(SYS_ARCHIVE_PATH).$fileName, + implode("\r\n", $fileData) + ); + + echo Display::toolbarButton( + get_lang('Download'), + api_get_path(WEB_ARCHIVE_PATH).$fileName, + 'download', + 'success', + ['target' => '_blank', 'download' => $fileName] + ); +} catch (Exception $e) { + echo Display::return_message($e->getMessage(), 'error'); +} diff --git a/plugin/grading_electronic/index.php b/plugin/grading_electronic/index.php new file mode 100644 index 000000000..882d869df --- /dev/null +++ b/plugin/grading_electronic/index.php @@ -0,0 +1,16 @@ +isAllowed()) { + return; +} + +$_template['show'] = true; +$_template['plugin_title'] = $gradingElectronic->get_title(); +$_template['form'] = $gradingElectronic->getForm(); diff --git a/plugin/grading_electronic/install.php b/plugin/grading_electronic/install.php new file mode 100644 index 000000000..d9f5dcfd3 --- /dev/null +++ b/plugin/grading_electronic/install.php @@ -0,0 +1,4 @@ +install(); diff --git a/plugin/grading_electronic/lang/english.php b/plugin/grading_electronic/lang/english.php new file mode 100644 index 000000000..df170755b --- /dev/null +++ b/plugin/grading_electronic/lang/english.php @@ -0,0 +1,16 @@ +Generate File button in the Assessments page. + You need assign the content_top region. +'; + +$strings['PluginDisabled'] = 'Electronic grading is disabed'; +$strings['StudentId'] = 'Student ID'; +$strings['ProviderId'] = 'Provider ID'; +$strings['CourseHours'] = 'Course hours'; diff --git a/plugin/grading_electronic/plugin.php b/plugin/grading_electronic/plugin.php new file mode 100644 index 000000000..c707eef20 --- /dev/null +++ b/plugin/grading_electronic/plugin.php @@ -0,0 +1,5 @@ +get_info(); +$plugin_info['templates'] = ['view/grading.html.twig']; diff --git a/plugin/grading_electronic/src/GradingElectronicPlugin.php b/plugin/grading_electronic/src/GradingElectronicPlugin.php new file mode 100644 index 000000000..5412d74c0 --- /dev/null +++ b/plugin/grading_electronic/src/GradingElectronicPlugin.php @@ -0,0 +1,221 @@ + 'boolean', + ] + ); + } + + /** + * @return \GradingElectronicPlugin|null + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * {@inheritdoc} + */ + public function get_name() + { + return 'grading_electronic'; + } + + /** + * Actions for install. + */ + public function install() + { + $this->setUpExtraFields(); + } + + /** + * Actions for uninstall. + */ + public function uninstall() + { + $this->setDownExtraFields(); + } + + /** + * @return \FormValidator|void + */ + public function getForm() + { + $extraField = new ExtraField('course'); + $courseIdField = $extraField->get_handler_field_info_by_field_variable( + self::EXTRAFIELD_COURSE_ID + ); + + if (!$courseIdField) { + return null; + } + + $extraFieldValue = new ExtraFieldValue('course'); + $courseIdValue = $extraFieldValue->get_values_by_handler_and_field_variable( + api_get_course_int_id(), + self::EXTRAFIELD_COURSE_ID + ); + + $form = new FormValidator('frm_grading_electronic'); + $form->addDateRangePicker( + 'range', + get_lang('DateRange'), + true, + [ + 'id' => 'range', + 'format' => 'YYYY-MM-DD', + 'timePicker' => 'false', + 'validate_format' => 'Y-m-d', + ] + ); + $form->addText('course', $this->get_lang('CourseId')); + $form->addButtonDownload(get_lang('Generate')); + $form->addRule('course', get_lang('ThisFieldIsRequired'), 'required'); + $form->setDefaults([ + 'course' => $courseIdValue ? $courseIdValue['value'] : null, + ]); + + return $form; + } + + /** + * Check if the current use is allowed to see the button. + * + * @return bool + */ + public function isAllowed() + { + $allowed = api_is_teacher() || api_is_platform_admin() || api_is_course_tutor(); + + if (!$allowed) { + return false; + } + + $toolIsEnabled = $this->get('tool_enable') === 'true'; + + if (!$toolIsEnabled) { + return false; + } + + return true; + } + + /** + * Create extra fields for this plugin. + */ + private function setUpExtraFields() + { + $uExtraField = new ExtraField('user'); + + if (!$uExtraField->get_handler_field_info_by_field_variable( + self::EXTRAFIELD_STUDENT_ID + )) { + $uExtraField->save([ + 'variable' => self::EXTRAFIELD_STUDENT_ID, + 'field_type' => ExtraField::FIELD_TYPE_TEXT, + 'display_text' => $this->get_lang('StudentId'), + 'visible_to_self' => true, + 'changeable' => true, + ]); + } + + $cExtraField = new ExtraField('course'); + + if (!$cExtraField->get_handler_field_info_by_field_variable( + self::EXTRAFIELD_COURSE_PROVIDER_ID + )) { + $cExtraField->save([ + 'variable' => self::EXTRAFIELD_COURSE_PROVIDER_ID, + 'field_type' => ExtraField::FIELD_TYPE_TEXT, + 'display_text' => $this->get_lang('ProviderId'), + 'visible_to_self' => true, + 'changeable' => true, + ]); + } + + if (!$cExtraField->get_handler_field_info_by_field_variable( + self::EXTRAFIELD_COURSE_ID + )) { + $cExtraField->save([ + 'variable' => self::EXTRAFIELD_COURSE_ID, + 'field_type' => ExtraField::FIELD_TYPE_TEXT, + 'display_text' => $this->get_lang('CourseId'), + 'visible_to_self' => true, + 'changeable' => true, + ]); + } + + if (!$cExtraField->get_handler_field_info_by_field_variable( + self::EXTRAFIELD_COURSE_HOURS + )) { + $cExtraField->save([ + 'variable' => self::EXTRAFIELD_COURSE_HOURS, + 'field_type' => ExtraField::FIELD_TYPE_TEXT, + 'display_text' => $this->get_lang('CourseHours'), + 'visible_to_self' => true, + 'changeable' => true, + ]); + } + } + + /** + * Remove extra fields for this plugin. + */ + private function setDownExtraFields() + { + $uExtraField = new ExtraField('user'); + $studentIdField = $uExtraField->get_handler_field_info_by_field_variable( + self::EXTRAFIELD_STUDENT_ID + ); + + if ($studentIdField) { + $uExtraField->delete($studentIdField['id']); + } + + $cExtraField = new ExtraField('course'); + $providerIdField = $cExtraField->get_handler_field_info_by_field_variable( + self::EXTRAFIELD_COURSE_PROVIDER_ID + ); + $courseIdField = $cExtraField->get_handler_field_info_by_field_variable( + self::EXTRAFIELD_COURSE_ID + ); + $courseHoursField = $cExtraField->get_handler_field_info_by_field_variable( + self::EXTRAFIELD_COURSE_HOURS + ); + + if ($providerIdField) { + $cExtraField->delete($providerIdField['id']); + } + + if ($courseIdField) { + $cExtraField->delete($courseIdField['id']); + } + + if ($courseHoursField) { + $cExtraField->delete($courseHoursField['id']); + } + } +} diff --git a/plugin/grading_electronic/uninstall.php b/plugin/grading_electronic/uninstall.php new file mode 100644 index 000000000..5f8498a7a --- /dev/null +++ b/plugin/grading_electronic/uninstall.php @@ -0,0 +1,4 @@ +uninstall(); diff --git a/plugin/grading_electronic/view/grading.html.twig b/plugin/grading_electronic/view/grading.html.twig new file mode 100644 index 000000000..c2cb99134 --- /dev/null +++ b/plugin/grading_electronic/view/grading.html.twig @@ -0,0 +1,40 @@ +{% if grading_electronic.show %} + + + + +{% endif %} diff --git a/plugin/h5p/README.md b/plugin/h5p/README.md new file mode 100644 index 000000000..5cbe13248 --- /dev/null +++ b/plugin/h5p/README.md @@ -0,0 +1,36 @@ +H5P plugin +=== + +This plugin is only compatible with Chamilo version 1.11.10 and above. + +This plugin allows you to create H5P resources directly from inside Chamilo, +using the Open Source H5P library. + +To enable: + +* install the plugin +* mark it as "enabled" (inside the plugin configuration page) +* set the plugin to the region "pre_footer" +* change permissions on disk for the plugin/h5p/cache-h5p/launch folder to be writeable by the web server + +Once enabled, permissions granted for the web server to write in plugin/h5p/cache-h5p/launch/ +and the pre_footer region set for the plugin, a new H5P logo will appear in the +new document creation form (the WYSIWIG editor), as a small icon at the end of +the editor interface, exclusively in the learning path document creation +interface (don't look for it anywhere else at this point). + +However, it is still very limited at this stage: the H5P files are created in a +common directory for all teachers. This means all teachers can re-use contents of +others (which is good) but also that all teachers can remove contents of others +(which is bad). + +We hope to be improving this in the future, but we will not be able, in future +versions, to assign content created in this version to the correct teacher. + +We suggest you consider this plugin as a Beta version. + +To enable tools in the document editor, please enable it in region pre_footer. + +Other docs: + +https://www.ludiscape.com/ressources/resources-elearning-en/integration-of-h5p-into-our-lms-chamilo/ \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/.eslintrc.json b/plugin/h5p/cache-h5p/.eslintrc.json new file mode 100644 index 000000000..bdd5594ba --- /dev/null +++ b/plugin/h5p/cache-h5p/.eslintrc.json @@ -0,0 +1,24 @@ +{ + "env": { + "browser": true, + "commonjs": true, + "es6": true, + "node": true + }, + "parserOptions": { + "ecmaVersion": 2017, + "sourceType": "module" + }, + "rules": { + "no-const-assign": "warn", + "no-this-before-super": "warn", + "no-undef": "warn", + "no-unreachable": "warn", + "no-unused-vars": "warn", + "constructor-super": "warn", + "valid-typeof": "warn" + }, + "globals": { + "H5PIntegration": true + } +} \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/.github/workflows/cypress.yml b/plugin/h5p/cache-h5p/.github/workflows/cypress.yml new file mode 100644 index 000000000..953e9727f --- /dev/null +++ b/plugin/h5p/cache-h5p/.github/workflows/cypress.yml @@ -0,0 +1,16 @@ +name: Node CI + +on: [push] + +jobs: + build: + + runs-on: ubuntu-latest + + strategy: + matrix: + node-version: [8.x, 10.x, 12.x] + + steps: + - name: Cypress.io + uses: cypress-io/github-action@v1.16.1 diff --git a/plugin/h5p/cache-h5p/.gitignore b/plugin/h5p/cache-h5p/.gitignore new file mode 100644 index 000000000..e7c660a94 --- /dev/null +++ b/plugin/h5p/cache-h5p/.gitignore @@ -0,0 +1,3 @@ +node_modules +.DS_Store +cypress/videos \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/CHANGELOG.md b/plugin/h5p/cache-h5p/CHANGELOG.md new file mode 100644 index 000000000..24e812850 --- /dev/null +++ b/plugin/h5p/cache-h5p/CHANGELOG.md @@ -0,0 +1,17 @@ +# 2.1.0 +* Add optional libraryPath option for serving libraries from another source, thanks @tdxdave + +# 2.0.2 +* Check if main library has dependencies before loading them + +# 2.0.1 +* fix paths for h5p assets + +# 2.0.0 +* Switched to Webpack +* Using module system, can be imported via ES6, CommonJS, AMD or Globals +* Hide H5P frame by default +* Move away from being a jQuery plugin +* Include H5P JS files directly in this project +* Remove bower +* Add tests \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/LICENSE b/plugin/h5p/cache-h5p/LICENSE new file mode 100644 index 000000000..9621b9de7 --- /dev/null +++ b/plugin/h5p/cache-h5p/LICENSE @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2015 Tunapanda + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/plugin/h5p/cache-h5p/README.md b/plugin/h5p/cache-h5p/README.md new file mode 100644 index 000000000..66909be89 --- /dev/null +++ b/plugin/h5p/cache-h5p/README.md @@ -0,0 +1,85 @@ +# h5p-standalone 2.1.0 +Display H5P content without using a webserver + + +## Install +``` +yarn add h5p-standalone +``` + +## Basic Usage + +```javascript +import { H5P } from 'h5p-standalone'; // ES6 +// const { H5P } = require('h5p-standalone'); AMD +// + + + + +
    + + + + + \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/launch/drag-the-words.html b/plugin/h5p/cache-h5p/launch/drag-the-words.html new file mode 100644 index 000000000..b68de0076 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/drag-the-words.html @@ -0,0 +1,23 @@ + + + + + + + + + +
    + + + + + \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/launch/guesstheanswer.html b/plugin/h5p/cache-h5p/launch/guesstheanswer.html new file mode 100644 index 000000000..5a1674efe --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/guesstheanswer.html @@ -0,0 +1,23 @@ + + + + + + + + + +
    + + + + + \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/launch/memory.html b/plugin/h5p/cache-h5p/launch/memory.html new file mode 100644 index 000000000..0d740cbdc --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/memory.html @@ -0,0 +1,23 @@ + + + + + + + + + +
    + + + + + \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/launch/mots-caches.html b/plugin/h5p/cache-h5p/launch/mots-caches.html new file mode 100644 index 000000000..1e3cdbc8a --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/mots-caches.html @@ -0,0 +1,23 @@ + + + + + + + + + +
    + + + + + \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/launch/multiple.html b/plugin/h5p/cache-h5p/launch/multiple.html new file mode 100644 index 000000000..32db890b2 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/multiple.html @@ -0,0 +1,34 @@ + + + + + + + + + +
    +
    + + + + + \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/Drop-1.0/css/drop-theme-arrows-bounce.min.css b/plugin/h5p/cache-h5p/launch/source-dialogcard/Drop-1.0/css/drop-theme-arrows-bounce.min.css new file mode 100644 index 000000000..c5c80302d --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/Drop-1.0/css/drop-theme-arrows-bounce.min.css @@ -0,0 +1 @@ +.drop-element,.drop-element *,.drop-element :after,.drop-element :before,.drop-element:after,.drop-element:before{box-sizing:border-box}.drop-element{position:absolute;display:none}.drop-element.drop-open{display:block}.drop-element.drop-theme-arrows-bounce .drop-content{border-radius:5px;position:relative;font-family:inherit;background:#fff;color:#444;padding:1em;font-size:1.1em;line-height:1.5em;-webkit-transform:translateZ(0);transform:translateZ(0);-webkit-filter:drop-shadow(0 1px 4px rgba(0, 0, 0, .2));filter:drop-shadow(0 1px 4px rgba(0, 0, 0, .2))}.drop-element.drop-theme-arrows-bounce .drop-content:before{content:"";display:block;position:absolute;width:0;height:0;border-color:transparent;border-width:12px;border-style:solid}.drop-element.drop-theme-arrows-bounce.drop-element-attached-bottom.drop-element-attached-center .drop-content:before{top:100%;left:50%;margin-left:-12px;border-top-color:#fff}.drop-element.drop-theme-arrows-bounce.drop-element-attached-top.drop-element-attached-center .drop-content{margin-top:12px}.drop-element.drop-theme-arrows-bounce.drop-element-attached-top.drop-element-attached-center .drop-content:before{bottom:100%;left:50%;margin-left:-12px;border-bottom-color:#fff}.drop-element.drop-theme-arrows-bounce.drop-element-attached-right.drop-element-attached-middle .drop-content:before{left:100%;top:50%;margin-top:-12px;border-left-color:#fff}.drop-element.drop-theme-arrows-bounce.drop-element-attached-left.drop-element-attached-middle .drop-content:before{right:100%;top:50%;margin-top:-12px;border-right-color:#fff}.drop-element.drop-theme-arrows-bounce.drop-element-attached-top.drop-element-attached-left.drop-target-attached-bottom .drop-content:before{bottom:100%;left:12px;border-bottom-color:#fff}.drop-element.drop-theme-arrows-bounce.drop-element-attached-top.drop-element-attached-right.drop-target-attached-bottom .drop-content:before{bottom:100%;right:12px;border-bottom-color:#fff}.drop-element.drop-theme-arrows-bounce.drop-element-attached-bottom.drop-element-attached-left.drop-target-attached-top .drop-content:before{top:100%;left:12px;border-top-color:#fff}.drop-element.drop-theme-arrows-bounce.drop-element-attached-bottom.drop-element-attached-right.drop-target-attached-top .drop-content:before{top:100%;right:12px;border-top-color:#fff}.drop-element.drop-theme-arrows-bounce.drop-element-attached-top.drop-element-attached-right.drop-target-attached-left .drop-content:before{top:12px;left:100%;border-left-color:#fff}.drop-element.drop-theme-arrows-bounce.drop-element-attached-top.drop-element-attached-left.drop-target-attached-right .drop-content:before{top:12px;right:100%;border-right-color:#fff}.drop-element.drop-theme-arrows-bounce.drop-element-attached-bottom.drop-element-attached-right.drop-target-attached-left .drop-content:before{bottom:12px;left:100%;border-left-color:#fff}.drop-element.drop-theme-arrows-bounce.drop-element-attached-bottom.drop-element-attached-left.drop-target-attached-right .drop-content:before{bottom:12px;right:100%;border-right-color:#fff}.drop-element.drop-theme-arrows-bounce{max-width:100%;max-height:100%;-webkit-transform:translateZ(0);transform:translateZ(0);-webkit-transition:opacity .1s;transition:opacity .1s;opacity:0}.drop-element.drop-theme-arrows-bounce .drop-content{-webkit-transition:-webkit-transform .3s cubic-bezier(0,0,.265,1.55);transition:transform .3s cubic-bezier(0,0,.265,1.55);-webkit-transform:scale(0) translateZ(0);transform:scale(0) translateZ(0)}.drop-element.drop-theme-arrows-bounce.drop-open{display:none}.drop-element.drop-theme-arrows-bounce.drop-open-transitionend{display:block}.drop-element.drop-theme-arrows-bounce.drop-after-open{-webkit-transition:none;transition:none;opacity:1}.drop-element.drop-theme-arrows-bounce.drop-after-open .drop-content{-webkit-transform:scale(1) translateZ(0);transform:scale(1) translateZ(0)}.drop-element.drop-theme-arrows-bounce.drop-element-attached-bottom.drop-element-attached-center .drop-content{margin-bottom:12px;-webkit-transform-origin:50%,calc(100% + 12px);-ms-transform-origin:50%,calc(100% + 12px);transform-origin:50%,calc(100% + 12px)}.drop-element.drop-theme-arrows-bounce.drop-element-attached-top.drop-element-attached-center .drop-content{-webkit-transform-origin:50%,-12px;-ms-transform-origin:50%,-12px;transform-origin:50%,-12px}.drop-element.drop-theme-arrows-bounce.drop-element-attached-right.drop-element-attached-middle .drop-content{margin-right:12px;-webkit-transform-origin:calc(100% + 12px),50%;-ms-transform-origin:calc(100% + 12px),50%;transform-origin:calc(100% + 12px),50%}.drop-element.drop-theme-arrows-bounce.drop-element-attached-left.drop-element-attached-middle .drop-content{margin-left:12px;-webkit-transform-origin:-12px,50%;-ms-transform-origin:-12px,50%;transform-origin:-12px,50%}.drop-element.drop-theme-arrows-bounce.drop-element-attached-top.drop-element-attached-left.drop-target-attached-bottom .drop-content{margin-top:12px;-webkit-transform-origin:0,-12px;-ms-transform-origin:0,-12px;transform-origin:0,-12px}.drop-element.drop-theme-arrows-bounce.drop-element-attached-top.drop-element-attached-right.drop-target-attached-bottom .drop-content{margin-top:12px;-webkit-transform-origin:100%,-12px;-ms-transform-origin:100%,-12px;transform-origin:100%,-12px}.drop-element.drop-theme-arrows-bounce.drop-element-attached-bottom.drop-element-attached-left.drop-target-attached-top .drop-content{margin-bottom:12px;-webkit-transform-origin:0,calc(100% + 12px);-ms-transform-origin:0,calc(100% + 12px);transform-origin:0,calc(100% + 12px)}.drop-element.drop-theme-arrows-bounce.drop-element-attached-bottom.drop-element-attached-right.drop-target-attached-top .drop-content{margin-bottom:12px;-webkit-transform-origin:100%,calc(100% + 12px);-ms-transform-origin:100%,calc(100% + 12px);transform-origin:100%,calc(100% + 12px)}.drop-element.drop-theme-arrows-bounce.drop-element-attached-top.drop-element-attached-right.drop-target-attached-left .drop-content{margin-right:12px;-webkit-transform-origin:calc(100% + 12px),0;-ms-transform-origin:calc(100% + 12px),0;transform-origin:calc(100% + 12px),0}.drop-element.drop-theme-arrows-bounce.drop-element-attached-top.drop-element-attached-left.drop-target-attached-right .drop-content{margin-left:12px;-webkit-transform-origin:-12px,0;-ms-transform-origin:-12px,0;transform-origin:-12px,0}.drop-element.drop-theme-arrows-bounce.drop-element-attached-bottom.drop-element-attached-right.drop-target-attached-left .drop-content{margin-right:12px;-webkit-transform-origin:calc(100% + 12px),100%;-ms-transform-origin:calc(100% + 12px),100%;transform-origin:calc(100% + 12px),100%}.drop-element.drop-theme-arrows-bounce.drop-element-attached-bottom.drop-element-attached-left.drop-target-attached-right .drop-content{margin-left:12px;-webkit-transform-origin:-12px,100%;-ms-transform-origin:-12px,100%;transform-origin:-12px,100%} \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/Drop-1.0/js/drop.min.js b/plugin/h5p/cache-h5p/launch/source-dialogcard/Drop-1.0/js/drop.min.js new file mode 100644 index 000000000..262412d48 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/Drop-1.0/js/drop.min.js @@ -0,0 +1,7 @@ +var oldDrop = window.Drop; +var oldTether = window.Tether; +Tether = H5P.Tether; +!function(t,e){"function"==typeof define&&define.amd?define(["tether"],e):"object"==typeof exports?module.exports=e(require("tether")):t.Drop=e(t.Tether)}(this,function(t){"use strict";function e(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")}function n(t,e){if("function"!=typeof e&&null!==e)throw new TypeError("Super expression must either be null or a function, not "+typeof e);t.prototype=Object.create(e&&e.prototype,{constructor:{value:t,enumerable:!1,writable:!0,configurable:!0}}),e&&(Object.setPrototypeOf?Object.setPrototypeOf(t,e):t.__proto__=e)}function o(t){var e=t.split(" "),n=a(e,2),o=n[0],i=n[1];if(["left","right"].indexOf(o)>=0){var s=[i,o];o=s[0],i=s[1]}return[o,i].join(" ")}function i(t,e){for(var n=void 0,o=[];-1!==(n=t.indexOf(e));)o.push(t.splice(n,1));return o}function s(){var a=arguments.length<=0||void 0===arguments[0]?{}:arguments[0],u=function(){for(var t=arguments.length,e=Array(t),n=0;t>n;n++)e[n]=arguments[n];return new(r.apply(b,[null].concat(e)))};p(u,{createContext:s,drops:[],defaults:{}});var g={classPrefix:"drop",defaults:{position:"bottom left",openOn:"click",beforeClose:null,constrainToScrollParent:!0,constrainToWindow:!0,classes:"",remove:!1,tetherOptions:{}}};p(u,g,a),p(u.defaults,g.defaults,a.defaults),"undefined"==typeof x[u.classPrefix]&&(x[u.classPrefix]=[]),u.updateBodyClasses=function(){for(var t=!1,e=x[u.classPrefix],n=e.length,o=0;n>o;++o)if(e[o].isOpened()){t=!0;break}t?d(document.body,u.classPrefix+"-open"):c(document.body,u.classPrefix+"-open")};var b=function(s){function r(t){if(e(this,r),l(Object.getPrototypeOf(r.prototype),"constructor",this).call(this),this.options=p({},u.defaults,t),this.target=this.options.target,"undefined"==typeof this.target)throw new Error("Drop Error: You must provide a target.");var n="data-"+u.classPrefix,o=this.target.getAttribute(n);o&&(this.options.content=o);for(var i=["position","openOn"],s=0;s=0)for(var n=function(e){t.toggle(e),e.preventDefault()},o=function(e){t.isOpened()&&(e.target===t.drop||t.drop.contains(e.target)||e.target===t.target||t.target.contains(e.target)||t.close(e))},i=0;i=0&&(this._on(this.target,"mouseover",h),this._on(this.drop,"mouseover",h),this._on(this.target,"mouseout",l),this._on(this.drop,"mouseout",l)),e.indexOf("focus")>=0&&(this._on(this.target,"focus",h),this._on(this.drop,"focus",h),this._on(this.target,"blur",l),this._on(this.drop,"blur",l))}}},{key:"isOpened",value:function(){return this.drop?f(this.drop,u.classPrefix+"-open"):void 0}},{key:"toggle",value:function(t){this.isOpened()?this.close(t):this.open(t)}},{key:"open",value:function(t){var e=this;this.isOpened()||(this.drop.parentNode||document.body.appendChild(this.drop),"undefined"!=typeof this.tether&&this.tether.enable(),d(this.drop,u.classPrefix+"-open"),d(this.drop,u.classPrefix+"-open-transitionend"),setTimeout(function(){e.drop&&d(e.drop,u.classPrefix+"-after-open")}),"undefined"!=typeof this.tether&&this.tether.position(),this.trigger("open"),u.updateBodyClasses())}},{key:"_transitionEndHandler",value:function(t){t.target===t.currentTarget&&(f(this.drop,u.classPrefix+"-open")||c(this.drop,u.classPrefix+"-open-transitionend"),this.drop.removeEventListener(m,this.transitionEndHandler))}},{key:"beforeCloseHandler",value:function(t){var e=!0;return this.isClosing||"function"!=typeof this.options.beforeClose||(this.isClosing=!0,e=this.options.beforeClose(t,this)!==!1),this.isClosing=!1,e}},{key:"close",value:function(t){this.isOpened()&&this.beforeCloseHandler(t)&&(c(this.drop,u.classPrefix+"-open"),c(this.drop,u.classPrefix+"-after-open"),this.drop.addEventListener(m,this.transitionEndHandler),this.trigger("close"),"undefined"!=typeof this.tether&&this.tether.disable(),u.updateBodyClasses(),this.options.remove&&this.remove(t))}},{key:"remove",value:function(t){this.close(t),this.drop.parentNode&&this.drop.parentNode.removeChild(this.drop)}},{key:"position",value:function(){this.isOpened()&&"undefined"!=typeof this.tether&&this.tether.position()}},{key:"destroy",value:function(){this.remove(),"undefined"!=typeof this.tether&&this.tether.destroy();for(var t=0;t + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/fontawesome-webfont.ttf b/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/fontawesome-webfont.ttf new file mode 100644 index 000000000..26dea7951 Binary files /dev/null and b/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/fontawesome-webfont.ttf differ diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/fontawesome-webfont.woff b/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/fontawesome-webfont.woff new file mode 100644 index 000000000..dc35ce3c2 Binary files /dev/null and b/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/fontawesome-webfont.woff differ diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/fontawesome-webfont.woff2 b/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/fontawesome-webfont.woff2 new file mode 100644 index 000000000..500e51725 Binary files /dev/null and b/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/fontawesome-webfont.woff2 differ diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/h5p-font-awesome.min.css b/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/h5p-font-awesome.min.css new file mode 100644 index 000000000..e7df42487 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/h5p-font-awesome.min.css @@ -0,0 +1,4 @@ +/*! + * Font Awesome 4.5.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:'H5PFontAwesome4';src:url('fontawesome-webfont.eot?v=4.5.0');src:url('fontawesome-webfont.eot?#iefix&v=4.5.0') format('embedded-opentype'),url('fontawesome-webfont.woff2?v=4.5.0') format('woff2'),url('fontawesome-webfont.woff?v=4.5.0') format('woff'),url('fontawesome-webfont.ttf?v=4.5.0') format('truetype'),url('fontawesome-webfont.svg?v=4.5.0#fontawesomeregular') format('svg');font-weight:normal;font-style:normal}.fa{display:inline-block;font:normal normal normal 14px/1 H5PFontAwesome4;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571429em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14285714em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14285714em;width:2.14285714em;top:.14285714em;text-align:center}.fa-li.fa-lg{left:-1.85714286em}.fa-border{padding:.2em .25em .15em;border:solid .08em #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa.fa-pull-left{margin-right:.3em}.fa.fa-pull-right{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left{margin-right:.3em}.fa.pull-right{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s infinite linear;animation:fa-spin 2s infinite linear}.fa-pulse{-webkit-animation:fa-spin 1s infinite steps(8);animation:fa-spin 1s infinite steps(8)}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}100%{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=1);-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2);-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=3);-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1);-webkit-transform:scale(-1, 1);-ms-transform:scale(-1, 1);transform:scale(-1, 1)}.fa-flip-vertical{filter:progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1);-webkit-transform:scale(1, -1);-ms-transform:scale(1, -1);transform:scale(1, -1)}:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270,:root .fa-flip-horizontal,:root .fa-flip-vertical{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:"\f000"}.fa-music:before{content:"\f001"}.fa-search:before{content:"\f002"}.fa-envelope-o:before{content:"\f003"}.fa-heart:before{content:"\f004"}.fa-star:before{content:"\f005"}.fa-star-o:before{content:"\f006"}.fa-user:before{content:"\f007"}.fa-film:before{content:"\f008"}.fa-th-large:before{content:"\f009"}.fa-th:before{content:"\f00a"}.fa-th-list:before{content:"\f00b"}.fa-check:before{content:"\f00c"}.fa-remove:before,.fa-close:before,.fa-times:before{content:"\f00d"}.fa-search-plus:before{content:"\f00e"}.fa-search-minus:before{content:"\f010"}.fa-power-off:before{content:"\f011"}.fa-signal:before{content:"\f012"}.fa-gear:before,.fa-cog:before{content:"\f013"}.fa-trash-o:before{content:"\f014"}.fa-home:before{content:"\f015"}.fa-file-o:before{content:"\f016"}.fa-clock-o:before{content:"\f017"}.fa-road:before{content:"\f018"}.fa-download:before{content:"\f019"}.fa-arrow-circle-o-down:before{content:"\f01a"}.fa-arrow-circle-o-up:before{content:"\f01b"}.fa-inbox:before{content:"\f01c"}.fa-play-circle-o:before{content:"\f01d"}.fa-rotate-right:before,.fa-repeat:before{content:"\f01e"}.fa-refresh:before{content:"\f021"}.fa-list-alt:before{content:"\f022"}.fa-lock:before{content:"\f023"}.fa-flag:before{content:"\f024"}.fa-headphones:before{content:"\f025"}.fa-volume-off:before{content:"\f026"}.fa-volume-down:before{content:"\f027"}.fa-volume-up:before{content:"\f028"}.fa-qrcode:before{content:"\f029"}.fa-barcode:before{content:"\f02a"}.fa-tag:before{content:"\f02b"}.fa-tags:before{content:"\f02c"}.fa-book:before{content:"\f02d"}.fa-bookmark:before{content:"\f02e"}.fa-print:before{content:"\f02f"}.fa-camera:before{content:"\f030"}.fa-font:before{content:"\f031"}.fa-bold:before{content:"\f032"}.fa-italic:before{content:"\f033"}.fa-text-height:before{content:"\f034"}.fa-text-width:before{content:"\f035"}.fa-align-left:before{content:"\f036"}.fa-align-center:before{content:"\f037"}.fa-align-right:before{content:"\f038"}.fa-align-justify:before{content:"\f039"}.fa-list:before{content:"\f03a"}.fa-dedent:before,.fa-outdent:before{content:"\f03b"}.fa-indent:before{content:"\f03c"}.fa-video-camera:before{content:"\f03d"}.fa-photo:before,.fa-image:before,.fa-picture-o:before{content:"\f03e"}.fa-pencil:before{content:"\f040"}.fa-map-marker:before{content:"\f041"}.fa-adjust:before{content:"\f042"}.fa-tint:before{content:"\f043"}.fa-edit:before,.fa-pencil-square-o:before{content:"\f044"}.fa-share-square-o:before{content:"\f045"}.fa-check-square-o:before{content:"\f046"}.fa-arrows:before{content:"\f047"}.fa-step-backward:before{content:"\f048"}.fa-fast-backward:before{content:"\f049"}.fa-backward:before{content:"\f04a"}.fa-play:before{content:"\f04b"}.fa-pause:before{content:"\f04c"}.fa-stop:before{content:"\f04d"}.fa-forward:before{content:"\f04e"}.fa-fast-forward:before{content:"\f050"}.fa-step-forward:before{content:"\f051"}.fa-eject:before{content:"\f052"}.fa-chevron-left:before{content:"\f053"}.fa-chevron-right:before{content:"\f054"}.fa-plus-circle:before{content:"\f055"}.fa-minus-circle:before{content:"\f056"}.fa-times-circle:before{content:"\f057"}.fa-check-circle:before{content:"\f058"}.fa-question-circle:before{content:"\f059"}.fa-info-circle:before{content:"\f05a"}.fa-crosshairs:before{content:"\f05b"}.fa-times-circle-o:before{content:"\f05c"}.fa-check-circle-o:before{content:"\f05d"}.fa-ban:before{content:"\f05e"}.fa-arrow-left:before{content:"\f060"}.fa-arrow-right:before{content:"\f061"}.fa-arrow-up:before{content:"\f062"}.fa-arrow-down:before{content:"\f063"}.fa-mail-forward:before,.fa-share:before{content:"\f064"}.fa-expand:before{content:"\f065"}.fa-compress:before{content:"\f066"}.fa-plus:before{content:"\f067"}.fa-minus:before{content:"\f068"}.fa-asterisk:before{content:"\f069"}.fa-exclamation-circle:before{content:"\f06a"}.fa-gift:before{content:"\f06b"}.fa-leaf:before{content:"\f06c"}.fa-fire:before{content:"\f06d"}.fa-eye:before{content:"\f06e"}.fa-eye-slash:before{content:"\f070"}.fa-warning:before,.fa-exclamation-triangle:before{content:"\f071"}.fa-plane:before{content:"\f072"}.fa-calendar:before{content:"\f073"}.fa-random:before{content:"\f074"}.fa-comment:before{content:"\f075"}.fa-magnet:before{content:"\f076"}.fa-chevron-up:before{content:"\f077"}.fa-chevron-down:before{content:"\f078"}.fa-retweet:before{content:"\f079"}.fa-shopping-cart:before{content:"\f07a"}.fa-folder:before{content:"\f07b"}.fa-folder-open:before{content:"\f07c"}.fa-arrows-v:before{content:"\f07d"}.fa-arrows-h:before{content:"\f07e"}.fa-bar-chart-o:before,.fa-bar-chart:before{content:"\f080"}.fa-twitter-square:before{content:"\f081"}.fa-facebook-square:before{content:"\f082"}.fa-camera-retro:before{content:"\f083"}.fa-key:before{content:"\f084"}.fa-gears:before,.fa-cogs:before{content:"\f085"}.fa-comments:before{content:"\f086"}.fa-thumbs-o-up:before{content:"\f087"}.fa-thumbs-o-down:before{content:"\f088"}.fa-star-half:before{content:"\f089"}.fa-heart-o:before{content:"\f08a"}.fa-sign-out:before{content:"\f08b"}.fa-linkedin-square:before{content:"\f08c"}.fa-thumb-tack:before{content:"\f08d"}.fa-external-link:before{content:"\f08e"}.fa-sign-in:before{content:"\f090"}.fa-trophy:before{content:"\f091"}.fa-github-square:before{content:"\f092"}.fa-upload:before{content:"\f093"}.fa-lemon-o:before{content:"\f094"}.fa-phone:before{content:"\f095"}.fa-square-o:before{content:"\f096"}.fa-bookmark-o:before{content:"\f097"}.fa-phone-square:before{content:"\f098"}.fa-twitter:before{content:"\f099"}.fa-facebook-f:before,.fa-facebook:before{content:"\f09a"}.fa-github:before{content:"\f09b"}.fa-unlock:before{content:"\f09c"}.fa-credit-card:before{content:"\f09d"}.fa-feed:before,.fa-rss:before{content:"\f09e"}.fa-hdd-o:before{content:"\f0a0"}.fa-bullhorn:before{content:"\f0a1"}.fa-bell:before{content:"\f0f3"}.fa-certificate:before{content:"\f0a3"}.fa-hand-o-right:before{content:"\f0a4"}.fa-hand-o-left:before{content:"\f0a5"}.fa-hand-o-up:before{content:"\f0a6"}.fa-hand-o-down:before{content:"\f0a7"}.fa-arrow-circle-left:before{content:"\f0a8"}.fa-arrow-circle-right:before{content:"\f0a9"}.fa-arrow-circle-up:before{content:"\f0aa"}.fa-arrow-circle-down:before{content:"\f0ab"}.fa-globe:before{content:"\f0ac"}.fa-wrench:before{content:"\f0ad"}.fa-tasks:before{content:"\f0ae"}.fa-filter:before{content:"\f0b0"}.fa-briefcase:before{content:"\f0b1"}.fa-arrows-alt:before{content:"\f0b2"}.fa-group:before,.fa-users:before{content:"\f0c0"}.fa-chain:before,.fa-link:before{content:"\f0c1"}.fa-cloud:before{content:"\f0c2"}.fa-flask:before{content:"\f0c3"}.fa-cut:before,.fa-scissors:before{content:"\f0c4"}.fa-copy:before,.fa-files-o:before{content:"\f0c5"}.fa-paperclip:before{content:"\f0c6"}.fa-save:before,.fa-floppy-o:before{content:"\f0c7"}.fa-square:before{content:"\f0c8"}.fa-navicon:before,.fa-reorder:before,.fa-bars:before{content:"\f0c9"}.fa-list-ul:before{content:"\f0ca"}.fa-list-ol:before{content:"\f0cb"}.fa-strikethrough:before{content:"\f0cc"}.fa-underline:before{content:"\f0cd"}.fa-table:before{content:"\f0ce"}.fa-magic:before{content:"\f0d0"}.fa-truck:before{content:"\f0d1"}.fa-pinterest:before{content:"\f0d2"}.fa-pinterest-square:before{content:"\f0d3"}.fa-google-plus-square:before{content:"\f0d4"}.fa-google-plus:before{content:"\f0d5"}.fa-money:before{content:"\f0d6"}.fa-caret-down:before{content:"\f0d7"}.fa-caret-up:before{content:"\f0d8"}.fa-caret-left:before{content:"\f0d9"}.fa-caret-right:before{content:"\f0da"}.fa-columns:before{content:"\f0db"}.fa-unsorted:before,.fa-sort:before{content:"\f0dc"}.fa-sort-down:before,.fa-sort-desc:before{content:"\f0dd"}.fa-sort-up:before,.fa-sort-asc:before{content:"\f0de"}.fa-envelope:before{content:"\f0e0"}.fa-linkedin:before{content:"\f0e1"}.fa-rotate-left:before,.fa-undo:before{content:"\f0e2"}.fa-legal:before,.fa-gavel:before{content:"\f0e3"}.fa-dashboard:before,.fa-tachometer:before{content:"\f0e4"}.fa-comment-o:before{content:"\f0e5"}.fa-comments-o:before{content:"\f0e6"}.fa-flash:before,.fa-bolt:before{content:"\f0e7"}.fa-sitemap:before{content:"\f0e8"}.fa-umbrella:before{content:"\f0e9"}.fa-paste:before,.fa-clipboard:before{content:"\f0ea"}.fa-lightbulb-o:before{content:"\f0eb"}.fa-exchange:before{content:"\f0ec"}.fa-cloud-download:before{content:"\f0ed"}.fa-cloud-upload:before{content:"\f0ee"}.fa-user-md:before{content:"\f0f0"}.fa-stethoscope:before{content:"\f0f1"}.fa-suitcase:before{content:"\f0f2"}.fa-bell-o:before{content:"\f0a2"}.fa-coffee:before{content:"\f0f4"}.fa-cutlery:before{content:"\f0f5"}.fa-file-text-o:before{content:"\f0f6"}.fa-building-o:before{content:"\f0f7"}.fa-hospital-o:before{content:"\f0f8"}.fa-ambulance:before{content:"\f0f9"}.fa-medkit:before{content:"\f0fa"}.fa-fighter-jet:before{content:"\f0fb"}.fa-beer:before{content:"\f0fc"}.fa-h-square:before{content:"\f0fd"}.fa-plus-square:before{content:"\f0fe"}.fa-angle-double-left:before{content:"\f100"}.fa-angle-double-right:before{content:"\f101"}.fa-angle-double-up:before{content:"\f102"}.fa-angle-double-down:before{content:"\f103"}.fa-angle-left:before{content:"\f104"}.fa-angle-right:before{content:"\f105"}.fa-angle-up:before{content:"\f106"}.fa-angle-down:before{content:"\f107"}.fa-desktop:before{content:"\f108"}.fa-laptop:before{content:"\f109"}.fa-tablet:before{content:"\f10a"}.fa-mobile-phone:before,.fa-mobile:before{content:"\f10b"}.fa-circle-o:before{content:"\f10c"}.fa-quote-left:before{content:"\f10d"}.fa-quote-right:before{content:"\f10e"}.fa-spinner:before{content:"\f110"}.fa-circle:before{content:"\f111"}.fa-mail-reply:before,.fa-reply:before{content:"\f112"}.fa-github-alt:before{content:"\f113"}.fa-folder-o:before{content:"\f114"}.fa-folder-open-o:before{content:"\f115"}.fa-smile-o:before{content:"\f118"}.fa-frown-o:before{content:"\f119"}.fa-meh-o:before{content:"\f11a"}.fa-gamepad:before{content:"\f11b"}.fa-keyboard-o:before{content:"\f11c"}.fa-flag-o:before{content:"\f11d"}.fa-flag-checkered:before{content:"\f11e"}.fa-terminal:before{content:"\f120"}.fa-code:before{content:"\f121"}.fa-mail-reply-all:before,.fa-reply-all:before{content:"\f122"}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:"\f123"}.fa-location-arrow:before{content:"\f124"}.fa-crop:before{content:"\f125"}.fa-code-fork:before{content:"\f126"}.fa-unlink:before,.fa-chain-broken:before{content:"\f127"}.fa-question:before{content:"\f128"}.fa-info:before{content:"\f129"}.fa-exclamation:before{content:"\f12a"}.fa-superscript:before{content:"\f12b"}.fa-subscript:before{content:"\f12c"}.fa-eraser:before{content:"\f12d"}.fa-puzzle-piece:before{content:"\f12e"}.fa-microphone:before{content:"\f130"}.fa-microphone-slash:before{content:"\f131"}.fa-shield:before{content:"\f132"}.fa-calendar-o:before{content:"\f133"}.fa-fire-extinguisher:before{content:"\f134"}.fa-rocket:before{content:"\f135"}.fa-maxcdn:before{content:"\f136"}.fa-chevron-circle-left:before{content:"\f137"}.fa-chevron-circle-right:before{content:"\f138"}.fa-chevron-circle-up:before{content:"\f139"}.fa-chevron-circle-down:before{content:"\f13a"}.fa-html5:before{content:"\f13b"}.fa-css3:before{content:"\f13c"}.fa-anchor:before{content:"\f13d"}.fa-unlock-alt:before{content:"\f13e"}.fa-bullseye:before{content:"\f140"}.fa-ellipsis-h:before{content:"\f141"}.fa-ellipsis-v:before{content:"\f142"}.fa-rss-square:before{content:"\f143"}.fa-play-circle:before{content:"\f144"}.fa-ticket:before{content:"\f145"}.fa-minus-square:before{content:"\f146"}.fa-minus-square-o:before{content:"\f147"}.fa-level-up:before{content:"\f148"}.fa-level-down:before{content:"\f149"}.fa-check-square:before{content:"\f14a"}.fa-pencil-square:before{content:"\f14b"}.fa-external-link-square:before{content:"\f14c"}.fa-share-square:before{content:"\f14d"}.fa-compass:before{content:"\f14e"}.fa-toggle-down:before,.fa-caret-square-o-down:before{content:"\f150"}.fa-toggle-up:before,.fa-caret-square-o-up:before{content:"\f151"}.fa-toggle-right:before,.fa-caret-square-o-right:before{content:"\f152"}.fa-euro:before,.fa-eur:before{content:"\f153"}.fa-gbp:before{content:"\f154"}.fa-dollar:before,.fa-usd:before{content:"\f155"}.fa-rupee:before,.fa-inr:before{content:"\f156"}.fa-cny:before,.fa-rmb:before,.fa-yen:before,.fa-jpy:before{content:"\f157"}.fa-ruble:before,.fa-rouble:before,.fa-rub:before{content:"\f158"}.fa-won:before,.fa-krw:before{content:"\f159"}.fa-bitcoin:before,.fa-btc:before{content:"\f15a"}.fa-file:before{content:"\f15b"}.fa-file-text:before{content:"\f15c"}.fa-sort-alpha-asc:before{content:"\f15d"}.fa-sort-alpha-desc:before{content:"\f15e"}.fa-sort-amount-asc:before{content:"\f160"}.fa-sort-amount-desc:before{content:"\f161"}.fa-sort-numeric-asc:before{content:"\f162"}.fa-sort-numeric-desc:before{content:"\f163"}.fa-thumbs-up:before{content:"\f164"}.fa-thumbs-down:before{content:"\f165"}.fa-youtube-square:before{content:"\f166"}.fa-youtube:before{content:"\f167"}.fa-xing:before{content:"\f168"}.fa-xing-square:before{content:"\f169"}.fa-youtube-play:before{content:"\f16a"}.fa-dropbox:before{content:"\f16b"}.fa-stack-overflow:before{content:"\f16c"}.fa-instagram:before{content:"\f16d"}.fa-flickr:before{content:"\f16e"}.fa-adn:before{content:"\f170"}.fa-bitbucket:before{content:"\f171"}.fa-bitbucket-square:before{content:"\f172"}.fa-tumblr:before{content:"\f173"}.fa-tumblr-square:before{content:"\f174"}.fa-long-arrow-down:before{content:"\f175"}.fa-long-arrow-up:before{content:"\f176"}.fa-long-arrow-left:before{content:"\f177"}.fa-long-arrow-right:before{content:"\f178"}.fa-apple:before{content:"\f179"}.fa-windows:before{content:"\f17a"}.fa-android:before{content:"\f17b"}.fa-linux:before{content:"\f17c"}.fa-dribbble:before{content:"\f17d"}.fa-skype:before{content:"\f17e"}.fa-foursquare:before{content:"\f180"}.fa-trello:before{content:"\f181"}.fa-female:before{content:"\f182"}.fa-male:before{content:"\f183"}.fa-gittip:before,.fa-gratipay:before{content:"\f184"}.fa-sun-o:before{content:"\f185"}.fa-moon-o:before{content:"\f186"}.fa-archive:before{content:"\f187"}.fa-bug:before{content:"\f188"}.fa-vk:before{content:"\f189"}.fa-weibo:before{content:"\f18a"}.fa-renren:before{content:"\f18b"}.fa-pagelines:before{content:"\f18c"}.fa-stack-exchange:before{content:"\f18d"}.fa-arrow-circle-o-right:before{content:"\f18e"}.fa-arrow-circle-o-left:before{content:"\f190"}.fa-toggle-left:before,.fa-caret-square-o-left:before{content:"\f191"}.fa-dot-circle-o:before{content:"\f192"}.fa-wheelchair:before{content:"\f193"}.fa-vimeo-square:before{content:"\f194"}.fa-turkish-lira:before,.fa-try:before{content:"\f195"}.fa-plus-square-o:before{content:"\f196"}.fa-space-shuttle:before{content:"\f197"}.fa-slack:before{content:"\f198"}.fa-envelope-square:before{content:"\f199"}.fa-wordpress:before{content:"\f19a"}.fa-openid:before{content:"\f19b"}.fa-institution:before,.fa-bank:before,.fa-university:before{content:"\f19c"}.fa-mortar-board:before,.fa-graduation-cap:before{content:"\f19d"}.fa-yahoo:before{content:"\f19e"}.fa-google:before{content:"\f1a0"}.fa-reddit:before{content:"\f1a1"}.fa-reddit-square:before{content:"\f1a2"}.fa-stumbleupon-circle:before{content:"\f1a3"}.fa-stumbleupon:before{content:"\f1a4"}.fa-delicious:before{content:"\f1a5"}.fa-digg:before{content:"\f1a6"}.fa-pied-piper:before{content:"\f1a7"}.fa-pied-piper-alt:before{content:"\f1a8"}.fa-drupal:before{content:"\f1a9"}.fa-joomla:before{content:"\f1aa"}.fa-language:before{content:"\f1ab"}.fa-fax:before{content:"\f1ac"}.fa-building:before{content:"\f1ad"}.fa-child:before{content:"\f1ae"}.fa-paw:before{content:"\f1b0"}.fa-spoon:before{content:"\f1b1"}.fa-cube:before{content:"\f1b2"}.fa-cubes:before{content:"\f1b3"}.fa-behance:before{content:"\f1b4"}.fa-behance-square:before{content:"\f1b5"}.fa-steam:before{content:"\f1b6"}.fa-steam-square:before{content:"\f1b7"}.fa-recycle:before{content:"\f1b8"}.fa-automobile:before,.fa-car:before{content:"\f1b9"}.fa-cab:before,.fa-taxi:before{content:"\f1ba"}.fa-tree:before{content:"\f1bb"}.fa-spotify:before{content:"\f1bc"}.fa-deviantart:before{content:"\f1bd"}.fa-soundcloud:before{content:"\f1be"}.fa-database:before{content:"\f1c0"}.fa-file-pdf-o:before{content:"\f1c1"}.fa-file-word-o:before{content:"\f1c2"}.fa-file-excel-o:before{content:"\f1c3"}.fa-file-powerpoint-o:before{content:"\f1c4"}.fa-file-photo-o:before,.fa-file-picture-o:before,.fa-file-image-o:before{content:"\f1c5"}.fa-file-zip-o:before,.fa-file-archive-o:before{content:"\f1c6"}.fa-file-sound-o:before,.fa-file-audio-o:before{content:"\f1c7"}.fa-file-movie-o:before,.fa-file-video-o:before{content:"\f1c8"}.fa-file-code-o:before{content:"\f1c9"}.fa-vine:before{content:"\f1ca"}.fa-codepen:before{content:"\f1cb"}.fa-jsfiddle:before{content:"\f1cc"}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-saver:before,.fa-support:before,.fa-life-ring:before{content:"\f1cd"}.fa-circle-o-notch:before{content:"\f1ce"}.fa-ra:before,.fa-rebel:before{content:"\f1d0"}.fa-ge:before,.fa-empire:before{content:"\f1d1"}.fa-git-square:before{content:"\f1d2"}.fa-git:before{content:"\f1d3"}.fa-y-combinator-square:before,.fa-yc-square:before,.fa-hacker-news:before{content:"\f1d4"}.fa-tencent-weibo:before{content:"\f1d5"}.fa-qq:before{content:"\f1d6"}.fa-wechat:before,.fa-weixin:before{content:"\f1d7"}.fa-send:before,.fa-paper-plane:before{content:"\f1d8"}.fa-send-o:before,.fa-paper-plane-o:before{content:"\f1d9"}.fa-history:before{content:"\f1da"}.fa-circle-thin:before{content:"\f1db"}.fa-header:before{content:"\f1dc"}.fa-paragraph:before{content:"\f1dd"}.fa-sliders:before{content:"\f1de"}.fa-share-alt:before{content:"\f1e0"}.fa-share-alt-square:before{content:"\f1e1"}.fa-bomb:before{content:"\f1e2"}.fa-soccer-ball-o:before,.fa-futbol-o:before{content:"\f1e3"}.fa-tty:before{content:"\f1e4"}.fa-binoculars:before{content:"\f1e5"}.fa-plug:before{content:"\f1e6"}.fa-slideshare:before{content:"\f1e7"}.fa-twitch:before{content:"\f1e8"}.fa-yelp:before{content:"\f1e9"}.fa-newspaper-o:before{content:"\f1ea"}.fa-wifi:before{content:"\f1eb"}.fa-calculator:before{content:"\f1ec"}.fa-paypal:before{content:"\f1ed"}.fa-google-wallet:before{content:"\f1ee"}.fa-cc-visa:before{content:"\f1f0"}.fa-cc-mastercard:before{content:"\f1f1"}.fa-cc-discover:before{content:"\f1f2"}.fa-cc-amex:before{content:"\f1f3"}.fa-cc-paypal:before{content:"\f1f4"}.fa-cc-stripe:before{content:"\f1f5"}.fa-bell-slash:before{content:"\f1f6"}.fa-bell-slash-o:before{content:"\f1f7"}.fa-trash:before{content:"\f1f8"}.fa-copyright:before{content:"\f1f9"}.fa-at:before{content:"\f1fa"}.fa-eyedropper:before{content:"\f1fb"}.fa-paint-brush:before{content:"\f1fc"}.fa-birthday-cake:before{content:"\f1fd"}.fa-area-chart:before{content:"\f1fe"}.fa-pie-chart:before{content:"\f200"}.fa-line-chart:before{content:"\f201"}.fa-lastfm:before{content:"\f202"}.fa-lastfm-square:before{content:"\f203"}.fa-toggle-off:before{content:"\f204"}.fa-toggle-on:before{content:"\f205"}.fa-bicycle:before{content:"\f206"}.fa-bus:before{content:"\f207"}.fa-ioxhost:before{content:"\f208"}.fa-angellist:before{content:"\f209"}.fa-cc:before{content:"\f20a"}.fa-shekel:before,.fa-sheqel:before,.fa-ils:before{content:"\f20b"}.fa-meanpath:before{content:"\f20c"}.fa-buysellads:before{content:"\f20d"}.fa-connectdevelop:before{content:"\f20e"}.fa-dashcube:before{content:"\f210"}.fa-forumbee:before{content:"\f211"}.fa-leanpub:before{content:"\f212"}.fa-sellsy:before{content:"\f213"}.fa-shirtsinbulk:before{content:"\f214"}.fa-simplybuilt:before{content:"\f215"}.fa-skyatlas:before{content:"\f216"}.fa-cart-plus:before{content:"\f217"}.fa-cart-arrow-down:before{content:"\f218"}.fa-diamond:before{content:"\f219"}.fa-ship:before{content:"\f21a"}.fa-user-secret:before{content:"\f21b"}.fa-motorcycle:before{content:"\f21c"}.fa-street-view:before{content:"\f21d"}.fa-heartbeat:before{content:"\f21e"}.fa-venus:before{content:"\f221"}.fa-mars:before{content:"\f222"}.fa-mercury:before{content:"\f223"}.fa-intersex:before,.fa-transgender:before{content:"\f224"}.fa-transgender-alt:before{content:"\f225"}.fa-venus-double:before{content:"\f226"}.fa-mars-double:before{content:"\f227"}.fa-venus-mars:before{content:"\f228"}.fa-mars-stroke:before{content:"\f229"}.fa-mars-stroke-v:before{content:"\f22a"}.fa-mars-stroke-h:before{content:"\f22b"}.fa-neuter:before{content:"\f22c"}.fa-genderless:before{content:"\f22d"}.fa-facebook-official:before{content:"\f230"}.fa-pinterest-p:before{content:"\f231"}.fa-whatsapp:before{content:"\f232"}.fa-server:before{content:"\f233"}.fa-user-plus:before{content:"\f234"}.fa-user-times:before{content:"\f235"}.fa-hotel:before,.fa-bed:before{content:"\f236"}.fa-viacoin:before{content:"\f237"}.fa-train:before{content:"\f238"}.fa-subway:before{content:"\f239"}.fa-medium:before{content:"\f23a"}.fa-yc:before,.fa-y-combinator:before{content:"\f23b"}.fa-optin-monster:before{content:"\f23c"}.fa-opencart:before{content:"\f23d"}.fa-expeditedssl:before{content:"\f23e"}.fa-battery-4:before,.fa-battery-full:before{content:"\f240"}.fa-battery-3:before,.fa-battery-three-quarters:before{content:"\f241"}.fa-battery-2:before,.fa-battery-half:before{content:"\f242"}.fa-battery-1:before,.fa-battery-quarter:before{content:"\f243"}.fa-battery-0:before,.fa-battery-empty:before{content:"\f244"}.fa-mouse-pointer:before{content:"\f245"}.fa-i-cursor:before{content:"\f246"}.fa-object-group:before{content:"\f247"}.fa-object-ungroup:before{content:"\f248"}.fa-sticky-note:before{content:"\f249"}.fa-sticky-note-o:before{content:"\f24a"}.fa-cc-jcb:before{content:"\f24b"}.fa-cc-diners-club:before{content:"\f24c"}.fa-clone:before{content:"\f24d"}.fa-balance-scale:before{content:"\f24e"}.fa-hourglass-o:before{content:"\f250"}.fa-hourglass-1:before,.fa-hourglass-start:before{content:"\f251"}.fa-hourglass-2:before,.fa-hourglass-half:before{content:"\f252"}.fa-hourglass-3:before,.fa-hourglass-end:before{content:"\f253"}.fa-hourglass:before{content:"\f254"}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:"\f255"}.fa-hand-stop-o:before,.fa-hand-paper-o:before{content:"\f256"}.fa-hand-scissors-o:before{content:"\f257"}.fa-hand-lizard-o:before{content:"\f258"}.fa-hand-spock-o:before{content:"\f259"}.fa-hand-pointer-o:before{content:"\f25a"}.fa-hand-peace-o:before{content:"\f25b"}.fa-trademark:before{content:"\f25c"}.fa-registered:before{content:"\f25d"}.fa-creative-commons:before{content:"\f25e"}.fa-gg:before{content:"\f260"}.fa-gg-circle:before{content:"\f261"}.fa-tripadvisor:before{content:"\f262"}.fa-odnoklassniki:before{content:"\f263"}.fa-odnoklassniki-square:before{content:"\f264"}.fa-get-pocket:before{content:"\f265"}.fa-wikipedia-w:before{content:"\f266"}.fa-safari:before{content:"\f267"}.fa-chrome:before{content:"\f268"}.fa-firefox:before{content:"\f269"}.fa-opera:before{content:"\f26a"}.fa-internet-explorer:before{content:"\f26b"}.fa-tv:before,.fa-television:before{content:"\f26c"}.fa-contao:before{content:"\f26d"}.fa-500px:before{content:"\f26e"}.fa-amazon:before{content:"\f270"}.fa-calendar-plus-o:before{content:"\f271"}.fa-calendar-minus-o:before{content:"\f272"}.fa-calendar-times-o:before{content:"\f273"}.fa-calendar-check-o:before{content:"\f274"}.fa-industry:before{content:"\f275"}.fa-map-pin:before{content:"\f276"}.fa-map-signs:before{content:"\f277"}.fa-map-o:before{content:"\f278"}.fa-map:before{content:"\f279"}.fa-commenting:before{content:"\f27a"}.fa-commenting-o:before{content:"\f27b"}.fa-houzz:before{content:"\f27c"}.fa-vimeo:before{content:"\f27d"}.fa-black-tie:before{content:"\f27e"}.fa-fonticons:before{content:"\f280"}.fa-reddit-alien:before{content:"\f281"}.fa-edge:before{content:"\f282"}.fa-credit-card-alt:before{content:"\f283"}.fa-codiepie:before{content:"\f284"}.fa-modx:before{content:"\f285"}.fa-fort-awesome:before{content:"\f286"}.fa-usb:before{content:"\f287"}.fa-product-hunt:before{content:"\f288"}.fa-mixcloud:before{content:"\f289"}.fa-scribd:before{content:"\f28a"}.fa-pause-circle:before{content:"\f28b"}.fa-pause-circle-o:before{content:"\f28c"}.fa-stop-circle:before{content:"\f28d"}.fa-stop-circle-o:before{content:"\f28e"}.fa-shopping-bag:before{content:"\f290"}.fa-shopping-basket:before{content:"\f291"}.fa-hashtag:before{content:"\f292"}.fa-bluetooth:before{content:"\f293"}.fa-bluetooth-b:before{content:"\f294"}.fa-percent:before{content:"\f295"} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/library.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/library.json new file mode 100644 index 000000000..f6943f441 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/FontAwesome-4.5/library.json @@ -0,0 +1,16 @@ +{ + "title": "Font Awesome", + "contentType": "Font", + "majorVersion": 4, + "minorVersion": 5, + "patchVersion": 4, + "runnable": 0, + "machineName": "FontAwesome", + "license": "MIT", + "author": "Dave Gandy", + "preloadedCss": [ + { + "path": "h5p-font-awesome.min.css" + } + ] +} \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/af.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/af.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/af.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ar.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ar.json new file mode 100644 index 000000000..451ae4859 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ar.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "الملفات المبدئية" + }, + { + "label": "وضع مشغل الصوت", + "description": "اختيار نوع مشغل الصوت", + "options": [ + { + "label": "مصغر" + }, + { + "label": "مكبر" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "ملء الحاوية" + }, + { + "label": "تفعيل ادوات التحكم", + "description": "ادوات التحكم تسمح للمستخدم على سبيل المثال وقف الصوت" + }, + { + "label": "تفعيل التشغيل التلقائي", + "description": "مع التشغيل التلقائي يبدأ الصوت للعب على الفور. إذا تم تعطيل التشغيل التلقائي يقوم المستخدم بالضغط على زر التشغيل لبدء الصوت" + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "اسم ملف الصوت", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/bg.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/bg.json new file mode 100644 index 000000000..63bda4001 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/bg.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Изходни файлове" + }, + { + "label": "Режим на плейъра", + "description": "Изберете оформлението на плейъра.", + "options": [ + { + "label": "Минималистичен" + }, + { + "label": "Пълен" + }, + { + "label": "Прозрачен" + } + ] + }, + { + "label": "Напаснат към рамката" + }, + { + "label": "Активиране на контролите", + "description": "Контролите позволяват на потребителя например да постави на пауза на звука" + }, + { + "label": "Активиране на автоматичното възпроизвеждане", + "description": "С автоматичното пускане аудиото започва да се възпроизвежда веднага. Ако функцията за автоматично пускане е забранена, потребителят натиска бутон за възпроизвеждане, за да стартира аудиото." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Заглавие на аудио съдържанието", + "default": "Аудио" + }, + { + "label": "Аудиото не поддържа съобщение", + "default": "Вашият браузър не поддържа това аудио" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/bs.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/bs.json new file mode 100644 index 000000000..956fe14a0 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/bs.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Izvorni fajlovi" + }, + { + "label": "Izgled playera", + "description": "Odaberi izgled playera.", + "options": [ + { + "label": "Minimalno" + }, + { + "label": "Potpuno" + }, + { + "label": "Transparentno" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Omogući kontrolu", + "description": "Kontrole omogućavaju korisniku da pauzira audio." + }, + { + "label": "Omogući autoplay", + "description": "Sa autoplay audio počinje automatski. Ako je autoplay onemogućen korisnik pritiskom na play pusta audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Pusti audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pauziraj audio" + }, + { + "label": "Naziv audio sadržaja", + "default": "Audio" + }, + { + "label": "Poruka za audio koji nije podržan.", + "default": "Vaš pretraživač ne podržava ovaj audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ca.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ca.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ca.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/cs.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/cs.json new file mode 100644 index 000000000..68a035460 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/cs.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Zdrojové soubory" + }, + { + "label": "Režim přehrávače", + "description": "Vyberte rozložení přehrávače.", + "options": [ + { + "label": "Minimalistický" + }, + { + "label": "Úplný" + }, + { + "label": "Transparentní" + } + ] + }, + { + "label": "Přizpůsobit obalu" + }, + { + "label": "Povolit ovládací prvky", + "description": "Ovládací prvky umožňují uživateli například pozastavit zvuk" + }, + { + "label": "Povolit automatické přehrávání", + "description": "Při automatickém přehrávání se zvuk začne okamžitě přehrávat. Pokud je automatické přehrávání zakázáno, uživatel spustí zvuk stiskem tlačítka přehrávání." + }, + { + "label": "Přehrát zvuk (Čtecí zařízení)", + "default": "Přehrát zvuk" + }, + { + "label": "Pozastavit zvuk (Čtecí zařízení)", + "default": "Pozastavit zvuk" + }, + { + "label": "Název zvukového obsahu", + "default": "Audio" + }, + { + "label": "Zvuk není podporován", + "default": "Váš prohlížeč nepodporuje tento zvuk" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/da.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/da.json new file mode 100644 index 000000000..b65aed6fb --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/da.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Vælg fil" + }, + { + "label": "Indstillinger for afspilning", + "description": "Vælg layout for afspiller.", + "options": [ + { + "label": "Minimalistisk" + }, + { + "label": "Fuld" + }, + { + "label": "Gennemsigtig" + } + ] + }, + { + "label": "Tilpas til område" + }, + { + "label": "Aktiver kontrolpanel", + "description": "Kontrolpanel giver mulighed for at pause afspilningen." + }, + { + "label": "Aktiver automatisk afspilning", + "description": "Vælges automatisk afspilning startes afspilningen med det samme. Hvis antomatisk afspilning er fravalgt skal brugeren starte afspilning ved at klikke på playknappen." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio fil-navn", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/de.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/de.json new file mode 100644 index 000000000..83b4c2fd7 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/de.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Audioquellen" + }, + { + "label": "Audioplayermodus", + "description": "Wähle den gewünschten Audioplayer-Modus.", + "options": [ + { + "label": "Minimaler Funktionsumfang" + }, + { + "label": "Voller Funktionsumfang" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Verfügbaren Platz nutzen" + }, + { + "label": "Steuerelemente aktivieren", + "description": "Dies gibt dem Nutzer z. B. die Möglichkeit, das Abspielen zu pausieren." + }, + { + "label": "Automatische Wiedergabe aktivieren", + "description": "Bei aktivierter, automatischer Wiedergabe wird die Tondatei sofort abgespielt. Ansonsten wird die Tondatei erst abgespielt, wenn der Nutzer den Play-Button gedrückt hat." + }, + { + "label": "Audio abspielen (Screenreader)", + "default": "Audio abspielen" + }, + { + "label": "Audio pausieren (Screenreader)", + "default": "Audio pausieren" + }, + { + "label": "Name des Audioinhalts", + "default": "Audio" + }, + { + "label": "Hinweis, dass keine Tonaufnahmen abgespielt werden können", + "default": "Dein Browser unterstützt diese Tondatei nicht." + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/el.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/el.json new file mode 100644 index 000000000..bf6f37234 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/el.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Αρχεία προέλευσης" + }, + { + "label": "Μορφή προγράμματος αναπαραγωγής", + "description": "Επιλέξτε την εμφάνιση του προγράμματος αναπαραγωγής.", + "options": [ + { + "label": "Απλή" + }, + { + "label": "Πλήρης" + }, + { + "label": "Διάφανη" + } + ] + }, + { + "label": "Προσαρμογή στην περιοχή ενσωμάτωσης" + }, + { + "label": "Ενεργοποίηση κουμπιών ελέγχου προγράμματος αναπαραγωγής", + "description": "Τα κουμπιά ελέγχου του προγράμματος αναπαραγωγής επιτρέπουν στον χρήστη π.χ. να κάνει παύση (pause) του ήχου" + }, + { + "label": "Ενεργοποίηση αυτόματης αναπαραγωγής", + "description": "Με την αυτόματη αναπαραγωγή ο ήχος ξεκινά να παίζει αυτόματα. Εάν η αυτόματη αναπαραγωγή είναι απενεργοποιημένη, ο χρήστης χρειάζεται να πατήσει το κουμπί αναπαραγωγής (play) του ήχου για να ξεκινήσει ο ήχος να παίζει." + }, + { + "label": "Αναπαραγωγή ήχου (Ακουστική υποβοήθηση)", + "default": "Αναπαραγωγή ήχου" + }, + { + "label": "Παύση ήχου (Ακουστική υποβοήθηση)", + "default": "Παύση ήχου" + }, + { + "label": "Όνομα περιεχομένου ήχου", + "default": "Ήχος" + }, + { + "label": "Μήνυμα μη υποστηριζόμενου αρχείου ήχου", + "default": "Ο φυλλομετρητής δεν υποστηρίζει το συγκεκριμένο αρχείο ήχου" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/es-mx.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/es-mx.json new file mode 100644 index 000000000..6b4b2f531 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/es-mx.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Archivo de origen" + }, + { + "label": "Modo reproductor", + "description": "Seleccione el diseño del reproductor.", + "options": [ + { + "label": "Minimalista" + }, + { + "label": "Completo" + }, + { + "label": "Transparente" + } + ] + }, + { + "label": "Ajustar al marco" + }, + { + "label": "Habilitar controles", + "description": "Los controles permiten al usuario por ejemplo pausar el audio" + }, + { + "label": "Habilitar reproduccion automatica", + "description": "Con la reproducción automática el audio empieza a reproducirse inmediatamente. Si la reproducción automática está deshabilitada, el usuario presiona un botón de reproducción para iniciar el audio." + }, + { + "label": "Reproducir audio (Readspeaker)", + "default": "Reproducir audio" + }, + { + "label": "Pausar audio (Readspeaker)", + "default": "Pausar audio" + }, + { + "label": "Nombre contenido de audio", + "default": "Audio" + }, + { + "label": "Mensaje de audio no permitido", + "default": "Su navegador no es compatible con este audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/es.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/es.json new file mode 100644 index 000000000..b3cc84db4 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/es.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Archivo de origen" + }, + { + "label": "Modo reproductor", + "description": "Seleccione el diseño del reproductor.", + "options": [ + { + "label": "Minimalista" + }, + { + "label": "Completo" + }, + { + "label": "Transparente" + } + ] + }, + { + "label": "Ajustar al marco" + }, + { + "label": "Habilitar controles", + "description": "Los controles permiten al usuario por ejemplo pausar el audio" + }, + { + "label": "Habilitar reproduccion automatica", + "description": "Con la reproducción automática el audio empieza a reproducirse inmediatamente. Si la reproducción automática está deshabilitada, el usuario presiona un botón de reproducción para iniciar el audio." + }, + { + "label": "Reproducir audio (Herramienta de lectura)", + "default": "Reproducir audio" + }, + { + "label": "Pausar audio (Herramienta de lectura)", + "default": "Pausar audio" + }, + { + "label": "Nombre contenido de audio", + "default": "Audio" + }, + { + "label": "Mensaje de audio no permitido", + "default": "Su navegador no es compatible con este audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/et.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/et.json new file mode 100644 index 000000000..46c51a3ee --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/et.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Lähtefailid" + }, + { + "label": "Pleieri teema", + "description": "Vali pleieri teema.", + "options": [ + { + "label": "Minimalistlik" + }, + { + "label": "Täielik" + }, + { + "label": "Läbipaistev" + } + ] + }, + { + "label": "Täida ümbrisraam" + }, + { + "label": "Luba juhised", + "description": "Juhised võimaldavad kasutajal näiteks heli mängimist peatada." + }, + { + "label": "Luba automaatne esitus", + "description": "Automaatse esituse korral hakkab heli koheselt mängima. Kui automaatne esitus on keelatud, tuleb kasutajal ise nupuvajutusega heli mängimine käivitada." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Helisisu nimi", + "default": "Heli" + }, + { + "label": "Heli ei ole toetatud sõnum", + "default": "Su brauser ei toeta heli esitamist" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/eu.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/eu.json new file mode 100644 index 000000000..09b308d48 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/eu.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Iturri-fitxategiak" + }, + { + "label": "Erreprodukzio modua", + "description": "Hautatu erreproduktorearen itxura.", + "options": [ + { + "label": "Minimalista" + }, + { + "label": "Osoa" + }, + { + "label": "Gardena" + } + ] + }, + { + "label": "Markora egokitu" + }, + { + "label": "Gaitu kontrolak", + "description": "Kontrolek aukera ematen diote erabiltzaileari, adibidez, audioa gelditzeko" + }, + { + "label": "Gaitu erreprodukzio automatikoa", + "description": "Erreprodukzio automatikoarekin audioa instantean hasiko da. Erreprodukzio automatikoa ez ba dago aktibatua erabiltzaileak erreproduzitzeko botoia sakatu behar du audio hasteko." + }, + { + "label": "Erreproduzitu audioa (irakugailuetarako)", + "default": "Erreproduzitu audioa" + }, + { + "label": "Pausatu audioa (irakugailuetarako)", + "default": "Pausatu audioa" + }, + { + "label": "Audio edukiaren izena", + "default": "Audioa" + }, + { + "label": "Audioa ez da onartzen mezua", + "default": "Zure nabigatzaileak ez du onartzen audio hau." + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/fi.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/fi.json new file mode 100644 index 000000000..921cf69ed --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/fi.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Lähdetiedostot" + }, + { + "label": "Soittimen teema", + "description": "Valitse soittimelle ulkoasu.", + "options": [ + { + "label": "Minimalistinen" + }, + { + "label": "Täysi" + }, + { + "label": "Läpinäkyvä" + } + ] + }, + { + "label": "Sovita kehykseen" + }, + { + "label": "Salli säätimet", + "description": "Säätimillä käyttäjä voi esimerkiksi pysäyttää äänen toiston." + }, + { + "label": "Salli automaattinen toisto", + "description": "Toisto alkaa välittömästi. Muussa tapauksessa käyttäjä aloittaa toiston." + }, + { + "label": "Toista audio (Readspeakerilla)", + "default": "Toista audio" + }, + { + "label": "Keskeytä audio (Readspeakerilla)", + "default": "Keskeytä audio" + }, + { + "label": "Äänisisällön nimi", + "default": "Ääni" + }, + { + "label": "Ääntä ei tueta -viesti", + "default": "Selaimesi ei tue tätä ääntä." + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/fr.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/fr.json new file mode 100644 index 000000000..0c0be2357 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/fr.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Fichiers sources" + }, + { + "label": "Mode d'affichage du lecteur", + "description": "Selectionnez le mode d'affichage du lecteur.", + "options": [ + { + "label": "Minimaliste" + }, + { + "label": "Complet" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Remplir le contenant" + }, + { + "label": "Activer les contrôles", + "description": "Les contrôles permettent, par exemple, à l'utilisateur de mettre le son sur pause" + }, + { + "label": "Activer le démarrage automatique", + "description": "Le son démarre directement sans appuyer sur un bouton. Si cette option est désactivée, l'utilisateur doit appuyer sur le bouton PLAY pour lancer la lecture." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Nom du contenu audio", + "default": "Audio" + }, + { + "label": "Message L'audio n'est pas supporté", + "default": "Votre navigateur ne supporte pas l'audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/he.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/he.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/he.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/hu.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/hu.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/hu.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/it.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/it.json new file mode 100644 index 000000000..f4351d4a0 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/it.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "File sorgenti" + }, + { + "label": "Modalità player", + "description": "Seleziona il layout del player.", + "options": [ + { + "label": "Minimalista" + }, + { + "label": "Intero" + }, + { + "label": "Trasparente" + } + ] + }, + { + "label": "Adatta al contenitore" + }, + { + "label": "Attiva controlli", + "description": "I controlli consentono all'utente di mettere, per esempio, in pausa l'audio" + }, + { + "label": "Attiva autoplay", + "description": "Con l'autoplay l'audio si avvia immediatamente. Se l'autoplay è disattivato l'utente premerà il pulsante play per avviarlo." + }, + { + "label": "Avvia l'audio (lettore vocale)", + "default": "Avvia l'audio" + }, + { + "label": "Metti in pausa l'audio (lettore vocale)", + "default": "Metti in pausa l'audio" + }, + { + "label": "Nome del contenuto dell'audio", + "default": "Audio" + }, + { + "label": "Messaggio per audio non supportato", + "default": "Il tuo browser non supporta questo file audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ja.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ja.json new file mode 100644 index 000000000..5b25c0104 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ja.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "ソースファイル" + }, + { + "label": "プレーヤーモード", + "description": "プレーヤーのレイアウトを選択してください。", + "options": [ + { + "label": "最小限" + }, + { + "label": "最大" + }, + { + "label": "透明" + } + ] + }, + { + "label": "ラッパーに合わせる" + }, + { + "label": "コントロールを有効にします", + "description": "コントロールを使用すると、たとえば、オーディオを一時停止することができます" + }, + { + "label": "自動再生を有効にします", + "description": "自動再生では、オーディオはすぐに再生を開始します。 自動再生が無効になっている場合、ユーザーは再生ボタンを押して音声を開始します。" + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "オーディオコンテンツ名", + "default": "オーディオ" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ko.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ko.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ko.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/nb.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/nb.json new file mode 100644 index 000000000..1088e26ad --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/nb.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Lydfiler" + }, + { + "label": "Avspiller modus", + "description": "Velg avspiller modus.", + "options": [ + { + "label": "Minimal" + }, + { + "label": "Full" + }, + { + "label": "Gjennomsiktig" + } + ] + }, + { + "label": "Tilpass størrelse" + }, + { + "label": "Slå på kontroller", + "description": "Kontrollene lar bl.a. brukeren sette lydavspillingen på pause" + }, + { + "label": "Slå på automatisk avspilling", + "description": "Med automatisk avspilling begynner lyden å spille av seg selv med en gang. Hvis automatisk avspilling er avslått må brukeren trykke for å starte avspillingen." + }, + { + "label": "Spill lyd (Readspeaker)", + "default": "Spill lyd" + }, + { + "label": "Pause lyd (Readspeaker)", + "default": "Pause lyd" + }, + { + "label": "Innholdsnavn for lyd", + "default": "Lyd" + }, + { + "label": "Melding vist når lydkilde ikke er støttet", + "default": "Nettleseren din støtter ikke denne lydkilden" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/nl.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/nl.json new file mode 100644 index 000000000..210916f68 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/nl.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Bronbestanden" + }, + { + "label": "Spelermodus", + "description": "Selecteer de spelermodus.", + "options": [ + { + "label": "Minimalistisch" + }, + { + "label": "Volledig" + }, + { + "label": "Onzichtbaar" + } + ] + }, + { + "label": "Past in de wrapper" + }, + { + "label": "Activeer audiobediening", + "description": "De audiobediening stelt je in staat om bijvoorbeeld de audio te pauzeren." + }, + { + "label": "Activeer automatisch afspelen", + "description": "Met autoplay begint de audio direct met afspelen. Als autoplay is uitgeschakeld, dan dient de gebruiker de audio te starten met de playknop ." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audionaam", + "default": "Audio" + }, + { + "label": "Statusbericht niet ondersteunde audio", + "default": "Je browser ondersteunt deze audio-opname niet" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/nn.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/nn.json new file mode 100644 index 000000000..8bac4c6eb --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/nn.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Lydfiler" + }, + { + "label": "Avspiller modus", + "description": "Velg avspiller modus.", + "options": [ + { + "label": "Minimal" + }, + { + "label": "Full" + }, + { + "label": "Gjennomsiktig" + } + ] + }, + { + "label": "Tilpass størrelse" + }, + { + "label": "Slå på kontrollar", + "description": "Kontrollane lar mellom anna brukaren setje lydavspelinga på pause" + }, + { + "label": "Slå på automatisk avspeling", + "description": "Med automatisk avspeling begynner lyden å spele av seg sjølv med ein gang. Viss automatisk avspeling er slått av må brukaren trykkje for å starte avspelinga." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Innhaldsnamn for lyd", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/pl.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/pl.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/pl.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/pt-br.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/pt-br.json new file mode 100644 index 000000000..39d9e3698 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/pt-br.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Arquivos fonte" + }, + { + "label": "Modo do reprodutor", + "description": "Selecione o layout do reprodutor.", + "options": [ + { + "label": "Minimalista" + }, + { + "label": "Completo" + }, + { + "label": "Transparente" + } + ] + }, + { + "label": "Preencher" + }, + { + "label": "Habilitar controles", + "description": "Controles permitem que o usuário por exemplo, pause o áudio" + }, + { + "label": "Habilitar reprodução automática", + "description": "O áudio é reproduzido automaticamente. Se a reprodução automática estiver desabilitada, o usuário deve pressionar o botão de reprodução para iniciar o áudio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Nome do conteúdo de áudio", + "default": "Áudio" + }, + { + "label": "Mensagem de áudio não suportado", + "default": "Seu navegador não suporta este áudio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/pt.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/pt.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/pt.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ro.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ro.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ro.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ru.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ru.json new file mode 100644 index 000000000..96561ce78 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/ru.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Исходный файл" + }, + { + "label": "Режим плеера", + "description": "Выберите макет плеера.", + "options": [ + { + "label": "Минималистичная эмблема" + }, + { + "label": "Полная звуковая дорожка" + }, + { + "label": "Прозрачный" + } + ] + }, + { + "label": "Расположить по всей горизонтали" + }, + { + "label": "Разрешить контроль", + "description": "Контроль позволит пользователю, например, поставить аудио на паузу" + }, + { + "label": "Разрешить автоматическое воспроизведение", + "description": "С автоматическим воспроизведением дорожка начнёт воспроизводиться сразу. Если автовоспроизведение запрещено, пользователю необходимо нажать кнопку воспроизведения самостоятельно." + }, + { + "label": "Воспроизвести аудио (ассистирующие технологии)", + "default": "Воспроизвести аудио" + }, + { + "label": "Пауза (ассистирующие технологии)", + "default": "Пауза" + }, + { + "label": "Название контента аудио", + "default": "Аудио" + }, + { + "label": "Сообщение об ошибке аудио", + "default": "Ваш браузер не поддерживает аудио" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sl.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sl.json new file mode 100644 index 000000000..d79fc6889 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sl.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Izvorne datoteke" + }, + { + "label": "Predvajalnik", + "description": "Nastavitev videza predvajalnika.", + "options": [ + { + "label": "Minimalističen" + }, + { + "label": "Celoten" + }, + { + "label": "Prosojno" + } + ] + }, + { + "label": "Prilagodi širini okna" + }, + { + "label": "Onemogoči kontrolnike v predvajalniku.", + "description": "Kontrolniki na primer uporabniku dovoljujejo začasno prekinitev predvajanja." + }, + { + "label": "Omogoči samodejno predvajanje", + "description": "Nastavitev samodejnega predvajanja. Neizbežno v primeru prosojnosti predvajalnika." + }, + { + "label": "Predvajaj zvok", + "default": "Predvajaj zvok" + }, + { + "label": "Zaustavi predvajanje", + "default": "Zaustavi predvajanje" + }, + { + "label": "Naslov vsebine posnetka", + "default": "Zvočni posnetek" + }, + { + "label": "Sporočilo o nepodprtosti zvočnega posnetka", + "default": "Spletni brskalnik ne podpira tega zvočnega posnetka." + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sma.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sma.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sma.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sme.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sme.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sme.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/smj.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/smj.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/smj.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sr.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sr.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sr.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sv.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sv.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/sv.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/tr.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/tr.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/tr.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/vi.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/vi.json new file mode 100644 index 000000000..488fc2c89 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/vi.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "Source files" + }, + { + "label": "Player mode", + "description": "Select the layout of the player.", + "options": [ + { + "label": "Minimalistic" + }, + { + "label": "Full" + }, + { + "label": "Transparent" + } + ] + }, + { + "label": "Fit to wrapper" + }, + { + "label": "Enable controls", + "description": "Controls allow the user to for instance pause the audio" + }, + { + "label": "Enable autoplay", + "description": "With autoplay the audio starts to play immediately. If autoplay is disabled the user presses a play button to start the audio." + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "Audio content name", + "default": "Audio" + }, + { + "label": "Audio not supported message", + "default": "Your browser does not support this audio" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/zh-hans.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/zh-hans.json new file mode 100644 index 000000000..044b1cef3 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/zh-hans.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "来源档案" + }, + { + "label": "播放方式", + "description": "选择播放器面板。", + "options": [ + { + "label": "简约" + }, + { + "label": "完整" + }, + { + "label": "透明" + } + ] + }, + { + "label": "自适应画面" + }, + { + "label": "启用控制项", + "description": "允许用户控制音频的播放，像是暂停。" + }, + { + "label": "启用自动播放", + "description": "让画面载入后就开始播放，如果停用，使用者就必须点击播放按钮才能开始。" + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "音乐名称", + "default": "Audio" + }, + { + "label": "无法播放时显示讯息", + "default": "你的浏览器不支持播放这个格式的音乐档案。" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/zh-hant.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/zh-hant.json new file mode 100644 index 000000000..379b083df --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/zh-hant.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "來源檔案" + }, + { + "label": "播放方式", + "description": "選擇播放器面版。", + "options": [ + { + "label": "簡約" + }, + { + "label": "完整" + }, + { + "label": "透明" + } + ] + }, + { + "label": "自適應畫面" + }, + { + "label": "啟用控制項", + "description": "允許用戶控制音頻的播放，像是暫停。" + }, + { + "label": "啟用自動播放", + "description": "讓畫面載入後就開始播放，如果停用，使用者就必須點擊播放按鈕才能開始。" + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "音樂名稱", + "default": "Audio" + }, + { + "label": "無法播放時顯示訊息", + "default": "你的瀏覽器不支援播放這個格式的音樂檔案。" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/zh.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/zh.json new file mode 100644 index 000000000..379b083df --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/language/zh.json @@ -0,0 +1,49 @@ +{ + "semantics": [ + { + "label": "來源檔案" + }, + { + "label": "播放方式", + "description": "選擇播放器面版。", + "options": [ + { + "label": "簡約" + }, + { + "label": "完整" + }, + { + "label": "透明" + } + ] + }, + { + "label": "自適應畫面" + }, + { + "label": "啟用控制項", + "description": "允許用戶控制音頻的播放，像是暫停。" + }, + { + "label": "啟用自動播放", + "description": "讓畫面載入後就開始播放，如果停用，使用者就必須點擊播放按鈕才能開始。" + }, + { + "label": "Play audio (Readspeaker)", + "default": "Play audio" + }, + { + "label": "Pause audio (Readspeaker)", + "default": "Pause audio" + }, + { + "label": "音樂名稱", + "default": "Audio" + }, + { + "label": "無法播放時顯示訊息", + "default": "你的瀏覽器不支援播放這個格式的音樂檔案。" + } + ] +} diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/library.json b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/library.json new file mode 100644 index 000000000..d49d72705 --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/library.json @@ -0,0 +1,40 @@ +{ + "title": "Audio", + "contentType": "Media", + "description": "Simple library that displays an audio player.", + "majorVersion": 1, + "minorVersion": 4, + "patchVersion": 3, + "runnable": 1, + "machineName": "H5P.Audio", + "embedTypes": [ + "iframe" + ], + "author": "Joubel", + "coreApi": { + "majorVersion": 1, + "minorVersion": 19 + }, + "preloadedJs": [ + { + "path": "scripts/audio.js" + } + ], + "preloadedCss": [ + { + "path": "styles/audio.css" + } + ], + "preloadedDependencies": [ + { + "machineName": "flowplayer", + "majorVersion": 1, + "minorVersion": 0 + }, + { + "machineName": "FontAwesome", + "majorVersion": 4, + "minorVersion": 5 + } + ] +} \ No newline at end of file diff --git a/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/scripts/audio.js b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/scripts/audio.js new file mode 100644 index 000000000..a9a2985de --- /dev/null +++ b/plugin/h5p/cache-h5p/launch/source-dialogcard/H5P.Audio-1.4/scripts/audio.js @@ -0,0 +1,386 @@ +var H5P = H5P || {}; + +/** + * H5P audio module + * + * @external {jQuery} $ H5P.jQuery + */ +H5P.Audio = (function ($) { + /** + * @param {Object} params Options for this library. + * @param {Number} id Content identifier. + * @param {Object} extras Extras. + * @returns {undefined} + */ + function C(params, id, extras) { + H5P.EventDispatcher.call(this); + this.contentId = id; + this.params = params; + this.extras = extras; + + this.toggleButtonEnabled = true; + + // Retrieve previous state + if (extras && extras.previousState !== undefined) { + this.oldTime = extras.previousState.currentTime; + } + + this.params = $.extend({}, { + playerMode: 'minimalistic', + fitToWrapper: false, + controls: true, + autoplay: false, + audioNotSupported: "Your browser does not support this audio", + playAudio: "Play audio", + pauseAudio: "Pause audio" + }, params); + + this.on('resize', this.resize, this); + } + + C.prototype = Object.create(H5P.EventDispatcher.prototype); + C.prototype.constructor = C; + + /** + * Adds a minimalistic audio player with only "play" and "pause" functionality. + * + * @param {jQuery} $container Container for the player. + * @param {boolean} transparentMode true: the player is only visible when hovering over it; false: player's UI always visible + */ + C.prototype.addMinimalAudioPlayer = function ($container, transparentMode) { + var INNER_CONTAINER = 'h5p-audio-inner'; + var AUDIO_BUTTON = 'h5p-audio-minimal-button'; + var PLAY_BUTTON = 'h5p-audio-minimal-play'; + var PLAY_BUTTON_PAUSED = 'h5p-audio-minimal-play-paused'; + var PAUSE_BUTTON = 'h5p-audio-minimal-pause'; + + var self = this; + this.$container = $container; + + self.$inner = $('
    ', { + 'class': INNER_CONTAINER + (transparentMode ? ' h5p-audio-transparent' : '') + }).appendTo($container); + + var audioButton = $('") + .button({ + label: this.options.closeText, + icons: { + primary: "ui-icon-closethick" + }, + text: false + }) + .addClass("ui-dialog-titlebar-close") + .appendTo( this.uiDialogTitlebar ); + this._on( this.uiDialogTitlebarClose, { + click: function( event ) { + event.preventDefault(); + this.close( event ); + } + }); + + uiDialogTitle = $("") + .uniqueId() + .addClass("ui-dialog-title") + .prependTo( this.uiDialogTitlebar ); + this._title( uiDialogTitle ); + + this.uiDialog.attr({ + "aria-labelledby": uiDialogTitle.attr("id") + }); + }, + + _title: function( title ) { + if ( !this.options.title ) { + title.html(" "); + } + title.text( this.options.title ); + }, + + _createButtonPane: function() { + this.uiDialogButtonPane = $("
    ") + .addClass("ui-dialog-buttonpane ui-widget-content ui-helper-clearfix"); + + this.uiButtonSet = $("
    ") + .addClass("ui-dialog-buttonset") + .appendTo( this.uiDialogButtonPane ); + + this._createButtons(); + }, + + _createButtons: function() { + var that = this, + buttons = this.options.buttons; + + // if we already have a button pane, remove it + this.uiDialogButtonPane.remove(); + this.uiButtonSet.empty(); + + if ( $.isEmptyObject( buttons ) || ($.isArray( buttons ) && !buttons.length) ) { + this.uiDialog.removeClass("ui-dialog-buttons"); + return; + } + + $.each( buttons, function( name, props ) { + var click, buttonOptions; + props = $.isFunction( props ) ? + { click: props, text: name } : + props; + // Default to a non-submitting button + props = $.extend( { type: "button" }, props ); + // Change the context for the click callback to be the main element + click = props.click; + props.click = function() { + click.apply( that.element[0], arguments ); + }; + buttonOptions = { + icons: props.icons, + text: props.showText + }; + delete props.icons; + delete props.showText; + $( "", props ) + .button( buttonOptions ) + .appendTo( that.uiButtonSet ); + }); + this.uiDialog.addClass("ui-dialog-buttons"); + this.uiDialogButtonPane.appendTo( this.uiDialog ); + }, + + _makeDraggable: function() { + var that = this, + options = this.options; + + function filteredUi( ui ) { + return { + position: ui.position, + offset: ui.offset + }; + } + + this.uiDialog.draggable({ + cancel: ".ui-dialog-content, .ui-dialog-titlebar-close", + handle: ".ui-dialog-titlebar", + containment: "document", + start: function( event, ui ) { + $( this ).addClass("ui-dialog-dragging"); + that._blockFrames(); + that._trigger( "dragStart", event, filteredUi( ui ) ); + }, + drag: function( event, ui ) { + that._trigger( "drag", event, filteredUi( ui ) ); + }, + stop: function( event, ui ) { + options.position = [ + ui.position.left - that.document.scrollLeft(), + ui.position.top - that.document.scrollTop() + ]; + $( this ).removeClass("ui-dialog-dragging"); + that._unblockFrames(); + that._trigger( "dragStop", event, filteredUi( ui ) ); + } + }); + }, + + _makeResizable: function() { + var that = this, + options = this.options, + handles = options.resizable, + // .ui-resizable has position: relative defined in the stylesheet + // but dialogs have to use absolute or fixed positioning + position = this.uiDialog.css("position"), + resizeHandles = typeof handles === "string" ? + handles : + "n,e,s,w,se,sw,ne,nw"; + + function filteredUi( ui ) { + return { + originalPosition: ui.originalPosition, + originalSize: ui.originalSize, + position: ui.position, + size: ui.size + }; + } + + this.uiDialog.resizable({ + cancel: ".ui-dialog-content", + containment: "document", + alsoResize: this.element, + maxWidth: options.maxWidth, + maxHeight: options.maxHeight, + minWidth: options.minWidth, + minHeight: this._minHeight(), + handles: resizeHandles, + start: function( event, ui ) { + $( this ).addClass("ui-dialog-resizing"); + that._blockFrames(); + that._trigger( "resizeStart", event, filteredUi( ui ) ); + }, + resize: function( event, ui ) { + that._trigger( "resize", event, filteredUi( ui ) ); + }, + stop: function( event, ui ) { + options.height = $( this ).height(); + options.width = $( this ).width(); + $( this ).removeClass("ui-dialog-resizing"); + that._unblockFrames(); + that._trigger( "resizeStop", event, filteredUi( ui ) ); + } + }) + .css( "position", position ); + }, + + _minHeight: function() { + var options = this.options; + + return options.height === "auto" ? + options.minHeight : + Math.min( options.minHeight, options.height ); + }, + + _position: function() { + // Need to show the dialog to get the actual offset in the position plugin + var isVisible = this.uiDialog.is(":visible"); + if ( !isVisible ) { + this.uiDialog.show(); + } + this.uiDialog.position( this.options.position ); + if ( !isVisible ) { + this.uiDialog.hide(); + } + }, + + _setOptions: function( options ) { + var that = this, + resize = false, + resizableOptions = {}; + + $.each( options, function( key, value ) { + that._setOption( key, value ); + + if ( key in sizeRelatedOptions ) { + resize = true; + } + if ( key in resizableRelatedOptions ) { + resizableOptions[ key ] = value; + } + }); + + if ( resize ) { + this._size(); + this._position(); + } + if ( this.uiDialog.is(":data(ui-resizable)") ) { + this.uiDialog.resizable( "option", resizableOptions ); + } + }, + + _setOption: function( key, value ) { + /*jshint maxcomplexity:15*/ + var isDraggable, isResizable, + uiDialog = this.uiDialog; + + if ( key === "dialogClass" ) { + uiDialog + .removeClass( this.options.dialogClass ) + .addClass( value ); + } + + if ( key === "disabled" ) { + return; + } + + this._super( key, value ); + + if ( key === "appendTo" ) { + this.uiDialog.appendTo( this._appendTo() ); + } + + if ( key === "buttons" ) { + this._createButtons(); + } + + if ( key === "closeText" ) { + this.uiDialogTitlebarClose.button({ + // Ensure that we always pass a string + label: "" + value + }); + } + + if ( key === "draggable" ) { + isDraggable = uiDialog.is(":data(ui-draggable)"); + if ( isDraggable && !value ) { + uiDialog.draggable("destroy"); + } + + if ( !isDraggable && value ) { + this._makeDraggable(); + } + } + + if ( key === "position" ) { + this._position(); + } + + if ( key === "resizable" ) { + // currently resizable, becoming non-resizable + isResizable = uiDialog.is(":data(ui-resizable)"); + if ( isResizable && !value ) { + uiDialog.resizable("destroy"); + } + + // currently resizable, changing handles + if ( isResizable && typeof value === "string" ) { + uiDialog.resizable( "option", "handles", value ); + } + + // currently non-resizable, becoming resizable + if ( !isResizable && value !== false ) { + this._makeResizable(); + } + } + + if ( key === "title" ) { + this._title( this.uiDialogTitlebar.find(".ui-dialog-title") ); + } + }, + + _size: function() { + // If the user has resized the dialog, the .ui-dialog and .ui-dialog-content + // divs will both have width and height set, so we need to reset them + var nonContentHeight, minContentHeight, maxContentHeight, + options = this.options; + + // Reset content sizing + this.element.show().css({ + width: "auto", + minHeight: 0, + maxHeight: "none", + height: 0 + }); + + if ( options.minWidth > options.width ) { + options.width = options.minWidth; + } + + // reset wrapper sizing + // determine the height of all the non-content elements + nonContentHeight = this.uiDialog.css({ + height: "auto", + width: options.width + }) + .outerHeight(); + minContentHeight = Math.max( 0, options.minHeight - nonContentHeight ); + maxContentHeight = typeof options.maxHeight === "number" ? + Math.max( 0, options.maxHeight - nonContentHeight ) : + "none"; + + if ( options.height === "auto" ) { + this.element.css({ + minHeight: minContentHeight, + maxHeight: maxContentHeight, + height: "auto" + }); + } else { + this.element.height( Math.max( 0, options.height - nonContentHeight ) ); + } + + if (this.uiDialog.is(":data(ui-resizable)") ) { + this.uiDialog.resizable( "option", "minHeight", this._minHeight() ); + } + }, + + _blockFrames: function() { + this.iframeBlocks = this.document.find( "iframe" ).map(function() { + var iframe = $( this ); + + return $( "
    " ) + .css({ + position: "absolute", + width: iframe.outerWidth(), + height: iframe.outerHeight() + }) + .appendTo( iframe.parent() ) + .offset( iframe.offset() )[0]; + }); + }, + + _unblockFrames: function() { + if ( this.iframeBlocks ) { + this.iframeBlocks.remove(); + delete this.iframeBlocks; + } + }, + + _allowInteraction: function( event ) { + if ( $( event.target ).closest(".ui-dialog").length ) { + return true; + } + + // TODO: Remove hack when datepicker implements + // the .ui-front logic (#8989) + return !!$( event.target ).closest(".ui-datepicker").length; + }, + + _createOverlay: function() { + if ( !this.options.modal ) { + return; + } + + var that = this, + widgetFullName = this.widgetFullName; + if ( !$.ui.dialog.overlayInstances ) { + // Prevent use of anchors and inputs. + // We use a delay in case the overlay is created from an + // event that we're going to be cancelling. (#2804) + this._delay(function() { + // Handle .dialog().dialog("close") (#4065) + if ( $.ui.dialog.overlayInstances ) { + this.document.bind( "focusin.dialog", function( event ) { + if ( !that._allowInteraction( event ) ) { + event.preventDefault(); + $(".ui-dialog:visible:last .ui-dialog-content") + .data( widgetFullName )._focusTabbable(); + } + }); + } + }); + } + + this.overlay = $("
    ") + .addClass("ui-widget-overlay ui-front") + .appendTo( this._appendTo() ); + this._on( this.overlay, { + mousedown: "_keepFocus" + }); + $.ui.dialog.overlayInstances++; + }, + + _destroyOverlay: function() { + if ( !this.options.modal ) { + return; + } + + if ( this.overlay ) { + $.ui.dialog.overlayInstances--; + + if ( !$.ui.dialog.overlayInstances ) { + this.document.unbind( "focusin.dialog" ); + } + this.overlay.remove(); + this.overlay = null; + } + } +}); + +$.ui.dialog.overlayInstances = 0; + +// DEPRECATED +if ( $.uiBackCompat !== false ) { + // position option with array notation + // just override with old implementation + $.widget( "ui.dialog", $.ui.dialog, { + _position: function() { + var position = this.options.position, + myAt = [], + offset = [ 0, 0 ], + isVisible; + + if ( position ) { + if ( typeof position === "string" || (typeof position === "object" && "0" in position ) ) { + myAt = position.split ? position.split(" ") : [ position[0], position[1] ]; + if ( myAt.length === 1 ) { + myAt[1] = myAt[0]; + } + + $.each( [ "left", "top" ], function( i, offsetPosition ) { + if ( +myAt[ i ] === myAt[ i ] ) { + offset[ i ] = myAt[ i ]; + myAt[ i ] = offsetPosition; + } + }); + + position = { + my: myAt[0] + (offset[0] < 0 ? offset[0] : "+" + offset[0]) + " " + + myAt[1] + (offset[1] < 0 ? offset[1] : "+" + offset[1]), + at: myAt.join(" ") + }; + } + + position = $.extend( {}, $.ui.dialog.prototype.options.position, position ); + } else { + position = $.ui.dialog.prototype.options.position; + } + + // need to show the dialog to get the actual offset in the position plugin + isVisible = this.uiDialog.is(":visible"); + if ( !isVisible ) { + this.uiDialog.show(); + } + this.uiDialog.position( position ); + if ( !isVisible ) { + this.uiDialog.hide(); + } + } + }); +} + +}( jQuery ) ); + +(function( $, undefined ) { + +var rvertical = /up|down|vertical/, + rpositivemotion = /up|left|vertical|horizontal/; + +$.effects.effect.blind = function( o, done ) { + // Create element + var el = $( this ), + props = [ "position", "top", "bottom", "left", "right", "height", "width" ], + mode = $.effects.setMode( el, o.mode || "hide" ), + direction = o.direction || "up", + vertical = rvertical.test( direction ), + ref = vertical ? "height" : "width", + ref2 = vertical ? "top" : "left", + motion = rpositivemotion.test( direction ), + animation = {}, + show = mode === "show", + wrapper, distance, margin; + + // if already wrapped, the wrapper's properties are my property. #6245 + if ( el.parent().is( ".ui-effects-wrapper" ) ) { + $.effects.save( el.parent(), props ); + } else { + $.effects.save( el, props ); + } + el.show(); + wrapper = $.effects.createWrapper( el ).css({ + overflow: "hidden" + }); + + distance = wrapper[ ref ](); + margin = parseFloat( wrapper.css( ref2 ) ) || 0; + + animation[ ref ] = show ? distance : 0; + if ( !motion ) { + el + .css( vertical ? "bottom" : "right", 0 ) + .css( vertical ? "top" : "left", "auto" ) + .css({ position: "absolute" }); + + animation[ ref2 ] = show ? margin : distance + margin; + } + + // start at 0 if we are showing + if ( show ) { + wrapper.css( ref, 0 ); + if ( ! motion ) { + wrapper.css( ref2, margin + distance ); + } + } + + // Animate + wrapper.animate( animation, { + duration: o.duration, + easing: o.easing, + queue: false, + complete: function() { + if ( mode === "hide" ) { + el.hide(); + } + $.effects.restore( el, props ); + $.effects.removeWrapper( el ); + done(); + } + }); + +}; + +})(jQuery); + +(function( $, undefined ) { + +$.effects.effect.bounce = function( o, done ) { + var el = $( this ), + props = [ "position", "top", "bottom", "left", "right", "height", "width" ], + + // defaults: + mode = $.effects.setMode( el, o.mode || "effect" ), + hide = mode === "hide", + show = mode === "show", + direction = o.direction || "up", + distance = o.distance, + times = o.times || 5, + + // number of internal animations + anims = times * 2 + ( show || hide ? 1 : 0 ), + speed = o.duration / anims, + easing = o.easing, + + // utility: + ref = ( direction === "up" || direction === "down" ) ? "top" : "left", + motion = ( direction === "up" || direction === "left" ), + i, + upAnim, + downAnim, + + // we will need to re-assemble the queue to stack our animations in place + queue = el.queue(), + queuelen = queue.length; + + // Avoid touching opacity to prevent clearType and PNG issues in IE + if ( show || hide ) { + props.push( "opacity" ); + } + + $.effects.save( el, props ); + el.show(); + $.effects.createWrapper( el ); // Create Wrapper + + // default distance for the BIGGEST bounce is the outer Distance / 3 + if ( !distance ) { + distance = el[ ref === "top" ? "outerHeight" : "outerWidth" ]() / 3; + } + + if ( show ) { + downAnim = { opacity: 1 }; + downAnim[ ref ] = 0; + + // if we are showing, force opacity 0 and set the initial position + // then do the "first" animation + el.css( "opacity", 0 ) + .css( ref, motion ? -distance * 2 : distance * 2 ) + .animate( downAnim, speed, easing ); + } + + // start at the smallest distance if we are hiding + if ( hide ) { + distance = distance / Math.pow( 2, times - 1 ); + } + + downAnim = {}; + downAnim[ ref ] = 0; + // Bounces up/down/left/right then back to 0 -- times * 2 animations happen here + for ( i = 0; i < times; i++ ) { + upAnim = {}; + upAnim[ ref ] = ( motion ? "-=" : "+=" ) + distance; + + el.animate( upAnim, speed, easing ) + .animate( downAnim, speed, easing ); + + distance = hide ? distance * 2 : distance / 2; + } + + // Last Bounce when Hiding + if ( hide ) { + upAnim = { opacity: 0 }; + upAnim[ ref ] = ( motion ? "-=" : "+=" ) + distance; + + el.animate( upAnim, speed, easing ); + } + + el.queue(function() { + if ( hide ) { + el.hide(); + } + $.effects.restore( el, props ); + $.effects.removeWrapper( el ); + done(); + }); + + // inject all the animations we just queued to be first in line (after "inprogress") + if ( queuelen > 1) { + queue.splice.apply( queue, + [ 1, 0 ].concat( queue.splice( queuelen, anims + 1 ) ) ); + } + el.dequeue(); + +}; + +})(jQuery); + +(function( $, undefined ) { + +$.effects.effect.clip = function( o, done ) { + // Create element + var el = $( this ), + props = [ "position", "top", "bottom", "left", "right", "height", "width" ], + mode = $.effects.setMode( el, o.mode || "hide" ), + show = mode === "show", + direction = o.direction || "vertical", + vert = direction === "vertical", + size = vert ? "height" : "width", + position = vert ? "top" : "left", + animation = {}, + wrapper, animate, distance; + + // Save & Show + $.effects.save( el, props ); + el.show(); + + // Create Wrapper + wrapper = $.effects.createWrapper( el ).css({ + overflow: "hidden" + }); + animate = ( el[0].tagName === "IMG" ) ? wrapper : el; + distance = animate[ size ](); + + // Shift + if ( show ) { + animate.css( size, 0 ); + animate.css( position, distance / 2 ); + } + + // Create Animation Object: + animation[ size ] = show ? distance : 0; + animation[ position ] = show ? 0 : distance / 2; + + // Animate + animate.animate( animation, { + queue: false, + duration: o.duration, + easing: o.easing, + complete: function() { + if ( !show ) { + el.hide(); + } + $.effects.restore( el, props ); + $.effects.removeWrapper( el ); + done(); + } + }); + +}; + +})(jQuery); + +(function( $, undefined ) { + +$.effects.effect.drop = function( o, done ) { + + var el = $( this ), + props = [ "position", "top", "bottom", "left", "right", "opacity", "height", "width" ], + mode = $.effects.setMode( el, o.mode || "hide" ), + show = mode === "show", + direction = o.direction || "left", + ref = ( direction === "up" || direction === "down" ) ? "top" : "left", + motion = ( direction === "up" || direction === "left" ) ? "pos" : "neg", + animation = { + opacity: show ? 1 : 0 + }, + distance; + + // Adjust + $.effects.save( el, props ); + el.show(); + $.effects.createWrapper( el ); + + distance = o.distance || el[ ref === "top" ? "outerHeight": "outerWidth" ]( true ) / 2; + + if ( show ) { + el + .css( "opacity", 0 ) + .css( ref, motion === "pos" ? -distance : distance ); + } + + // Animation + animation[ ref ] = ( show ? + ( motion === "pos" ? "+=" : "-=" ) : + ( motion === "pos" ? "-=" : "+=" ) ) + + distance; + + // Animate + el.animate( animation, { + queue: false, + duration: o.duration, + easing: o.easing, + complete: function() { + if ( mode === "hide" ) { + el.hide(); + } + $.effects.restore( el, props ); + $.effects.removeWrapper( el ); + done(); + } + }); +}; + +})(jQuery); + +(function( $, undefined ) { + +$.effects.effect.explode = function( o, done ) { + + var rows = o.pieces ? Math.round( Math.sqrt( o.pieces ) ) : 3, + cells = rows, + el = $( this ), + mode = $.effects.setMode( el, o.mode || "hide" ), + show = mode === "show", + + // show and then visibility:hidden the element before calculating offset + offset = el.show().css( "visibility", "hidden" ).offset(), + + // width and height of a piece + width = Math.ceil( el.outerWidth() / cells ), + height = Math.ceil( el.outerHeight() / rows ), + pieces = [], + + // loop + i, j, left, top, mx, my; + + // children animate complete: + function childComplete() { + pieces.push( this ); + if ( pieces.length === rows * cells ) { + animComplete(); + } + } + + // clone the element for each row and cell. + for( i = 0; i < rows ; i++ ) { // ===> + top = offset.top + i * height; + my = i - ( rows - 1 ) / 2 ; + + for( j = 0; j < cells ; j++ ) { // ||| + left = offset.left + j * width; + mx = j - ( cells - 1 ) / 2 ; + + // Create a clone of the now hidden main element that will be absolute positioned + // within a wrapper div off the -left and -top equal to size of our pieces + el + .clone() + .appendTo( "body" ) + .wrap( "
    " ) + .css({ + position: "absolute", + visibility: "visible", + left: -j * width, + top: -i * height + }) + + // select the wrapper - make it overflow: hidden and absolute positioned based on + // where the original was located +left and +top equal to the size of pieces + .parent() + .addClass( "ui-effects-explode" ) + .css({ + position: "absolute", + overflow: "hidden", + width: width, + height: height, + left: left + ( show ? mx * width : 0 ), + top: top + ( show ? my * height : 0 ), + opacity: show ? 0 : 1 + }).animate({ + left: left + ( show ? 0 : mx * width ), + top: top + ( show ? 0 : my * height ), + opacity: show ? 1 : 0 + }, o.duration || 500, o.easing, childComplete ); + } + } + + function animComplete() { + el.css({ + visibility: "visible" + }); + $( pieces ).remove(); + if ( !show ) { + el.hide(); + } + done(); + } +}; + +})(jQuery); + +(function( $, undefined ) { + +$.effects.effect.fade = function( o, done ) { + var el = $( this ), + mode = $.effects.setMode( el, o.mode || "toggle" ); + + el.animate({ + opacity: mode + }, { + queue: false, + duration: o.duration, + easing: o.easing, + complete: done + }); +}; + +})( jQuery ); + +(function( $, undefined ) { + +$.effects.effect.fold = function( o, done ) { + + // Create element + var el = $( this ), + props = [ "position", "top", "bottom", "left", "right", "height", "width" ], + mode = $.effects.setMode( el, o.mode || "hide" ), + show = mode === "show", + hide = mode === "hide", + size = o.size || 15, + percent = /([0-9]+)%/.exec( size ), + horizFirst = !!o.horizFirst, + widthFirst = show !== horizFirst, + ref = widthFirst ? [ "width", "height" ] : [ "height", "width" ], + duration = o.duration / 2, + wrapper, distance, + animation1 = {}, + animation2 = {}; + + $.effects.save( el, props ); + el.show(); + + // Create Wrapper + wrapper = $.effects.createWrapper( el ).css({ + overflow: "hidden" + }); + distance = widthFirst ? + [ wrapper.width(), wrapper.height() ] : + [ wrapper.height(), wrapper.width() ]; + + if ( percent ) { + size = parseInt( percent[ 1 ], 10 ) / 100 * distance[ hide ? 0 : 1 ]; + } + if ( show ) { + wrapper.css( horizFirst ? { + height: 0, + width: size + } : { + height: size, + width: 0 + }); + } + + // Animation + animation1[ ref[ 0 ] ] = show ? distance[ 0 ] : size; + animation2[ ref[ 1 ] ] = show ? distance[ 1 ] : 0; + + // Animate + wrapper + .animate( animation1, duration, o.easing ) + .animate( animation2, duration, o.easing, function() { + if ( hide ) { + el.hide(); + } + $.effects.restore( el, props ); + $.effects.removeWrapper( el ); + done(); + }); + +}; + +})(jQuery); + +(function( $, undefined ) { + +$.effects.effect.highlight = function( o, done ) { + var elem = $( this ), + props = [ "backgroundImage", "backgroundColor", "opacity" ], + mode = $.effects.setMode( elem, o.mode || "show" ), + animation = { + backgroundColor: elem.css( "backgroundColor" ) + }; + + if (mode === "hide") { + animation.opacity = 0; + } + + $.effects.save( elem, props ); + + elem + .show() + .css({ + backgroundImage: "none", + backgroundColor: o.color || "#ffff99" + }) + .animate( animation, { + queue: false, + duration: o.duration, + easing: o.easing, + complete: function() { + if ( mode === "hide" ) { + elem.hide(); + } + $.effects.restore( elem, props ); + done(); + } + }); +}; + +})(jQuery); + +(function( $, undefined ) { + +$.effects.effect.pulsate = function( o, done ) { + var elem = $( this ), + mode = $.effects.setMode( elem, o.mode || "show" ), + show = mode === "show", + hide = mode === "hide", + showhide = ( show || mode === "hide" ), + + // showing or hiding leaves of the "last" animation + anims = ( ( o.times || 5 ) * 2 ) + ( showhide ? 1 : 0 ), + duration = o.duration / anims, + animateTo = 0, + queue = elem.queue(), + queuelen = queue.length, + i; + + if ( show || !elem.is(":visible")) { + elem.css( "opacity", 0 ).show(); + animateTo = 1; + } + + // anims - 1 opacity "toggles" + for ( i = 1; i < anims; i++ ) { + elem.animate({ + opacity: animateTo + }, duration, o.easing ); + animateTo = 1 - animateTo; + } + + elem.animate({ + opacity: animateTo + }, duration, o.easing); + + elem.queue(function() { + if ( hide ) { + elem.hide(); + } + done(); + }); + + // We just queued up "anims" animations, we need to put them next in the queue + if ( queuelen > 1 ) { + queue.splice.apply( queue, + [ 1, 0 ].concat( queue.splice( queuelen, anims + 1 ) ) ); + } + elem.dequeue(); +}; + +})(jQuery); + +(function( $, undefined ) { + +$.effects.effect.puff = function( o, done ) { + var elem = $( this ), + mode = $.effects.setMode( elem, o.mode || "hide" ), + hide = mode === "hide", + percent = parseInt( o.percent, 10 ) || 150, + factor = percent / 100, + original = { + height: elem.height(), + width: elem.width(), + outerHeight: elem.outerHeight(), + outerWidth: elem.outerWidth() + }; + + $.extend( o, { + effect: "scale", + queue: false, + fade: true, + mode: mode, + complete: done, + percent: hide ? percent : 100, + from: hide ? + original : + { + height: original.height * factor, + width: original.width * factor, + outerHeight: original.outerHeight * factor, + outerWidth: original.outerWidth * factor + } + }); + + elem.effect( o ); +}; + +$.effects.effect.scale = function( o, done ) { + + // Create element + var el = $( this ), + options = $.extend( true, {}, o ), + mode = $.effects.setMode( el, o.mode || "effect" ), + percent = parseInt( o.percent, 10 ) || + ( parseInt( o.percent, 10 ) === 0 ? 0 : ( mode === "hide" ? 0 : 100 ) ), + direction = o.direction || "both", + origin = o.origin, + original = { + height: el.height(), + width: el.width(), + outerHeight: el.outerHeight(), + outerWidth: el.outerWidth() + }, + factor = { + y: direction !== "horizontal" ? (percent / 100) : 1, + x: direction !== "vertical" ? (percent / 100) : 1 + }; + + // We are going to pass this effect to the size effect: + options.effect = "size"; + options.queue = false; + options.complete = done; + + // Set default origin and restore for show/hide + if ( mode !== "effect" ) { + options.origin = origin || ["middle","center"]; + options.restore = true; + } + + options.from = o.from || ( mode === "show" ? { + height: 0, + width: 0, + outerHeight: 0, + outerWidth: 0 + } : original ); + options.to = { + height: original.height * factor.y, + width: original.width * factor.x, + outerHeight: original.outerHeight * factor.y, + outerWidth: original.outerWidth * factor.x + }; + + // Fade option to support puff + if ( options.fade ) { + if ( mode === "show" ) { + options.from.opacity = 0; + options.to.opacity = 1; + } + if ( mode === "hide" ) { + options.from.opacity = 1; + options.to.opacity = 0; + } + } + + // Animate + el.effect( options ); + +}; + +$.effects.effect.size = function( o, done ) { + + // Create element + var original, baseline, factor, + el = $( this ), + props0 = [ "position", "top", "bottom", "left", "right", "width", "height", "overflow", "opacity" ], + + // Always restore + props1 = [ "position", "top", "bottom", "left", "right", "overflow", "opacity" ], + + // Copy for children + props2 = [ "width", "height", "overflow" ], + cProps = [ "fontSize" ], + vProps = [ "borderTopWidth", "borderBottomWidth", "paddingTop", "paddingBottom" ], + hProps = [ "borderLeftWidth", "borderRightWidth", "paddingLeft", "paddingRight" ], + + // Set options + mode = $.effects.setMode( el, o.mode || "effect" ), + restore = o.restore || mode !== "effect", + scale = o.scale || "both", + origin = o.origin || [ "middle", "center" ], + position = el.css( "position" ), + props = restore ? props0 : props1, + zero = { + height: 0, + width: 0, + outerHeight: 0, + outerWidth: 0 + }; + + if ( mode === "show" ) { + el.show(); + } + original = { + height: el.height(), + width: el.width(), + outerHeight: el.outerHeight(), + outerWidth: el.outerWidth() + }; + + if ( o.mode === "toggle" && mode === "show" ) { + el.from = o.to || zero; + el.to = o.from || original; + } else { + el.from = o.from || ( mode === "show" ? zero : original ); + el.to = o.to || ( mode === "hide" ? zero : original ); + } + + // Set scaling factor + factor = { + from: { + y: el.from.height / original.height, + x: el.from.width / original.width + }, + to: { + y: el.to.height / original.height, + x: el.to.width / original.width + } + }; + + // Scale the css box + if ( scale === "box" || scale === "both" ) { + + // Vertical props scaling + if ( factor.from.y !== factor.to.y ) { + props = props.concat( vProps ); + el.from = $.effects.setTransition( el, vProps, factor.from.y, el.from ); + el.to = $.effects.setTransition( el, vProps, factor.to.y, el.to ); + } + + // Horizontal props scaling + if ( factor.from.x !== factor.to.x ) { + props = props.concat( hProps ); + el.from = $.effects.setTransition( el, hProps, factor.from.x, el.from ); + el.to = $.effects.setTransition( el, hProps, factor.to.x, el.to ); + } + } + + // Scale the content + if ( scale === "content" || scale === "both" ) { + + // Vertical props scaling + if ( factor.from.y !== factor.to.y ) { + props = props.concat( cProps ).concat( props2 ); + el.from = $.effects.setTransition( el, cProps, factor.from.y, el.from ); + el.to = $.effects.setTransition( el, cProps, factor.to.y, el.to ); + } + } + + $.effects.save( el, props ); + el.show(); + $.effects.createWrapper( el ); + el.css( "overflow", "hidden" ).css( el.from ); + + // Adjust + if (origin) { // Calculate baseline shifts + baseline = $.effects.getBaseline( origin, original ); + el.from.top = ( original.outerHeight - el.outerHeight() ) * baseline.y; + el.from.left = ( original.outerWidth - el.outerWidth() ) * baseline.x; + el.to.top = ( original.outerHeight - el.to.outerHeight ) * baseline.y; + el.to.left = ( original.outerWidth - el.to.outerWidth ) * baseline.x; + } + el.css( el.from ); // set top & left + + // Animate + if ( scale === "content" || scale === "both" ) { // Scale the children + + // Add margins/font-size + vProps = vProps.concat([ "marginTop", "marginBottom" ]).concat(cProps); + hProps = hProps.concat([ "marginLeft", "marginRight" ]); + props2 = props0.concat(vProps).concat(hProps); + + el.find( "*[width]" ).each( function(){ + var child = $( this ), + c_original = { + height: child.height(), + width: child.width(), + outerHeight: child.outerHeight(), + outerWidth: child.outerWidth() + }; + if (restore) { + $.effects.save(child, props2); + } + + child.from = { + height: c_original.height * factor.from.y, + width: c_original.width * factor.from.x, + outerHeight: c_original.outerHeight * factor.from.y, + outerWidth: c_original.outerWidth * factor.from.x + }; + child.to = { + height: c_original.height * factor.to.y, + width: c_original.width * factor.to.x, + outerHeight: c_original.height * factor.to.y, + outerWidth: c_original.width * factor.to.x + }; + + // Vertical props scaling + if ( factor.from.y !== factor.to.y ) { + child.from = $.effects.setTransition( child, vProps, factor.from.y, child.from ); + child.to = $.effects.setTransition( child, vProps, factor.to.y, child.to ); + } + + // Horizontal props scaling + if ( factor.from.x !== factor.to.x ) { + child.from = $.effects.setTransition( child, hProps, factor.from.x, child.from ); + child.to = $.effects.setTransition( child, hProps, factor.to.x, child.to ); + } + + // Animate children + child.css( child.from ); + child.animate( child.to, o.duration, o.easing, function() { + + // Restore children + if ( restore ) { + $.effects.restore( child, props2 ); + } + }); + }); + } + + // Animate + el.animate( el.to, { + queue: false, + duration: o.duration, + easing: o.easing, + complete: function() { + if ( el.to.opacity === 0 ) { + el.css( "opacity", el.from.opacity ); + } + if( mode === "hide" ) { + el.hide(); + } + $.effects.restore( el, props ); + if ( !restore ) { + + // we need to calculate our new positioning based on the scaling + if ( position === "static" ) { + el.css({ + position: "relative", + top: el.to.top, + left: el.to.left + }); + } else { + $.each([ "top", "left" ], function( idx, pos ) { + el.css( pos, function( _, str ) { + var val = parseInt( str, 10 ), + toRef = idx ? el.to.left : el.to.top; + + // if original was "auto", recalculate the new value from wrapper + if ( str === "auto" ) { + return toRef + "px"; + } + + return val + toRef + "px"; + }); + }); + } + } + + $.effects.removeWrapper( el ); + done(); + } + }); + +}; + +})(jQuery); + +(function( $, undefined ) { + +$.effects.effect.shake = function( o, done ) { + + var el = $( this ), + props = [ "position", "top", "bottom", "left", "right", "height", "width" ], + mode = $.effects.setMode( el, o.mode || "effect" ), + direction = o.direction || "left", + distance = o.distance || 20, + times = o.times || 3, + anims = times * 2 + 1, + speed = Math.round(o.duration/anims), + ref = (direction === "up" || direction === "down") ? "top" : "left", + positiveMotion = (direction === "up" || direction === "left"), + animation = {}, + animation1 = {}, + animation2 = {}, + i, + + // we will need to re-assemble the queue to stack our animations in place + queue = el.queue(), + queuelen = queue.length; + + $.effects.save( el, props ); + el.show(); + $.effects.createWrapper( el ); + + // Animation + animation[ ref ] = ( positiveMotion ? "-=" : "+=" ) + distance; + animation1[ ref ] = ( positiveMotion ? "+=" : "-=" ) + distance * 2; + animation2[ ref ] = ( positiveMotion ? "-=" : "+=" ) + distance * 2; + + // Animate + el.animate( animation, speed, o.easing ); + + // Shakes + for ( i = 1; i < times; i++ ) { + el.animate( animation1, speed, o.easing ).animate( animation2, speed, o.easing ); + } + el + .animate( animation1, speed, o.easing ) + .animate( animation, speed / 2, o.easing ) + .queue(function() { + if ( mode === "hide" ) { + el.hide(); + } + $.effects.restore( el, props ); + $.effects.removeWrapper( el ); + done(); + }); + + // inject all the animations we just queued to be first in line (after "inprogress") + if ( queuelen > 1) { + queue.splice.apply( queue, + [ 1, 0 ].concat( queue.splice( queuelen, anims + 1 ) ) ); + } + el.dequeue(); + +}; + +})(jQuery); + +(function( $, undefined ) { + +$.effects.effect.slide = function( o, done ) { + + // Create element + var el = $( this ), + props = [ "position", "top", "bottom", "left", "right", "width", "height" ], + mode = $.effects.setMode( el, o.mode || "show" ), + show = mode === "show", + direction = o.direction || "left", + ref = (direction === "up" || direction === "down") ? "top" : "left", + positiveMotion = (direction === "up" || direction === "left"), + distance, + animation = {}; + + // Adjust + $.effects.save( el, props ); + el.show(); + distance = o.distance || el[ ref === "top" ? "outerHeight" : "outerWidth" ]( true ); + + $.effects.createWrapper( el ).css({ + overflow: "hidden" + }); + + if ( show ) { + el.css( ref, positiveMotion ? (isNaN(distance) ? "-" + distance : -distance) : distance ); + } + + // Animation + animation[ ref ] = ( show ? + ( positiveMotion ? "+=" : "-=") : + ( positiveMotion ? "-=" : "+=")) + + distance; + + // Animate + el.animate( animation, { + queue: false, + duration: o.duration, + easing: o.easing, + complete: function() { + if ( mode === "hide" ) { + el.hide(); + } + $.effects.restore( el, props ); + $.effects.removeWrapper( el ); + done(); + } + }); +}; + +})(jQuery); + +(function( $, undefined ) { + +$.effects.effect.transfer = function( o, done ) { + var elem = $( this ), + target = $( o.to ), + targetFixed = target.css( "position" ) === "fixed", + body = $("body"), + fixTop = targetFixed ? body.scrollTop() : 0, + fixLeft = targetFixed ? body.scrollLeft() : 0, + endPosition = target.offset(), + animation = { + top: endPosition.top - fixTop , + left: endPosition.left - fixLeft , + height: target.innerHeight(), + width: target.innerWidth() + }, + startPosition = elem.offset(), + transfer = $( "
    " ) + .appendTo( document.body ) + .addClass( o.className ) + .css({ + top: startPosition.top - fixTop , + left: startPosition.left - fixLeft , + height: elem.innerHeight(), + width: elem.innerWidth(), + position: targetFixed ? "fixed" : "absolute" + }) + .animate( animation, o.duration, o.easing, function() { + transfer.remove(); + done(); + }); +}; + +})(jQuery); + +(function( $, undefined ) { + +$.widget( "ui.menu", { + version: "1.10.2", + defaultElement: "
    + {{ tool.name }} + {% if not is_child %} +
    {{ tool.versionName }} + {% endif %} +     		{{ tool.launchUrl }} + {% if tool.course is not empty %} + {{ tool.course.title }} + {% endif %} + {% if tool.session is not empty %} + ({{ tool.session.name }}) + {% endif %} + + {% if not is_child and tool.version == 'lti1p3' %} + + {{ 'webservices.png'|img(22, 'ConfigSettingsForTool'|get_plugin_lang('ImsLtiPlugin')) }} + + {% endif %} + + {% if not is_child %} + + {{ 'multiplicate_survey.png'|img(22, 'AddInCourses'|get_plugin_lang('ImsLtiPlugin')) }} + + {% endif %} + + {% if not is_child %} + + {{ 'session.png'|img(22, 'AddInSessions'|get_plugin_lang('ImsLtiPlugin')) }} + + {% endif %} + + {% if is_child %} + {% for category in categories %} + {% set url_eval_params = null %} + {% if tool.session is not empty %} + {% if category.get_course_code == tool.course.code and category.get_session_id == tool.session.id %} + {% set url_eval_params = {'selectcat': category.get_id, 'cidReq': tool.course.code, 'id_session': tool.session.id, 'gidReq': 0, 'gradebook': 0}|url_encode() %} + {% endif %} + {% else %} + {% if category.get_course_code == tool.course.code %} + {% set url_eval_params = {'selectcat': category.get_id, 'cidReq': tool.course.code, 'id_session': 0, 'gidReq': 0, 'gradebook': 0}|url_encode() %} + {% endif %} + {% endif %} + {% if url_eval_params is not null %} + + {{ 'gradebook.png'|img(22, 'MakeQualifiable'|get_lang) }} + + {% endif %} + {% endfor %} + {% endif %} + + + {{ 'edit.png'|img(22, 'Edit'|get_lang) }} + + + {{ 'delete.png'|img(22, 'Delete'|get_lang) }} + +
    + + + + + + + + + + {% for tool in tools %} + {{ table_tool.row_tool(tool, false, categories, _p) }} + {% for child_tool in tool.getChildren %} + {{ table_tool.row_tool(child_tool, true, categories, _p) }} + {% endfor %} + {% endfor %} + +
    {{ 'Name'|get_lang }}{{ 'LaunchUrl'|get_plugin_lang('ImsLtiPlugin') }}{{ 'Course'|get_lang }}{{ 'Actions'|get_lang }}
    +
    +{% endautoescape %} diff --git a/plugin/ims_lti/view/start.tpl b/plugin/ims_lti/view/start.tpl new file mode 100644 index 000000000..0bcc1c5d1 --- /dev/null +++ b/plugin/ims_lti/view/start.tpl @@ -0,0 +1,6 @@ +{% if tool.description %} +

    {{ tool.description|e|nl2br }}

    +{% endif %} +
    + +
    diff --git a/plugin/index.html b/plugin/index.html new file mode 100644 index 000000000..8e464d8ce --- /dev/null +++ b/plugin/index.html @@ -0,0 +1,8 @@ + + + + + +
    + + \ No newline at end of file diff --git a/plugin/jcapture/JCaptureApplet.html b/plugin/jcapture/JCaptureApplet.html new file mode 100644 index 000000000..22cd306a1 --- /dev/null +++ b/plugin/jcapture/JCaptureApplet.html @@ -0,0 +1,9 @@ + + + + + + + + diff --git a/plugin/jcapture/README.md b/plugin/jcapture/README.md new file mode 100644 index 000000000..a26f11a27 --- /dev/null +++ b/plugin/jcapture/README.md @@ -0,0 +1,12 @@ +JCapture +=== + +> DEPRECATED: This plugin is no longer maintained and will be removed in a future release. +> +> JCapture use the embed Java Applet element. This feature is no longer recommended. +> Though some browsers might still support it, it may have already been removed from the relevant web standards + + +The jCapture plugin integrates a set of JavaScript and Java Applet files that enable the recording of desktop screencasts directly into the Chamilo documents tool. + +By enabling the plugin, a new icon will appear in the action bar of the documents tool. \ No newline at end of file diff --git a/plugin/jcapture/action.php b/plugin/jcapture/action.php new file mode 100644 index 000000000..d4188cc78 --- /dev/null +++ b/plugin/jcapture/action.php @@ -0,0 +1,52 @@ + 'Pavel Vlasov', + 'email' => 'Pavel.Vlasov@nasdanika.com', + 'name' => 'JCapture', + 'desc' => 'Plugin for making screen captures.', + 'url' => 'http://www.nasdanika.com/wiki/doku.php?id=products:jcapture:start', + ]; + } + + /** + * Register the eventhandlers. + */ + public function register(&$controller) + { + $controller->register_hook('TOOLBAR_DEFINE', 'AFTER', $this, 'insert_button', []); + } + + /** + * Inserts the toolbar button. + */ + public function insert_button(&$event, $param) + { + $event->data[] = [ + 'type' => 'JCapture', + 'title' => 'Screen capture', + 'icon' => '../../plugins/jcapture/camera.png', + 'open' => '', + 'close' => '', + ]; + } +} diff --git a/plugin/jcapture/applet.php b/plugin/jcapture/applet.php new file mode 100644 index 000000000..e6a44b4d6 --- /dev/null +++ b/plugin/jcapture/applet.php @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + + + + + + + +Java 2 Standard Edition v 1.7 or above is required for this applet.
    + Download it from http://java.sun.com. +     + + + + diff --git a/plugin/jcapture/camera.png b/plugin/jcapture/camera.png new file mode 100644 index 000000000..f7cbba0a8 Binary files /dev/null and b/plugin/jcapture/camera.png differ diff --git a/plugin/jcapture/jcapture.jnlp b/plugin/jcapture/jcapture.jnlp new file mode 100644 index 000000000..310d39268 --- /dev/null +++ b/plugin/jcapture/jcapture.jnlp @@ -0,0 +1,21 @@ + + + + jCapture Applet + Hammurapi Group + + + + + + + + + + + + diff --git a/plugin/jcapture/lib/apache-mime4j-0.6.jar b/plugin/jcapture/lib/apache-mime4j-0.6.jar new file mode 100644 index 000000000..0e65158e0 Binary files /dev/null and b/plugin/jcapture/lib/apache-mime4j-0.6.jar differ diff --git a/plugin/jcapture/lib/commons-codec-1.3.jar b/plugin/jcapture/lib/commons-codec-1.3.jar new file mode 100644 index 000000000..52931a897 Binary files /dev/null and b/plugin/jcapture/lib/commons-codec-1.3.jar differ diff --git a/plugin/jcapture/lib/commons-logging-1.1.1.jar b/plugin/jcapture/lib/commons-logging-1.1.1.jar new file mode 100644 index 000000000..19ab11415 Binary files /dev/null and b/plugin/jcapture/lib/commons-logging-1.1.1.jar differ diff --git a/plugin/jcapture/lib/httpclient-4.0.1.jar b/plugin/jcapture/lib/httpclient-4.0.1.jar new file mode 100644 index 000000000..d1433c799 Binary files /dev/null and b/plugin/jcapture/lib/httpclient-4.0.1.jar differ diff --git a/plugin/jcapture/lib/httpcore-4.0.1.jar b/plugin/jcapture/lib/httpcore-4.0.1.jar new file mode 100644 index 000000000..6cf82c55c Binary files /dev/null and b/plugin/jcapture/lib/httpcore-4.0.1.jar differ diff --git a/plugin/jcapture/lib/httpmime-4.0.1.jar b/plugin/jcapture/lib/httpmime-4.0.1.jar new file mode 100644 index 000000000..47f15d967 Binary files /dev/null and b/plugin/jcapture/lib/httpmime-4.0.1.jar differ diff --git a/plugin/jcapture/lib/jcapture.jar b/plugin/jcapture/lib/jcapture.jar new file mode 100644 index 000000000..663c474af Binary files /dev/null and b/plugin/jcapture/lib/jcapture.jar differ diff --git a/plugin/jcapture/lib/transform-3.0.2.jar b/plugin/jcapture/lib/transform-3.0.2.jar new file mode 100644 index 000000000..527318393 Binary files /dev/null and b/plugin/jcapture/lib/transform-3.0.2.jar differ diff --git a/plugin/jcapture/license.txt b/plugin/jcapture/license.txt new file mode 100644 index 000000000..0c73c0553 --- /dev/null +++ b/plugin/jcapture/license.txt @@ -0,0 +1 @@ +GPL v 2 \ No newline at end of file diff --git a/plugin/jcapture/plugin.php b/plugin/jcapture/plugin.php new file mode 100644 index 000000000..cd3975d71 --- /dev/null +++ b/plugin/jcapture/plugin.php @@ -0,0 +1,12 @@ + 'Jcapture Screencast', + 'comment' => "Screencast widget", + 'version' => '1.0', + 'author' => 'Julio Montoya', +]; diff --git a/plugin/jcapture/plugin_applet.php b/plugin/jcapture/plugin_applet.php new file mode 100644 index 000000000..a9fc036ab --- /dev/null +++ b/plugin/jcapture/plugin_applet.php @@ -0,0 +1,84 @@ +getInstalledPlugins(); +$capturePluginInstalled = in_array('jcapture', $pluginList); +if (!$capturePluginInstalled) { + exit; +} + +$capturePath = api_get_path(WEB_PLUGIN_PATH).'jcapture/'; +$hostName = api_get_path(WEB_PATH); + +define('DOKU_BASE', '/tmp'); +function getSecurityToken() +{ +} + +//close sesseion +session_write_close(); + +header('Content-Type: text/html; charset=utf-8'); +$imageFormat = "PNG"; +$cookies = null; +foreach (array_keys($_COOKIE) as $cookieName) { + $cookies .= bin2hex($cookieName)."=".bin2hex($_COOKIE[$cookieName]).";"; +} + +$pageName = 'file'; +$edid = '1'; +?> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugin/jcapture/script.js b/plugin/jcapture/script.js new file mode 100644 index 000000000..b5f0234c5 --- /dev/null +++ b/plugin/jcapture/script.js @@ -0,0 +1,19 @@ +function addBtnActionJCapture($btn, props, edid) { + $btn.click(function() { + var jCaptureApplet = document.getElementById("jCaptureApplet"); + if (jCaptureApplet==null) { + var oNewDiv = document.createElement("div"); + oNewDiv.id="jCaptureAppletDiv"; + //oNewDiv.style.display='none'; + document.body.appendChild(oNewDiv); + jQuery("#jCaptureAppletDiv").load(DOKU_BASE+"lib/plugins/jcapture/applet.php?edid="+edid+"&pageName="+document.forms['dw__editform'].elements['id'].value); + } else { + jCaptureApplet.showCaptureFrame(); + } + return false; + }); + + return true; +} + + diff --git a/plugin/jcapture/src/META-INF/services/com.hammurapi.jcapture.VideoEncoder b/plugin/jcapture/src/META-INF/services/com.hammurapi.jcapture.VideoEncoder new file mode 100644 index 000000000..1fbadfcc9 --- /dev/null +++ b/plugin/jcapture/src/META-INF/services/com.hammurapi.jcapture.VideoEncoder @@ -0,0 +1 @@ +com.hammurapi.jcapture.SwfEncoder \ No newline at end of file diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/AWTUtilitiesTranslucener.java b/plugin/jcapture/src/com/hammurapi/jcapture/AWTUtilitiesTranslucener.java new file mode 100644 index 000000000..e4ecc2334 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/AWTUtilitiesTranslucener.java @@ -0,0 +1,17 @@ +package com.hammurapi.jcapture; + +import java.awt.Frame; + +import com.sun.awt.AWTUtilities; +import com.sun.awt.AWTUtilities.Translucency; + +public class AWTUtilitiesTranslucener extends Translucener { + + @Override + protected void makeTranslucent(Frame frame) { + if (AWTUtilities.isTranslucencySupported(Translucency.TRANSLUCENT)) { + AWTUtilities.setWindowOpacity(frame, 0.7f); + } + } + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/AbstractCaptureApplet.java b/plugin/jcapture/src/com/hammurapi/jcapture/AbstractCaptureApplet.java new file mode 100644 index 000000000..54db002f4 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/AbstractCaptureApplet.java @@ -0,0 +1,275 @@ +package com.hammurapi.jcapture; + +import java.awt.Component; +import java.io.Closeable; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.InputStream; +import java.io.OutputStream; +import java.net.ProxySelector; +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Iterator; +import java.util.Properties; +import java.util.StringTokenizer; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.ThreadFactory; + +import javax.swing.JApplet; +import javax.swing.JOptionPane; +import javax.swing.ProgressMonitorInputStream; +import javax.swing.SwingUtilities; + +import org.apache.commons.codec.DecoderException; +import org.apache.commons.codec.binary.Hex; +import org.apache.commons.codec.net.URLCodec; +import org.apache.http.HttpResponse; +import org.apache.http.client.methods.HttpUriRequest; +import org.apache.http.entity.mime.content.InputStreamBody; +import org.apache.http.impl.client.DefaultHttpClient; +import org.apache.http.impl.conn.ProxySelectorRoutePlanner; + +/** + * Base class for capture applets. + * @author Pavel + * + */ +public abstract class AbstractCaptureApplet extends JApplet { + + private static final String OUTPUT_DIR_PARAMETER = "outputDir"; + + private CaptureFrame captureFrame; + + @Override + public void stop() { + if (captureFrame!=null) { + captureFrame.dispose(); + captureFrame = null; + } + backgroundProcessor.shutdown(); + synchronized (closeables) { + Iterator cit = closeables.iterator(); + while (cit.hasNext()) { + try { + cit.next().close(); + } catch (Exception e) { + e.printStackTrace(); + } + cit.remove(); + } + } + super.stop(); + } + + /** + * Adds closeable to close in applet stop() method. + * @param closeable + */ + public void addCloseable(Closeable closeable) { + synchronized (closeables) { + closeables.add(closeable); + } + } + + private Collection closeables = new ArrayList(); + + public void showCaptureFrame() { + System.out.println("Showing capture frame"); + SwingUtilities.invokeLater(new Runnable() { + + @Override + public void run() { + try { + if (captureFrame==null) { + createCaptureFrame(); + } + captureFrame.setVisible(true); + } catch (Exception e) { + e.printStackTrace(); + } + } + + }); + } + + private ExecutorService backgroundProcessor; + + @Override + public void start() { + super.start(); + + ThreadFactory threadFactory = new ThreadFactory() { + + @Override + public Thread newThread(Runnable r) { + Thread th=new Thread(r, "Background processor"); + th.setPriority(Thread.NORM_PRIORITY); + return th; + } + }; + backgroundProcessor = Executors.newSingleThreadExecutor(threadFactory); + + SwingUtilities.invokeLater(new Runnable() { + + public void run() { + createCaptureFrame(); + } + + }); + + try { + // Proxy configuration - requires java.net.NetPermission getProxySelector + proxySelector = ProxySelector.getDefault(); + } catch (Exception e) { + System.err.println("Can't obtain proxy information: "+e); + e.printStackTrace(); + } + } + + public ExecutorService getBackgroundProcessor() { + return backgroundProcessor; + } + + protected void createCaptureFrame() { + try { + captureFrame = new CaptureFrame(this); + captureFrame.setVisible(true); + } catch (Exception e) { + JOptionPane.showMessageDialog( + null, + "Error: "+e, + "Cannot create capture window", + JOptionPane.ERROR_MESSAGE); + e.printStackTrace(); + } + } + + public static String formatByteSize(long bytes) { + if (bytes<1024) { + return bytes + "bytes"; + } + if (bytes<1024*1024) { + return MessageFormat.format("{0,number,0.0} Kb", new Object[] {(double) bytes/1024.0}); + } + if (bytes<1024*1024*1024) { + return MessageFormat.format("{0,number,0.00} Mb", new Object[] {(double) bytes/(double) (1024.0*1024.0)}); + } + return MessageFormat.format("{0,number,0.00} Gb", new Object[] {(double) bytes/(double) (1024.0*1024.0*1024.0)}); + } + + + protected File preferencesFile = new File(System.getProperty("user.home")+File.separator+"."+getClass().getName()+".properties"); + + public Properties loadConfig() { + try { + if (preferencesFile.isFile()) { + InputStream configStream = new FileInputStream(preferencesFile); + Properties ret = new Properties(); + ret.load(configStream); + configStream.close(); + return ret; + } + } catch (Exception e) { + e.printStackTrace(); + } + return null; + } + + public void storeConfig(Properties properties) { + try { + FileOutputStream out = new FileOutputStream(preferencesFile); + properties.store(out, "Config"); + out.close(); + } catch (Exception e) { + e.printStackTrace(); + } + } + + protected String getCookies() throws DecoderException { + String cookiesStr = getParameter("cookies"); + if (cookiesStr==null) { + return null; + } + + StringBuilder ret = new StringBuilder(); + StringTokenizer st = new StringTokenizer(cookiesStr, ";"); + while (st.hasMoreTokens()) { + String tok = st.nextToken(); + int idx = tok.indexOf("="); + ret.append(hex2urlEncoded(tok.substring(0, idx))); + ret.append("="); + ret.append(hex2urlEncoded(tok.substring(idx+1))); + if (st.hasMoreElements()) { + ret.append(";"); + } + } + + return ret.toString(); + } + + private String hex2urlEncoded(String hexStr) throws DecoderException { + return new String(URLCodec.encodeUrl(null, Hex.decodeHex(hexStr.toCharArray()))); + } + + protected ProxySelector proxySelector; + + /** + * Posts capture/recording to the web site. + * @param parentComponent Parent component for the progress bar. + * @param content Content - file or byte array. + * @param fileName File name. + * @param mimeType Mime type. + * @return + * @throws Exception + */ + public HttpResponse post( + Component parentComponent, + final InputStream content, + final long contentLength, + String fileName, + String mimeType) throws Exception { + + + System.out.println("jCapture applet, build @@@time@@@"); + + /** + * Debugging - save to file. + */ + if (getParameter(OUTPUT_DIR_PARAMETER)!=null) { + OutputStream out = new FileOutputStream(new File(getParameter(OUTPUT_DIR_PARAMETER)+File.separator+fileName)); + byte[] buf=new byte[4096]; + int l; + while ((l=content.read(buf))!=-1) { + out.write(buf, 0, l); + } + out.close(); + content.close(); + return null; + } + + ProgressMonitorInputStream pmis = new ProgressMonitorInputStream(parentComponent, "Uploading "+ fileName + " ("+formatByteSize(contentLength)+")", content); + InputStreamBody bin = new InputStreamBody(pmis, mimeType, bodyName(fileName)) { + + @Override + public long getContentLength() { + return contentLength; + } + }; + + DefaultHttpClient httpClient = new DefaultHttpClient(); + if (proxySelector!=null) { + ProxySelectorRoutePlanner routePlanner = new ProxySelectorRoutePlanner( + httpClient.getConnectionManager().getSchemeRegistry(), + proxySelector); + httpClient.setRoutePlanner(routePlanner); + } + return httpClient.execute(createRequest(fileName, bin)); + } + + protected abstract HttpUriRequest createRequest(String fileName, InputStreamBody bin) throws Exception; + + protected abstract String bodyName(String fileName); +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/ButtonManager.java b/plugin/jcapture/src/com/hammurapi/jcapture/ButtonManager.java new file mode 100644 index 000000000..eb9bbfc9a --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/ButtonManager.java @@ -0,0 +1,85 @@ +package com.hammurapi.jcapture; +import java.io.IOException; +import java.net.URL; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.zip.DataFormatException; + +import com.flagstone.transform.DefineTag; +import com.flagstone.transform.Movie; +import com.flagstone.transform.MovieTag; +import com.flagstone.transform.Place2; +import com.flagstone.transform.datatype.CoordTransform; + + +public class ButtonManager { + + private final Map buttons; + private final List definitions; + + public ButtonManager() { + buttons = new HashMap(); + definitions = new ArrayList(); + } + + public void loadLibrary(URL libUrl) throws IOException, DataFormatException { + Movie movie = new Movie(); + movie.decodeFromUrl(libUrl); + findDefinitions(movie, definitions); + findButtons(movie, buttons); + } + + public int maxIdentifier() { + int identifier = 0; + DefineTag object; + for (Iteratoriter = definitions.iterator(); iter.hasNext();) { + object = iter.next(); + if (object.getIdentifier() > identifier) { + identifier = object.getIdentifier(); + } + } + return identifier; + } + + public List getDefinitions() { + List list = new ArrayList(definitions.size()); + for (Iteratoriter = definitions.iterator(); iter.hasNext();) { + list.add((DefineTag) iter.next().copy()); + } + return list; + } + + public Place2 getButton(final String name, final int layer, final int xpos, final int ypos) { + Place2 place = (Place2)buttons.get(name).copy(); + place.setLayer(layer); + place.setTransform(new CoordTransform(1, 1, 0, 0, xpos, ypos)); + return place; + } + + private void findDefinitions(final Movie movie, final List list) { + MovieTag object; + for (Iterator iter = movie.getObjects().iterator(); iter.hasNext();) { + object = iter.next(); + if (object instanceof DefineTag) { + list.add((DefineTag)object); + } + } + } + + private void findButtons(final Movie movie, final Map list) { + MovieTag object; + Place2 place; + for (Iteratoriter = movie.getObjects().iterator(); iter.hasNext();) { + object = iter.next(); + if (object instanceof Place2) { + place = (Place2)object; + if (place.getName() != null) { + list.put(place.getName(), place); + } + } + } + } +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/CaptureConfig.java b/plugin/jcapture/src/com/hammurapi/jcapture/CaptureConfig.java new file mode 100644 index 000000000..fbd6a0ab8 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/CaptureConfig.java @@ -0,0 +1,370 @@ +package com.hammurapi.jcapture; + +import java.awt.AWTException; +import java.awt.Component; +import java.awt.MouseInfo; +import java.awt.Point; +import java.awt.Rectangle; +import java.awt.Robot; +import java.awt.image.BufferedImage; +import java.io.IOException; +import java.nio.channels.FileChannel; +import java.util.ArrayList; +import java.util.Collections; +import java.util.Comparator; +import java.util.Iterator; +import java.util.List; +import java.util.Properties; +import java.util.ServiceLoader; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Future; + +import javax.sound.sampled.AudioFormat; + +public class CaptureConfig implements VideoEncoder.Config { + + private static final String MP3_COMMAND_PROPERTY = "mp3command"; + private static final String TOOL_BAR_PROPERTY = "toolBar"; + private static final String SPEED_SCALE_PROPERTY = "speedScale"; + private static final String SOUND_PROPERTY = "sound"; + private static final String SCREEN_SCALE_PROPERTY = "screenScale"; + private static final String REMOVE_INACTIVITY_PROPERTY = "removeInactivity"; + private static final String PLAY_PROPERTY = "play"; + private static final String MOUSE_PROPERTY = "mouse"; + private static final String MIXER_NAME_PROPERTY = "mixerName"; + private static final String LOOP_PROPERTY = "loop"; + private static final String INACTIVITY_INTERVAL_PROPERTY = "inactivityInterval"; + private static final String IMAGE_FORMAT_PROPERTY = "imageFormat"; + private static final String FRAMES_PER_SECOND_PROPERTY = "framesPerSecond"; + private static final String BORDER_PROPERTY = "border"; + private static final String RECORDING_RECTANGLE_PROPERTY = "recordingRectangle"; + private static final String ENCODER_NAME_PROPERTY = "encoderName"; + private static final String AUDIO_FORMAT_SAMPLE_SIZE_PROPERTY = "audioFormat.sampleSize"; + private static final String AUDIO_FORMAT_SAMPLE_RATE_PROPERTY = "audioFormat.sampleRate"; + private static final String AUDIO_FORMAT_CHANNELS_PROPERTY = "audioFormat.channels"; + private AudioFormat audioFormat = new AudioFormat(22050.0F, 16, 1, true, false);; + private String mixerName; + private float framesPerSecond = 10.0f; + private double screenScale = 1.0; + private float speedScale = 1.0f; + private boolean removeInactivity; + private double inactivityInterval = 0.7; + private Component parentComponent; + private Rectangle recordingRectangle; + private boolean border = true; + private boolean toolBar = true; + private Robot robot; + private String imageFormat = "PNG"; + private boolean sound = true; + private boolean mouse = true; + private boolean loop = true; + private boolean play = false; + private VideoEncoder encoder; + private int grabRange = 3; + private ExecutorService backgroundProcessor; + private String mp3command; + + public String getMp3command() { + return mp3command; + } + + public void setMp3command(String mp3command) { + this.mp3command = mp3command; + } + + public int getGrabRange() { + return grabRange; + } + + public ExecutorService getBackgroundProcessor() { + return backgroundProcessor; + } + + public void setBackgroundProcessor(ExecutorService backgroundProcessor) { + this.backgroundProcessor = backgroundProcessor; + } + + public void setGrabRange(int grabRange) { + this.grabRange = grabRange; + } + + public VideoEncoder getEncoder() { + return encoder; + } + + public void setEncoder(VideoEncoder encoder) { + this.encoder = encoder; + } + + public boolean isLoop() { + return loop; + } + + public void setLoop(boolean loop) { + this.loop = loop; + } + + public boolean isPlay() { + return play; + } + + public void setPlay(boolean play) { + this.play = play; + } + + public boolean isSound() { + return sound; + } + + public void setSound(boolean sound) { + this.sound = sound; + } + + public boolean isMouse() { + return mouse; + } + + public void setMouse(boolean mouse) { + this.mouse = mouse; + } + + public String getImageFormat() { + return imageFormat; + } + + public void setImageFormat(String imageFormat) { + this.imageFormat = imageFormat; + } + + public CaptureConfig() throws AWTException { + robot = new Robot(); + + ServiceLoader sl = ServiceLoader.load(VideoEncoder.class); + List accumulator = new ArrayList(); + Iterator vit = sl.iterator(); + while (vit.hasNext()) { + accumulator.add(vit.next()); + } + + Collections.sort(accumulator, new Comparator() { + + @Override + public int compare(VideoEncoder o1, VideoEncoder o2) { + return o1.toString().compareTo(o2.toString()); + } + + }); + + encoders = Collections.unmodifiableList(accumulator); + if (encoder==null && !encoders.isEmpty()) { + encoder = encoders.get(0); + } + + } + + /** + * Submits screenshot for processing in a background thread. + * @param task + * @return + */ + public Future submit(ScreenShot task) { + return backgroundProcessor.submit(task); + } + + public Robot getRobot() { + return robot; + } + + public ScreenShot createScreenShot(ScreenShot prev, FileChannel imageChannel) throws IOException { + BufferedImage image = robot.createScreenCapture(recordingRectangle); + Point mouseLocation = MouseInfo.getPointerInfo().getLocation(); + if (mouse && recordingRectangle.contains(mouseLocation)) { + mouseLocation.move(mouseLocation.x-recordingRectangle.x, mouseLocation.y-recordingRectangle.y); + } else { + mouseLocation = null; + } + return new ScreenShot( + image, + mouseLocation, + prev, + System.currentTimeMillis(), + grabRange, + isTransparencySupported(), + border, + getScreenScale(), + imageChannel, + getImageFormat()); + } + + public boolean isTransparencySupported() { + return !"jpeg".equalsIgnoreCase(getImageFormat()) + && !"jpg".equalsIgnoreCase(getImageFormat()); + } + + public boolean isToolBar() { + return toolBar; + } + public void setToolBar(boolean toolBar) { + this.toolBar = toolBar; + } + public boolean isBorder() { + return border; + } + public void setBorder(boolean border) { + this.border = border; + } + public Rectangle getRecordingRectangle() { + return recordingRectangle; + } + public Properties setRecordingRectangle(Rectangle recordingRectangle) { + Rectangle oldValue = this.recordingRectangle; + this.recordingRectangle = recordingRectangle; + if (this.recordingRectangle!=null && !this.recordingRectangle.equals(oldValue)) { + return store(); + } + return null; + } + public AudioFormat getAudioFormat() { + return audioFormat; + } + public void setAudioFormat(AudioFormat audioFormat) { + this.audioFormat = audioFormat; + } + public String getMixerName() { + return mixerName; + } + public void setMixerName(String mixerName) { + this.mixerName = mixerName; + } + public float getFramesPerSecond() { + return framesPerSecond; + } + public void setFramesPerSecond(float framesPerSecond) { + this.framesPerSecond = framesPerSecond; + } + public double getScreenScale() { + return screenScale; + } + public void setScreenScale(double screenScale) { + this.screenScale = screenScale; + } + public float getSpeedScale() { + return speedScale; + } + public void setSpeedScale(float speedScale) { + this.speedScale = speedScale; + } + public boolean isRemoveInactivity() { + return removeInactivity; + } + public void setRemoveInactivity(boolean removeInactivity) { + this.removeInactivity = removeInactivity; + } + public double getInactivityInterval() { + return inactivityInterval; + } + public void setInactivityInterval(double inactivityInterval) { + this.inactivityInterval = inactivityInterval; + } + public Component getParentComponent() { + return parentComponent; + } + public void setParentComponent(Component parentComponent) { + this.parentComponent = parentComponent; + } + + void load(Properties properties) { + if (properties!=null) { + try { + if (properties.containsKey(AUDIO_FORMAT_CHANNELS_PROPERTY)) { + audioFormat = new AudioFormat( + Float.parseFloat(properties.getProperty(AUDIO_FORMAT_SAMPLE_RATE_PROPERTY, String.valueOf(audioFormat.getSampleRate()))), + Integer.parseInt(properties.getProperty(AUDIO_FORMAT_SAMPLE_SIZE_PROPERTY, String.valueOf(audioFormat.getSampleSizeInBits()))), + Integer.parseInt(properties.getProperty(AUDIO_FORMAT_CHANNELS_PROPERTY, String.valueOf(audioFormat.getChannels()))), + true, false); + } + + border=Boolean.parseBoolean(properties.getProperty(BORDER_PROPERTY, String.valueOf(border))); + framesPerSecond=Float.parseFloat(properties.getProperty(FRAMES_PER_SECOND_PROPERTY, String.valueOf(framesPerSecond))); + imageFormat=properties.getProperty(IMAGE_FORMAT_PROPERTY, String.valueOf(imageFormat)); + inactivityInterval=Double.parseDouble(properties.getProperty(INACTIVITY_INTERVAL_PROPERTY, String.valueOf(inactivityInterval))); + loop=Boolean.parseBoolean(properties.getProperty(LOOP_PROPERTY, String.valueOf(loop))); + mixerName=properties.getProperty(MIXER_NAME_PROPERTY, String.valueOf(mixerName)); + mouse=Boolean.parseBoolean(properties.getProperty(MOUSE_PROPERTY, String.valueOf(mouse))); + play=Boolean.parseBoolean(properties.getProperty(PLAY_PROPERTY, String.valueOf(play))); + removeInactivity=Boolean.parseBoolean(properties.getProperty(REMOVE_INACTIVITY_PROPERTY, String.valueOf(removeInactivity))); + screenScale=Double.parseDouble(properties.getProperty(SCREEN_SCALE_PROPERTY, String.valueOf(screenScale))); + sound=Boolean.parseBoolean(properties.getProperty(SOUND_PROPERTY, String.valueOf(sound))); + speedScale=Float.parseFloat(properties.getProperty(SPEED_SCALE_PROPERTY, String.valueOf(speedScale))); + toolBar=Boolean.parseBoolean(properties.getProperty(TOOL_BAR_PROPERTY, String.valueOf(toolBar))); + mp3command=properties.getProperty(MP3_COMMAND_PROPERTY); + encoder = null; + String encoderName = properties.getProperty(ENCODER_NAME_PROPERTY); + if (encoderName!=null) { + for (VideoEncoder candidate: getEncoders()) { + if (encoderName.equals(candidate.toString())) { + encoder = candidate; + break; + } + } + } + if (encoder==null && !getEncoders().isEmpty()) { + encoder = getEncoders().get(0); + } + + String rr = properties.getProperty(RECORDING_RECTANGLE_PROPERTY); + if (rr!=null && rr.trim().length()>0) { + String[] dims = rr.split(";"); + recordingRectangle = new Rectangle(Integer.parseInt(dims[0]), Integer.parseInt(dims[1]), Integer.parseInt(dims[2]), Integer.parseInt(dims[3])); + } + + } catch (Exception e) { + e.printStackTrace(); + } + } + } + + private List encoders; + + /** + * @return array of available encoders. + */ + public List getEncoders() { + return encoders; + } + + Properties store() { + Properties properties = new Properties(); + if (audioFormat!=null) { + properties.setProperty(AUDIO_FORMAT_CHANNELS_PROPERTY, String.valueOf(audioFormat.getChannels())); + properties.setProperty(AUDIO_FORMAT_SAMPLE_RATE_PROPERTY, String.valueOf(audioFormat.getSampleRate())); + properties.setProperty(AUDIO_FORMAT_SAMPLE_SIZE_PROPERTY, String.valueOf(audioFormat.getSampleSizeInBits())); + } + properties.setProperty(BORDER_PROPERTY, String.valueOf(border)); + properties.setProperty(FRAMES_PER_SECOND_PROPERTY, String.valueOf(framesPerSecond)); + properties.setProperty(IMAGE_FORMAT_PROPERTY, String.valueOf(imageFormat)); + properties.setProperty(INACTIVITY_INTERVAL_PROPERTY, String.valueOf(inactivityInterval)); + properties.setProperty(LOOP_PROPERTY, String.valueOf(loop)); + properties.setProperty(MIXER_NAME_PROPERTY, String.valueOf(mixerName)); + properties.setProperty(MOUSE_PROPERTY, String.valueOf(mouse)); + properties.setProperty(PLAY_PROPERTY, String.valueOf(play)); + properties.setProperty(REMOVE_INACTIVITY_PROPERTY, String.valueOf(removeInactivity)); + properties.setProperty(SCREEN_SCALE_PROPERTY, String.valueOf(screenScale)); + properties.setProperty(SOUND_PROPERTY, String.valueOf(sound)); + properties.setProperty(SPEED_SCALE_PROPERTY, String.valueOf(speedScale)); + properties.setProperty(TOOL_BAR_PROPERTY, String.valueOf(toolBar)); + if (recordingRectangle!=null) { + properties.setProperty(RECORDING_RECTANGLE_PROPERTY, recordingRectangle.x+";"+recordingRectangle.y+";"+recordingRectangle.width+";"+recordingRectangle.height); + } + if (mp3command!=null) { + properties.setProperty(MP3_COMMAND_PROPERTY, mp3command); + } + if (encoder!=null) { + properties.setProperty(ENCODER_NAME_PROPERTY, encoder.toString()); + } + + return properties; + } + + +} \ No newline at end of file diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/CaptureFrame.java b/plugin/jcapture/src/com/hammurapi/jcapture/CaptureFrame.java new file mode 100644 index 000000000..23e0d10bf --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/CaptureFrame.java @@ -0,0 +1,405 @@ +package com.hammurapi.jcapture; +import java.awt.BorderLayout; +import java.awt.Color; +import java.awt.Dimension; +import java.awt.Insets; +import java.awt.Point; +import java.awt.Rectangle; +import java.awt.Toolkit; +import java.awt.event.ActionEvent; +import java.awt.event.ComponentAdapter; +import java.awt.event.ComponentEvent; +import java.awt.event.ComponentListener; +import java.awt.image.BufferedImage; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.text.SimpleDateFormat; +import java.util.Date; +import java.util.Properties; +import java.util.concurrent.atomic.AtomicBoolean; + +import javax.imageio.ImageIO; +import javax.swing.AbstractAction; +import javax.swing.JButton; +import javax.swing.JFrame; +import javax.swing.JLabel; +import javax.swing.JOptionPane; +import javax.swing.JPanel; +import javax.swing.SwingUtilities; +import javax.swing.SwingWorker; +import javax.swing.border.LineBorder; + +import netscape.javascript.JSObject; + +import org.apache.http.HttpResponse; +import org.apache.http.HttpStatus; + +/** + * License: LGPL. + * @author Pavel Vlasov. + * + */ +public class CaptureFrame extends javax.swing.JFrame { + private JPanel capturePanel; + private SimpleDateFormat dateFormat = new SimpleDateFormat("yyyyMMddHHmmss-SSS"); + private int counter; + private CaptureConfig captureConfig; + private AbstractCaptureApplet applet; + private JButton recordButton; + + public CaptureConfig getCaptureConfig() { + return captureConfig; + } + + public CaptureFrame(final AbstractCaptureApplet applet) throws Exception { + super("Screen capture"); + setIconImage(Toolkit.getDefaultToolkit().getImage(getClass().getResource("camera.png"))); + + setUndecorated(true); + + Translucener.makeFrameTranslucent(this); + + setAlwaysOnTop(true); + this.applet = applet; + captureConfig = new CaptureConfig(); + captureConfig.load(applet.loadConfig()); + captureConfig.setBackgroundProcessor(applet.getBackgroundProcessor()); + + //--- GUI construction --- + + capturePanel = new JPanel(); + + final JLabel dimensionsLabel = new JLabel(""); + capturePanel.add(dimensionsLabel, BorderLayout.CENTER); + + capturePanel.addComponentListener(new ComponentAdapter() { + + @Override + public void componentResized(ComponentEvent e) { + super.componentResized(e); + dimensionsLabel.setText(e.getComponent().getWidth()+" x "+e.getComponent().getHeight()); + } + }); + + JButton captureButton = new JButton(new AbstractAction() { + + @Override + public void actionPerformed(ActionEvent e) { + Rectangle bounds = capturePanel.getBounds(); + Point loc = bounds.getLocation(); + SwingUtilities.convertPointToScreen(loc, capturePanel); + bounds.setLocation(loc); + Properties props = captureConfig.setRecordingRectangle(bounds); + if (props!=null) { + getApplet().storeConfig(props); + } + capturing.set(true); + setVisible(false); + } + + }); + captureButton.setText("Capture"); + captureButton.setToolTipText("Create a snapshot of the screen"); + capturePanel.add(captureButton, BorderLayout.CENTER); + + recordButton = new JButton(new AbstractAction() { + + @Override + public void actionPerformed(ActionEvent e) { + Rectangle bounds = capturePanel.getBounds(); + Point loc = bounds.getLocation(); + SwingUtilities.convertPointToScreen(loc, capturePanel); + bounds.setLocation(loc); + Properties props = captureConfig.setRecordingRectangle(bounds); + if (props!=null) { + getApplet().storeConfig(props); + } + recording.set(true); + setVisible(false); + } + + }); + recordButton.setText("Record"); + setRecordButtonState(); + capturePanel.add(recordButton, BorderLayout.CENTER); + + JButton optionsButton = new JButton(new AbstractAction() { + + @Override + public void actionPerformed(ActionEvent e) { + new CaptureOptionsDialog(CaptureFrame.this).setVisible(true); + } + + }); + optionsButton.setText("Options"); + capturePanel.add(optionsButton, BorderLayout.CENTER); + + JButton cancelButton = new JButton(new AbstractAction() { + + @Override + public void actionPerformed(ActionEvent e) { + CaptureFrame.this.setVisible(false); + } + + }); + cancelButton.setText("Cancel"); + capturePanel.add(cancelButton, BorderLayout.CENTER); + + getContentPane().add(capturePanel, BorderLayout.CENTER); + + capturePanel.setBorder(new LineBorder(new java.awt.Color(0,0,0), 1, false)); + + if (captureConfig.getRecordingRectangle()==null) { + setSize(400, 300); + setLocationRelativeTo(null); + } else { + setBounds(captureConfig.getRecordingRectangle()); + } + + Insets dragInsets = new Insets(5, 5, 5, 5); + new ComponentResizer(dragInsets, this); + + ComponentMover cm = new ComponentMover(); + cm.registerComponent(this); + cm.setDragInsets(dragInsets); + + addComponentListener(new ComponentListener() { + + @Override + public void componentShown(ComponentEvent e) { + // TODO Auto-generated method stub + + } + + @Override + public void componentResized(ComponentEvent e) { + // TODO Auto-generated method stub + + } + + @Override + public void componentMoved(ComponentEvent e) { + // TODO Auto-generated method stub + + } + + @Override + public void componentHidden(ComponentEvent e) { + if (capturing.get()) { + capturing.set(false); + try { + capture(); + } catch (Exception ex) { + ex.printStackTrace(); + } + } else if (recording.get()) { + recording.set(false); + record(); + } + } + }); + + } + + void setRecordButtonState() { + if (captureConfig.getEncoder()==null) { + recordButton.setEnabled(false); + recordButton.setToolTipText("Video format not selected. Use Options dialog to select video format."); + } else { + recordButton.setEnabled(true); + recordButton.setToolTipText("Record screen activity and audio"); + } + } + + public AbstractCaptureApplet getApplet() { + return applet; + } + + protected void capture() throws Exception { + try { + Thread.sleep(200); // For Ubuntu. + } catch (InterruptedException ie) { + // Ignore + } + + BufferedImage screenShot = captureConfig.createScreenShot(null, null).call().getRegions().get(0).getImage().getImage(); + + String prefix = getDatePrefix(); + + String defaultImageFormat = applet.getParameter("imageFormat"); + if (defaultImageFormat==null || defaultImageFormat.trim().length()==0) { + defaultImageFormat = "PNG"; + } + final String defaultFileExtension=defaultImageFormat.toLowerCase(); + + final String fileName = JOptionPane.showInputDialog(CaptureFrame.this, "Upload as", applet.getParameter("pageName")+"-capture-"+prefix+"-" + nextCounter() +"."+defaultFileExtension); + if (fileName!=null) { + try { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + int idx = fileName.lastIndexOf('.'); + String imageFormat = idx==-1 ? defaultImageFormat : fileName.substring(idx+1).toUpperCase(); + ImageIO.write(screenShot, imageFormat, baos); + final byte[] imageBytes = baos.toByteArray(); + System.out.println("Image size: "+imageBytes.length); + // Uploading + SwingWorker task = new SwingWorker() { + + @Override + protected Boolean doInBackground() throws Exception { + + System.out.println("Uploading in background"); + try { + HttpResponse iResponse = applet.post( + CaptureFrame.this, + new ByteArrayInputStream(imageBytes), + imageBytes.length, + fileName, + "application/octet-stream"); + + System.out.println("Response status line: "+iResponse.getStatusLine()); + if (iResponse.getStatusLine().getStatusCode()!=HttpStatus.SC_OK) { + errorMessage = iResponse.getStatusLine(); + errorTitle = "Error saving image"; + return false; + } + return true; + } catch (Error e) { + errorMessage=e.toString(); + errorTitle = "Upload error"; + e.printStackTrace(); + return false; + } + } + + private Object errorMessage; + private String errorTitle; + + protected void done() { + try { + if (get()) { + JSObject window = JSObject.getWindow(applet); + String toEval = "insertAtCarret('"+applet.getParameter("edid")+"','{{:"+fileName+"|}}')"; + System.out.println("Evaluating: "+toEval); + window.eval(toEval); + CaptureFrame.this.setVisible(false); + } else { + JOptionPane.showMessageDialog( + CaptureFrame.this, + errorMessage, + errorTitle, + JOptionPane.ERROR_MESSAGE); + } + } catch (Exception e) { + e.printStackTrace(); + JOptionPane.showMessageDialog( + CaptureFrame.this, + e.toString(), + "Exception", + JOptionPane.ERROR_MESSAGE); + } + }; + + }; + + task.execute(); + } catch (IOException ex) { + JOptionPane.showMessageDialog( + applet, + ex.toString(), + "Error saving image", + JOptionPane.ERROR_MESSAGE); + } + } + } + + public int nextCounter() { + return counter++; + } + + public String getDatePrefix() { + return dateFormat.format(new Date()); + } + + protected void record() { + try { + Thread.sleep(200); // For Ubuntu. + } catch (InterruptedException ie) { + // Ignore + } + + int borderWidth = 1; + JFrame[] borderFrames = new JFrame[4]; + + Dimension dim = Toolkit.getDefaultToolkit().getScreenSize(); + + Rectangle rr = captureConfig.getRecordingRectangle(); + Color borderColor = Color.RED; + if (rr.x>=borderWidth) { + // West border + borderFrames[0] = new JFrame(); + borderFrames[0].setDefaultCloseOperation(DISPOSE_ON_CLOSE); + borderFrames[0].setSize(borderWidth, rr.height+borderWidth*2); + borderFrames[0].setLocation(rr.x-borderWidth, rr.y-borderWidth); + borderFrames[0].setUndecorated(true); + borderFrames[0].setAlwaysOnTop(true); + borderFrames[0].setFocusableWindowState(false); + borderFrames[0].getContentPane().setBackground(borderColor); + } + if (rr.x+rr.width=borderWidth) { + // North border + borderFrames[2] = new JFrame(); + borderFrames[2].setDefaultCloseOperation(DISPOSE_ON_CLOSE); + borderFrames[2].setSize(rr.width, borderWidth); + borderFrames[2].setLocation(rr.x, rr.y-borderWidth); + borderFrames[2].setUndecorated(true); + borderFrames[2].setAlwaysOnTop(true); + borderFrames[2].setFocusableWindowState(false); + borderFrames[2].getContentPane().setBackground(borderColor); + } + if (rr.y+rr.heightdim.getWidth()) { + x = dim.width-inst.getWidth(); + } else if (x<0) { + x = 0; + } + + int y = rr.getLocation().y+getHeight()+1; + if (y+inst.getHeight()>dim.height) { + y = rr.getLocation().y-inst.getHeight(); + if (y<0) { + y=dim.height-inst.getHeight(); + } + } + inst.setLocation(x, y); + inst.setVisible(true); + } + + private AtomicBoolean capturing = new AtomicBoolean(false); + private AtomicBoolean recording = new AtomicBoolean(false); + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/CaptureOptionsDialog.java b/plugin/jcapture/src/com/hammurapi/jcapture/CaptureOptionsDialog.java new file mode 100644 index 000000000..a4298de0e --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/CaptureOptionsDialog.java @@ -0,0 +1,606 @@ +package com.hammurapi.jcapture; + +import java.awt.BorderLayout; +import java.awt.Component; +import java.awt.GridBagConstraints; +import java.awt.GridBagLayout; +import java.awt.Insets; +import java.awt.event.ActionEvent; +import java.awt.event.ActionListener; +import java.util.List; + +import javax.sound.sampled.AudioFormat; +import javax.sound.sampled.AudioSystem; +import javax.sound.sampled.DataLine; +import javax.sound.sampled.Mixer; +import javax.sound.sampled.TargetDataLine; +import javax.swing.BorderFactory; +import javax.swing.ButtonGroup; +import javax.swing.ComboBoxModel; +import javax.swing.DefaultComboBoxModel; +import javax.swing.JButton; +import javax.swing.JCheckBox; +import javax.swing.JComboBox; +import javax.swing.JLabel; +import javax.swing.JOptionPane; +import javax.swing.JPanel; +import javax.swing.JRadioButton; +import javax.swing.JTabbedPane; +import javax.swing.JTextField; +import javax.swing.SwingConstants; + +public class CaptureOptionsDialog extends javax.swing.JDialog { + private JRadioButton sampleSize16Button; + private JTextField timeLineScaleTextField; + private JCheckBox toobarCheckBox; + private JCheckBox videoBorderCheckBox; + private JTextField screenScaleTextField; + private JLabel timelineScalingLabel; + private JLabel screenScalingLabel; + private JTextField fpsTextField; + private JLabel fpsLabel; + private ButtonGroup sampleSizeButtonGroup; + private JComboBox sampleRateComboBox; + private JRadioButton sampleSize8Button; + private JTextField inactivityIntervalTextField; + private JLabel inactivityIntervalLabel; + private JCheckBox inactivityCheckBox; + private JPanel inactivityPanel; + private JPanel scalingPanel; + private JCheckBox stereoCheckBox; + private JLabel sampleSizeLabel; + private JTabbedPane recordingSettingsPane; + private JCheckBox recordSoundCheckBox; + private JLabel sampleRateLabel; + private JComboBox soundLineComboBox; + private JLabel soundSourceLabel; + private JPanel audioSettingsPanel; + private JPanel videoSettingsPanel; + private JButton cancelButton; + private JButton okButton; + private JPanel recordPanel; + private JComboBox encodersComboBox; + private JTextField mp3Text; + + public CaptureOptionsDialog(final CaptureFrame owner) { + super(owner); + setDefaultCloseOperation(DISPOSE_ON_CLOSE); + BorderLayout thisLayout = new BorderLayout(); + this.setLayout(thisLayout); + this.setPreferredSize(new java.awt.Dimension(333, 186)); + + recordPanel = new JPanel(); + this.add(recordPanel); + GridBagLayout recordPanelLayout = new GridBagLayout(); + recordPanelLayout.rowWeights = new double[] { 0.1, 0.0, 0.0, 0.0 }; + recordPanelLayout.rowHeights = new int[] { 7, 7, 20, 7 }; + recordPanelLayout.columnWeights = new double[] { 0.1, 0.0, 0.0, 0.0, 0.0 }; + recordPanelLayout.columnWidths = new int[] { 20, 7, 7, 7, 7 }; + recordPanel.setLayout(recordPanelLayout); + recordPanel.setPreferredSize(new java.awt.Dimension(335, 297)); + + okButton = new JButton(); + recordPanel.add(okButton, new GridBagConstraints(1, 2, 1, 1, 0.0, + 0.0, GridBagConstraints.CENTER, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + okButton.setText("OK"); + okButton.addActionListener(new ActionListener() { + public void actionPerformed(ActionEvent evt) { + try { + if (recordSoundCheckBox.isSelected()) { + owner.getCaptureConfig().setAudioFormat(audioFormat); + owner.getCaptureConfig().setMixerName((String) soundLineComboBox.getSelectedItem()); + } else { + owner.getCaptureConfig().setRemoveInactivity(inactivityCheckBox.isSelected()); + if (owner.getCaptureConfig().isRemoveInactivity()) { + owner.getCaptureConfig().setInactivityInterval(Double.parseDouble(inactivityIntervalTextField.getText())); + } + } + + owner.getCaptureConfig().setLoop(getLoopCheckBox().isSelected()); + owner.getCaptureConfig().setPlay(getPlayCheckBox().isSelected()); + owner.getCaptureConfig().setMouse(getMouseCheckBox().isSelected()); + owner.getCaptureConfig().setSound(recordSoundCheckBox.isSelected()); + owner.getCaptureConfig().setImageFormat(getImageFormatTextField().getText().trim()); + owner.getCaptureConfig().setBorder(videoBorderCheckBox.isSelected()); + owner.getCaptureConfig().setFramesPerSecond(Float.parseFloat(fpsTextField.getText())); + owner.getCaptureConfig().setScreenScale(Double.parseDouble(screenScaleTextField.getText()) / 100.0); + owner.getCaptureConfig().setSpeedScale((float) (Float.parseFloat(timeLineScaleTextField.getText()) / 100.0)); + owner.getCaptureConfig().setToolBar(toobarCheckBox.isSelected()); + owner.getApplet().storeConfig(owner.getCaptureConfig().store()); + owner.getCaptureConfig().setMp3command(mp3Text.getText()); + owner.getCaptureConfig().setEncoder((VideoEncoder) encodersComboBox.getSelectedItem()); + owner.setRecordButtonState(); + CaptureOptionsDialog.this.setVisible(false); + } catch (Exception e) { + e.printStackTrace(); + JOptionPane.showMessageDialog(CaptureOptionsDialog.this, + e.toString(), "Error in configuration parameters", + JOptionPane.ERROR_MESSAGE); + } + } + }); + + cancelButton = new JButton(); + recordPanel.add(cancelButton, new GridBagConstraints(3, 2, 1, 1, 0.0, + 0.0, GridBagConstraints.CENTER, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + cancelButton.setText("Cancel"); + cancelButton.addActionListener(new ActionListener() { + + @Override + public void actionPerformed(ActionEvent e) { + CaptureOptionsDialog.this.setVisible(false); + } + }); + + recordingSettingsPane = new JTabbedPane(); + recordPanel.add(recordingSettingsPane, new GridBagConstraints(0, 0, 5, + 1, 0.0, 0.0, GridBagConstraints.CENTER, + GridBagConstraints.BOTH, new Insets(0, 0, 0, 0), 0, 0)); + + videoSettingsPanel = new JPanel(); + GridBagLayout videoSettingsPanelLayout = new GridBagLayout(); + recordingSettingsPane.addTab("Video", null, videoSettingsPanel, null); + videoSettingsPanel.setPreferredSize(new java.awt.Dimension(112, 207)); + videoSettingsPanelLayout.rowWeights = new double[] { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.1 }; + videoSettingsPanelLayout.rowHeights = new int[] { 7, 7, 7, 7, 7, 7, 7, 20 }; + videoSettingsPanelLayout.columnWeights = new double[] { 0.0, 0.0, 0.0, + 0.0, 0.0, 0.0, 0.0, 0.0, 0.1 }; + videoSettingsPanelLayout.columnWidths = new int[] { 115, 7, 40, 7, 20, + 7, 20, 7, 20 }; + videoSettingsPanel.setLayout(videoSettingsPanelLayout); + + scalingPanel = new JPanel(); + GridBagLayout scalingPanelLayout = new GridBagLayout(); + videoSettingsPanel.add(scalingPanel, new GridBagConstraints(0, 6, 1, 1, + 0.0, 0.0, GridBagConstraints.CENTER, GridBagConstraints.BOTH, + new Insets(0, 0, 0, 0), 0, 0)); + scalingPanel.setBorder(BorderFactory.createTitledBorder("Scaling (%)")); + scalingPanelLayout.rowWeights = new double[] { 0.1, 0.0, 0.1 }; + scalingPanelLayout.rowHeights = new int[] { 7, 7, 7 }; + scalingPanelLayout.columnWeights = new double[] { 0.0, 0.0, 0.1 }; + scalingPanelLayout.columnWidths = new int[] { 7, 7, 7 }; + scalingPanel.setLayout(scalingPanelLayout); + scalingPanel.add(getScreenScalingLabel(), new GridBagConstraints(0, 0, + 1, 1, 0.0, 0.0, GridBagConstraints.EAST, + GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0)); + scalingPanel.add(getTimelineScalingLabel(), new GridBagConstraints(0, + 2, 1, 1, 0.0, 0.0, GridBagConstraints.EAST, + GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0)); + scalingPanel.add(getScreenScaleTextField(), new GridBagConstraints(2, + 0, 1, 1, 0.0, 0.0, GridBagConstraints.CENTER, + GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0)); + scalingPanel.add(getTimeLineScaleTextField(), new GridBagConstraints(2, + 2, 1, 1, 0.0, 0.0, GridBagConstraints.CENTER, + GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0)); + + inactivityPanel = new JPanel(); + GridBagLayout inactivityPanelLayout = new GridBagLayout(); + videoSettingsPanel.add(inactivityPanel, new GridBagConstraints(2, 6, 8, + 1, 0.0, 0.0, GridBagConstraints.WEST, + GridBagConstraints.VERTICAL, new Insets(0, 0, 0, 0), 0, 0)); + videoSettingsPanel.add(getFpsLabel(), new GridBagConstraints(0, 0, 1, + 1, 0.0, 0.0, GridBagConstraints.EAST, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + videoSettingsPanel.add(getFpsTextField(), new GridBagConstraints(2, 0, + 1, 1, 0.0, 0.0, GridBagConstraints.WEST, + GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0)); + + videoSettingsPanel.add(getImageFormatLabel(), new GridBagConstraints(0, 2, 1, + 1, 0.0, 0.0, GridBagConstraints.EAST, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + videoSettingsPanel.add(getImageFormatTextField(), new GridBagConstraints(2, 2, + 1, 1, 0.0, 0.0, GridBagConstraints.WEST, + GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0)); + + videoSettingsPanel.add(getEncoderLabel(), new GridBagConstraints(0, 4, 1, + 1, 0.0, 0.0, GridBagConstraints.EAST, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + videoSettingsPanel.add(getEncoderComboBox(), new GridBagConstraints(2, 4, + 6, 1, 0.0, 0.0, GridBagConstraints.WEST, + GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0)); + + videoSettingsPanel.add(getVideoBorderCheckBox(), + new GridBagConstraints(4, 0, 1, 1, 0.0, 0.0, + GridBagConstraints.WEST, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + videoSettingsPanel.add(getLoopCheckBox(), + new GridBagConstraints(6, 2, 1, 1, 0.0, 0.0, + GridBagConstraints.WEST, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + videoSettingsPanel.add(getPlayCheckBox(), + new GridBagConstraints(8, 2, 1, 1, 0.0, 0.0, + GridBagConstraints.WEST, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + videoSettingsPanel.add(getMouseCheckBox(), + new GridBagConstraints(4, 2, 1, 1, 0.0, 0.0, + GridBagConstraints.WEST, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + videoSettingsPanel.add(getJToobarCheckBox(), new GridBagConstraints(6, + 0, 1, 1, 0.0, 0.0, GridBagConstraints.WEST, + GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0)); + inactivityPanel.setBorder(BorderFactory + .createTitledBorder("Inactivity processing")); + inactivityPanel + .setToolTipText("Inactivity handling, enabled if audio is not being recorded."); + inactivityPanelLayout.rowWeights = new double[] { 0.0, 0.0, 0.0 }; + inactivityPanelLayout.rowHeights = new int[] { 7, 7, 7 }; + inactivityPanelLayout.columnWeights = new double[] { 0.0, 0.0, 0.0, + 0.0, 0.1 }; + inactivityPanelLayout.columnWidths = new int[] { 7, 7, 7, 47, 7 }; + inactivityPanel.setLayout(inactivityPanelLayout); + inactivityPanel.setEnabled(false); + + inactivityCheckBox = new JCheckBox(); + inactivityPanel.add(inactivityCheckBox, new GridBagConstraints(1, 0, 4, + 1, 0.0, 0.0, GridBagConstraints.WEST, + GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0)); + inactivityCheckBox.setText("Remove inactivity"); + inactivityCheckBox.setEnabled(false); + + inactivityIntervalLabel = new JLabel(); + inactivityPanel.add(inactivityIntervalLabel, new GridBagConstraints(1, + 2, 1, 1, 0.0, 0.0, GridBagConstraints.EAST, + GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0)); + inactivityIntervalLabel.setText("Inactivity interval (sec)"); + inactivityIntervalLabel.setEnabled(false); + + inactivityIntervalTextField = new JTextField(); + inactivityPanel.add(inactivityIntervalTextField, + new GridBagConstraints(3, 2, 1, 1, 0.0, 0.0, + GridBagConstraints.CENTER, + GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), + 0, 0)); + inactivityIntervalTextField.setText("0.7"); + inactivityIntervalTextField.setEnabled(false); + + audioSettingsPanel = new JPanel(); + GridBagLayout audioSettingsPanelLayout = new GridBagLayout(); + recordingSettingsPane.addTab("Audio", null, audioSettingsPanel, null); + audioSettingsPanelLayout.rowWeights = new double[] { 0.0, 0.0, 0.0, + 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.1 }; + audioSettingsPanelLayout.rowHeights = new int[] { 7, 7, 7, 7, 7, 7, 7, 7, 7, + 20 }; + audioSettingsPanelLayout.columnWeights = new double[] { 0.0, 0.0, 0.0, + 0.0, 0.0, 0.0, 0.1 }; + audioSettingsPanelLayout.columnWidths = new int[] { 7, 7, 49, 7, 135, + 7, 20 }; + audioSettingsPanel.setLayout(audioSettingsPanelLayout); + + sampleSize16Button = new JRadioButton(); + audioSettingsPanel.add(sampleSize16Button, new GridBagConstraints(4, 4, + 1, 1, 0.0, 0.0, GridBagConstraints.WEST, + GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0)); + sampleSize16Button.setText("16"); + sampleSize16Button.setSelected(true); + getSampleSizeButtonGroup().add(sampleSize16Button); + sampleSize16Button.addActionListener(new ActionListener() { + public void actionPerformed(ActionEvent evt) { + selectSoundSource(); + } + }); + + recordSoundCheckBox = new JCheckBox(); + audioSettingsPanel.add(recordSoundCheckBox, new GridBagConstraints(0, + 0, 4, 1, 0.0, 0.0, GridBagConstraints.WEST, + GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0)); + recordSoundCheckBox.setText("Record sound"); + recordSoundCheckBox.setSelected(true); + recordSoundCheckBox.addActionListener(new ActionListener() { + public void actionPerformed(ActionEvent evt) { + onSetSound(); + } + }); + + soundSourceLabel = new JLabel(); + audioSettingsPanel.add(soundSourceLabel, new GridBagConstraints(0, 6, + 1, 1, 0.0, 0.0, GridBagConstraints.EAST, + GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0)); + soundSourceLabel.setText("Source"); + + soundLineComboBox = new JComboBox(); + audioSettingsPanel.add(soundLineComboBox, new GridBagConstraints(2, 6, + 3, 1, 0.0, 0.0, GridBagConstraints.CENTER, + GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0)); + + audioSettingsPanel.add(new JLabel("WAV2MP3 command"), new GridBagConstraints(0, 8, + 1, 1, 0.0, 0.0, GridBagConstraints.EAST, + GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0)); + + mp3Text = new JTextField(); + audioSettingsPanel.add(mp3Text, new GridBagConstraints(2, 8, + 5, 1, 0.0, 0.0, GridBagConstraints.CENTER, + GridBagConstraints.HORIZONTAL, new Insets(0, 0, 0, 0), 0, 0)); + + sampleRateLabel = new JLabel(); + audioSettingsPanel.add(sampleRateLabel, new GridBagConstraints(0, 2, 1, + 1, 0.0, 0.0, GridBagConstraints.EAST, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + sampleRateLabel.setText("Sample rate (khz)"); + + sampleSizeLabel = new JLabel(); + audioSettingsPanel.add(sampleSizeLabel, new GridBagConstraints(0, 4, 1, + 1, 0.0, 0.0, GridBagConstraints.EAST, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + sampleSizeLabel.setText("Sample size (bits)"); + + stereoCheckBox = new JCheckBox(); + audioSettingsPanel.add(stereoCheckBox, new GridBagConstraints(4, 2, 1, + 1, 0.0, 0.0, GridBagConstraints.WEST, GridBagConstraints.NONE, + new Insets(0, 0, 0, 0), 0, 0)); + stereoCheckBox.setText("Stereo"); + stereoCheckBox.addActionListener(new ActionListener() { + public void actionPerformed(ActionEvent evt) { + selectSoundSource(); + } + }); + + sampleSize8Button = new JRadioButton(); + audioSettingsPanel.add(sampleSize8Button, new GridBagConstraints(2, 4, + 1, 1, 0.0, 0.0, GridBagConstraints.WEST, + GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0)); + sampleSize8Button.setText("8"); + getSampleSizeButtonGroup().add(sampleSize8Button); + sampleSize8Button.addActionListener(new ActionListener() { + public void actionPerformed(ActionEvent evt) { + selectSoundSource(); + } + }); + + ComboBoxModel sampleRateComboBoxModel = new DefaultComboBoxModel( + new String[] { "5.5", "11", "22", "44" }); + sampleRateComboBox = new JComboBox(); + audioSettingsPanel.add(sampleRateComboBox, new GridBagConstraints(2, 2, + 1, 1, 0.0, 0.0, GridBagConstraints.CENTER, + GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0)); + sampleRateComboBox.setModel(sampleRateComboBoxModel); + sampleRateComboBox.setSelectedIndex(2); + sampleRateComboBox.addActionListener(new ActionListener() { + public void actionPerformed(ActionEvent evt) { + selectSoundSource(); + } + }); + + getImageFormatTextField().setText(owner.getCaptureConfig().getImageFormat()); + + recordSoundCheckBox.setSelected(owner.getCaptureConfig().isSound()); + stereoCheckBox.setSelected(owner.getCaptureConfig().getAudioFormat().getChannels()>1); + if (owner.getCaptureConfig().getAudioFormat().getSampleSizeInBits()==8) { + sampleSize8Button.setSelected(true); + } else { + sampleSize16Button.setSelected(true); + } + + float sampleRate = owner.getCaptureConfig().getAudioFormat().getSampleRate(); + float proximity = Math.abs(sampleRate-sampleRates[0]); + sampleRateComboBox.setSelectedIndex(0); + for (int i=1; i soundLineComboBoxModel; + private JLabel imageFormatLabel; + private JTextField imageFormatTextField; + private JCheckBox mouseCheckBox; + private JCheckBox playCheckBox; + private JCheckBox loopCheckBox; + private JLabel encoderLabel; + + private void selectSoundSource() { + audioFormat = new AudioFormat( + sampleRates[sampleRateComboBox.getSelectedIndex()], + sampleSize8Button.isSelected() ? 8 : 16, + stereoCheckBox.isSelected() ? 2 : 1, true, false); + + String sourceName = (String) soundLineComboBox.getSelectedItem(); + + if (soundLineComboBoxModel == null) { + soundLineComboBoxModel = new DefaultComboBoxModel(); + soundLineComboBox.setModel(soundLineComboBoxModel); + } else { + soundLineComboBoxModel.removeAllElements(); + } + + DataLine.Info info = new DataLine.Info(TargetDataLine.class, audioFormat); + + boolean hasSourceName = false; + for (Mixer.Info mi : AudioSystem.getMixerInfo()) { + Mixer mx = AudioSystem.getMixer(mi); + if (mx.isLineSupported(info)) { + soundLineComboBoxModel.addElement(mi.getName()); + if (sourceName!=null && mi.getName().equals(sourceName)) { + hasSourceName = true; + } + } + } + + if (hasSourceName) { + soundLineComboBoxModel.setSelectedItem(sourceName); + } + } + + private ButtonGroup getSampleSizeButtonGroup() { + if (sampleSizeButtonGroup == null) { + sampleSizeButtonGroup = new ButtonGroup(); + } + return sampleSizeButtonGroup; + } + + private JLabel getFpsLabel() { + if (fpsLabel == null) { + fpsLabel = new JLabel(); + fpsLabel.setText("Frames Per Second"); + } + return fpsLabel; + } + + private JTextField getFpsTextField() { + if (fpsTextField == null) { + fpsTextField = new JTextField(); + fpsTextField.setText("10"); + fpsTextField.setSize(30, 23); + } + return fpsTextField; + } + + private JLabel getImageFormatLabel() { + if (imageFormatLabel == null) { + imageFormatLabel = new JLabel(); + imageFormatLabel.setText("Image format"); + } + return imageFormatLabel; + } + + private JTextField getImageFormatTextField() { + if (imageFormatTextField == null) { + imageFormatTextField = new JTextField(); + imageFormatTextField.setText("png"); + imageFormatTextField.setSize(30, 23); + } + return imageFormatTextField; + } + + private JLabel getEncoderLabel() { + if (encoderLabel == null) { + encoderLabel = new JLabel(); + encoderLabel.setText("Video format"); + } + return encoderLabel; + } + + private JComboBox getEncoderComboBox() { + if (encodersComboBox == null) { + List el = ((CaptureFrame) getOwner()).getCaptureConfig().getEncoders(); + encodersComboBox = new JComboBox(el.toArray(new VideoEncoder[el.size()])); +// encodersComboBox.setSize(30, 23); + } + return encodersComboBox; + } + + private JLabel getScreenScalingLabel() { + if (screenScalingLabel == null) { + screenScalingLabel = new JLabel(); + screenScalingLabel.setText("Graphics"); + } + return screenScalingLabel; + } + + private JLabel getTimelineScalingLabel() { + if (timelineScalingLabel == null) { + timelineScalingLabel = new JLabel(); + timelineScalingLabel.setText("Speed"); + } + return timelineScalingLabel; + } + + private JTextField getScreenScaleTextField() { + if (screenScaleTextField == null) { + screenScaleTextField = new JTextField(); + screenScaleTextField.setText("100"); + } + return screenScaleTextField; + } + + private JTextField getTimeLineScaleTextField() { + if (timeLineScaleTextField == null) { + timeLineScaleTextField = new JTextField(); + timeLineScaleTextField.setText("100"); + } + return timeLineScaleTextField; + } + + private JCheckBox getVideoBorderCheckBox() { + if (videoBorderCheckBox == null) { + videoBorderCheckBox = new JCheckBox(); + videoBorderCheckBox.setText("Border"); + } + return videoBorderCheckBox; + } + + private JCheckBox getMouseCheckBox() { + if (mouseCheckBox == null) { + mouseCheckBox = new JCheckBox(); + mouseCheckBox.setText("Mouse"); + } + return mouseCheckBox; + } + + private JCheckBox getLoopCheckBox() { + if (loopCheckBox == null) { + loopCheckBox = new JCheckBox(); + loopCheckBox.setText("Loop"); + } + return loopCheckBox; + } + + private JCheckBox getPlayCheckBox() { + if (playCheckBox == null) { + playCheckBox = new JCheckBox(); + playCheckBox.setText("Play"); + } + return playCheckBox; + } + + private JCheckBox getJToobarCheckBox() { + if (toobarCheckBox == null) { + toobarCheckBox = new JCheckBox(); + toobarCheckBox.setText("Toolbar"); + toobarCheckBox.setSelected(true); + } + return toobarCheckBox; + } + + void onSetSound() { + for (Component child : recordSoundCheckBox.getParent().getComponents()) { + if (child != recordSoundCheckBox) { + child.setEnabled(recordSoundCheckBox.isSelected()); + } + } + inactivityPanel.setEnabled(!recordSoundCheckBox.isSelected()); + timeLineScaleTextField.setEnabled(!recordSoundCheckBox.isSelected()); + for (Component child : inactivityPanel.getComponents()) { + child.setEnabled(!recordSoundCheckBox.isSelected()); + } + } + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/ComponentMover.java b/plugin/jcapture/src/com/hammurapi/jcapture/ComponentMover.java new file mode 100644 index 000000000..29526cc1d --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/ComponentMover.java @@ -0,0 +1,361 @@ +package com.hammurapi.jcapture; + +import java.awt.Component; +import java.awt.Cursor; +import java.awt.Dimension; +import java.awt.GraphicsEnvironment; +import java.awt.Insets; +import java.awt.Point; +import java.awt.Rectangle; +import java.awt.Window; +import java.awt.event.MouseAdapter; +import java.awt.event.MouseEvent; + +import javax.swing.JComponent; +import javax.swing.SwingUtilities; + +/** + * This class allows you to move a Component by using a mouse. The Component + * moved can be a high level Window (ie. Window, Frame, Dialog) in which case + * the Window is moved within the desktop. Or the Component can belong to a + * Container in which case the Component is moved within the Container. + * + * When moving a Window, the listener can be added to a child Component of the + * Window. In this case attempting to move the child will result in the Window + * moving. For example, you might create a custom "Title Bar" for an undecorated + * Window and moving of the Window is accomplished by moving the title bar only. + * Multiple components can be registered as "window movers". + * + * Components can be registered when the class is created. Additional components + * can be added at any time using the registerComponent() method. + * + * Taken from http://tips4java.wordpress.com/2009/06/14/moving-windows/ + */ +public class ComponentMover extends MouseAdapter { + private Insets dragInsets = new Insets(0, 0, 0, 0); + private Dimension snapSize = new Dimension(1, 1); + private Insets edgeInsets = new Insets(0, 0, 0, 0); + private boolean changeCursor = true; + private boolean autoLayout = false; + + private Class destinationClass; + private Component destinationComponent; + private Component destination; + private Component source; + + private Point pressed; + private Point location; + + private Cursor originalCursor; + private boolean autoscrolls; + private boolean potentialDrag; + + /** + * Constructor for moving individual components. The components must be + * regisetered using the registerComponent() method. + */ + public ComponentMover() { + } + + /** + * Constructor to specify a Class of Component that will be moved when drag + * events are generated on a registered child component. The events will be + * passed to the first ancestor of this specified class. + * + * @param destinationClass + * the Class of the ancestor component + * @param component + * the Components to be registered for forwarding drag events to + * the ancestor Component. + */ + public ComponentMover(Class destinationClass, Component... components) { + this.destinationClass = destinationClass; + registerComponent(components); + } + + /** + * Constructor to specify a parent component that will be moved when drag + * events are generated on a registered child component. + * + * @param destinationComponent + * the component drage events should be forwareded to + * @param components + * the Components to be registered for forwarding drag events to + * the parent component to be moved + */ + public ComponentMover(Component destinationComponent, + Component... components) { + this.destinationComponent = destinationComponent; + registerComponent(components); + } + + /** + * Get the auto layout property + * + * @return the auto layout property + */ + public boolean isAutoLayout() { + return autoLayout; + } + + /** + * Set the auto layout property + * + * @param autoLayout + * when true layout will be invoked on the parent container + */ + public void setAutoLayout(boolean autoLayout) { + this.autoLayout = autoLayout; + } + + /** + * Get the change cursor property + * + * @return the change cursor property + */ + public boolean isChangeCursor() { + return changeCursor; + } + + /** + * Set the change cursor property + * + * @param changeCursor + * when true the cursor will be changed to the Cursor.MOVE_CURSOR + * while the mouse is pressed + */ + public void setChangeCursor(boolean changeCursor) { + this.changeCursor = changeCursor; + } + + /** + * Get the drag insets + * + * @return the drag insets + */ + public Insets getDragInsets() { + return dragInsets; + } + + /** + * Set the drag insets. The insets specify an area where mouseDragged events + * should be ignored and therefore the component will not be moved. This + * will prevent these events from being confused with a MouseMotionListener + * that supports component resizing. + * + * @param dragInsets + */ + public void setDragInsets(Insets dragInsets) { + this.dragInsets = dragInsets; + } + + /** + * Get the bounds insets + * + * @return the bounds insets + */ + public Insets getEdgeInsets() { + return edgeInsets; + } + + /** + * Set the edge insets. The insets specify how close to each edge of the + * parent component that the child component can be moved. Positive values + * means the component must be contained within the parent. Negative values + * means the component can be moved outside the parent. + * + * @param edgeInsets + */ + public void setEdgeInsets(Insets edgeInsets) { + this.edgeInsets = edgeInsets; + } + + /** + * Remove listeners from the specified component + * + * @param component + * the component the listeners are removed from + */ + public void deregisterComponent(Component... components) { + for (Component component : components) + component.removeMouseListener(this); + } + + /** + * Add the required listeners to the specified component + * + * @param component + * the component the listeners are added to + */ + public void registerComponent(Component... components) { + for (Component component : components) + component.addMouseListener(this); + } + + /** + * Get the snap size + * + * @return the snap size + */ + public Dimension getSnapSize() { + return snapSize; + } + + /** + * Set the snap size. Forces the component to be snapped to the closest grid + * position. Snapping will occur when the mouse is dragged half way. + */ + public void setSnapSize(Dimension snapSize) { + if (snapSize.width < 1 || snapSize.height < 1) + throw new IllegalArgumentException( + "Snap sizes must be greater than 0"); + + this.snapSize = snapSize; + } + + /** + * Setup the variables used to control the moving of the component: + * + * source - the source component of the mouse event destination - the + * component that will ultimately be moved pressed - the Point where the + * mouse was pressed in the destination component coordinates. + */ + @Override + public void mousePressed(MouseEvent e) { + source = e.getComponent(); + int width = source.getSize().width - dragInsets.left - dragInsets.right; + int height = source.getSize().height - dragInsets.top + - dragInsets.bottom; + Rectangle r = new Rectangle(dragInsets.left, dragInsets.top, width, + height); + + if (r.contains(e.getPoint())) + setupForDragging(e); + } + + private void setupForDragging(MouseEvent e) { + source.addMouseMotionListener(this); + potentialDrag = true; + + // Determine the component that will ultimately be moved + + if (destinationComponent != null) { + destination = destinationComponent; + } else if (destinationClass == null) { + destination = source; + } else // forward events to destination component + { + destination = SwingUtilities.getAncestorOfClass(destinationClass, + source); + } + + pressed = e.getLocationOnScreen(); + location = destination.getLocation(); + + if (changeCursor) { + originalCursor = source.getCursor(); + source.setCursor(Cursor.getPredefinedCursor(Cursor.MOVE_CURSOR)); + } + + // Making sure autoscrolls is false will allow for smoother dragging of + // individual components + + if (destination instanceof JComponent) { + JComponent jc = (JComponent) destination; + autoscrolls = jc.getAutoscrolls(); + jc.setAutoscrolls(false); + } + } + + /** + * Move the component to its new location. The dragged Point must be in the + * destination coordinates. + */ + @Override + public void mouseDragged(MouseEvent e) { + Point dragged = e.getLocationOnScreen(); + int dragX = getDragDistance(dragged.x, pressed.x, snapSize.width); + int dragY = getDragDistance(dragged.y, pressed.y, snapSize.height); + + int locationX = location.x + dragX; + int locationY = location.y + dragY; + + // Mouse dragged events are not generated for every pixel the mouse + // is moved. Adjust the location to make sure we are still on a + // snap value. + +// while (locationX < edgeInsets.left) +// locationX += snapSize.width; +// +// while (locationY < edgeInsets.top) +// locationY += snapSize.height; +// +// Dimension d = getBoundingSize(destination); + +// while (locationX + destination.getSize().width + edgeInsets.right > d.width) +// locationX -= snapSize.width; +// +// while (locationY + destination.getSize().height + edgeInsets.bottom > d.height) +// locationY -= snapSize.height; + + // Adjustments are finished, move the component + + destination.setLocation(locationX, locationY); + } + + /* + * Determine how far the mouse has moved from where dragging started (Assume + * drag direction is down and right for positive drag distance) + */ + private int getDragDistance(int larger, int smaller, int snapSize) { + int halfway = snapSize / 2; + int drag = larger - smaller; + drag += (drag < 0) ? -halfway : halfway; + drag = (drag / snapSize) * snapSize; + + return drag; + } + + /* + * Get the bounds of the parent of the dragged component. + */ + private Dimension getBoundingSize(Component source) { + if (source instanceof Window) { + GraphicsEnvironment env = GraphicsEnvironment + .getLocalGraphicsEnvironment(); + Rectangle bounds = env.getMaximumWindowBounds(); + return new Dimension(bounds.width, bounds.height); + } else { + return source.getParent().getSize(); + } + } + + /** + * Restore the original state of the Component + */ + @Override + public void mouseReleased(MouseEvent e) { + if (!potentialDrag) + return; + + source.removeMouseMotionListener(this); + potentialDrag = false; + + if (changeCursor) + source.setCursor(originalCursor); + + if (destination instanceof JComponent) { + ((JComponent) destination).setAutoscrolls(autoscrolls); + } + + // Layout the components on the parent container + + if (autoLayout) { + if (destination instanceof JComponent) { + ((JComponent) destination).revalidate(); + } else { + destination.validate(); + } + } + } +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/ComponentResizer.java b/plugin/jcapture/src/com/hammurapi/jcapture/ComponentResizer.java new file mode 100644 index 000000000..513c2bdb5 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/ComponentResizer.java @@ -0,0 +1,446 @@ +package com.hammurapi.jcapture; + +import java.awt.Component; +import java.awt.Cursor; +import java.awt.Dimension; +import java.awt.GraphicsEnvironment; +import java.awt.Insets; +import java.awt.Point; +import java.awt.Rectangle; +import java.awt.Window; +import java.awt.event.MouseAdapter; +import java.awt.event.MouseEvent; +import java.util.HashMap; +import java.util.Map; + +import javax.swing.JComponent; +import javax.swing.SwingUtilities; + +/** + * The ComponentResizer allows you to resize a component by dragging a border of + * the component. + * + * Taken from http://tips4java.wordpress.com/2009/09/13/resizing-components/ + */ +public class ComponentResizer extends MouseAdapter { + private final static Dimension MINIMUM_SIZE = new Dimension(10, 10); + private final static Dimension MAXIMUM_SIZE = new Dimension( + Integer.MAX_VALUE, Integer.MAX_VALUE); + + private static Map cursors = new HashMap(); + { + cursors.put(1, Cursor.N_RESIZE_CURSOR); + cursors.put(2, Cursor.W_RESIZE_CURSOR); + cursors.put(4, Cursor.S_RESIZE_CURSOR); + cursors.put(8, Cursor.E_RESIZE_CURSOR); + cursors.put(3, Cursor.NW_RESIZE_CURSOR); + cursors.put(9, Cursor.NE_RESIZE_CURSOR); + cursors.put(6, Cursor.SW_RESIZE_CURSOR); + cursors.put(12, Cursor.SE_RESIZE_CURSOR); + } + + private Insets dragInsets; + private Dimension snapSize; + + private int direction; + protected static final int NORTH = 1; + protected static final int WEST = 2; + protected static final int SOUTH = 4; + protected static final int EAST = 8; + + private Cursor sourceCursor; + private boolean resizing; + private Rectangle bounds; + private Point pressed; + private boolean autoscrolls; + + private Dimension minimumSize = MINIMUM_SIZE; + private Dimension maximumSize = MAXIMUM_SIZE; + + /** + * Convenience contructor. All borders are resizable in increments of a + * single pixel. Components must be registered separately. + */ + public ComponentResizer() { + this(new Insets(5, 5, 5, 5), new Dimension(1, 1)); + } + + /** + * Convenience contructor. All borders are resizable in increments of a + * single pixel. Components can be registered when the class is created or + * they can be registered separately afterwards. + * + * @param components + * components to be automatically registered + */ + public ComponentResizer(Component... components) { + this(new Insets(5, 5, 5, 5), new Dimension(1, 1), components); + } + + /** + * Convenience contructor. Eligible borders are resisable in increments of a + * single pixel. Components can be registered when the class is created or + * they can be registered separately afterwards. + * + * @param dragInsets + * Insets specifying which borders are eligible to be resized. + * @param components + * components to be automatically registered + */ + public ComponentResizer(Insets dragInsets, Component... components) { + this(dragInsets, new Dimension(1, 1), components); + } + + /** + * Create a ComponentResizer. + * + * @param dragInsets + * Insets specifying which borders are eligible to be resized. + * @param snapSize + * Specify the dimension to which the border will snap to when + * being dragged. Snapping occurs at the halfway mark. + * @param components + * components to be automatically registered + */ + public ComponentResizer(Insets dragInsets, Dimension snapSize, + Component... components) { + setDragInsets(dragInsets); + setSnapSize(snapSize); + registerComponent(components); + } + + /** + * Get the drag insets + * + * @return the drag insets + */ + public Insets getDragInsets() { + return dragInsets; + } + + /** + * Set the drag dragInsets. The insets specify an area where mouseDragged + * events are recognized from the edge of the border inwards. A value of 0 + * for any size will imply that the border is not resizable. Otherwise the + * appropriate drag cursor will appear when the mouse is inside the + * resizable border area. + * + * @param dragInsets + * Insets to control which borders are resizeable. + */ + public void setDragInsets(Insets dragInsets) { + validateMinimumAndInsets(minimumSize, dragInsets); + + this.dragInsets = dragInsets; + } + + /** + * Get the components maximum size. + * + * @return the maximum size + */ + public Dimension getMaximumSize() { + return maximumSize; + } + + /** + * Specify the maximum size for the component. The component will still be + * constrained by the size of its parent. + * + * @param maximumSize + * the maximum size for a component. + */ + public void setMaximumSize(Dimension maximumSize) { + this.maximumSize = maximumSize; + } + + /** + * Get the components minimum size. + * + * @return the minimum size + */ + public Dimension getMinimumSize() { + return minimumSize; + } + + /** + * Specify the minimum size for the component. The minimum size is + * constrained by the drag insets. + * + * @param minimumSize + * the minimum size for a component. + */ + public void setMinimumSize(Dimension minimumSize) { + validateMinimumAndInsets(minimumSize, dragInsets); + + this.minimumSize = minimumSize; + } + + /** + * Remove listeners from the specified component + * + * @param component + * the component the listeners are removed from + */ + public void deregisterComponent(Component... components) { + for (Component component : components) { + component.removeMouseListener(this); + component.removeMouseMotionListener(this); + } + } + + /** + * Add the required listeners to the specified component + * + * @param component + * the component the listeners are added to + */ + public void registerComponent(Component... components) { + for (Component component : components) { + component.addMouseListener(this); + component.addMouseMotionListener(this); + } + } + + /** + * Get the snap size. + * + * @return the snap size. + */ + public Dimension getSnapSize() { + return snapSize; + } + + /** + * Control how many pixels a border must be dragged before the size of the + * component is changed. The border will snap to the size once dragging has + * passed the halfway mark. + * + * @param snapSize + * Dimension object allows you to separately spcify a horizontal + * and vertical snap size. + */ + public void setSnapSize(Dimension snapSize) { + this.snapSize = snapSize; + } + + /** + * When the components minimum size is less than the drag insets then we + * can't determine which border should be resized so we need to prevent this + * from happening. + */ + private void validateMinimumAndInsets(Dimension minimum, Insets drag) { + int minimumWidth = drag.left + drag.right; + int minimumHeight = drag.top + drag.bottom; + + if (minimum.width < minimumWidth || minimum.height < minimumHeight) { + String message = "Minimum size cannot be less than drag insets"; + throw new IllegalArgumentException(message); + } + } + + /** + */ + @Override + public void mouseMoved(MouseEvent e) { + Component source = e.getComponent(); + Point location = e.getPoint(); + direction = 0; + + if (location.x < dragInsets.left) + direction += WEST; + + if (location.x > source.getWidth() - dragInsets.right - 1) + direction += EAST; + + if (location.y < dragInsets.top) + direction += NORTH; + + if (location.y > source.getHeight() - dragInsets.bottom - 1) + direction += SOUTH; + + // Mouse is no longer over a resizable border + + if (direction == 0) { + source.setCursor(sourceCursor); + } else // use the appropriate resizable cursor + { + int cursorType = cursors.get(direction); + Cursor cursor = Cursor.getPredefinedCursor(cursorType); + source.setCursor(cursor); + } + } + + @Override + public void mouseEntered(MouseEvent e) { + if (!resizing) { + Component source = e.getComponent(); + sourceCursor = source.getCursor(); + } + } + + @Override + public void mouseExited(MouseEvent e) { + if (!resizing) { + Component source = e.getComponent(); + source.setCursor(sourceCursor); + } + } + + @Override + public void mousePressed(MouseEvent e) { + // The mouseMoved event continually updates this variable + + if (direction == 0) + return; + + // Setup for resizing. All future dragging calculations are done based + // on the original bounds of the component and mouse pressed location. + + resizing = true; + + Component source = e.getComponent(); + pressed = e.getPoint(); + SwingUtilities.convertPointToScreen(pressed, source); + bounds = source.getBounds(); + + // Making sure autoscrolls is false will allow for smoother resizing + // of components + + if (source instanceof JComponent) { + JComponent jc = (JComponent) source; + autoscrolls = jc.getAutoscrolls(); + jc.setAutoscrolls(false); + } + } + + /** + * Restore the original state of the Component + */ + @Override + public void mouseReleased(MouseEvent e) { + resizing = false; + + Component source = e.getComponent(); + source.setCursor(sourceCursor); + + if (source instanceof JComponent) { + ((JComponent) source).setAutoscrolls(autoscrolls); + } + } + + /** + * Resize the component ensuring location and size is within the bounds of + * the parent container and that the size is within the minimum and maximum + * constraints. + * + * All calculations are done using the bounds of the component when the + * resizing started. + */ + @Override + public void mouseDragged(MouseEvent e) { + if (resizing == false) + return; + + Component source = e.getComponent(); + Point dragged = e.getPoint(); + SwingUtilities.convertPointToScreen(dragged, source); + + changeBounds(source, direction, bounds, pressed, dragged); + } + + protected void changeBounds(Component source, int direction, + Rectangle bounds, Point pressed, Point current) { + // Start with original locaton and size + + int x = bounds.x; + int y = bounds.y; + int width = bounds.width; + int height = bounds.height; + + // Resizing the West or North border affects the size and location + + if (WEST == (direction & WEST)) { + int drag = getDragDistance(pressed.x, current.x, snapSize.width); + int maximum = Math.min(width + x, maximumSize.width); + drag = getDragBounded(drag, snapSize.width, width, + minimumSize.width, maximum); + + x -= drag; + width += drag; + } + + if (NORTH == (direction & NORTH)) { + int drag = getDragDistance(pressed.y, current.y, snapSize.height); + int maximum = Math.min(height + y, maximumSize.height); + drag = getDragBounded(drag, snapSize.height, height, + minimumSize.height, maximum); + + y -= drag; + height += drag; + } + + // Resizing the East or South border only affects the size + + if (EAST == (direction & EAST)) { + int drag = getDragDistance(current.x, pressed.x, snapSize.width); + Dimension boundingSize = getBoundingSize(source); + int maximum = Math.min(boundingSize.width - x, maximumSize.width); + drag = getDragBounded(drag, snapSize.width, width, + minimumSize.width, maximum); + width += drag; + } + + if (SOUTH == (direction & SOUTH)) { + int drag = getDragDistance(current.y, pressed.y, snapSize.height); + Dimension boundingSize = getBoundingSize(source); + int maximum = Math.min(boundingSize.height - y, maximumSize.height); + drag = getDragBounded(drag, snapSize.height, height, + minimumSize.height, maximum); + height += drag; + } + + source.setBounds(x, y, width, height); + source.validate(); + } + + /* + * Determine how far the mouse has moved from where dragging started + */ + private int getDragDistance(int larger, int smaller, int snapSize) { + int halfway = snapSize / 2; + int drag = larger - smaller; + drag += (drag < 0) ? -halfway : halfway; + drag = (drag / snapSize) * snapSize; + + return drag; + } + + /* + * Adjust the drag value to be within the minimum and maximum range. + */ + private int getDragBounded(int drag, int snapSize, int dimension, + int minimum, int maximum) { + while (dimension + drag < minimum) + drag += snapSize; + + while (dimension + drag > maximum) + drag -= snapSize; + + return drag; + } + + /* + * Keep the size of the component within the bounds of its parent. + */ + private Dimension getBoundingSize(Component source) { + if (source instanceof Window) { + GraphicsEnvironment env = GraphicsEnvironment + .getLocalGraphicsEnvironment(); + Rectangle bounds = env.getMaximumWindowBounds(); + return new Dimension(bounds.width, bounds.height); + } else { + return source.getParent().getSize(); + } + } +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/FragmentImpl.java b/plugin/jcapture/src/com/hammurapi/jcapture/FragmentImpl.java new file mode 100644 index 000000000..0d4b066af --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/FragmentImpl.java @@ -0,0 +1,28 @@ +package com.hammurapi.jcapture; + +import java.io.File; +import java.util.List; + +import com.hammurapi.jcapture.VideoEncoder.Fragment; + +class FragmentImpl implements Fragment { + + private File audio; + private List frames; + + FragmentImpl( List frames, File audio) { + this.audio = audio; + this.frames = frames; + } + + @Override + public List getFrames() { + return frames; + } + + @Override + public File getAudio() { + return audio; + } + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/FrameImpl.java b/plugin/jcapture/src/com/hammurapi/jcapture/FrameImpl.java new file mode 100644 index 000000000..69172c0f4 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/FrameImpl.java @@ -0,0 +1,57 @@ +package com.hammurapi.jcapture; + +import java.awt.Dimension; +import java.awt.Point; +import java.util.List; + +import com.hammurapi.jcapture.VideoEncoder.Fragment.Frame; + +class FrameImpl implements Frame { + + private List shapes; + private Point mousePointer; + private Dimension size; + private boolean isActive; + + FrameImpl(List shapes, Point mousePointer, Dimension size, boolean isActive) { + super(); + this.shapes = shapes; + this.mousePointer = mousePointer; + this.size = size; + this.isActive = isActive; + } + + /** + * Merges frame before this frame into this frame by incorporating its shapes. + * This method is used for merging deleted frames. + * @param frame + */ + void merge(Frame frame) { + for (Shape shape: shapes) { + if (shape.getContent().coversEverything()) { + return; // No need in previous shapes. + } + } + shapes.addAll(0, frame.getShapes()); + } + + @Override + public List getShapes() { + return shapes; + } + + @Override + public Point getMousePointer() { + return mousePointer; + } + + @Override + public Dimension getSize() { + return size; + } + + @Override + public boolean isActive() { + return isActive; + } +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/GraphicsDeviceTranslucener.java b/plugin/jcapture/src/com/hammurapi/jcapture/GraphicsDeviceTranslucener.java new file mode 100644 index 000000000..36a0ec395 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/GraphicsDeviceTranslucener.java @@ -0,0 +1,21 @@ +package com.hammurapi.jcapture; + +import java.awt.Frame; +import java.awt.GraphicsDevice; +import java.awt.GraphicsEnvironment; +import java.awt.GraphicsDevice.WindowTranslucency; + +public class GraphicsDeviceTranslucener extends Translucener { + + @Override + protected void makeTranslucent(Frame frame) { + GraphicsEnvironment ge = GraphicsEnvironment.getLocalGraphicsEnvironment(); + GraphicsDevice gd = ge.getDefaultScreenDevice(); + + //If translucent windows aren't supported, exit. + if (gd.isWindowTranslucencySupported(WindowTranslucency.TRANSLUCENT)) { + frame.setOpacity(0.7f); + } + } + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/ImageToolTip.java b/plugin/jcapture/src/com/hammurapi/jcapture/ImageToolTip.java new file mode 100644 index 000000000..f083fbd99 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/ImageToolTip.java @@ -0,0 +1,80 @@ +/* + * This file is an adapted example from javareference.com + * for more information visit, + * http://www.javareference.com + */ +package com.hammurapi.jcapture; + +import java.awt.Dimension; +import java.awt.FontMetrics; +import java.awt.Graphics; +import java.awt.Image; + +import javax.swing.JComponent; +import javax.swing.JToolTip; +import javax.swing.SwingUtilities; +import javax.swing.plaf.metal.MetalToolTipUI; + +/** + * This class extends JToolTip and set the UI to ImageToolTipUI. + * + * @author Rahul Sapkal(rahul@javareference.com) + */ +public class ImageToolTip extends JToolTip { + + /** + * This class extends MetalToolTipUI and provides customizes it to draw a + * given image on it. + * + * @author Rahul Sapkal(rahul@javareference.com) + */ + private class ImageToolTipUI extends MetalToolTipUI { + private Image m_image; + + public ImageToolTipUI(Image image) { + m_image = image; + } + + /** + * This method is overriden from the MetalToolTipUI to draw the given + * image and text + */ + public void paint(Graphics g, JComponent c) { + FontMetrics metrics = c.getFontMetrics(g.getFont()); + g.setColor(c.getForeground()); + + g.drawString(((ImageToolTip) c).text, 3, 15); + + g.drawImage(m_image, 3, metrics.getHeight() + 3, c); + } + + /** + * This method is overriden from the MetalToolTipUI to return the + * appropiate preferred size to size the ToolTip to show both the text + * and image. + */ + public Dimension getPreferredSize(JComponent c) { + FontMetrics metrics = c.getFontMetrics(c.getFont()); + String tipText = ((JToolTip) c).getTipText(); + if (tipText == null) { + tipText = ""; + } + + int width = SwingUtilities.computeStringWidth(metrics, tipText); + int height = metrics.getHeight() + m_image.getHeight(c) + 6; + + if (width < m_image.getWidth(c)) { + width = m_image.getWidth(c); + } + + return new Dimension(width, height); + } + } + + private String text; + + public ImageToolTip(String text, Image image) { + this.text = text; + setUI(new ImageToolTipUI(image)); + } +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/JCaptureApplet.java b/plugin/jcapture/src/com/hammurapi/jcapture/JCaptureApplet.java new file mode 100644 index 000000000..1627c6a4d --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/JCaptureApplet.java @@ -0,0 +1,92 @@ +package com.hammurapi.jcapture; + +import org.apache.commons.codec.DecoderException; +import org.apache.commons.codec.binary.Hex; +import org.apache.http.client.methods.HttpPost; +import org.apache.http.client.methods.HttpUriRequest; +import org.apache.http.entity.mime.MultipartEntity; +import org.apache.http.entity.mime.content.InputStreamBody; +import org.apache.http.entity.mime.content.StringBody; + +public class JCaptureApplet extends AbstractCaptureApplet { + + private static final String HTTPS_PREFIX = "https://"; + + protected HttpUriRequest createRequest(String fileName, InputStreamBody bin) throws Exception { + String uploadUrl = getParameter("uploadUrl"); + if (uploadUrl==null || uploadUrl.trim().length()==0) { + String host = getParameter("host"); + String dokuHost = host; + + if (dokuHost.toLowerCase().startsWith(HTTPS_PREFIX)) { + if (dokuHost.lastIndexOf(":")0) { + reqEntity.addPart("sectok", new StringBody(sectok)); + } + reqEntity.addPart("ow", new StringBody("1")); + + String opaque = getParameter("opaque"); + if (opaque!=null && opaque.trim().length()>0) { + reqEntity.addPart("opaque", new StringBody(opaque)); + } + + reqEntity.addPart("Filename", new StringBody(fileName)); + + int nsIdx = fileName.lastIndexOf(":"); + String namespace; + if (nsIdx==-1) { + namespace = ":"; + } else { + namespace = ":"+fileName.substring(0, nsIdx); + fileName = fileName.substring(nsIdx+1); + } + + if (namespace!=null) { + reqEntity.addPart("ns", new StringBody(namespace)); + } + + reqEntity.addPart("Filedata", bin); + + httppost.setEntity(reqEntity); + return httppost; + } + + String getDokuBase() throws DecoderException { + return new String(Hex.decodeHex(getParameter("dokuBase").toCharArray())); + } + + @Override + protected String bodyName(String fileName) { + return fileName.substring(fileName.lastIndexOf(":")+1); + } + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/MappedImage.java b/plugin/jcapture/src/com/hammurapi/jcapture/MappedImage.java new file mode 100644 index 000000000..6f7d401fe --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/MappedImage.java @@ -0,0 +1,121 @@ +package com.hammurapi.jcapture; + +import java.awt.image.BufferedImage; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.lang.ref.Reference; +import java.lang.ref.SoftReference; +import java.nio.ByteBuffer; +import java.nio.MappedByteBuffer; +import java.nio.channels.FileChannel; +import java.nio.channels.FileChannel.MapMode; +import java.util.zip.Adler32; + +import javax.imageio.ImageIO; + +/** + * Mapped image is softly kept in memory and also is written to a temporary file. + * If image reference is cleared by the garbage collector, the image is loaded from the file on demand. + * @author Pavel + * + */ +public class MappedImage { + + private Reference imageRef; + private Reference imageBytesRef; + private MappedByteBuffer buffer; + private int height; + private int width; + private String format; + private long checksum; + private int bytesLength; + + public MappedImage(final BufferedImage image, String format, FileChannel channel) throws IOException { + if (format==null) { + throw new NullPointerException("Format is null"); + } + + class HardReference extends SoftReference { + + HardReference(BufferedImage referent) { + super(referent); + } + + @Override + public BufferedImage get() { + return image; + } + + } + imageRef = channel==null ? new HardReference(image) : new SoftReference(image); + width = image.getWidth(); + height = image.getHeight(); + this.format = format; + if (channel!=null) { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + ImageIO.write(imageRef.get(), format, baos); + baos.close(); + byte[] imageBytes = baos.toByteArray(); + Adler32 adler = new Adler32(); + adler.update(imageBytes); + checksum = adler.getValue(); + bytesLength = imageBytes.length; + imageBytesRef = new SoftReference(imageBytes); + synchronized (channel) { + long position = channel.position(); + channel.write(ByteBuffer.wrap(imageBytes)); + buffer = channel.map(MapMode.READ_ONLY, position, imageBytes.length); + } + } + } + + public byte[] getImageBytes() throws IOException { + if (imageBytesRef==null) { + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + ImageIO.write(imageRef.get(), format, baos); + return baos.toByteArray(); + } + byte[] ret = imageBytesRef.get(); + if (ret==null) { + buffer.load(); + buffer.rewind(); + ret = new byte[buffer.remaining()]; + buffer.get(ret); + if (bytesLength != ret.length) { + throw new IllegalStateException("Invalid image bytes length, expected "+bytesLength+", got "+ret.length); + } + + Adler32 adler = new Adler32(); + adler.update(ret); + if (checksum != adler.getValue()) { + throw new IllegalStateException("Invalid image bytes checksum"); + } + imageBytesRef = new SoftReference(ret); + } + return ret; + } + + /** + * Reads from reference, if reference was cleared, loads from the mapped buffer. + * @return + * @throws IOException + */ + public BufferedImage getImage() throws IOException { + BufferedImage ret = imageRef.get(); + if (ret==null) { + ret = ImageIO.read(new ByteArrayInputStream(getImageBytes())); + imageRef = new SoftReference(ret); + } + return ret; + } + + public int getHeight() { + return height; + } + + public int getWidth() { + return width; + } + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/Movie.java b/plugin/jcapture/src/com/hammurapi/jcapture/Movie.java new file mode 100644 index 000000000..c7303e971 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/Movie.java @@ -0,0 +1,55 @@ +package com.hammurapi.jcapture; + +import java.awt.Dimension; +import java.io.Closeable; +import java.io.IOException; +import java.text.MessageFormat; +import java.util.List; + +public class Movie implements Closeable { + + private float framesPerSecond; + private List fragments; + private Dimension frameDimension; + private Closeable imagesFileCloseable; + + public Movie(Dimension frameDimension, float framesPerSecond, List fragments, Closeable imagesFileCloseable) { + super(); + this.frameDimension = frameDimension; + this.framesPerSecond = framesPerSecond; + this.fragments = fragments; + this.imagesFileCloseable = imagesFileCloseable; + } + + public List getFragments() { + return fragments; + } + + public float getFramesPerSecond() { + return framesPerSecond; + } + + public Dimension getFrameDimension() { + return frameDimension; + } + + @Override + public String toString() { + int frames = 0; + for (VideoEncoder.Fragment f: fragments) { + frames+=f.getFrames().size(); + } + + long length = (long) (frames/framesPerSecond); + + return MessageFormat.format("{0,number,00}:{1,number,00}:{2,number,00}, {3} frames", length/3600, (length/60) % 60, length % 60, frames); + } + + @Override + public void close() throws IOException { + if (imagesFileCloseable!=null) { + imagesFileCloseable.close(); + } + } + +} \ No newline at end of file diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/MovieEditorDialog.java b/plugin/jcapture/src/com/hammurapi/jcapture/MovieEditorDialog.java new file mode 100644 index 000000000..297420a2d --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/MovieEditorDialog.java @@ -0,0 +1,1124 @@ +package com.hammurapi.jcapture; + +import java.awt.AlphaComposite; +import java.awt.BorderLayout; +import java.awt.Color; +import java.awt.Component; +import java.awt.Dimension; +import java.awt.Graphics; +import java.awt.Graphics2D; +import java.awt.GridBagConstraints; +import java.awt.GridBagLayout; +import java.awt.Image; +import java.awt.Insets; +import java.awt.Point; +import java.awt.Rectangle; +import java.awt.RenderingHints; +import java.awt.Toolkit; +import java.awt.event.ActionEvent; +import java.awt.event.ActionListener; +import java.awt.event.MouseAdapter; +import java.awt.event.MouseEvent; +import java.awt.event.WindowAdapter; +import java.awt.event.WindowEvent; +import java.awt.image.BufferedImage; +import java.io.File; +import java.io.IOException; +import java.lang.ref.Reference; +import java.lang.ref.SoftReference; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.concurrent.Executor; + +import javax.sound.sampled.AudioFormat; +import javax.sound.sampled.AudioInputStream; +import javax.sound.sampled.AudioSystem; +import javax.sound.sampled.DataLine; +import javax.sound.sampled.SourceDataLine; +import javax.swing.AbstractAction; +import javax.swing.Action; +import javax.swing.JButton; +import javax.swing.JCheckBox; +import javax.swing.JCheckBoxMenuItem; +import javax.swing.JComponent; +import javax.swing.JFrame; +import javax.swing.JMenuItem; +import javax.swing.JOptionPane; +import javax.swing.JPanel; +import javax.swing.JPopupMenu; +import javax.swing.JScrollPane; +import javax.swing.JTable; +import javax.swing.JToolTip; +import javax.swing.ListSelectionModel; +import javax.swing.ProgressMonitor; +import javax.swing.SwingWorker; +import javax.swing.Timer; +import javax.swing.event.PopupMenuEvent; +import javax.swing.event.PopupMenuListener; +import javax.swing.table.DefaultTableModel; +import javax.swing.table.TableCellRenderer; +import javax.swing.table.TableModel; + +import com.hammurapi.jcapture.ShapeImpl.ImageImpl; +import com.hammurapi.jcapture.VideoEncoder.Fragment; +import com.hammurapi.jcapture.VideoEncoder.Fragment.Frame; +import com.hammurapi.jcapture.VideoEncoder.Fragment.Frame.Shape; +import com.hammurapi.jcapture.VideoEncoder.Fragment.Frame.Shape.ImageReference; +import com.hammurapi.jcapture.VideoEncoder.Fragment.Frame.Shape.ShapeContent; + +public class MovieEditorDialog extends javax.swing.JDialog { + + private static final double DECIBELS_PER_PIXEL = 2.0; + private static final double NORMALIZED_LEVEL = 0.95; + private static final int AUDIO_CELL_HEIGHT = 50; + private static final int MEDIAN = AUDIO_CELL_HEIGHT/2; + int minCellDimension = 10; + int minToolTipImageDimension = 150; + + int splashIndex = -1; + + double coeff; + + private static Color INACTIVE_COLOR = new Color(230, 230, 230); + private static Color ACTIVE_COLOR = Color.white; + private static Color SELECTED_COLOR = new Color(0, 0, 255, 70); + private static Color FOCUSED_COLOR = new Color(0, 0, 255, 100); + private static Color PLAYING_COLOR = new Color(255, 0, 0, 100); + + private static Color SPLASH_COLOR = new Color(0, 255, 0, 127); + + private static Color SOUND_COLOR = new Color(0, 0, 127); + private static Color DELETED_SOUND_COLOR = new Color(100, 100, 100); + + private JButton saveButton; + private JPanel contentPanel; + private JScrollPane timeLineScrollPane; + private JCheckBox normalizeVolumeCheckBox; + private JPanel frameCanvas; + JTable timeLineTable; + private JButton discardButton; + private int focusColumn = 0; + private int playingColumn = -1; + private Image mouseImage; + private double maxVolume = -1; + FrameEntry[] frameEntries; + int cellWidth; + int cellHeight; + int toolTipImageWidth; + int toolTipImageHeight; + boolean hasAudio; + private Movie movie; + + int numChannels; + int validBits; + long sampleRate; + Timer[] playTimera = {null}; + private Executor backgroundProcessor; + private double inactivityInterval; + private String imageFormat; + + private class FrameEntry { + + // Not null for first frames in fragments indicating that + // Indicating that it's time to open a new audio file. + File audioFile; + + boolean mouseMoved; + + // Scaled samples for painting - not real ones. + // idx, {min, max} + double[] audioSamples; + + // Number of real samples falling to this frame. + int audioSamplesInFrame; + + boolean isDeleted; + + Reference toolTipImageRef; + + Reference frameImageRef; + + // row, selected, focus + private JPanel[][][] canvases = { + { {new FrameCellCanvas(false, false), new FrameCellCanvas(false, true)}, {new FrameCellCanvas(true, false), new FrameCellCanvas(true, true)} }, + { {new AudioCellCanvas(false, false), new AudioCellCanvas(false, true)}, {new AudioCellCanvas(true, false), new AudioCellCanvas(true, true)} } + }; + + class CellCanvas extends JPanel { + + boolean selected; + boolean hasFocus; + + CellCanvas(boolean selected, boolean hasFocus) { + this.selected = selected; + this.hasFocus = hasFocus; + } + + } + + class FrameCellCanvas extends CellCanvas { + + FrameCellCanvas(boolean selected, boolean hasFocus) { + super(selected, hasFocus); + } + + @Override + public void paintComponent(Graphics g) { + super.paintComponent(g); + paintFrame(this, g, selected, hasFocus); + } + + } + + class AudioCellCanvas extends CellCanvas { + + AudioCellCanvas(boolean selected, boolean hasFocus) { + super(selected, hasFocus); + } + + @Override + public void paintComponent(Graphics g) { + super.paintComponent(g); + paintAudio(this, g, selected, hasFocus); + } + + } + + int idx; + int delta; + + Frame frame; + + BufferedImage getToolTipImage() throws IOException { + BufferedImage ret = toolTipImageRef==null ? null : toolTipImageRef.get(); + if (ret == null) { + BufferedImage image = getImage(); + ret = new BufferedImage(toolTipImageWidth, toolTipImageHeight, image.getType()); + Graphics2D g = ret.createGraphics(); + g.setComposite(AlphaComposite.Src); + g.setRenderingHint(RenderingHints.KEY_INTERPOLATION,RenderingHints.VALUE_INTERPOLATION_BILINEAR); + g.setRenderingHint(RenderingHints.KEY_RENDERING,RenderingHints.VALUE_RENDER_QUALITY); + g.setRenderingHint(RenderingHints.KEY_ANTIALIASING,RenderingHints.VALUE_ANTIALIAS_ON); + g.drawImage(image, 0, 0, ret.getWidth(), ret.getHeight(), null); + g.dispose(); + toolTipImageRef = new SoftReference(ret); + } + return ret; + + } + + void paintFrame(FrameCellCanvas frameCellCanvas, Graphics g, boolean selected, boolean hasFocus) { + g.setColor(frame.isActive() ? ACTIVE_COLOR : INACTIVE_COLOR); + g.fillRect(0, 0, frameCellCanvas.getWidth(), frameCellCanvas.getHeight()); + + if (idx==splashIndex) { + g.setColor(SPLASH_COLOR); + g.fillRect(1, 1, frameCellCanvas.getWidth()-2, frameCellCanvas.getHeight()-2); + + } + + if (frame.getMousePointer()!=null) { + int mx = (int) (frame.getMousePointer().getX()*(frameCellCanvas.getWidth()-3)/frame.getSize().getWidth())+1; + int my = (int) (frame.getMousePointer().getY()*(frameCellCanvas.getHeight()-3)/frame.getSize().getHeight())+1; + g.setColor(mouseMoved ? Color.BLACK : Color.GRAY); + g.fillRect(mx, my, 2, 2); + } + + if (isDeleted) { + g.setColor(Color.RED); + g.drawLine(2, 2, frameCellCanvas.getWidth()-2, frameCellCanvas.getHeight()-2); + g.drawLine(frameCellCanvas.getWidth()-2, 2, 2, frameCellCanvas.getHeight()-2); + } + + decorate(frameCellCanvas, g, selected, hasFocus); + } + + void paintAudio(AudioCellCanvas audioCellCanvas, Graphics g, boolean selected, boolean hasFocus) { + g.setColor(frame.isActive() ? ACTIVE_COLOR : INACTIVE_COLOR); + g.fillRect(0, 0, audioCellCanvas.getWidth(), audioCellCanvas.getHeight()); + + if (audioSamples!=null) { + for (int i = 0; i0 && !coversEverything(startIdx)) { + --startIdx; + } + int deltaArea = 0; + ret = new BufferedImage(frame.getSize().width, frame.getSize().height, shapeImage(frameEntries[startIdx].frame.getShapes().get(0)).getType()); + Graphics2D g = ret.createGraphics(); + for (int i=startIdx; i<=idx; ++i) { + for (Shape shape: frameEntries[i].frame.getShapes()) { + BufferedImage si = shapeImage(shape); + g.drawImage(si, shape.getLocation().x, shape.getLocation().y, null); + if (i==idx) { + deltaArea+=si.getWidth()*si.getHeight(); + } + } + } + delta = (int) (100.0*deltaArea/(frame.getSize().width * frame.getSize().height)); + if (frame.getMousePointer()!=null) { + g.drawImage(mouseImage, frame.getMousePointer().x, frame.getMousePointer().y, null); + } + frameImageRef = new SoftReference(ret); + } + return ret; + } + + private BufferedImage shapeImage(Shape shape) throws IOException { + ShapeContent shapeContent = shape.getContent(); + if (shapeContent instanceof ImageReference) { + return ((ImageReference) shapeContent).getImage().getImage().getImage(); + } + return ((com.hammurapi.jcapture.VideoEncoder.Fragment.Frame.Shape.Image) shapeContent).getImage().getImage(); + } + + boolean coversEverything(int entryIdx) { + for (Shape shape: frameEntries[entryIdx].frame.getShapes()) { + if (shape.getContent().coversEverything()) { + return true; + } + } + return false; + } + + public Component getCellRendererComponent(int row, boolean isSelected, boolean hasFocus) { + return canvases[row][isSelected ? 1 : 0][hasFocus ? 1 : 0]; + } + + } + + public MovieEditorDialog( + final JFrame frame, + final Movie movie, + final Executor backgroundProcessor, + double inactivityInterval, + String imageFormat) { + + super(frame, "Movie editor ("+movie+")"); + frame.setAlwaysOnTop(false); + frame.setVisible(false); + + this.movie = movie; + this.backgroundProcessor = backgroundProcessor; + this.inactivityInterval = inactivityInterval; + this.imageFormat = imageFormat; + + setModal(true); + setIconImage(frame.getIconImage()); + + mouseImage = Toolkit.getDefaultToolkit().getImage(getClass().getResource("mouse.png")); + + double aspectRatio = (double) movie.getFrameDimension().getWidth()/(double) movie.getFrameDimension().getHeight(); + + if (aspectRatio>1) { + cellHeight = minCellDimension; + cellWidth = (int) Math.round(aspectRatio*cellHeight); + + toolTipImageHeight = minToolTipImageDimension; + toolTipImageWidth = (int) Math.round(aspectRatio*toolTipImageHeight); + } else { + cellWidth = minCellDimension; + cellHeight = (int) Math.round((double) cellWidth/aspectRatio); + + toolTipImageWidth = minToolTipImageDimension; + toolTipImageHeight = (int) Math.round((double) toolTipImageWidth/aspectRatio); + } + + setDefaultCloseOperation(DO_NOTHING_ON_CLOSE); + + addWindowListener(new WindowAdapter() { + public void windowClosing(WindowEvent e) { + int confirmed = JOptionPane.showConfirmDialog(null, + "Are you sure you want to exit and discard the movie?", "User Confirmation", + JOptionPane.YES_NO_OPTION); + if (confirmed == JOptionPane.YES_OPTION) { + dispose(); + getOwner().setVisible(false); + } + } + }); + + SwingWorker loader = new SwingWorker() { + + @Override + protected Boolean doInBackground() throws Exception { + int totalFrames = 0; + for (Fragment fr: movie.getFragments()) { + if (fr.getAudio()!=null) { + hasAudio = true; + } + totalFrames+=fr.getFrames().size(); + } + + ProgressMonitor progressMonitor = new ProgressMonitor(frame, "Loading frames", "Loading movie frames", 0, totalFrames); + + try { + frameEntries = new FrameEntry[totalFrames]; + int idx = 0; + double audioSamplesPerFrame = -1; + Point prevMouse = null; + for (Fragment fr: movie.getFragments()) { + WavFile wavFile = fr.getAudio()==null ? null : WavFile.openWavFile(fr.getAudio()); + if (wavFile!=null) { + audioSamplesPerFrame = wavFile.getSampleRate()/movie.getFramesPerSecond(); + numChannels = wavFile.getNumChannels(); + validBits = wavFile.getValidBits(); + sampleRate = wavFile.getSampleRate(); + } + int audioFramesRead = 0; + int framePosition = 0; + for (Frame frm: fr.getFrames()) { + if (progressMonitor.isCanceled()) { + return false; + } + frameEntries[idx] = new FrameEntry(); + frameEntries[idx].frame = frm; + frameEntries[idx].idx = idx; + if (frm.getMousePointer()!=null) { + frameEntries[idx].mouseMoved = !frm.getMousePointer().equals(prevMouse); + } + prevMouse = frm.getMousePointer(); + + if (framePosition == 0) { + frameEntries[idx].audioFile = fr.getAudio(); + } + + if (wavFile!=null && wavFile.getFramesRemaining()>0) { + frameEntries[idx].audioSamplesInFrame = (int) ((framePosition+1)*audioSamplesPerFrame-audioFramesRead); + frameEntries[idx].audioSamples = new double[cellWidth]; + double[][] sampleBuffer = new double[wavFile.getNumChannels()][frameEntries[idx].audioSamplesInFrame]; + frameEntries[idx].audioSamplesInFrame=wavFile.readFrames(sampleBuffer, frameEntries[idx].audioSamplesInFrame); + audioFramesRead+=frameEntries[idx].audioSamplesInFrame; + for (int i=0; i encoder = new SwingWorker() { + + @Override + protected Movie doInBackground() throws Exception { + ProgressMonitor progressMonitor = new ProgressMonitor(MovieEditorDialog.this, "Saving movie", "Composing movie", 0, frameEntries.length); + + List newFrames = new ArrayList(); + + if (splashIndex!=-1) { + newFrames.add(new FrameImpl( + Collections.singletonList((Shape) new ShapeImpl(new Point(0,0), new ImageImpl(new MappedImage(frameEntries[splashIndex].getImage(), imageFormat, null), true))) , + frameEntries[splashIndex].frame.getMousePointer(), + frameEntries[splashIndex].frame.getSize(), + false)); + } + + File newAudio = hasAudio ? File.createTempFile("jCaptureAudioSink", ".wav") : null; + + long numFrames=0; + for (FrameEntry fe: frameEntries) { + if (!fe.isDeleted) { + numFrames+=fe.audioSamplesInFrame; + } + } + WavFile newWavFile = newAudio==null ? null : WavFile.newWavFile(newAudio, numChannels, numFrames, validBits, sampleRate); + + File currentAudio = null; + WavFile currentWav = null; + + for (int i=0; i0 && !frameEntries[i].isDeleted) { + // Normalization + for (double[] ch: buf) { + for (int j=0; j0 && !frameEntries[i].isDeleted) { + newWavFile.writeFrames(buf, read); + } + } + } + + if (frameEntries[i].isDeleted) { + if (i=0 && timeLineTable.isColumnSelected(i); --i) { + range[0] = i; + } + + if (range[0]==range[1]) { + range[1]=frameEntries.length-1; + } + + playingColumn = range[0]; + + if (hasAudio) { + try { + backgroundProcessor.execute(new SoundPlayer(range[0], range[1])); + } catch (Exception ex) { + ex.printStackTrace(); + JOptionPane.showMessageDialog( + MovieEditorDialog.this, + ex.toString(), + "Audio problem", + JOptionPane.ERROR_MESSAGE); + + } + } + + playTimera[0] = new Timer((int) ((double) 1000/movie.getFramesPerSecond()), new ActionListener() { + + @Override + public void actionPerformed(ActionEvent e) { + while (frameEntries[playingColumn].isDeleted) { + ++playingColumn; + if (playingColumn>range[1]) { + ((Timer) e.getSource()).stop(); + return; + } + } + + Rectangle visibleRect = timeLineTable.getVisibleRect(); + Rectangle playingRect = timeLineTable.getCellRect(0, playingColumn, true); + if (!visibleRect.contains(playingRect)) { + Rectangle scrollTo = new Rectangle(playingRect.x, playingRect.width, visibleRect.width-1, visibleRect.height-1); + timeLineTable.scrollRectToVisible(scrollTo); + } + + frameCanvas.repaint(); + timeLineTable.repaint(); + + ++playingColumn; + if (playingColumn>range[1]) { + ((Timer) e.getSource()).stop(); + return; + } + } + + + }) { + @Override + public void stop() { + super.stop(); + playingColumn=-1; + timeLineTable.scrollRectToVisible(timeLineTable.getCellRect(0, focusColumn, true)); + frameCanvas.repaint(); + timeLineTable.repaint(); + playTimera[0] = null; + } + }; + + playTimera[0].start(); + synchronized (playTimera) { + playTimera.notifyAll(); + } + } + }; + playMenuItem.setAction(playAction); + + popup.add(playMenuItem); + + timeLineTable.setComponentPopupMenu(popup ); + + timeLineTable.addMouseListener(new MouseAdapter() { + + @Override + public void mouseClicked(MouseEvent e) { + if (playTimera[0]!=null) { + playTimera[0].stop(); + } + + if (e.getClickCount()==2) { + int hitColumnIndex = timeLineTable.columnAtPoint(e.getPoint()); + if (hitColumnIndex!=-1) { + frameEntries[hitColumnIndex].isDeleted=!frameEntries[hitColumnIndex].isDeleted; + timeLineTable.repaint(); + } + } + } + }); + + timeLineTable.setToolTipText("Movie timeline"); + timeLineScrollPane.setViewportView(timeLineTable); + timeLineTable.setModel(timeLineTableModel); + timeLineTable.setRowHeight(0, cellHeight+timeLineTable.getRowMargin()*2); + timeLineTable.setRowHeight(1, AUDIO_CELL_HEIGHT+timeLineTable.getRowMargin()*2); + for (int i=0; i 0) { + break; + } + } catch (NumberFormatException nfe) { + // NOP - loop + } + msg = "Invalid double value for inactivity interval: "+newVal+", enter valid value"; + } + int inactivityInFrames = (int) (inactivityInterval*movie.getFramesPerSecond()); + int lastActivity = -inactivityInFrames-1; + for (int idx: timeLineTable.getSelectedColumns()) { + if (!frameEntries[idx].isDeleted && frameEntries[idx].frame.isActive()) { + lastActivity = idx; + } else if (idx - lastActivity > inactivityInFrames && !frameEntries[idx].frame.isActive()) { + frameEntries[idx].isDeleted = true; + } + } + timeLineTable.repaint(); + } + }; + + removeInactivityMenuItem.setAction(deleteFrameAction); + popup.add(removeInactivityMenuItem); + } + + private class SoundPlayer implements Runnable { + + private final int BUFFER_SIZE; + private AudioInputStream audioStream; + private SourceDataLine sourceLine; + private File audioFile; + + public SoundPlayer(int start, int end) throws Exception { + + audioFile = hasAudio ? File.createTempFile("jCaptureRangeAudio", ".wav") : null; + + BUFFER_SIZE = (int) ((double) numChannels*sampleRate*validBits/(movie.getFramesPerSecond()*8)); // 1 frame buffer. + + long numFrames=0; + for (int i = start; i<=end; ++i) { + if (!frameEntries[i].isDeleted) { + numFrames+=frameEntries[i].audioSamplesInFrame; + } + } + WavFile newWavFile = audioFile==null ? null : WavFile.newWavFile(audioFile, numChannels, numFrames, validBits, sampleRate); + + File currentAudio = null; + WavFile currentWav = null; + + for (int i=0; i<=end; ++i) { + if (frameEntries[i].audioFile!=null) { + if (currentWav!=null) { + currentWav.close(); + } + + currentAudio = frameEntries[i].audioFile; + currentWav = WavFile.openWavFile(currentAudio); + } + + if (currentWav!=null) { + if (normalizeVolumeCheckBox!=null && normalizeVolumeCheckBox.isSelected()) { + double[][] buf = new double[numChannels][frameEntries[i].audioSamplesInFrame]; + int read = currentWav.readFrames(buf, frameEntries[i].audioSamplesInFrame); + if (read>0 && i>=start && !frameEntries[i].isDeleted) { + // Normalization + for (double[] ch: buf) { + for (int j=0; j0 && i>=start && !frameEntries[i].isDeleted) { + newWavFile.writeFrames(buf, read); + } + } + } + } + + if (currentWav!=null) { + currentWav.close(); + } + if (newWavFile!=null) { + newWavFile.close(); + } + + if (audioFile!=null) { + audioStream = AudioSystem.getAudioInputStream(audioFile); + AudioFormat audioFormat = audioStream.getFormat(); + DataLine.Info info = new DataLine.Info(SourceDataLine.class, audioFormat); + sourceLine = (SourceDataLine) AudioSystem.getLine(info); + sourceLine.open(audioFormat); + } + } + + @Override + public void run() { + try { + sourceLine.start(); + synchronized (playTimera) { + if (playTimera[0] == null) { + playTimera.wait(100); + } + } + try { + byte[] buf = new byte[BUFFER_SIZE]; + int l; + while (playTimera[0]!=null && (l=audioStream.read(buf))!=-1) { + sourceLine.write(buf, 0, l); + } + } finally { + audioStream.close(); + sourceLine.drain(); + sourceLine.close(); + if (!audioFile.delete()) { + audioFile.deleteOnExit(); + } + } + } catch (Exception e) { + e.printStackTrace(); + } + } + + } + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/RecordingControlsFrame.java b/plugin/jcapture/src/com/hammurapi/jcapture/RecordingControlsFrame.java new file mode 100644 index 000000000..2196ce30d --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/RecordingControlsFrame.java @@ -0,0 +1,321 @@ +package com.hammurapi.jcapture; + +import java.awt.BorderLayout; +import java.awt.Dimension; +import java.awt.GridBagConstraints; +import java.awt.GridBagLayout; +import java.awt.Insets; +import java.awt.event.ActionEvent; +import java.awt.event.ActionListener; +import java.awt.event.ComponentEvent; +import java.awt.event.ComponentListener; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; + +import javax.swing.JButton; +import javax.swing.JFrame; +import javax.swing.JOptionPane; +import javax.swing.JPanel; +import javax.swing.SwingWorker; +import javax.swing.WindowConstants; +import javax.swing.border.LineBorder; + +import netscape.javascript.JSObject; + +import org.apache.http.HttpResponse; +import org.apache.http.HttpStatus; + +public class RecordingControlsFrame extends javax.swing.JFrame { + private static final String RESUME_TEXT = "Resume"; + private static final String PAUSE_TEXT = "Pause"; + private JButton pauseButton; + private JButton cancelButton; + private JButton stopButton; + private ScreenRecorder screenRecorder; + private CaptureFrame captureFrame; + + public RecordingControlsFrame(final CaptureFrame captureFrame, final JFrame[] borderFrames) { + super("jCapture recording"); + setIconImage(captureFrame.getIconImage()); + this.captureFrame = captureFrame; + + setUndecorated(true); + setAlwaysOnTop(!getBounds().intersects(captureFrame.getBounds())); + + addComponentListener(new ComponentListener() { + + @Override + public void componentShown(ComponentEvent e) { + for (JFrame bf: borderFrames) { + if (bf!=null) { + bf.setVisible(true); + } + } + } + + @Override + public void componentResized(ComponentEvent e) { + // TODO Auto-generated method stub + + } + + @Override + public void componentMoved(ComponentEvent e) { + // TODO Auto-generated method stub + + } + + @Override + public void componentHidden(ComponentEvent e) { + for (JFrame bf: borderFrames) { + if (bf!=null) { + bf.setVisible(false); + } + } + } + }); + + JPanel contentPanel = new JPanel(); + contentPanel.setBorder(new LineBorder(new java.awt.Color(0, 0, 0), 1, false)); + getContentPane().add(contentPanel, BorderLayout.CENTER); + + GridBagLayout thisLayout = new GridBagLayout(); + setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE); + thisLayout.rowWeights = new double[] { 0.0, 0.1, 0.0 }; + thisLayout.rowHeights = new int[] { 7, 7, 7 }; + thisLayout.columnWeights = new double[] { 0.0, 0.1, 0.0, 0.1, 0.0, 0.1, 0.0 }; + thisLayout.columnWidths = new int[] { 7, 20, 7, 20, 7, 7, 7 }; + contentPanel.setLayout(thisLayout); + + pauseButton = new JButton(); + contentPanel.add(pauseButton, new GridBagConstraints(1, 1, 1, 1, 0.0, + 0.0, GridBagConstraints.CENTER, GridBagConstraints.BOTH, + new Insets(0, 0, 0, 0), 0, 0)); + pauseButton.setText(PAUSE_TEXT); + pauseButton.addActionListener(new ActionListener() { + public void actionPerformed(ActionEvent evt) { + try { + if (PAUSE_TEXT.equals(pauseButton.getText())) { + screenRecorder.stop(); + pauseButton.setText(RESUME_TEXT); + } else { + screenRecorder.start(); + pauseButton.setText(PAUSE_TEXT); + } + } catch (Exception e) { + e.printStackTrace(); + JOptionPane.showMessageDialog(RecordingControlsFrame.this, + e.toString(), "Error pausing/resuming recording", + JOptionPane.ERROR_MESSAGE); + } + } + }); + + stopButton = new JButton(); + contentPanel.add(stopButton, new GridBagConstraints(3, 1, 1, 1, 0.0, + 0.0, GridBagConstraints.CENTER, GridBagConstraints.BOTH, + new Insets(0, 0, 0, 0), 0, 0)); + stopButton.setText("Stop"); + stopButton.addActionListener(new ActionListener() { + public void actionPerformed(ActionEvent evt) { + + pauseButton.setEnabled(false); + stopButton.setEnabled(false); + cancelButton.setEnabled(false); + + SwingWorker task = new SwingWorker() { + + @Override + protected Movie doInBackground() throws Exception { + screenRecorder.stop(); + return screenRecorder.getMovie(); + } + + @Override + protected void done() { + try { + final Movie movie = get(); + if (movie!=null) { + if (JOptionPane.showConfirmDialog(RecordingControlsFrame.this, "Would you like to edit the movie before uploading?", "Edit movie?", JOptionPane.YES_NO_OPTION)==JOptionPane.YES_OPTION) { + new MovieEditorDialog( + RecordingControlsFrame.this, + movie, + captureFrame.getCaptureConfig().getBackgroundProcessor(), + captureFrame.getCaptureConfig().getInactivityInterval(), + captureFrame.getCaptureConfig().getImageFormat()); + } else { + uploadMovie(movie); + } + } else { + JOptionPane.showMessageDialog( + RecordingControlsFrame.this, + "Recording discarded", + "Saving recording", + JOptionPane.INFORMATION_MESSAGE); + RecordingControlsFrame.this.setVisible(false); + } + } catch (Exception e) { + e.printStackTrace(); + JOptionPane.showMessageDialog( + RecordingControlsFrame.this, e.toString(), + "Error saving recording", + JOptionPane.ERROR_MESSAGE); + RecordingControlsFrame.this.setVisible(false); + } + } + + }; + + task.execute(); + + } + }); + + cancelButton = new JButton(); + contentPanel.add(cancelButton, new GridBagConstraints(5, 1, 1, 1, 0.0, + 0.0, GridBagConstraints.CENTER, GridBagConstraints.BOTH, + new Insets(0, 0, 0, 0), 0, 0)); + cancelButton.setText("Cancel"); + cancelButton.addActionListener(new ActionListener() { + public void actionPerformed(ActionEvent evt) { + if (JOptionPane.showConfirmDialog(RecordingControlsFrame.this, "Are you sure you want to discard the recording?", "Confirm discarding movie", JOptionPane.YES_NO_OPTION)==JOptionPane.YES_OPTION) {; + try { + screenRecorder.stop(); + } catch (Exception e) { + e.printStackTrace(); + JOptionPane.showMessageDialog(RecordingControlsFrame.this, + e.toString(), "Error cancelling recording", + JOptionPane.ERROR_MESSAGE); + } finally { + RecordingControlsFrame.this.setVisible(false); + captureFrame.setVisible(true); + } + } + } + }); + + pack(); + this.setSize(301, 40); + captureFrame.getCaptureConfig().setParentComponent(this); + try { + screenRecorder = new ScreenRecorder(captureFrame.getCaptureConfig(), captureFrame.getApplet()); + } catch (Exception e) { + e.printStackTrace(); + JOptionPane.showMessageDialog(this, e.toString(), "Error starting recording", JOptionPane.ERROR_MESSAGE); + setVisible(false); + } + + } + + /** + * Asks for file name and uploads the movie. + * @param movie + */ + void uploadMovie(final Movie movie) { + try { + if (movie!=null) { + + final String fileName = JOptionPane.showInputDialog( + RecordingControlsFrame.this, + "Upload as", + captureFrame.getApplet().getParameter("pageName")+ + "-recording-"+ + captureFrame.getDatePrefix()+ + "-" + captureFrame.nextCounter() +"."+captureFrame.getCaptureConfig().getEncoder().getFileExtension()); + + if (fileName!=null) { + // Uploading + SwingWorker task = new SwingWorker() { + + @Override + protected Dimension doInBackground() throws Exception { + + File savedTo = null; + + try { + // encode and upload + File tmpFile = File.createTempFile("jCaptureMovie", "."+captureFrame.getCaptureConfig().getEncoder().getFileExtension()); + FileOutputStream out = new FileOutputStream(tmpFile); + Dimension dimension = captureFrame.getCaptureConfig().getEncoder().encode(captureFrame.getCaptureConfig(), movie, out); + if (dimension==null) { + return null; + } + out.close(); + savedTo = tmpFile; + + HttpResponse iResponse = captureFrame.getApplet().post( + RecordingControlsFrame.this, + new FileInputStream(tmpFile), + tmpFile.length(), + fileName, + "application/octet-stream"); + + if (iResponse!=null) { + System.out.println("Response status line: "+iResponse.getStatusLine()); + if (iResponse.getStatusLine().getStatusCode()!=HttpStatus.SC_OK) { + errorMessage = iResponse.getStatusLine(); + errorTitle = "Error saving recording"; + return null; + } + } + if (!tmpFile.delete()) { + tmpFile.deleteOnExit(); + } + return dimension; + } catch (Error e) { + errorMessage=e.toString(); + if (savedTo!=null) { + errorMessage=errorMessage + ",\n recording was saved to "+savedTo.getAbsolutePath(); + } + errorTitle = "Upload error"; + e.printStackTrace(); + return null; + } + } + + private Object errorMessage; + private String errorTitle; + + protected void done() { + try { + Dimension dimension = get(); + if (dimension!=null) { + JSObject window = JSObject.getWindow(captureFrame.getApplet()); + String toEval = "insertAtCarret('"+captureFrame.getApplet().getParameter("edid")+"','{{:"+fileName+"?"+dimension.width+"x"+dimension.height+"|}}')"; + System.out.println("Evaluating: "+toEval); + window.eval(toEval); + } else { + JOptionPane.showMessageDialog( + RecordingControlsFrame.this, + errorMessage, + errorTitle, + JOptionPane.ERROR_MESSAGE); + } + } catch (Exception e) { + e.printStackTrace(); + JOptionPane.showMessageDialog( + RecordingControlsFrame.this, + e.toString(), + "Exception", + JOptionPane.ERROR_MESSAGE); + } + }; + + }; + + task.execute(); + } + } else { + JOptionPane.showMessageDialog( + RecordingControlsFrame.this, + "Recording discarded", + "Saving recording", + JOptionPane.INFORMATION_MESSAGE); + } + } finally { + RecordingControlsFrame.this.setVisible(false); + } + } + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/Region.java b/plugin/jcapture/src/com/hammurapi/jcapture/Region.java new file mode 100644 index 000000000..b5bc0a05d --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/Region.java @@ -0,0 +1,221 @@ +package com.hammurapi.jcapture; + +import java.awt.Color; +import java.awt.Point; +import java.awt.Rectangle; +import java.awt.image.BufferedImage; +import java.io.IOException; +import java.nio.channels.FileChannel; + +public class Region extends Rectangle { + + private static final int TRANSPARENT_COLOR = new Color(0,0,0,0).getRGB(); + + private BufferedImage master; + private BufferedImage prev; + private int grabRange; + private MappedImage image; + private boolean transparency; + + public Region(BufferedImage master, String format, FileChannel channel, BufferedImage prev, boolean transparency, int x, int y, int grabRange) { + this.master = master; + this.format = format; + this.channel = channel; + this.prev = prev; + this.transparency = transparency; + this.grabRange = grabRange; + + setBounds(x-grabRange, y-grabRange, grabRange*2+1, grabRange*2+1); + } + + /** + * Special case when region covers the whole image. + * @param master + * @param x + * @param y + * @param grabRange + * @throws IOException + */ + public Region(MappedImage master) throws IOException { + this.image = master; + this.grabRange = 0; + imageLocation = new Point(0,0); + coversEverything = true; + + setBounds(0,0,master.getWidth(),master.getHeight()); + BufferedImage img = master.getImage(); + for (int sx=0, sw=master.getWidth(); sx0) { + imageWidth-=widthDelta; + } + + int imageHeight = height; + int heightDelta = imageHeight+imageLocation.y - master.getHeight(); + if (heightDelta>0) { + imageHeight-=heightDelta; + } + + BufferedImage bImage = new BufferedImage(imageWidth, imageHeight, BufferedImage.TYPE_INT_ARGB); + for (int x=0; x0) { + Thread.sleep(toSleep); + } + + screenShot = config.createScreenShot(screenShot, imagesChannel); + if (first==null) { + first = screenShot; + } + screenshots.add(config.submit(screenShot)); + } + + System.out.println("Captured "+screenshots.size()+" screenshots"); + } + + } + + public Fragment() throws Exception { + if (targetDataLine!=null) { + audioSink = File.createTempFile("jCaptureAudioSink", ".wav"); + targetDataLine.start(); + audioRecordingThread = new AudioRecordingThread(); + audioRecordingThread.start(); + } + + screenCapturingThread = new ScreenCapturingThread(); + screenCapturingThread.start(); + } + + File audioSink; + List> screenshots = new ArrayList>(); + + AudioRecordingThread audioRecordingThread; + ScreenCapturingThread screenCapturingThread; + + volatile boolean isDone; + + void stop() throws Exception { + if (targetDataLine!=null) { + targetDataLine.stop(); + } + isDone = true; + if (audioRecordingThread!=null) { + audioRecordingThread.join(); + } + screenCapturingThread.join(); + if (screenCapturingThread.getException()!=null) { + throw screenCapturingThread.getException(); + } + if (audioRecordingThread!=null && audioRecordingThread.getException()!=null) { + throw audioRecordingThread.getException(); + } + } + + } + + LinkedList fragments = new LinkedList(); + private FileChannel imagesChannel; + + public ScreenRecorder(CaptureConfig config, AbstractCaptureApplet applet) throws Exception { + this.config = config; + final File imagesFile = File.createTempFile("jCaptureImages", ".tmp"); + imagesFile.deleteOnExit(); + final RandomAccessFile raf = new RandomAccessFile(imagesFile, "rw"); + this.imagesChannel = raf.getChannel(); + + imagesFileCloseable = new Closeable() { + + @Override + public void close() throws IOException { + imagesChannel.close(); + raf.close(); + if (!imagesFile.delete()) { + imagesFile.deleteOnExit(); + } + } + + }; + + applet.addCloseable(imagesFileCloseable); + + if (config.isSound()) { + DataLine.Info info = new DataLine.Info(TargetDataLine.class, config.getAudioFormat()); + + Mixer mixer = null; + Mixer firstMixer = null; + for (Mixer.Info mi: AudioSystem.getMixerInfo()) { + Mixer mx = AudioSystem.getMixer(mi); + if (mx.isLineSupported(info)) { + if (firstMixer==null) { + firstMixer = mx; + } + if (config.getMixerName()==null || mi.getName().equals(config.getMixerName())) { + mixer = mx; + break; + } + } + } + + if (mixer==null) { + mixer = firstMixer; + } + + if (mixer!=null) { + targetDataLine = (TargetDataLine) mixer.getLine(info); + targetDataLine.open(config.getAudioFormat()); + } + } + + frameLength = (long) (1000.0/config.getFramesPerSecond()); + + start(); + } + + public synchronized void start() throws Exception { + fragments.add(new Fragment()); + } + + public void stop() throws Exception { + fragments.getLast().stop(); + } + + /** + * Recording is discarded if saveTo is null + * @param saveTo + * @return Movie size in pixels or null if saving was cancelled. + * @throws IOException + * @throws DataFormatException + */ + public Movie getMovie() throws Exception { + stop(); + + if (targetDataLine!=null) { + targetDataLine.close(); + } + + int totalWork = 3; + for (Fragment f: fragments) { + totalWork+=f.screenshots.size()+1; + } + + Map imageCache = new IdentityHashMap(); + + Dimension frameDimension = null; + + ProgressMonitor progressMonitor = new ProgressMonitor(config.getParentComponent(), "Encoding video", "Preparing frames", 0, totalWork+4); + try { + int progressCounter = 0; + + //In frames + int inactivityInterval = config.isRemoveInactivity() && !config.isSound() ? (int) (1000.0 * config.getInactivityInterval() / frameLength) : -1; + float fps = -1; + final List fragmentCollector = new ArrayList(); + for (Fragment fragment: fragments) { + if (progressMonitor.isCanceled()) { + return null; + } + + if (fps<0) { + fps = config.isSound() ? fragment.getActualFps() : config.getSpeedScale()*fragment.getActualFps(); + } + + progressMonitor.setProgress(++progressCounter); + + int lastActivity = -1; + List framesCollector = new ArrayList(); + for (Future sf: fragment.screenshots) { + + if (progressMonitor.isCanceled()) { + return null; + } + + ScreenShot screenShot = sf.get(); + + if (inactivityInterval<0 || screenShot.isActive() || screenShot.getSecNo()-lastActivity frameShapes = new ArrayList(); + for (Region region: screenShot.getRegions()) { + ShapeContent content; + if (region.getMasterImageRegion()==null) { + content = new ShapeImpl.ImageImpl(region.getImage(), region.coversEverything()); + imageCache.put(region, (Image) content); + if (frameDimension==null && region.coversEverything()) { + frameDimension = region.getSize(); + } + } else { + content = new ShapeImpl.ImageReferenceImpl(imageCache.get(region.getMasterImageRegion())); + } + frameShapes.add(new ShapeImpl(region.getImageLocation(), content)); + } + framesCollector.add(new FrameImpl(frameShapes, screenShot.getMousePosition(), screenShot.getSize(), screenShot.isActive())); + } else { + progressMonitor.setProgress(++progressCounter); // Skipping frame, report progress here. + } + + if (screenShot.isActive()) { + lastActivity = screenShot.getSecNo(); + } + + progressMonitor.setProgress(++progressCounter); + } + + fragmentCollector.add(new FragmentImpl(Collections.unmodifiableList(framesCollector), fragment.audioSink)); + } + + return new Movie(frameDimension, fps, fragmentCollector, imagesFileCloseable); + } finally { + progressMonitor.close(); + } + } + + private static abstract class SafeThread extends Thread { + private Exception exception; + + public SafeThread(String name) { + super(name); + } + + @Override + public void run() { + try { + runInternal(); + } catch (Exception e) { + this.exception = e; + e.printStackTrace(); + } + } + + protected abstract void runInternal() throws Exception; + + public Exception getException() { + return exception; + } + } + + long frameLength; + + + private TargetDataLine targetDataLine; + +} \ No newline at end of file diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/ScreenShot.java b/plugin/jcapture/src/com/hammurapi/jcapture/ScreenShot.java new file mode 100644 index 000000000..080c127b0 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/ScreenShot.java @@ -0,0 +1,251 @@ +package com.hammurapi.jcapture; + +import java.awt.AlphaComposite; +import java.awt.Dimension; +import java.awt.Graphics2D; +import java.awt.Point; +import java.awt.RenderingHints; +import java.awt.image.BufferedImage; +import java.io.File; +import java.io.IOException; +import java.nio.channels.FileChannel; +import java.util.ArrayList; +import java.util.List; +import java.util.ListIterator; +import java.util.concurrent.Callable; + +import javax.imageio.ImageIO; + +public class ScreenShot implements Callable { + + private final ScreenShot prev; + private final int secNo; + private ScreenShot next; + final private long timeStamp; + private int grabRange; + private boolean transparency; + private MappedImage image; + private Point mousePosition; + private double scale; + private boolean border; + private Dimension size; + private FileChannel imageChannel; + private String imageFormat; + + public ScreenShot( + BufferedImage image, + Point mousePosition, + ScreenShot prev, + long timeStamp, + int grabRange, + boolean transparency, + boolean border, + double scale, + FileChannel imageChannel, + String imageFormat) throws IOException { + + this.image = new MappedImage(image, imageFormat, imageChannel); + this.mousePosition = mousePosition; + this.prev = prev; + if (prev==null) { + secNo=0; + } else { + prev.next = this; + secNo = prev.secNo+1; + } + this.timeStamp = timeStamp; + this.grabRange = grabRange; + this.transparency = transparency; + this.scale = scale; + this.border = border; + this.imageChannel = imageChannel; + this.imageFormat = imageFormat; + } + + public Point getMousePosition() { + return mousePosition; + } + + /** + * Calculates actual FPS. + * @return + */ + public float getFramesPerSecond() { + long start = timeStamp; + long end = 0; + int length = 0; + for (ScreenShot sibling = next; sibling!=null; sibling=sibling.next) { + ++length; + end = sibling.timeStamp; + } + if (length==0) { + return -1; // No way to tell. + } + return (float) (length * 1000.0)/(end - start); + } + + private List regions; + + private long totalPixels; + private long differentPixels; + + public double getDiffLevel() { + return (double) differentPixels/(double) totalPixels; + } + + /** + * If images are different more than diffThreshold, then the + * entire screenshot shall be taken. + */ + private double diffThreshold = 0.7; + + /** + * Performs processing and returns self. + * Screenshot is structured as Callable to simplify live processing in a background thread. + */ + @Override + public ScreenShot call() throws Exception { + BufferedImage img = image.getImage(); + // No petty scaling. + if (scale<0.99 || scale > 1.01) { + BufferedImage scaled = new BufferedImage((int) (img.getWidth()*scale), (int) (img.getHeight()*scale), img.getType()); + Graphics2D g = scaled.createGraphics(); + g.setComposite(AlphaComposite.Src); + g.setRenderingHint(RenderingHints.KEY_INTERPOLATION,RenderingHints.VALUE_INTERPOLATION_BILINEAR); + g.setRenderingHint(RenderingHints.KEY_RENDERING,RenderingHints.VALUE_RENDER_QUALITY); + g.setRenderingHint(RenderingHints.KEY_ANTIALIASING,RenderingHints.VALUE_ANTIALIAS_ON); + g.drawImage(img, 0, 0, scaled.getWidth(), scaled.getHeight(), null); + g.dispose(); + img = scaled; + + if (mousePosition!=null) { + mousePosition = new Point((int) (mousePosition.x*scale), (int) (mousePosition.y*scale)); + } + } + + if (border) { + Graphics2D ssg = img.createGraphics(); + ssg.setColor(java.awt.Color.GRAY); + ssg.drawRect(0, 0, img.getWidth()-1, img.getHeight()-1); + } + + size = new Dimension(image.getWidth(), image.getHeight()); + + regions = new ArrayList(); + if (prev==null) { + regions.add(new Region(image)); + } else { + BufferedImage pimg = prev.image.getImage(); + for (int x=0, w=img.getWidth(); xdiffThreshold) { + regions.clear(); + regions.add(new Region(image)); + } else { + // Merging adjacent regions + for (int i=0; i lit = regions.listIterator(i+1); + Region master = regions.get(i); + while (lit.hasNext()) { + if (master.merge(lit.next())) { + lit.remove(); + } + } + } + + for (Region region: regions) { + region.grabImage(); + } + } + + // Eligible for garbage collection + if (prev!=null) { + prev.image=null; + } + } + + // De-dup + ListIterator oit = regions.listIterator(); + R: while (oit.hasNext()) { + Region or = oit.next(); + + if (oit.hasPrevious()) { + ListIterator iit = regions.listIterator(oit.previousIndex()); + while (iit.hasPrevious()) { + if (or.dedup(iit.previous())) { + continue R; + } + } + } + + for (ScreenShot sibling=prev; sibling!=null; sibling=sibling.prev) { + for (Region sr: sibling.regions) { + if (or.dedup(sr)) { + continue R; + } + } + } + } + return this; + } + + public void dump(File dir, String imageFormat) throws IOException { + for (int i=0; i getRegions() { + return regions; + } + + public int getSecNo() { + return secNo; + } + + public boolean isActive() { + if (!regions.isEmpty()) { + return true; + } + if (mousePosition==null) { + if (prev==null) { + return false; + } + if (prev.getMousePosition()!=null) { + return true; + } + return false; + } + + if (prev==null) { + return true; + } + if (!mousePosition.equals(prev.getMousePosition())) { + return true; + } + return false; + } + + public Dimension getSize() { + return size; + } + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/ShapeImpl.java b/plugin/jcapture/src/com/hammurapi/jcapture/ShapeImpl.java new file mode 100644 index 000000000..ca3fda48d --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/ShapeImpl.java @@ -0,0 +1,75 @@ +package com.hammurapi.jcapture; + +import java.awt.Point; + +import com.hammurapi.jcapture.VideoEncoder.Fragment.Frame.Shape; + +class ShapeImpl implements Shape { + + static class ImageImpl implements Image { + + MappedImage image; + private boolean coversEverything; + + ImageImpl(MappedImage image, boolean coversEverything) { + super(); + this.image = image; + this.coversEverything = coversEverything; + } + + @Override + public boolean coversEverything() { + return coversEverything; + } + + @Override + public MappedImage getImage() { + return image; + } + + } + + static class ImageReferenceImpl implements ImageReference { + + private Image image; + + ImageReferenceImpl(Image image) { + super(); + if (image==null) { + throw new NullPointerException(); + } + this.image = image; + } + + @Override + public boolean coversEverything() { + return image.coversEverything(); + } + + @Override + public Image getImage() { + return image; + } + + } + + private Point location; + private ShapeContent content; + + ShapeImpl(Point location, ShapeContent content) { + super(); + this.location = location; + this.content = content; + } + + @Override + public Point getLocation() { + return location; + } + + @Override + public ShapeContent getContent() { + return content; + } + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/SwfEncoder.java b/plugin/jcapture/src/com/hammurapi/jcapture/SwfEncoder.java new file mode 100644 index 000000000..88e59a868 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/SwfEncoder.java @@ -0,0 +1,353 @@ +package com.hammurapi.jcapture; + +import java.awt.AlphaComposite; +import java.awt.Dimension; +import java.awt.Graphics2D; +import java.awt.Point; +import java.awt.RenderingHints; +import java.awt.image.BufferedImage; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.OutputStream; +import java.text.MessageFormat; +import java.util.ArrayList; +import java.util.IdentityHashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.atomic.AtomicInteger; + +import javax.imageio.ImageIO; +import javax.swing.JOptionPane; +import javax.swing.ProgressMonitor; + +import com.flagstone.transform.Background; +import com.flagstone.transform.DefineTag; +import com.flagstone.transform.DoAction; +import com.flagstone.transform.Movie; +import com.flagstone.transform.MovieHeader; +import com.flagstone.transform.MovieTag; +import com.flagstone.transform.Place2; +import com.flagstone.transform.Remove; +import com.flagstone.transform.Remove2; +import com.flagstone.transform.ShowFrame; +import com.flagstone.transform.action.Action; +import com.flagstone.transform.action.BasicAction; +import com.flagstone.transform.coder.Coder; +import com.flagstone.transform.datatype.Bounds; +import com.flagstone.transform.datatype.CoordTransform; +import com.flagstone.transform.datatype.WebPalette; +import com.flagstone.transform.image.ImageTag; +import com.flagstone.transform.util.image.ImageDecoder; +import com.flagstone.transform.util.image.ImageRegistry; +import com.flagstone.transform.util.image.ImageShape; +import com.flagstone.transform.util.shape.Canvas; +import com.flagstone.transform.util.sound.SoundFactory; +import com.hammurapi.jcapture.VideoEncoder.Fragment.Frame; +import com.hammurapi.jcapture.VideoEncoder.Fragment.Frame.Shape; +import com.hammurapi.jcapture.VideoEncoder.Fragment.Frame.Shape.Image; +import com.hammurapi.jcapture.VideoEncoder.Fragment.Frame.Shape.ImageReference; +import com.hammurapi.jcapture.VideoEncoder.Fragment.Frame.Shape.ShapeContent; + +public class SwfEncoder implements VideoEncoder { + + @Override + public String getFileExtension() { + return "swf"; + } + + @Override + public String getMimeType() { + return "application/x-shockwave-flash"; + } + + @Override + public String toString() { + return "SWF"; + } + + @Override + public Dimension encode(Config config, + com.hammurapi.jcapture.Movie source, + OutputStream out) + throws Exception { + + AtomicInteger uid = new AtomicInteger(); + + /** + * For reusing shape id's. + */ + int maxId = Coder.USHORT_MAX; + + ButtonManager manager = null; + if (config.isToolBar()) { + manager = new ButtonManager(); + manager.loadLibrary(getClass().getResource("toolbar_buttons.swf")); + uid.set(manager.maxIdentifier()+1); + } + + Canvas path = new Canvas(); + path.setPixels(false); + + int minImgLayer = 10; + int imgLayer = minImgLayer; + int maxImgLayer = maxId - 1000; + + int mouseLayer = maxImgLayer+1; + int mouseUid = -1; + Place2 mousePlace = null; + ImageTag mouseImage = null; + + int layer = maxImgLayer+2; + + int totalWork = 0; + for (Fragment frg: source.getFragments()) { + totalWork = frg.getFrames().size()+1; + } + + ProgressMonitor progressMonitor = new ProgressMonitor(config.getParentComponent(), "Encoding to SWF", "Composing movie", 0, totalWork); + int progressCounter = 0; + + progressMonitor.setNote("Composing movie"); + boolean firstFrame = true; + Dimension ret = null; + Map imageCache = new IdentityHashMap(); + + Movie movie = new Movie(); + + Point prevMouseLocation = null; + + int frameNo = 0; + + for (Fragment fragment: source.getFragments()) { + + SoundFactory soundFactory = null; + boolean soundHeaderAdded = false; + File audio = fragment.getAudio(); + if (audio!=null) { + progressMonitor.setNote("Loading sound"); + soundFactory = new SoundFactory(); + + // MP3 conversion + if (config.getMp3command()!=null && config.getMp3command().trim().length()>0) { + audio = new File(audio.getAbsolutePath()+".mp3"); + Runtime runtime = Runtime.getRuntime(); + Process proc = runtime.exec(MessageFormat.format(config.getMp3command(), new Object[] {fragment.getAudio().getAbsolutePath(), audio.getAbsolutePath()})); + proc.waitFor(); + if (!fragment.getAudio().delete()) { + fragment.getAudio().deleteOnExit(); + } + } + + soundFactory.read(audio); + } + + progressMonitor.setProgress(++progressCounter); + + if (progressMonitor.isCanceled()) { + return null; + } + + for (Frame frame: fragment.getFrames()) { + if (progressMonitor.isCanceled()) { + return null; + } + + boolean addStop = false; + + ++frameNo; + + if (firstFrame) { + firstFrame = false; + + MovieHeader header = new MovieHeader(); + header.setCompressed(true); + header.setFrameRate(source.getFramesPerSecond()); + + int toolbarHeight = 29 * 20; + int toolbarWidth = 495 * 20; + + int toolbarX = 0; // - image.getWidth()*20/2; + int toolbarY = frame.getSize().height*20; + + int movieWidth = frame.getSize().width*20; + int movieHeight = frame.getSize().height*20; + if (config.isToolBar()) { + movieHeight+=toolbarHeight; + } + + ret = new Dimension(movieWidth/20, movieHeight/20); + + float toolbarScaleX = (float) movieWidth / (float) toolbarWidth; + float toolbarScaleY = 1.0f; + + Bounds movieBounds = new Bounds(0, 0, movieWidth, movieHeight); + header.setFrameSize(movieBounds); + movie.add(header); + movie.add(new Background(WebPalette.WHITE.color())); + + if (config.isToolBar()) { + // Add all the shapes etc used for buttons + List toolbarDefinitions = manager.getDefinitions(); + movie.getObjects().addAll(toolbarDefinitions); + + Place2 placeBackground = manager.getButton("background", layer++, 0, 0); + placeBackground.setTransform(new CoordTransform(toolbarScaleX, toolbarScaleY, 0, 0, toolbarX, toolbarY)); + + // Get the button to use and give its position + movie.add(placeBackground); + movie.add(manager.getButton("play_button", layer++, toolbarX + 500, toolbarY + toolbarHeight / 2)); + movie.add(manager.getButton("progress_bar", layer++, toolbarX + 1000, toolbarY + toolbarHeight / 2)); + movie.add(manager.getButton("volume_control", layer++, toolbarX + 5600, toolbarY + toolbarHeight / 2)); + + if (!config.isPlay()) { + addStop = true; + } + } + } + + if (!soundHeaderAdded && soundFactory!=null) { + movie.add(soundFactory.streamHeader(source.getFramesPerSecond())); + soundHeaderAdded = true; + } + + if (soundFactory!=null) { + MovieTag soundBlock = soundFactory.streamSound(); + if (soundBlock != null) { + movie.add(soundBlock); + } + } + + for (Shape shape: frame.getShapes()) { + if (shape.getContent().coversEverything() || imgLayer==maxImgLayer) { + for (int i=minImgLayer; i<=imgLayer; ++i) { + movie.add(new Remove2(i)); + } + imgLayer = minImgLayer; + } + + ShapeContent shapeContent = shape.getContent(); + Image image; + if (shapeContent instanceof Image) { + image = (Image) shapeContent; + } else if (shape.getContent() instanceof ImageReference) { + image = ((ImageReference) shapeContent).getImage(); + } else { + throw new IllegalArgumentException("Unexpected content type: "+shapeContent); + } + + ImageTag imageTag = imageCache.get(image); + if (imageTag==null) { + try { + ImageDecoder decoder = ImageRegistry.getImageProvider("image/"+config.getImageFormat().toLowerCase()); + decoder.read(new ByteArrayInputStream(image.getImage().getImageBytes())); + imageTag = decoder.defineImage(uid.incrementAndGet()); + imageCache.put(image, imageTag); + movie.add(imageTag); + } catch (Exception e) { + // Doing our best to create movie, even with flaws. + System.err.println("Error encoding image at frame "+frameNo+": "+e); + e.printStackTrace(); + if (JOptionPane.showConfirmDialog(config.getParentComponent(), + "Error encoding image ("+image.getImage().getWidth()+"*"+image.getImage().getHeight()+") at frame "+frameNo+": "+e+". Continue encoding?", + "Encoding error", + JOptionPane.YES_NO_OPTION, + JOptionPane.ERROR_MESSAGE)==JOptionPane.NO_OPTION) { + throw e; + } + } + } + + int shapeId = uid.incrementAndGet(); + DefineTag shapeTag = new ImageShape().defineShape(shapeId, imageTag); + Place2 place = Place2.show(shapeTag.getIdentifier(), imgLayer++, shape.getLocation().x*20, shape.getLocation().y*20); + movie.add(shapeTag); + movie.add(place); + } + + Point mouseLocation = frame.getMousePointer(); + if (mouseLocation!=null) { + if (mouseImage==null) { + BufferedImage mouseBi = ImageIO.read(getClass().getResource("mouse.png")); + if (config.getScreenScale()<0.99 || config.getScreenScale() > 1.01) { + BufferedImage scaled = new BufferedImage((int) (mouseBi.getWidth()*config.getScreenScale()), (int) (mouseBi.getHeight()*config.getScreenScale()), mouseBi.getType()); + Graphics2D g = scaled.createGraphics(); + g.setComposite(AlphaComposite.Src); + g.setRenderingHint(RenderingHints.KEY_INTERPOLATION,RenderingHints.VALUE_INTERPOLATION_BILINEAR); + g.setRenderingHint(RenderingHints.KEY_RENDERING,RenderingHints.VALUE_RENDER_QUALITY); + g.setRenderingHint(RenderingHints.KEY_ANTIALIASING,RenderingHints.VALUE_ANTIALIAS_ON); + g.drawImage(mouseBi, 0, 0, scaled.getWidth(), scaled.getHeight(), null); + g.dispose(); + mouseBi = scaled; + } + + ByteArrayOutputStream baos = new ByteArrayOutputStream(); + ImageIO.write(mouseBi, "PNG", baos); + baos.close(); + ImageDecoder decoder = ImageRegistry.getImageProvider("image/png"); + decoder.read(new ByteArrayInputStream(baos.toByteArray())); + mouseImage = decoder.defineImage(uid.incrementAndGet()); + movie.add(mouseImage); + } + + if (!mouseLocation.equals(prevMouseLocation)) { + prevMouseLocation = mouseLocation; + mouseUid = uid.incrementAndGet(); + DefineTag mShape = new ImageShape().defineShape(uid.incrementAndGet(), mouseImage); //createRect(mouseUid, 100, 100, WebPalette.RED.color()); + if (mousePlace==null) { + mousePlace = Place2.show(mShape.getIdentifier(), mouseLayer, mouseLocation.x*20, mouseLocation.y*20); + } else { + mousePlace = Place2.replace(mShape.getIdentifier(), mouseLayer, mouseLocation.x*20, mouseLocation.y*20); + } + movie.add(mShape); + movie.add(mousePlace); + } + } else if (mouseUid!=-1) { + Remove remove = new Remove(mouseUid, mouseLayer); + movie.add(remove); + } + + if (addStop) { + DoAction cmd = new DoAction(new ArrayList()); + cmd.add(BasicAction.STOP); + movie.add(cmd); + } + movie.add(ShowFrame.getInstance()); + + progressMonitor.setProgress(++progressCounter); + } + + progressMonitor.setProgress(++progressCounter); + if (soundFactory!=null) { + progressMonitor.setNote("Recording trailing sound"); + MovieTag block; + while ((block = soundFactory.streamSound()) != null) { + movie.add(block); + movie.add(ShowFrame.getInstance()); + } + } + + if (audio!=null) { + if (!audio.delete()) { + audio.deleteOnExit(); + } + } + } + + if (!config.isLoop()) { + List actions = new ArrayList(); + actions.add(BasicAction.STOP); + actions.add(BasicAction.END); + DoAction doAction = new DoAction(actions); + movie.add(doAction); + movie.add(ShowFrame.getInstance()); + } + + progressMonitor.setProgress(++progressCounter); + progressMonitor.setNote("Encoding movie"); + movie.encodeToStream(out); + source.close(); + return ret; + } + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/Translucener.java b/plugin/jcapture/src/com/hammurapi/jcapture/Translucener.java new file mode 100644 index 000000000..33a537b7f --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/Translucener.java @@ -0,0 +1,17 @@ +package com.hammurapi.jcapture; + +import java.awt.Frame; + +abstract class Translucener { + + protected abstract void makeTranslucent(Frame frame); + + static void makeFrameTranslucent(Frame frame) throws Exception { + String jVersion = System.getProperty("java.version"); + if (jVersion==null || "1.6".equals(jVersion) || jVersion.startsWith("1.6.")) { + ((Translucener) Class.forName("com.hammurapi.jcapture.AWTUtilitiesTranslucener").newInstance()).makeTranslucent(frame); + } else { + ((Translucener) Class.forName("com.hammurapi.jcapture.GraphicsDeviceTranslucener").newInstance()).makeTranslucent(frame); + } + } +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/VideoEncoder.java b/plugin/jcapture/src/com/hammurapi/jcapture/VideoEncoder.java new file mode 100644 index 000000000..d32f2a834 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/VideoEncoder.java @@ -0,0 +1,164 @@ +package com.hammurapi.jcapture; + +import java.awt.Component; +import java.awt.Dimension; +import java.awt.Point; +import java.io.File; +import java.io.OutputStream; +import java.util.List; + +/** + * This is a service interface to be implemented by video encoders. + * jCapture discovers encoders using java.util.ServiceLoader. + * + * All interfaces used by this interface are defined as nested for easy reference. + * @author Pavel + * + */ +public interface VideoEncoder { + + interface Config { + + /** + * + * @return true if encoder shall add a toolbar to the movie. + */ + boolean isToolBar(); + + /** + * + * @return true if movie shall be played in a loop. + */ + boolean isLoop(); + + /** + * + * @return true if movie shall start playing after downloading. + */ + boolean isPlay(); + + /** + * @return For scaling mouse pointer. + */ + double getScreenScale(); + + /** + * For progress monitor. + * @return + */ + Component getParentComponent(); + + String getImageFormat(); + + /** + * @return OS command to convert WAV to MP3 if encoder requires/benefits from it. + */ + String getMp3command(); + } + + /** + * Movie fragment is a collection of frames with associated audio. + * @author Pavel + * + */ + interface Fragment { + + /** + * Frame contains zero or more shapes and mouse location. + * @author Pavel + * + */ + interface Frame { + + boolean isActive(); + + /** + * Image shape to be placed on the screen. + * @author Pavel + * + */ + interface Shape { + + /** + * Base interface for shape content. + * @author Pavel + * + */ + interface ShapeContent { + + /** + * @return true if this shape covers the entire screen area. + */ + boolean coversEverything(); + } + + interface Image extends ShapeContent { + + MappedImage getImage(); + + } + + /** + * References already defined image. + * @author Pavel + * + */ + interface ImageReference extends ShapeContent { + + Image getImage(); + + } + + Point getLocation(); + + ShapeContent getContent(); + + } + + /** + * Frame's shapes. + * @return + */ + List getShapes(); + + Point getMousePointer(); + + Dimension getSize(); + + } + + /** + * Fragment frames. + * @return + */ + List getFrames(); + + /** + * Audio file (WAV). + * @return + */ + File getAudio(); + + } + + String getFileExtension(); + + String getMimeType(); + + /** + * This method shall return output format name, e.g. SWF. + * @return + */ + String toString(); + + /** + * Encodes video to output stream. + * @param fragments Fragments to encode + * @param out Output stream + * @param progressMonitor Progress monitor has work allocated for each frame plus one unit of work per fragment for sound decoding plus one unit for final encoding. + * @param progressCounter current progress counter position. + * @return movie size or null if operation was cancelled + */ + Dimension encode(Config config, Movie movie, OutputStream out) throws Exception; + +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/WavFile.java b/plugin/jcapture/src/com/hammurapi/jcapture/WavFile.java new file mode 100644 index 000000000..0c2d68e72 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/WavFile.java @@ -0,0 +1,787 @@ +package com.hammurapi.jcapture; + +// This file was taken from http://www.labbookpages.co.uk/audio/javaWavFiles.html + +// Wav file IO class +// A.Greensted +// http://www.labbookpages.co.uk + +// File format is based on the information from +// http://www.sonicspot.com/guide/wavefiles.html +// http://www.blitter.com/~russtopia/MIDI/~jglatt/tech/wave.htm + +// Version 1.0 + +import java.io.*; + +public class WavFile { + private enum IOState { + READING, WRITING, CLOSED + }; + + private final static int BUFFER_SIZE = 4096; + + private final static int FMT_CHUNK_ID = 0x20746D66; + private final static int DATA_CHUNK_ID = 0x61746164; + private final static int RIFF_CHUNK_ID = 0x46464952; + private final static int RIFF_TYPE_ID = 0x45564157; + + private File file; // File that will be read from or written to + private IOState ioState; // Specifies the IO State of the Wav File (used for + // snaity checking) + private int bytesPerSample; // Number of bytes required to store a single + // sample + private long numFrames; // Number of frames within the data section + private FileOutputStream oStream; // Output stream used for writting data + private FileInputStream iStream; // Input stream used for reading data + private double floatScale; // Scaling factor used for int <-> float + // conversion + private double floatOffset; // Offset factor used for int <-> float + // conversion + private boolean wordAlignAdjust; // Specify if an extra byte at the end of + // the data chunk is required for word + // alignment + + // Wav Header + private int numChannels; // 2 bytes unsigned, 0x0001 (1) to 0xFFFF (65,535) + private long sampleRate; // 4 bytes unsigned, 0x00000001 (1) to 0xFFFFFFFF + // (4,294,967,295) + // Although a java int is 4 bytes, it is signed, + // so need to use a long + private int blockAlign; // 2 bytes unsigned, 0x0001 (1) to 0xFFFF (65,535) + private int validBits; // 2 bytes unsigned, 0x0002 (2) to 0xFFFF (65,535) + + // Buffering + private byte[] buffer; // Local buffer used for IO + private int bufferPointer; // Points to the current position in local buffer + private int bytesRead; // Bytes read after last read into local buffer + private long frameCounter; // Current number of frames read or written + + // Cannot instantiate WavFile directly, must either use newWavFile() or + // openWavFile() + private WavFile() { + buffer = new byte[BUFFER_SIZE]; + } + + public int getNumChannels() { + return numChannels; + } + + public long getNumFrames() { + return numFrames; + } + + public long getFramesRemaining() { + return numFrames - frameCounter; + } + + public long getSampleRate() { + return sampleRate; + } + + public int getValidBits() { + return validBits; + } + + public static WavFile newWavFile(File file, int numChannels, + long numFrames, int validBits, long sampleRate) throws IOException, + WavFileException { + // Instantiate new Wavfile and initialise + WavFile wavFile = new WavFile(); + wavFile.file = file; + wavFile.numChannels = numChannels; + wavFile.numFrames = numFrames; + wavFile.sampleRate = sampleRate; + wavFile.bytesPerSample = (validBits + 7) / 8; + wavFile.blockAlign = wavFile.bytesPerSample * numChannels; + wavFile.validBits = validBits; + + // Sanity check arguments + if (numChannels < 1 || numChannels > 65535) + throw new WavFileException( + "Illegal number of channels, valid range 1 to 65536"); + if (numFrames < 0) + throw new WavFileException("Number of frames must be positive"); + if (validBits < 2 || validBits > 65535) + throw new WavFileException( + "Illegal number of valid bits, valid range 2 to 65536"); + if (sampleRate < 0) + throw new WavFileException("Sample rate must be positive"); + + // Create output stream for writing data + wavFile.oStream = new FileOutputStream(file); + + // Calculate the chunk sizes + long dataChunkSize = wavFile.blockAlign * numFrames; + long mainChunkSize = 4 + // Riff Type + 8 + // Format ID and size + 16 + // Format data + 8 + // Data ID and size + dataChunkSize; + + // Chunks must be word aligned, so if odd number of audio data bytes + // adjust the main chunk size + if (dataChunkSize % 2 == 1) { + mainChunkSize += 1; + wavFile.wordAlignAdjust = true; + } else { + wavFile.wordAlignAdjust = false; + } + + // Set the main chunk size + putLE(RIFF_CHUNK_ID, wavFile.buffer, 0, 4); + putLE(mainChunkSize, wavFile.buffer, 4, 4); + putLE(RIFF_TYPE_ID, wavFile.buffer, 8, 4); + + // Write out the header + wavFile.oStream.write(wavFile.buffer, 0, 12); + + // Put format data in buffer + long averageBytesPerSecond = sampleRate * wavFile.blockAlign; + + putLE(FMT_CHUNK_ID, wavFile.buffer, 0, 4); // Chunk ID + putLE(16, wavFile.buffer, 4, 4); // Chunk Data Size + putLE(1, wavFile.buffer, 8, 2); // Compression Code (Uncompressed) + putLE(numChannels, wavFile.buffer, 10, 2); // Number of channels + putLE(sampleRate, wavFile.buffer, 12, 4); // Sample Rate + putLE(averageBytesPerSecond, wavFile.buffer, 16, 4); // Average Bytes + // Per Second + putLE(wavFile.blockAlign, wavFile.buffer, 20, 2); // Block Align + putLE(validBits, wavFile.buffer, 22, 2); // Valid Bits + + // Write Format Chunk + wavFile.oStream.write(wavFile.buffer, 0, 24); + + // Start Data Chunk + putLE(DATA_CHUNK_ID, wavFile.buffer, 0, 4); // Chunk ID + putLE(dataChunkSize, wavFile.buffer, 4, 4); // Chunk Data Size + + // Write Format Chunk + wavFile.oStream.write(wavFile.buffer, 0, 8); + + // Calculate the scaling factor for converting to a normalised double + if (wavFile.validBits > 8) { + // If more than 8 validBits, data is signed + // Conversion required multiplying by magnitude of max positive + // value + wavFile.floatOffset = 0; + wavFile.floatScale = Long.MAX_VALUE >> (64 - wavFile.validBits); + } else { + // Else if 8 or less validBits, data is unsigned + // Conversion required dividing by max positive value + wavFile.floatOffset = 1; + wavFile.floatScale = 0.5 * ((1 << wavFile.validBits) - 1); + } + + // Finally, set the IO State + wavFile.bufferPointer = 0; + wavFile.bytesRead = 0; + wavFile.frameCounter = 0; + wavFile.ioState = IOState.WRITING; + + return wavFile; + } + + public static WavFile openWavFile(File file) throws IOException, + WavFileException { + // Instantiate new Wavfile and store the file reference + WavFile wavFile = new WavFile(); + wavFile.file = file; + + // Create a new file input stream for reading file data + wavFile.iStream = new FileInputStream(file); + + // Read the first 12 bytes of the file + int bytesRead = wavFile.iStream.read(wavFile.buffer, 0, 12); + if (bytesRead != 12) + throw new WavFileException("Not enough wav file bytes for header"); + + // Extract parts from the header + long riffChunkID = getLE(wavFile.buffer, 0, 4); + long chunkSize = getLE(wavFile.buffer, 4, 4); + long riffTypeID = getLE(wavFile.buffer, 8, 4); + + // Check the header bytes contains the correct signature + if (riffChunkID != RIFF_CHUNK_ID) + throw new WavFileException( + "Invalid Wav Header data, incorrect riff chunk ID"); + if (riffTypeID != RIFF_TYPE_ID) + throw new WavFileException( + "Invalid Wav Header data, incorrect riff type ID"); + + // Check that the file size matches the number of bytes listed in header + if (file.length() != chunkSize + 8) { + throw new WavFileException("Header chunk size (" + chunkSize + + ") does not match file size (" + file.length() + ")"); + } + + boolean foundFormat = false; + boolean foundData = false; + + // Search for the Format and Data Chunks + while (true) { + // Read the first 8 bytes of the chunk (ID and chunk size) + bytesRead = wavFile.iStream.read(wavFile.buffer, 0, 8); + if (bytesRead == -1) + throw new WavFileException( + "Reached end of file without finding format chunk"); + if (bytesRead != 8) + throw new WavFileException("Could not read chunk header"); + + // Extract the chunk ID and Size + long chunkID = getLE(wavFile.buffer, 0, 4); + chunkSize = getLE(wavFile.buffer, 4, 4); + + // Word align the chunk size + // chunkSize specifies the number of bytes holding data. However, + // the data should be word aligned (2 bytes) so we need to calculate + // the actual number of bytes in the chunk + long numChunkBytes = (chunkSize % 2 == 1) ? chunkSize + 1 + : chunkSize; + + if (chunkID == FMT_CHUNK_ID) { + // Flag that the format chunk has been found + foundFormat = true; + + // Read in the header info + bytesRead = wavFile.iStream.read(wavFile.buffer, 0, 16); + + // Check this is uncompressed data + int compressionCode = (int) getLE(wavFile.buffer, 0, 2); + if (compressionCode != 1) + throw new WavFileException("Compression Code " + + compressionCode + " not supported"); + + // Extract the format information + wavFile.numChannels = (int) getLE(wavFile.buffer, 2, 2); + wavFile.sampleRate = getLE(wavFile.buffer, 4, 4); + wavFile.blockAlign = (int) getLE(wavFile.buffer, 12, 2); + wavFile.validBits = (int) getLE(wavFile.buffer, 14, 2); + + if (wavFile.numChannels == 0) + throw new WavFileException( + "Number of channels specified in header is equal to zero"); + if (wavFile.blockAlign == 0) + throw new WavFileException( + "Block Align specified in header is equal to zero"); + if (wavFile.validBits < 2) + throw new WavFileException( + "Valid Bits specified in header is less than 2"); + if (wavFile.validBits > 64) + throw new WavFileException( + "Valid Bits specified in header is greater than 64, this is greater than a long can hold"); + + // Calculate the number of bytes required to hold 1 sample + wavFile.bytesPerSample = (wavFile.validBits + 7) / 8; + if (wavFile.bytesPerSample * wavFile.numChannels != wavFile.blockAlign) + throw new WavFileException( + "Block Align does not agree with bytes required for validBits and number of channels"); + + // Account for number of format bytes and then skip over + // any extra format bytes + numChunkBytes -= 16; + if (numChunkBytes > 0) + wavFile.iStream.skip(numChunkBytes); + } else if (chunkID == DATA_CHUNK_ID) { + // Check if we've found the format chunk, + // If not, throw an exception as we need the format information + // before we can read the data chunk + if (foundFormat == false) + throw new WavFileException( + "Data chunk found before Format chunk"); + + // Check that the chunkSize (wav data length) is a multiple of + // the + // block align (bytes per frame) + if (chunkSize % wavFile.blockAlign != 0) + throw new WavFileException( + "Data Chunk size is not multiple of Block Align"); + + // Calculate the number of frames + wavFile.numFrames = chunkSize / wavFile.blockAlign; + + // Flag that we've found the wave data chunk + foundData = true; + + break; + } else { + // If an unknown chunk ID is found, just skip over the chunk + // data + wavFile.iStream.skip(numChunkBytes); + } + } + + // Throw an exception if no data chunk has been found + if (foundData == false) + throw new WavFileException("Did not find a data chunk"); + + // Calculate the scaling factor for converting to a normalised double + if (wavFile.validBits > 8) { + // If more than 8 validBits, data is signed + // Conversion required dividing by magnitude of max negative value + wavFile.floatOffset = 0; + wavFile.floatScale = 1 << (wavFile.validBits - 1); + } else { + // Else if 8 or less validBits, data is unsigned + // Conversion required dividing by max positive value + wavFile.floatOffset = -1; + wavFile.floatScale = 0.5 * ((1 << wavFile.validBits) - 1); + } + + wavFile.bufferPointer = 0; + wavFile.bytesRead = 0; + wavFile.frameCounter = 0; + wavFile.ioState = IOState.READING; + + return wavFile; + } + + // Get and Put little endian data from local buffer + // ------------------------------------------------ + private static long getLE(byte[] buffer, int pos, int numBytes) { + numBytes--; + pos += numBytes; + + long val = buffer[pos] & 0xFF; + for (int b = 0; b < numBytes; b++) + val = (val << 8) + (buffer[--pos] & 0xFF); + + return val; + } + + private static void putLE(long val, byte[] buffer, int pos, int numBytes) { + for (int b = 0; b < numBytes; b++) { + buffer[pos] = (byte) (val & 0xFF); + val >>= 8; + pos++; + } + } + + // Sample Writing and Reading + // -------------------------- + private void writeSample(long val) throws IOException { + for (int b = 0; b < bytesPerSample; b++) { + if (bufferPointer == BUFFER_SIZE) { + oStream.write(buffer, 0, BUFFER_SIZE); + bufferPointer = 0; + } + + buffer[bufferPointer] = (byte) (val & 0xFF); + val >>= 8; + bufferPointer++; + } + } + + private long readSample() throws IOException, WavFileException { + long val = 0; + + for (int b = 0; b < bytesPerSample; b++) { + if (bufferPointer == bytesRead) { + int read = iStream.read(buffer, 0, BUFFER_SIZE); + if (read == -1) + throw new WavFileException("Not enough data available"); + bytesRead = read; + bufferPointer = 0; + } + + int v = buffer[bufferPointer]; + if (b < bytesPerSample - 1 || bytesPerSample == 1) + v &= 0xFF; + val += v << (b * 8); + + bufferPointer++; + } + + return val; + } + + // Integer + // ------- + public int readFrames(int[] sampleBuffer, int numFramesToRead) + throws IOException, WavFileException { + return readFrames(sampleBuffer, 0, numFramesToRead); + } + + public int readFrames(int[] sampleBuffer, int offset, int numFramesToRead) + throws IOException, WavFileException { + if (ioState != IOState.READING) + throw new IOException("Cannot read from WavFile instance"); + + for (int f = 0; f < numFramesToRead; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) { + sampleBuffer[offset] = (int) readSample(); + offset++; + } + + frameCounter++; + } + + return numFramesToRead; + } + + public int readFrames(int[][] sampleBuffer, int numFramesToRead) + throws IOException, WavFileException { + return readFrames(sampleBuffer, 0, numFramesToRead); + } + + public int readFrames(int[][] sampleBuffer, int offset, int numFramesToRead) + throws IOException, WavFileException { + if (ioState != IOState.READING) + throw new IOException("Cannot read from WavFile instance"); + + for (int f = 0; f < numFramesToRead; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) + sampleBuffer[c][offset] = (int) readSample(); + + offset++; + frameCounter++; + } + + return numFramesToRead; + } + + public int writeFrames(int[] sampleBuffer, int numFramesToWrite) + throws IOException, WavFileException { + return writeFrames(sampleBuffer, 0, numFramesToWrite); + } + + public int writeFrames(int[] sampleBuffer, int offset, int numFramesToWrite) + throws IOException, WavFileException { + if (ioState != IOState.WRITING) + throw new IOException("Cannot write to WavFile instance"); + + for (int f = 0; f < numFramesToWrite; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) { + writeSample(sampleBuffer[offset]); + offset++; + } + + frameCounter++; + } + + return numFramesToWrite; + } + + public int writeFrames(int[][] sampleBuffer, int numFramesToWrite) + throws IOException, WavFileException { + return writeFrames(sampleBuffer, 0, numFramesToWrite); + } + + public int writeFrames(int[][] sampleBuffer, int offset, + int numFramesToWrite) throws IOException, WavFileException { + if (ioState != IOState.WRITING) + throw new IOException("Cannot write to WavFile instance"); + + for (int f = 0; f < numFramesToWrite; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) + writeSample(sampleBuffer[c][offset]); + + offset++; + frameCounter++; + } + + return numFramesToWrite; + } + + // Long + // ---- + public int readFrames(long[] sampleBuffer, int numFramesToRead) + throws IOException, WavFileException { + return readFrames(sampleBuffer, 0, numFramesToRead); + } + + public int readFrames(long[] sampleBuffer, int offset, int numFramesToRead) + throws IOException, WavFileException { + if (ioState != IOState.READING) + throw new IOException("Cannot read from WavFile instance"); + + for (int f = 0; f < numFramesToRead; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) { + sampleBuffer[offset] = readSample(); + offset++; + } + + frameCounter++; + } + + return numFramesToRead; + } + + public int readFrames(long[][] sampleBuffer, int numFramesToRead) + throws IOException, WavFileException { + return readFrames(sampleBuffer, 0, numFramesToRead); + } + + public int readFrames(long[][] sampleBuffer, int offset, int numFramesToRead) + throws IOException, WavFileException { + if (ioState != IOState.READING) + throw new IOException("Cannot read from WavFile instance"); + + for (int f = 0; f < numFramesToRead; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) + sampleBuffer[c][offset] = readSample(); + + offset++; + frameCounter++; + } + + return numFramesToRead; + } + + public int writeFrames(long[] sampleBuffer, int numFramesToWrite) + throws IOException, WavFileException { + return writeFrames(sampleBuffer, 0, numFramesToWrite); + } + + public int writeFrames(long[] sampleBuffer, int offset, int numFramesToWrite) + throws IOException, WavFileException { + if (ioState != IOState.WRITING) + throw new IOException("Cannot write to WavFile instance"); + + for (int f = 0; f < numFramesToWrite; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) { + writeSample(sampleBuffer[offset]); + offset++; + } + + frameCounter++; + } + + return numFramesToWrite; + } + + public int writeFrames(long[][] sampleBuffer, int numFramesToWrite) + throws IOException, WavFileException { + return writeFrames(sampleBuffer, 0, numFramesToWrite); + } + + public int writeFrames(long[][] sampleBuffer, int offset, + int numFramesToWrite) throws IOException, WavFileException { + if (ioState != IOState.WRITING) + throw new IOException("Cannot write to WavFile instance"); + + for (int f = 0; f < numFramesToWrite; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) + writeSample(sampleBuffer[c][offset]); + + offset++; + frameCounter++; + } + + return numFramesToWrite; + } + + // Double + // ------ + public int readFrames(double[] sampleBuffer, int numFramesToRead) + throws IOException, WavFileException { + return readFrames(sampleBuffer, 0, numFramesToRead); + } + + public int readFrames(double[] sampleBuffer, int offset, int numFramesToRead) + throws IOException, WavFileException { + if (ioState != IOState.READING) + throw new IOException("Cannot read from WavFile instance"); + + for (int f = 0; f < numFramesToRead; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) { + sampleBuffer[offset] = floatOffset + (double) readSample() + / floatScale; + offset++; + } + + frameCounter++; + } + + return numFramesToRead; + } + + public int readFrames(double[][] sampleBuffer, int numFramesToRead) + throws IOException, WavFileException { + return readFrames(sampleBuffer, 0, numFramesToRead); + } + + public int readFrames(double[][] sampleBuffer, int offset, + int numFramesToRead) throws IOException, WavFileException { + if (ioState != IOState.READING) + throw new IOException("Cannot read from WavFile instance"); + + for (int f = 0; f < numFramesToRead; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) + sampleBuffer[c][offset] = floatOffset + (double) readSample() + / floatScale; + + offset++; + frameCounter++; + } + + return numFramesToRead; + } + + public int writeFrames(double[] sampleBuffer, int numFramesToWrite) + throws IOException, WavFileException { + return writeFrames(sampleBuffer, 0, numFramesToWrite); + } + + public int writeFrames(double[] sampleBuffer, int offset, + int numFramesToWrite) throws IOException, WavFileException { + if (ioState != IOState.WRITING) + throw new IOException("Cannot write to WavFile instance"); + + for (int f = 0; f < numFramesToWrite; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) { + writeSample((long) (floatScale * (floatOffset + sampleBuffer[offset]))); + offset++; + } + + frameCounter++; + } + + return numFramesToWrite; + } + + public int writeFrames(double[][] sampleBuffer, int numFramesToWrite) + throws IOException, WavFileException { + return writeFrames(sampleBuffer, 0, numFramesToWrite); + } + + public int writeFrames(double[][] sampleBuffer, int offset, + int numFramesToWrite) throws IOException, WavFileException { + if (ioState != IOState.WRITING) + throw new IOException("Cannot write to WavFile instance"); + + for (int f = 0; f < numFramesToWrite; f++) { + if (frameCounter == numFrames) + return f; + + for (int c = 0; c < numChannels; c++) + writeSample((long) (floatScale * (floatOffset + sampleBuffer[c][offset]))); + + offset++; + frameCounter++; + } + + return numFramesToWrite; + } + + public void close() throws IOException { + // Close the input stream and set to null + if (iStream != null) { + iStream.close(); + iStream = null; + } + + if (oStream != null) { + // Write out anything still in the local buffer + if (bufferPointer > 0) + oStream.write(buffer, 0, bufferPointer); + + // If an extra byte is required for word alignment, add it to the + // end + if (wordAlignAdjust) + oStream.write(0); + + // Close the stream and set to null + oStream.close(); + oStream = null; + } + + // Flag that the stream is closed + ioState = IOState.CLOSED; + } + + public void display() { + display(System.out); + } + + public void display(PrintStream out) { + out.printf("File: %s\n", file); + out.printf("Channels: %d, Frames: %d\n", numChannels, numFrames); + out.printf("IO State: %s\n", ioState); + out.printf("Sample Rate: %d, Block Align: %d\n", sampleRate, blockAlign); + out.printf("Valid Bits: %d, Bytes per sample: %d\n", validBits, + bytesPerSample); + } + + public static void main(String[] args) { + if (args.length < 1) { + System.err.println("Must supply filename"); + System.exit(1); + } + + try { + for (String filename : args) { + WavFile readWavFile = openWavFile(new File(filename)); + readWavFile.display(); + + long numFrames = readWavFile.getNumFrames(); + int numChannels = readWavFile.getNumChannels(); + int validBits = readWavFile.getValidBits(); + long sampleRate = readWavFile.getSampleRate(); + + WavFile writeWavFile = newWavFile(new File("out.wav"), + numChannels, numFrames, validBits, sampleRate); + + final int BUF_SIZE = 5001; + + // int[] buffer = new int[BUF_SIZE * numChannels]; + // long[] buffer = new long[BUF_SIZE * numChannels]; + double[] buffer = new double[BUF_SIZE * numChannels]; + + int framesRead = 0; + int framesWritten = 0; + + do { + framesRead = readWavFile.readFrames(buffer, BUF_SIZE); + framesWritten = writeWavFile.writeFrames(buffer, BUF_SIZE); + System.out.printf("%d %d\n", framesRead, framesWritten); + } while (framesRead != 0); + + readWavFile.close(); + writeWavFile.close(); + } + + WavFile writeWavFile = newWavFile(new File("out2.wav"), 1, 10, 23, + 44100); + double[] buffer = new double[10]; + writeWavFile.writeFrames(buffer, 10); + writeWavFile.close(); + } catch (Exception e) { + System.err.println(e); + e.printStackTrace(); + } + } +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/WavFileException.java b/plugin/jcapture/src/com/hammurapi/jcapture/WavFileException.java new file mode 100644 index 000000000..64e27feb7 --- /dev/null +++ b/plugin/jcapture/src/com/hammurapi/jcapture/WavFileException.java @@ -0,0 +1,26 @@ +package com.hammurapi.jcapture; + +//This file was taken from http://www.labbookpages.co.uk/audio/javaWavFiles.html and package declaration was added. + +public class WavFileException extends Exception +{ + public WavFileException() + { + super(); + } + + public WavFileException(String message) + { + super(message); + } + + public WavFileException(String message, Throwable cause) + { + super(message, cause); + } + + public WavFileException(Throwable cause) + { + super(cause); + } +} diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/camera.png b/plugin/jcapture/src/com/hammurapi/jcapture/camera.png new file mode 100644 index 000000000..f7cbba0a8 Binary files /dev/null and b/plugin/jcapture/src/com/hammurapi/jcapture/camera.png differ diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/mouse.png b/plugin/jcapture/src/com/hammurapi/jcapture/mouse.png new file mode 100644 index 000000000..59c10fd24 Binary files /dev/null and b/plugin/jcapture/src/com/hammurapi/jcapture/mouse.png differ diff --git a/plugin/jcapture/src/com/hammurapi/jcapture/toolbar_buttons.swf b/plugin/jcapture/src/com/hammurapi/jcapture/toolbar_buttons.swf new file mode 100644 index 000000000..524d8a304 Binary files /dev/null and b/plugin/jcapture/src/com/hammurapi/jcapture/toolbar_buttons.swf differ diff --git a/plugin/jcapture/upload.php b/plugin/jcapture/upload.php new file mode 100644 index 000000000..ae4ce2a96 --- /dev/null +++ b/plugin/jcapture/upload.php @@ -0,0 +1,62 @@ +getInstalledPlugins(); +$capturePluginInstalled = in_array('jcapture', $pluginList); +if (!$capturePluginInstalled) { + exit; +} + +if (!isset($_FILES['Filedata'])) { + exit; +} + +$courseInfo = api_get_course_info(); +$folderName = 'captures'; +$documentId = DocumentManager::get_document_id($courseInfo, '/'.$folderName); +$path = null; +if (empty($documentId)) { + $course_dir = $courseInfo['path'].'/document'; + $sys_course_path = api_get_path(SYS_COURSE_PATH); + $dir = $sys_course_path.$course_dir; + $createdDir = create_unexisting_directory( + $courseInfo, + api_get_user_id(), + api_get_session_id(), + null, + null, + $dir, + '/'.$folderName, + $folderName + ); + if ($createdDir) { + $path = '/'.$folderName; + } +} else { + $data = DocumentManager::get_document_data_by_id($documentId, $courseInfo['code']); + $path = $data['path']; +} + +if (empty($path)) { + exit; +} + +$files = [ + 'file' => $_FILES['Filedata'], +]; + +DocumentManager::upload_document( + $files, + $path, + $_FILES['Filedata']['name'], + null, + false, + 'rename', + false, + true +); diff --git a/plugin/justification/Justification.php b/plugin/justification/Justification.php new file mode 100644 index 000000000..722e2c165 --- /dev/null +++ b/plugin/justification/Justification.php @@ -0,0 +1,101 @@ + 'boolean', + 'notification_to_creator_only' => 'boolean', + 'access_for_session_admin' => 'boolean', + 'default_course_id' => 'text', + ] + ); + } + + /** + * @return $this + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + public function getJustification($id) + { + $id = (int) $id; + + $sql = 'SELECT * FROM justification_document WHERE id = '.$id; + $query = Database::query($sql); + + return Database::fetch_array($query, 'ASSOC'); + } + + public function getUserJustificationList($userId) + { + $userId = (int) $userId; + + $sql = "SELECT * FROM justification_document_rel_users WHERE user_id = $userId "; + $query = Database::query($sql); + + return Database::store_result($query, 'ASSOC'); + } + + public function getUserJustification($id) + { + $id = (int) $id; + + $sql = "SELECT * FROM justification_document_rel_users WHERE id = $id "; + $query = Database::query($sql); + + return Database::fetch_array($query, 'ASSOC'); + } + + public function getList() + { + $sql = 'SELECT * FROM justification_document ORDER BY name '; + $query = Database::query($sql); + + return Database::store_result($query, 'ASSOC'); + } + + /** + * Install. + */ + public function install() + { + $sql = "CREATE TABLE IF NOT EXISTS justification_document ( + id INT unsigned NOT NULL auto_increment PRIMARY KEY, + code TEXT NULL, + name TEXT NULL, + validity_duration INT, + comment TEXT NULL, + date_manual_on INT + )"; + Database::query($sql); + + $sql = "CREATE TABLE IF NOT EXISTS justification_document_rel_users ( + id INT unsigned NOT NULL auto_increment PRIMARY KEY, + justification_document_id INT NOT NULL, + file_path VARCHAR(255), + user_id INT, + date_validity DATE + )"; + Database::query($sql); + } + + public function uninstall() + { + $sql = 'DROP TABLE IF EXISTS justification_document'; + Database::query($sql); + + $sql = 'DROP TABLE IF EXISTS justification_document_rel_users'; + Database::query($sql); + } +} diff --git a/plugin/justification/README.md b/plugin/justification/README.md new file mode 100644 index 000000000..bc4406d38 --- /dev/null +++ b/plugin/justification/README.md @@ -0,0 +1,39 @@ +Justification +============== + +1. Enable the plugin. +2. Create the justification files in plugin/justification/list.php + + +When activating the justification plugin it adds a link at the bottom of the plateform block of the administration page to open plugin/justification/list.php to create and manage the justification needed. +On this page the admin can manage the list of justification that would be asked to users, and select a course for automatic inscription if the justificatives are completed and desinscription if justicatives are not completed or outdated. For the automatic subscription and removal you need to create a cron to run plugin/justification/cron.php periodically to do the verification. +The justification plugin only activate a new tab in the profile for the user to upload some justification (the list of which are defined by the administrator on the page plugin/justification/list.php indicated above). +If the notification system is activated then you have the ability to create notification to be sent before the expiration of the justification if configured so. +To activate it you have to set it in app/config/configuration.php with : +``` +// Show notification events +/*CREATE TABLE IF NOT EXISTS notification_event ( +id INT unsigned NOT NULL auto_increment PRIMARY KEY, + title VARCHAR(255), + content TEXT, + link TEXT, + persistent INT, + day_diff INT, + event_type VARCHAR(255) + ); +ALTER TABLE notification_event ADD COLUMN event_id INT NULL; +CREATE TABLE IF NOT EXISTS notification_event_rel_user ( + id INT UNSIGNED AUTO_INCREMENT NOT NULL, + event_id INT unsigned, + user_id INT, + INDEX FK_EVENT (event_id), + INDEX FK_USER (user_id), + PRIMARY KEY (id) +); +ALTER TABLE notification_event_rel_user ADD CONSTRAINT FK_EVENT FOREIGN KEY (event_id) REFERENCES notification_event (id) ON DELETE CASCADE; +ALTER TABLE notification_event_rel_user ADD CONSTRAINT FK_USER FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE; +*/ +// create new user text extra field called 'notification_event' to save the persistent settings. +// $_configuration['notification_event'] = false; +``` + diff --git a/plugin/justification/add.php b/plugin/justification/add.php new file mode 100644 index 000000000..ed5629b01 --- /dev/null +++ b/plugin/justification/add.php @@ -0,0 +1,68 @@ +addText('name', get_lang('Name')); +$form->addText('code', $plugin->get_lang('JustificationCode')); +$form->addNumeric('validity_duration', $plugin->get_lang('ValidityDuration')); +$form->addCheckBox('date_manual_on', $plugin->get_lang('DateManualOn')); +$form->addTextarea('comment', get_lang('Comment')); +$form->addButtonSave(get_lang('Save')); + +if ($form->validate()) { + $values = $form->getSubmitValues(); + $dateManual = isset($values['date_manual_on']) ? 1 : 0; + + $cleanedCode = api_replace_dangerous_char($values['code']); + $code = Database::escape_string($cleanedCode); + + $sql = "SELECT * FROM justification_document WHERE code = '$code' "; + $result = Database::query($sql); + $data = Database::fetch_array($result); + $message = Display::return_message(get_lang('ThisCodeAlradyExists'), 'warning'); + + if (empty($data)) { + $params = [ + 'name' => $values['name'], + 'code' => $cleanedCode, + 'validity_duration' => $values['validity_duration'], + 'date_manual_on' => $dateManual, + 'comment' => $values['comment'], + ]; + Database::insert('justification_document', $params); + $message = Display::return_message(get_lang('Saved')); + } + + Display::addFlash($message); + + $url = api_get_path(WEB_PLUGIN_PATH).'justification/list.php?'; + header('Location: '.$url); + exit; +} + +$actionLinks = Display::toolbarButton( + $plugin->get_lang('Back'), + api_get_path(WEB_PLUGIN_PATH).'justification/list.php', + 'arrow-left', + 'primary' +); + +$tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$actionLinks]) +); + +$content = $form->returnForm(); + +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/justification/cron.php b/plugin/justification/cron.php new file mode 100644 index 000000000..d03992f3d --- /dev/null +++ b/plugin/justification/cron.php @@ -0,0 +1,88 @@ +getList(); +$totalFields = count($fieldList); + +if (empty($fieldList)) { + echo 'No fields to check. Please add them in the justification plugin'; + exit; +} + +$userList = UserManager::get_user_list(); +$count = count($userList); + +echo "#$count users found".PHP_EOL; +$currentDate = api_get_utc_datetime(); + +foreach ($userList as $user) { + $userId = $user['id']; + + echo "Checking user id #$userId".PHP_EOL; + + $userJustificationList = $plugin->getUserJustificationList($userId); + $userJustificationDocumentList = array_column($userJustificationList, 'date_validity', 'justification_document_id'); + + if (count($userJustificationList) < $totalFields) { + unsubscribeUser($userId, $courseInfo); + continue; + } + + if (count($userJustificationList) >= $totalFields) { + $successList = []; + foreach ($fieldList as $field) { + if (isset($userJustificationDocumentList[$field['id']])) { + $dateValidity = $userJustificationDocumentList[$field['id']]; + if ($dateValidity > $currentDate) { + $successList[] = true; + } + } + } + $countSuccess = count($successList); + if ($countSuccess === $totalFields) { + subscribeUser($userId, $courseInfo); + continue; + } else { + echo "User #$userId only got $countSuccess justification(s) out of $totalFields.".PHP_EOL; + } + } + + unsubscribeUser($userId, $courseInfo); +} + +function unsubscribeUser($userId, $courseInfo) +{ + $courseId = $courseInfo['real_id']; + CourseManager::unsubscribe_user($userId, $courseInfo['code']); + echo "Unsubscribe user id #$userId to course #$courseId".PHP_EOL; +} + +function subscribeUser($userId, $courseInfo) +{ + $courseId = $courseInfo['real_id']; + $isUserSubscribed = CourseManager::is_user_subscribed_in_course($userId, $courseInfo['code']); + if ($isUserSubscribed === false) { + CourseManager::subscribeUser($userId, $courseInfo['code'], STUDENT); + echo "Subscribe user id #$userId to course #$courseId".PHP_EOL; + } else { + echo "Nothing to do user id #$userId is already subscribed to #$courseId".PHP_EOL; + } +} diff --git a/plugin/justification/edit.php b/plugin/justification/edit.php new file mode 100644 index 000000000..2852732ea --- /dev/null +++ b/plugin/justification/edit.php @@ -0,0 +1,76 @@ +getJustification($id); + +$tpl = new Template($tool); +$fields = []; + +$form = new FormValidator('add', 'post', api_get_self().'?id='.$id); +$form->addText('name', get_lang('Name')); +$form->addText('code', $plugin->get_lang('JustificationCode')); +$form->addNumeric('validity_duration', $plugin->get_lang('ValidityDuration')); +$form->addCheckBox('date_manual_on', $plugin->get_lang('DateManualOn')); +$form->addTextarea('comment', get_lang('Comment')); +$form->addButtonSave(get_lang('Update')); + +$form->setDefaults($justification); + +if ($form->validate()) { + $values = $form->getSubmitValues(); + $cleanedCode = api_replace_dangerous_char($values['code']); + $code = Database::escape_string($cleanedCode); + + $sql = "SELECT * FROM justification_document WHERE code = '$code' AND id <> $id"; + $result = Database::query($sql); + $data = Database::fetch_array($result); + $message = Display::return_message(get_lang('ThisCodeAlradyExists'), 'warning'); + if (empty($data)) { + $params = [ + 'name' => $values['name'], + 'code' => $cleanedCode, + 'validity_duration' => $values['validity_duration'], + 'date_manual_on' => (int) $values['date_manual_on'], + 'comment' => $values['comment'], + ]; + + Database::update('justification_document', $params, ['id = ?' => $id]); + $message = Display::return_message(get_lang('Saved')); + } + + Display::addFlash($message); + + $url = api_get_path(WEB_PLUGIN_PATH).'justification/list.php?'; + header('Location: '.$url); + exit; +} + +$actionLinks = Display::toolbarButton( + $plugin->get_lang('Back'), + api_get_path(WEB_PLUGIN_PATH).'justification/list.php', + 'arrow-left', + 'primary' +); + +$tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$actionLinks]) +); + +$content = $form->returnForm(); + +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/justification/index.php b/plugin/justification/index.php new file mode 100644 index 000000000..e1533d2fe --- /dev/null +++ b/plugin/justification/index.php @@ -0,0 +1,4 @@ +install(); diff --git a/plugin/justification/justification_by_user.php b/plugin/justification/justification_by_user.php new file mode 100644 index 000000000..e663db404 --- /dev/null +++ b/plugin/justification/justification_by_user.php @@ -0,0 +1,114 @@ +addHeader('Search'); +$form->addSelectAjax( + 'user_id', + get_lang('User'), + [], + [ + 'url' => api_get_path(WEB_AJAX_PATH).'user_manager.ajax.php?a=get_user_like', + ] +); +$form->addButtonSearch(get_lang('Search')); +$tpl->assign('form', $form->returnForm()); + +$userId = isset($_REQUEST['user_id']) ? (int) $_REQUEST['user_id'] : 0; + +if ($form->validate()) { + $userId = $form->getSubmitValue('user_id'); +} + +if ($userId) { + $tpl->assign('user_info', api_get_user_info($userId)); + $list = $plugin->getUserJustificationList($userId); + if ($list) { + foreach ($list as &$item) { + if ($item['date_validity'] < api_get_local_time()) { + $item['date_validity'] = Display::label($item['date_validity'], 'warning'); + } + $item['justification'] = $plugin->getJustification($item['justification_document_id']); + $item['file_path'] = Display::url( + $item['file_path'], + api_get_uploaded_web_url('justification', $item['id'], $item['file_path']), + ['target' => '_blank'] + ); + } + } + if (empty($list)) { + Display::addFlash(Display::return_message($plugin->get_lang('NoJustificationFound'))); + } + $tpl->assign('list', $list); +} + +$tpl->assign('user_id', $userId); +$content = $tpl->fetch('justification/view/justification_user_list.tpl'); + +$actionLinks = ''; + +$action = isset($_REQUEST['a']) ? $_REQUEST['a'] : ''; +$id = isset($_REQUEST['id']) ? (int) $_REQUEST['id'] : 0; + +switch ($action) { + case 'edit': + $userJustification = $plugin->getUserJustification($id); + $userInfo = api_get_user_info($userJustification['user_id']); + $form = new FormValidator('edit', 'post', api_get_self().'?a=edit&id='.$id.'&user_id='.$userId); + $form->addHeader($userInfo['complete_name']); + $element = $form->addDatePicker('date_validity', $plugin->get_lang('ValidityDate')); + $element->setValue($userJustification['date_validity']); + $form->addButtonUpdate(get_lang('Update')); + $form->setDefaults($userJustification); + $content = $form->returnForm(); + + if ($form->validate()) { + $values = $form->getSubmitValues(); + $date = Database::escape_string($values['date_validity']); + $sql = "UPDATE justification_document_rel_users SET date_validity = '$date' WHERE id = $id"; + Database::query($sql); + Display::addFlash(Display::return_message(get_lang('Updated'))); + header('Location: '.api_get_self().'?user_id='.$userId); + exit; + } + break; + case 'delete': + $userJustification = $plugin->getUserJustification($id); + if ($userJustification) { + api_remove_uploaded_file_by_id('justification', $id, $userJustification['file_path']); + + $sql = "DELETE FROM justification_document_rel_users WHERE id = $id"; + Database::query($sql); + + Display::addFlash(Display::return_message(get_lang('Deleted'))); + } + header('Location: '.api_get_self().'?user_id='.$userId); + exit; + break; +} + +$actionLinks .= Display::toolbarButton( + $plugin->get_lang('Back'), + api_get_path(WEB_PLUGIN_PATH).'justification/list.php', + 'arrow-left', + 'primary' +); + +$tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$actionLinks]) +); + +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/justification/lang/english.php b/plugin/justification/lang/english.php new file mode 100644 index 000000000..6d7a7a3ad --- /dev/null +++ b/plugin/justification/lang/english.php @@ -0,0 +1,27 @@ +getList(); + +$tpl->assign('list', $list); + +$content = $tpl->fetch('justification/view/list.tpl'); +$actionLinks = ''; +$action = isset($_REQUEST['a']) ? $_REQUEST['a'] : ''; +$id = isset($_REQUEST['id']) ? (int) $_REQUEST['id'] : 0; + +switch ($action) { + case 'delete': + $sql = "DELETE FROM justification_document WHERE id = $id"; + Database::query($sql); + + Display::addFlash(Display::return_message(get_lang('Deleted'))); + header('Location: '.api_get_self()); + exit; + break; +} + +if (api_is_platform_admin()) { + $actionLinks .= Display::toolbarButton( + $plugin->get_lang('Add'), + api_get_path(WEB_PLUGIN_PATH).'justification/add.php', + 'plus', + 'primary' + ); +} + +$actionLinks .= Display::toolbarButton( + $plugin->get_lang('Users'), + api_get_path(WEB_PLUGIN_PATH).'justification/justification_by_user.php', + 'user', + 'primary' +); + +if (api_is_platform_admin()) { + $actionLinks .= Display::toolbarButton( + $plugin->get_lang('SetNewCourse'), + api_get_path(WEB_PLUGIN_PATH).'justification/set_course.php', + 'book', + 'primary' + ); +} + +$tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$actionLinks]) +); + +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/justification/plugin.php b/plugin/justification/plugin.php new file mode 100644 index 000000000..02126ea19 --- /dev/null +++ b/plugin/justification/plugin.php @@ -0,0 +1,6 @@ +get_info(); diff --git a/plugin/justification/set_course.php b/plugin/justification/set_course.php new file mode 100644 index 000000000..1fdecfb6d --- /dev/null +++ b/plugin/justification/set_course.php @@ -0,0 +1,57 @@ +addHeader($plugin->get_lang('SetNewCourse')); +$currentCourse = api_get_setting('justification_default_course_id', 'justification'); + +if (!empty($currentCourse)) { + $courseInfo = api_get_course_info_by_id($currentCourse); + Display::addFlash(Display::return_message(get_lang('Course').': '.$courseInfo['title'])); +} + +$form->addSelectAjax( + 'course_id', + get_lang('Course'), + null, + [ + 'url' => api_get_path(WEB_AJAX_PATH).'course.ajax.php?a=search_course', + ] +); +$form->addButtonSave(get_lang('Save')); + +if ($form->validate()) { + $values = $form->getSubmitValues(); + api_set_setting('justification_default_course_id', $values['course_id']); + Display::addFlash(Display::return_message(get_lang('Saved'))); + $url = api_get_path(WEB_PLUGIN_PATH).'justification/list.php?'; + header('Location: '.$url); + exit; +} + +$actionLinks = Display::toolbarButton( + $plugin->get_lang('Back'), + api_get_path(WEB_PLUGIN_PATH).'justification/list.php', + 'arrow-left', + 'primary' +); + +$tpl->assign( + 'actions', + Display::toolbarAction('toolbar', [$actionLinks]) +); + +$content = $form->returnForm(); + +$tpl->assign('content', $content); +$tpl->display_one_col_template(); diff --git a/plugin/justification/uninstall.php b/plugin/justification/uninstall.php new file mode 100644 index 000000000..a1e3b57a1 --- /dev/null +++ b/plugin/justification/uninstall.php @@ -0,0 +1,8 @@ +uninstall(); diff --git a/plugin/justification/view/add.tpl b/plugin/justification/view/add.tpl new file mode 100644 index 000000000..078f032f1 --- /dev/null +++ b/plugin/justification/view/add.tpl @@ -0,0 +1,48 @@ +{{ search_form }} + + + + + + + + + + + + + + {% for meeting in meetings %} + + {% if meeting.visibility == 0 %} + + {% else %} + + {% endif %} + + + + + + + + {% endfor %} + +
    {{ 'CreatedAt'|get_lang }}{{ 'Status'|get_lang }}{{ 'Records'|get_plugin_lang('BBBPlugin') }}{{ 'Course'|get_lang }}{{ 'Session'|get_lang }}{{ 'Participants'|get_lang }}{{ 'Actions'|get_lang }}
    {{ meeting.created_at }}{{ meeting.created_at }} + {% if meeting.status == 1 %} + {{ 'MeetingOpened'|get_plugin_lang('BBBPlugin') }} + {% else %} + {{ 'MeetingClosed'|get_plugin_lang('BBBPlugin') }} + {% endif %} + + {% if meeting.record == 1 %} + {# Record list #} + {{ meeting.show_links }} + {% else %} + {{ 'NoRecording'|get_plugin_lang('BBBPlugin') }} + {% endif %} + {{ meeting.course ?: '-' }}{{ meeting.session ?: '-' }} + {{ meeting.participants ? meeting.participants|join('
    ') : '-' }} +     		+ {{ meeting.action_links }} +
    diff --git a/plugin/justification/view/justification_user_list.tpl b/plugin/justification/view/justification_user_list.tpl new file mode 100644 index 000000000..35b88d286 --- /dev/null +++ b/plugin/justification/view/justification_user_list.tpl @@ -0,0 +1,38 @@ +{{ form }} + +{% if list %} +
    +
    +
    +

    {{ 'DocumentListForUserX'| get_plugin_lang('Justification')|format(user_info.complete_name) }}

    +
    + + + + + + + + {% for item in list %} + + + + + + + {% endfor %} +
    {{ 'Justification'| get_plugin_lang('Justification') }}{{ 'File'| get_lang }}{{ 'Date'| get_lang('Date') }}{{ 'Actions'| get_lang }}
    {{ item.justification.name }} {{ item.file_path }} + {{ item.date_validity }} + + + {{'Edit' | get_lang}} + + + {{'Delete' | get_lang}} + +
    +
    +
    +{% endif %} diff --git a/plugin/justification/view/list.tpl b/plugin/justification/view/list.tpl new file mode 100644 index 000000000..2147efa94 --- /dev/null +++ b/plugin/justification/view/list.tpl @@ -0,0 +1,33 @@ +
    +
    +
    +

    {{ 'List'| get_lang }}

    +
    + + + + + + + + + {% for item in list %} + + + + + + + + {% endfor %} +
    {{ 'Name'| get_lang }}{{ 'ValidityDuration'| get_plugin_lang('Justification') }}{{ 'DateManualOn'| get_plugin_lang('Justification') }}{{ 'Actions'| get_lang }}
    {{ item.name }} ({{ item.code }}){{ item.validity_duration }}{{ item.date_manual_on }} + + {{'Edit' | get_lang}} + + + + {{'Delete' | get_lang}} + +
    +
    +
    diff --git a/plugin/kannelsms/README.md b/plugin/kannelsms/README.md new file mode 100644 index 000000000..0ca15db7a --- /dev/null +++ b/plugin/kannelsms/README.md @@ -0,0 +1,10 @@ +Kannel SMS plugin +=== + +This plugin enables Chamilo to send SMS messages to Chamilo users when a notification email is sent. + +SMS message types (a new course is created, an account is approved and so on) can be enabled or disabled from its plugin configuration option. + +Kannel SMS requires a Kannel server (software) to be installed on the machine and a cellphone to be connected to this server (usually through a USB cable). The communication is thus made through the cellphone itself. + +This is only for one-way communication from the Chamilo server to students cellphones. diff --git a/plugin/kannelsms/config.php b/plugin/kannelsms/config.php new file mode 100644 index 000000000..4b175b28b --- /dev/null +++ b/plugin/kannelsms/config.php @@ -0,0 +1,15 @@ + + */ +require_once __DIR__.'/../../main/inc/global.inc.php'; + +require_once 'lib/kannelsms.lib.php'; +require_once 'vendor/kannelsms_api.php'; +require_once 'lib/kannelsms_plugin.class.php'; diff --git a/plugin/kannelsms/index.php b/plugin/kannelsms/index.php new file mode 100644 index 000000000..b3d9bbc7f --- /dev/null +++ b/plugin/kannelsms/index.php @@ -0,0 +1 @@ + + */ +/** + * Initialization. + */ +require_once __DIR__.'/config.php'; +KannelsmsPlugin::create()->install(); diff --git a/plugin/kannelsms/lang/english.php b/plugin/kannelsms/lang/english.php new file mode 100644 index 000000000..d030d99eb --- /dev/null +++ b/plugin/kannelsms/lang/english.php @@ -0,0 +1,105 @@ +"; + +$strings['hostAddress'] = "Host address"; +$strings['hostAddress_help'] = "This is the address where your SMS gateway is hosted. Example: http://mobilegateway.com/tools/gateways/smssender"; +$strings['username'] = "Username"; +$strings['password'] = "Password"; +$strings['from'] = "Sender mobile number"; + +$strings['sms_types'] = "Send SMS when"; +$strings['mobile_phone_number'] = "Mobile"; + +$strings['MessageWelcomeXLoginXPasswordX'] = "A user is added to the platform"; +$strings['MessageXNewFileSharedCourseXByX'] = "A file is added to dropbox"; +$strings['MessageXAccountApprovedConnectX'] = "An account is approved"; +$strings['MessageXNewCourseXBeenCreatedX'] = "A new course is created"; +$strings['MessageXNewUserXSubscribedCourseX'] = "A user is subscribed to a course"; +$strings['MessageXNewCourseSuggestedTeacherX'] = "A new course is suggested"; +$strings['MessageXCourseOpeningRequestCodeXRegistered'] = "A new course opening request is registered"; +$strings['MessageXCourseOpeningRequestCourseCodeXApproved'] = "A new course opening request is approved"; +$strings['MessageXRequestOpenCourseCodeXReject'] = "A new course opening request is rejected"; +$strings['MessageXCourseOpeningRequestCourseCodeX'] = "Additional information is required for a new course opening request"; +$strings['MessageXBeenSubscribedCourseX'] = "A user is added to the course but not registered to it yet"; +$strings['MessageXAssignmentBeenCreatedCourseX'] = "Homework is created"; +$strings['MessageXAccountCreatedUpdatedLoginXPasswordX'] = "A user account is created or updated"; +$strings['MessageXPasswordUpdatedLoginXPasswordX'] = "A user password is updated"; +$strings['MessageXRequestedPasswordChange'] = "A user requests a password change"; +$strings['MessageXReceivedNewPersonalMessages'] = "New personal messages are received in user's inbox or forum"; +$strings['MessageXNewUserXPendingApproval'] = "A new user registration is pending for approval"; +$strings['MessageXXPostedForumXCourseX'] = "A user posts in forum"; +$strings['MessageXXXCheckEmailConnectMoreInfo'] = "An announcement is sent"; +$strings['MessageXXStudentXAnsweredTestX'] = "A student solves an exercise"; +$strings['MessageXXStudentXAnsweredTestXOpenQuestion'] = "A student solves an open question"; +$strings['MessageXXStudentXAnsweredTestXVoiceQuestion'] = "A student solves a voice question"; +$strings['MessageXXAnswerOpenQuestionTestXReviewed'] = "An open question answer is reviewed"; +$strings['MessageXXNewThreadXStartedForumX'] = "A new thread is started in forum"; +$strings['MessageXXNewAnswerPostedXForumX'] = "A new answer is posted in forum"; +$strings['MessageXXNewSystemAnnouncementAdded'] = "A new system announcement is added and the user does not want to send a test email"; +$strings['MessageXTestXNewSystemAnnouncementAdded'] = "A new system announcement is added and the user wants to send a test email"; +$strings['MessageXXSystemAnnouncementUpdate'] = "A new system announcement is updated and the user does not want to send a test email"; +$strings['MessageXTestXSystemAnnouncementUpdate'] = "A new system announcement is updated and the user wants to send a test email"; +$strings['MessageXUserXUploadedAssignmentXCourseXStudentSubmitsPaper'] = "An assignment is uploaded and there is no current session (this will be sent only to coaches)"; +$strings['MessageXUserXUploadedAssignmentXCheckXStudentSubmitsPaper'] = "An assignment is uploaded (this will be sent only to teachers)"; +$strings['MessageXUserXUploadedAssignmentXCourseX'] = "... and there is no current session (this will be sent only to coaches)"; +$strings['MessageXUserXUploadedAssignmentXCheckX'] = "... (this will be sent only to teachers)"; +$strings['MessageXSubscribedSessionX'] = "A session is created or updated and new users are subscribed"; +$strings['MessageXSubscribedSessionXCSV'] = "New users are subscribed to a session importing a CSV file"; +$strings['MessageXUserXSuggestedBeFriends'] = "A friendship invitation is received"; +$strings['MessageXUserXAnsweredInboxMessage'] = "A message reply is received in inbox"; +$strings['MessageXBeenInvitedJoinGroupX'] = "A group join invitation is received"; +$strings['MessageXMessagesSentEditedGroupXEdited'] = "A group topic message is updated"; +$strings['MessageXMessagesSentEditedGroupXAdded'] = "A group topic message is added"; +$strings['MessageXBeenInvitedCompleteSurveyXCourseX'] = "A new survey is created"; +$strings['MessageXReminderAssignmentXCourseXDue'] = "A reminder is sent to students who have not uploaded their assignment yet"; +$strings['MessageXUserDetailsModified'] = "User details have been updated"; + +$strings['WelcomeXLoginXPasswordX'] = "Welcome to %s. Here are your user account details: login: %s, password: %s"; +$strings['XNewFileSharedCourseXByX'] = "%s: A new file has been shared with you in course %s by %s"; +$strings['XAccountApprovedConnectX'] = "%s: Your account has been approved by an administrator. You can now connect to %s"; +$strings['XNewCourseXBeenCreatedX'] = "%s: A new course (%s) has been created by %s"; +$strings['XNewUserXSubscribedCourseX'] = "%s: A new user (%s) has just subscribed to your course (%s)"; +$strings['XNewCourseSuggestedTeacherX'] = "%s: A new course has been suggested by teacher (%s). Please connect to the admin page to review it"; +$strings['XCourseOpeningRequestCodeXRegistered'] = "%s: Your course opening request (code %s) has been registered. You will be informed when it is approved"; +$strings['XCourseOpeningRequestCourseCodeXApproved'] = "%s: Your course opening request for course code %s has been approved. Connect to your portal to use it"; +$strings['XRequestOpenCourseCodeXReject'] = "%s: We are sorry to inform you that your request to open course code %s has been rejected"; +$strings['XCourseOpeningRequestCourseCodeX'] = "%s: Your course opening request for course code %s requires more information. Check e-mail for more info"; +$strings['XBeenSubscribedCourseX'] = "%s: You have been subscribed to course %s"; +$strings['XAssignmentBeenCreatedCourseX'] = "%s: A new assignment has been created in course %s. Please connect for more info"; +$strings['XAccountCreatedUpdatedLoginXPasswordX'] = "%s: Your account has been created or updated. You can now login as %s, password: %s"; +$strings['XPasswordUpdatedLoginXPasswordX'] = "%s: Your password has been updated. You can now login as %s, password: %s"; +$strings['XRequestedPasswordChange'] = "%s: You have requested a password change. Please check your e-mail for more information"; +$strings['XReceivedNewPersonalMessages'] = "%s: You have received new personal messages in your inbox or in the forum. Please check your e-mail for more info"; +$strings['XNewUserXPendingApproval'] = "%s: A new user (%s) registration is pending your approval. Please connect to the admin panel to review"; +$strings['XXPostedForumXCourseX'] = "%s: %s just posted on forum %s in course %s"; +$strings['XXXCheckEmailConnectMoreInfo'] = "%s: %s: %s. Check your e-mail or connect for more info"; +$strings['XXStudentXAnsweredTestX'] = "%s: %s: Student %s has just answered test %s"; +$strings['XXStudentXAnsweredTestXOpenQuestion'] = "%s: %s: Student %s answered test %s's open question. Please connect to review"; +$strings['XXStudentXAnsweredTestXVoiceQuestion'] = "%s: %s: Student %s answered test %s's voice question. Please connect to review"; +$strings['XXAnswerOpenQuestionTestXReviewed'] = "%s: %s: Your answer to an open question in test %s has been reviewed"; +$strings['XXNewThreadXStartedForumX'] = "%s: %s: A new thread (%s) has been started in forum %s"; +$strings['XXNewAnswerPostedXForumX'] = "%s: %s: A new answer has been posted to (%s) in forum %s"; +$strings['XXNewSystemAnnouncementAdded'] = "%s: %s"; +$strings['XTestXNewSystemAnnouncementAdded'] = "%s (test): %s"; +$strings['XXSystemAnnouncementUpdate'] = "%s: %s (update)"; +$strings['XTestXSystemAnnouncementUpdate'] = "%s (test): %s"; +$strings['XUserXUploadedAssignmentXCourseXStudentSubmitsPaper'] = "%s: User %s uploaded assignment %s in course %s"; +$strings['XUserXUploadedAssignmentXCheckXStudentSubmitsPaper'] = "%s: User %s uploaded assignment %s. Check %s"; +$strings['XUserXUploadedAssignmentXCourseX'] = "%s: User %s uploaded assignment %s in course %s"; +$strings['XUserXUploadedAssignmentXCheckX'] = "%s: User %s uploaded assignment %s. Check %s"; +$strings['XSubscribedSessionX'] = "%s: You have been subscribed to session %s"; +$strings['XSubscribedSessionXCSV'] = "%s: You have been subscribed to session %s"; +$strings['XUserXSuggestedBeFriends'] = "%s: User %s suggested you should be friends. Check your inbox or e-mail for details"; +$strings['XUserXAnsweredInboxMessage'] = "%s: User %s just answered your Inbox message"; +$strings['XBeenInvitedJoinGroupX'] = "%s: you have been invited to join group %s. Check your Inbox for details"; +$strings['XMessagesSentEditedGroupXEdited'] = "%s: Messages sent or edited in group %s. Check your Inbox for details"; +$strings['XMessagesSentEditedGroupXAdded'] = "%s: Messages sent or edited in group %s. Check your Inbox for details"; +$strings['XBeenInvitedCompleteSurveyXCourseX'] = "%s: You have been invited to complete survey %s in course %s"; +$strings['XReminderAssignmentXCourseXDue'] = "%s: This is a simple reminder that your assignment (%s) in course %s is still due"; +$strings['XUserDetailsModified'] = "%s: Your user details have been modified. Please check your e-mail for more information"; diff --git a/plugin/kannelsms/lang/spanish.php b/plugin/kannelsms/lang/spanish.php new file mode 100644 index 000000000..eefe9fbfa --- /dev/null +++ b/plugin/kannelsms/lang/spanish.php @@ -0,0 +1,105 @@ +"; + +$strings['hostAddress'] = "Dirección del servidor"; +$strings['hostAddress_help'] = "Ésta es la dirección en donde se aloja su pasarela de SMS. Ejemplo: http://mobilegateway.com/tools/gateways/smssender"; +$strings['username'] = "Nombre de usuario"; +$strings['password'] = "Contraseña"; +$strings['from'] = "Número de móvil remitente"; + +$strings['sms_types'] = "Enviar un SMS cuando"; +$strings['mobile_phone_number'] = "Móvil"; + +$strings['MessageWelcomeXLoginXPasswordX'] = "Se añada un usuario a la plataforma"; +$strings['MessageXNewFileSharedCourseXByX'] = "Un archivo se añada a dropbox"; +$strings['MessageXAccountApprovedConnectX'] = "Se apruebe una cuenta de usuario"; +$strings['MessageXNewCourseXBeenCreatedX'] = "Se cree un curso nuevo"; +$strings['MessageXNewUserXSubscribedCourseX'] = "Un usuario se suscriba a un curso"; +$strings['MessageXNewCourseSuggestedTeacherX'] = "Un profesor sugiera un curso nuevo"; +$strings['MessageXCourseOpeningRequestCodeXRegistered'] = "Se registre una solicitud de apertura de curso"; +$strings['MessageXCourseOpeningRequestCourseCodeXApproved'] = "Se apruebe una solicitud de apertura de curso"; +$strings['MessageXRequestOpenCourseCodeXReject'] = "Se rechace una solicitud de apertura de curso"; +$strings['MessageXCourseOpeningRequestCourseCodeX'] = "Se requiera más información de una solicitud de apertura de curso"; +$strings['MessageXBeenSubscribedCourseX'] = "Se le suscriba a un curso a un usuario que aún no está registrado"; +$strings['MessageXAssignmentBeenCreatedCourseX'] = "Se cree una nueva tarea en un curso"; +$strings['MessageXAccountCreatedUpdatedLoginXPasswordX'] = "Se cree o actualice una cuenta de usuario"; +$strings['MessageXPasswordUpdatedLoginXPasswordX'] = "Se actualice la contraseña de un usuario"; +$strings['MessageXRequestedPasswordChange'] = "Un usuario solicite un cambio de contraseña"; +$strings['MessageXReceivedNewPersonalMessages'] = "Se reciban mensajes personales nuevos en la bandeja de entrada o en el foro"; +$strings['MessageXNewUserXPendingApproval'] = "Una inscripción de un nuevo usuario esté pendiente de aprobación"; +$strings['MessageXXPostedForumXCourseX'] = "Un usuario escriba en el foro"; +$strings['MessageXXXCheckEmailConnectMoreInfo'] = "Se envíe una notificación"; +$strings['MessageXXStudentXAnsweredTestX'] = "Un estudiante resuelva un ejercicio de un examen"; +$strings['MessageXXStudentXAnsweredTestXOpenQuestion'] = "Un estudiante conteste a una pregunta abierta de un examen"; +$strings['MessageXXStudentXAnsweredTestXVoiceQuestion'] = "Un estudiante conteste a una pregunta de voz de un examen"; +$strings['MessageXXAnswerOpenQuestionTestXReviewed'] = "Se revise una pregunta abierta de un examen"; +$strings['MessageXXNewThreadXStartedForumX'] = "Se cree un hilo nuevo en el foro"; +$strings['MessageXXNewAnswerPostedXForumX'] = "Se escriba una respuesta nueva en el foro"; +$strings['MessageXXNewSystemAnnouncementAdded'] = "Se añada una notificación y el usuario no desee enviar un examen por correo electrónico"; +$strings['MessageXTestXNewSystemAnnouncementAdded'] = "Se añada una notificación y el usuario desee enviar un examen por correo electrónico"; +$strings['MessageXXSystemAnnouncementUpdate'] = "Se actualice una notificación y el usuario no desee enviar un examen por correo electrónico"; +$strings['MessageXTestXSystemAnnouncementUpdate'] = "Se actualice una notificación y el usuario desee enviar un examen por correo electrónico"; +$strings['MessageXUserXUploadedAssignmentXCourseXStudentSubmitsPaper'] = "Un estudiante suba su tarea y no exista una sesión (se enviará sólo a coordinadores)"; +$strings['MessageXUserXUploadedAssignmentXCheckXStudentSubmitsPaper'] = "Un estudiante suba su tarea (se enviará sólo a profesores)"; +$strings['MessageXUserXUploadedAssignmentXCourseX'] = "... y no exista una sesión (se enviará sólo a coordinadores)"; +$strings['MessageXUserXUploadedAssignmentXCheckX'] = "... (se enviará sólo a profesores)"; +$strings['MessageXSubscribedSessionX'] = "Se cree o edite una sesión nueva y se suscriban a usuarios nuevos"; +$strings['MessageXSubscribedSessionXCSV'] = "Se suscriban a usuarios nuevos desde un archivo CSV"; +$strings['MessageXUserXSuggestedBeFriends'] = "Se reciba una invitación de amistad"; +$strings['MessageXUserXAnsweredInboxMessage'] = "Se reciba la contestación a un mensaje en la bandeja de entrada"; +$strings['MessageXBeenInvitedJoinGroupX'] = "Se reciba una invitación para unirse a un grupo"; +$strings['MessageXMessagesSentEditedGroupXEdited'] = "Se actualice un mensaje en un tema de grupo"; +$strings['MessageXMessagesSentEditedGroupXAdded'] = "Se añada un mensaje en un tema de grupo"; +$strings['MessageXBeenInvitedCompleteSurveyXCourseX'] = "Se cree una encuesta nueva"; +$strings['MessageXReminderAssignmentXCourseXDue'] = "Se envíe un recordatorio a los estudiantes que no hayan enviado su tarea"; +$strings['MessageXUserDetailsModified'] = "Se actualice información de un usuario"; + +$strings['WelcomeXLoginXPasswordX'] = "Bienvenido a %s. Éstos son sus datos de acceso: usuario: %s, contraseña: %s"; +$strings['XNewFileSharedCourseXByX'] = "%s: Un nuevo archivo ha sido compartido contigo en el curso %s por %s"; +$strings['XAccountApprovedConnectX'] = "%s: Su cuenta ha sido aprobada por un administrador. Ya puede conectarse a %s"; +$strings['XNewCourseXBeenCreatedX'] = "%s: Un nuevo curso (%s) ha sido creado por %s"; +$strings['XNewUserXSubscribedCourseX'] = "%s: Un nuevo usuario (%s) se ha suscrito a su curso (%s)"; +$strings['XNewCourseSuggestedTeacherX'] = "%s: Un nuevo curso ha sido sugerido por el profesor (%s). Por favor, conéctese a la página de administración para revisarlo"; +$strings['XCourseOpeningRequestCodeXRegistered'] = "%s: Su solicitud de apertura de curso (código %s) ha sido registrada. Será informado cuando ésta sea aprobada"; +$strings['XCourseOpeningRequestCourseCodeXApproved'] = "%s: Su solicitud de apertura de curso para el código de curso %s ha sido aprobada. Conéctese a su portal para usarlo"; +$strings['XRequestOpenCourseCodeXReject'] = "%s: Lamentamos informarle que su solicitud de apertura de curso para el código de curso %s ha sido rechazada"; +$strings['XCourseOpeningRequestCourseCodeX'] = "%s: Su solicitud de apertura de curso para el código de curso %s requiere más información. Compruebe su e-mail para más información"; +$strings['XBeenSubscribedCourseX'] = "%s: Ha sido suscrito al curso %s"; +$strings['XAssignmentBeenCreatedCourseX'] = "%s: Una nueva tarea ha sido creada en el curso %s. Por favor, conéctese para más información"; +$strings['XAccountCreatedUpdatedLoginXPasswordX'] = "%s: Su cuenta ha sido creada o actualizada. Ya puede conectarse como %s, contraseña: %s"; +$strings['XPasswordUpdatedLoginXPasswordX'] = "%s: Su contraseña ha sido actualizada. Ya puede conectarse como %s, contraseña: %s"; +$strings['XRequestedPasswordChange'] = "%s: Ha solicitado un cambio de contraseña. Por favor, compruebe su e-mail para más información"; +$strings['XReceivedNewPersonalMessages'] = "%s: Ha recibido mensajes personales nuevos en su bandeja de entrada o en el foro. Por favor, compruebe su e-mail para más información"; +$strings['XNewUserXPendingApproval'] = "%s: Una inscripción de un nuevo usuario (%s) está pendiente de su aprobación. Por favor, conéctese al panel de administración para revisarla"; +$strings['XXPostedForumXCourseX'] = "%s: %s acaba de escribir en el foro %s del curso %s"; +$strings['XXXCheckEmailConnectMoreInfo'] = "%s: %s: %s. Compruebe su e-mail o conéctese para más información"; +$strings['XXStudentXAnsweredTestX'] = "%s: %s: El estudiante %s acaba de contestar al test %s"; +$strings['XXStudentXAnsweredTestXOpenQuestion'] = "%s: %s: El estudiante %s contestó a la pregunta abierta del test %s. Por favor, conéctese para revisarla"; +$strings['XXStudentXAnsweredTestXVoiceQuestion'] = "%s: %s: El estudiante %s contestó a la pregunta de voz del test %s. Por favor, conéctese para revisarla"; +$strings['XXAnswerOpenQuestionTestXReviewed'] = "%s: %s: Su respuesta a la pregunta abierta en el test %s ha sido revisada."; +$strings['XXNewThreadXStartedForumX'] = "%s: %s: Se ha comenzado un nuevo hilo (%s) en el foro %s"; +$strings['XXNewAnswerPostedXForumX'] = "%s: %s: Se ha escrito una nueva respuesta a (%s) en el foro %s"; +$strings['XXNewSystemAnnouncementAdded'] = "%s: %s"; +$strings['XTestXNewSystemAnnouncementAdded'] = "%s (prueba): %s"; +$strings['XXSystemAnnouncementUpdate'] = "%s: %s (actualización)"; +$strings['XTestXSystemAnnouncementUpdate'] = "%s (prueba): %s"; +$strings['XUserXUploadedAssignmentXCourseXStudentSubmitsPaper'] = "%s: El usuario %s subió la tarea %s al curso %s"; +$strings['XUserXUploadedAssignmentXCheckXStudentSubmitsPaper'] = "%s: El usuario %s subió la tarea %s. Compruébelo en %s"; +$strings['XUserXUploadedAssignmentXCourseX'] = "%s: El usuario %s subió la tarea %s al curso %s"; +$strings['XUserXUploadedAssignmentXCheckX'] = "%s: El usuario %s subió la tarea %s. Compruébelo en %s"; +$strings['XSubscribedSessionX'] = "%s: Ha sido suscrito a la sesión %s"; +$strings['XSubscribedSessionXCSV'] = "%s: Ha sido suscrito a la sesión %s"; +$strings['XUserXSuggestedBeFriends'] = "%s: El usuario %s le sugirió que podrían ser amigos. Compruebe su bandeja de entrada o su e-mail para más detalles"; +$strings['XUserXAnsweredInboxMessage'] = "%s: El usuario acaba de contestar a su mensaje de la bandeja de entrada"; +$strings['XBeenInvitedJoinGroupX'] = "%s: Ha sido invitado a unirse al grupo %s. Compruebe su bandeja de entrada para más detalles"; +$strings['XMessagesSentEditedGroupXEdited'] = "%s: Hay mensajes enviados o editados en el grupo %s. Compruebe su bandeja de entrada para más detalles"; +$strings['XMessagesSentEditedGroupXAdded'] = "%s: Hay mensajes enviados o editados en el grupo %s. Compruebe su bandeja de entrada para más detalles"; +$strings['XBeenInvitedCompleteSurveyXCourseX'] = "%s: Ha sido invitado a completar la encuesta %s del curso %s"; +$strings['XReminderAssignmentXCourseXDue'] = "%s: Se le recuerda que su tarea (%s) del curso %s aún está pendiente"; +$strings['XUserDetailsModified'] = "%s: Su información de usuario ha sido modificada. Compruebe su e-mail para más información"; diff --git a/plugin/kannelsms/lib/kannelsms.lib.php b/plugin/kannelsms/lib/kannelsms.lib.php new file mode 100644 index 000000000..83a5dcd7b --- /dev/null +++ b/plugin/kannelsms/lib/kannelsms.lib.php @@ -0,0 +1,661 @@ + + * + * Kannelsms-Chamilo connector class + */ +class Kannelsms implements SmsPluginLibraryInterface +{ + public $api; + public $hostAddress; + public $username; + public $password; + public $from; + public $plugin_enabled = false; + + /** + * Constructor (generates a connection to the API). + * + * @param string Kannelsms API key required to use the plugin + */ + public function __construct($apiKey = null) + { + $plugin = KannelsmsPlugin::create(); + $kannelSMSPlugin = $plugin->get('tool_enable'); + $this->table = Database::get_main_table('user_field_values'); + if ($kannelSMSPlugin == true) { + $this->api = new Kannel(' '); + $this->hostAddress = $plugin->get('hostAddress'); + $this->username = $plugin->get('username'); + $this->password = $plugin->get('password'); + $this->from = $plugin->get('from'); + $this->plugin_enabled = true; + } + } + + /** + * getMobilePhoneNumberById (retrieves a user mobile phone number by user id). + * + * @param int $userId User id + * + * @return int User's mobile phone number + */ + public function getMobilePhoneNumberById($userId) + { + $mobilePhoneNumberExtraField = new ExtraField('user'); + $mobilePhoneNumberExtraField = $mobilePhoneNumberExtraField->get_handler_field_info_by_field_variable( + 'mobile_phone_number' + ); + + $mobilePhoneNumberExtraFieldValue = new ExtraFieldValue('user'); + $mobilePhoneNumberExtraFieldValue = $mobilePhoneNumberExtraFieldValue->get_values_by_handler_and_field_id( + $userId, + $mobilePhoneNumberExtraField['id'] + ); + + return $mobilePhoneNumberExtraFieldValue['value']; + } + + /** + * send (sends an SMS to the user). + * + * @param array Data needed to send the SMS. It is mandatory to include the + * 'smsType' and 'userId' (or 'mobilePhoneNumber') fields at least. + * More data may be neccesary depending on the message type + * Example: $additional_parameters = array( + * 'smsType' => EXAMPLE_SMS_TYPE, + * 'userId' => $userId, + * 'moreData' => $moreData + * ); + */ + public function send($additionalParameters) + { + $trimmedKey = trim(CONFIG_SECURITY_API_KEY); + if (!empty($trimmedKey)) { + $message = [ + "to" => array_key_exists("mobilePhoneNumber", $additionalParameters) ? + $additionalParameters['mobilePhoneNumber'] : $this->getMobilePhoneNumberById($additionalParameters['userId']), + "message" => $this->getSms($additionalParameters), + ]; + + if (!empty($message['message'])) { + if (extension_loaded('curl')) { + $url = $this->hostAddress.'?username='. + $this->username.'&password='.$this->password.'&from='. + $this->from.'&to='.$message['to'].'&msg='.urlencode($message['message']); + $ch = curl_init($url); + curl_exec($ch); + curl_close($ch); + } + + // Commented for future message logging / tracking purposes + /*if( $result["success"] ) { + echo "Message sent - ID: " . $result["id"]; + } else { + echo "Message failed - Error: " . $result["error_message"]; + }*/ + } + } + } + + /** + * buildSms (builds an SMS from a template and data). + * + * @param object KannelsmsPlugin object + * @param object Template object + * @param string Template file name + * @param string Text key from lang file + * @param array Data to fill message variables (if any) + * + * @return object Template object with message property updated + */ + public function buildSms($plugin, $tpl, $templateName, $messageKey, $parameters = null) + { + $result = Database::select( + 'selected_value', + 'settings_current', + [ + 'where' => ['variable = ?' => ['kannelsms_message'.$messageKey]], + ] + ); + + if (empty($result)) { + $tpl->assign('message', ''); + } else { + $templatePath = 'kannelsms/sms_templates/'; + $content = $tpl->fetch($templatePath.$templateName); + $message = $plugin->get_lang($messageKey); + if ($parameters !== null) { + $message = vsprintf($message, $parameters); + } + $tpl->assign('message', $message); + } + + return $tpl->params['message']; + } + + /** + * getSms (returns an SMS message depending of its type). + * + * @param array Data needed to send the SMS. It is mandatory to include the + * 'smsType' and 'userId' (or 'mobilePhoneNumber') fields at least. + * More data may be neccesary depending on the message type + * Example: $additional_parameters = array( + * 'smsType' => EXAMPLE_SMS_TYPE, + * 'userId' => $userId, + * 'moreData' => $moreData + * ); + * + * @return string A ready to be sent SMS + */ + public function getSms($additionalParameters) + { + $plugin = KannelsmsPlugin::create(); + $tool_name = $plugin->get_lang('plugin_title'); + $tpl = new Template($tool_name); + + switch ($additionalParameters['smsType']) { + case SmsPlugin::WELCOME_LOGIN_PASSWORD: + $userInfo = api_get_user_info($additionalParameters['userId']); + + return $this->buildSms( + $plugin, + $tpl, + 'welcome_login_password.tpl', + 'WelcomeXLoginXPasswordX', + [ + api_get_setting('siteName'), + $userInfo['username'], + $additionalParameters['password'], + ] + ); + break; + case SmsPlugin::NEW_FILE_SHARED_COURSE_BY: + return $this->buildSms( + $plugin, + $tpl, + 'new_file_shared_course_by.tpl', + 'XNewFileSharedCourseXByX', + [ + api_get_setting('siteName'), + $additionalParameters['courseTitle'], + $additionalParameters['userUsername'], + ] + ); + break; + case SmsPlugin::ACCOUNT_APPROVED_CONNECT: + return $this->buildSms( + $plugin, + $tpl, + 'account_approved_connect.tpl', + 'XAccountApprovedConnectX', + [ + api_get_setting('siteName'), + $tpl->params['_p']['web'], + ] + ); + break; + case SmsPlugin::NEW_COURSE_BEEN_CREATED: + return $this->buildSms( + $plugin, + $tpl, + 'new_course_been_created.tpl', + 'XNewCourseXBeenCreatedX', + [ + api_get_setting('siteName'), + $additionalParameters['courseName'], + $additionalParameters['creatorUsername'], + ] + ); + break; + case SmsPlugin::NEW_USER_SUBSCRIBED_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'new_user_subscribed_course.tpl', + 'XNewUserXSubscribedCourseX', + [ + api_get_setting('siteName'), + $additionalParameters['userUsername'], + $additionalParameters['courseCode'], + ] + ); + break; + case SmsPlugin::NEW_COURSE_SUGGESTED_TEACHER: + return $this->buildSms( + $plugin, + $tpl, + 'new_course_suggested_teacher.tpl', + 'XNewCourseSuggestedTeacherX', + [ + api_get_setting('siteName'), + $additionalParameters['userUsername'], + ] + ); + break; + case SmsPlugin::COURSE_OPENING_REQUEST_CODE_REGISTERED: + return $this->buildSms( + $plugin, + $tpl, + 'course_opening_request_code_registered.tpl', + 'XCourseOpeningRequestCodeXRegistered', + [ + api_get_setting('siteName'), + $additionalParameters['courseCode'], + ] + ); + break; + case SmsPlugin::COURSE_OPENING_REQUEST_CODE_APPROVED: + return $this->buildSms( + $plugin, + $tpl, + 'course_opening_request_course_code_approved.tpl', + 'XCourseOpeningRequestCourseCodeXApproved', + [ + api_get_setting('siteName'), + $additionalParameters['courseCode'], + ] + ); + break; + case SmsPlugin::COURSE_OPENING_REQUEST_CODE_REJECTED: + return $this->buildSms( + $plugin, + $tpl, + 'request_open_course_code_rejected.tpl', + 'XRequestOpenCourseCodeXReject', + [ + api_get_setting('siteName'), + $additionalParameters['courseCode'], + ] + ); + break; + case SmsPlugin::COURSE_OPENING_REQUEST_CODE: + return $this->buildSms( + $plugin, + $tpl, + 'course_opening_request_course_code.tpl', + 'XCourseOpeningRequestCourseCodeX', + [ + api_get_setting('siteName'), + $additionalParameters['courseCode'], + ] + ); + break; + case SmsPlugin::BEEN_SUBSCRIBED_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'been_subscribed_course.tpl', + 'XBeenSubscribedCourseX', + [ + api_get_setting('siteName'), + $additionalParameters['courseTitle'], + ] + ); + break; + case SmsPlugin::ASSIGNMENT_BEEN_CREATED_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'assignment_been_created_course.tpl', + 'XAssignmentBeenCreatedCourseX', + [ + api_get_setting('siteName'), + $additionalParameters['courseTitle'], + ] + ); + break; + // Message types to be implemented. Fill the array parameter with arguments. + /*case SmsPlugin::ACCOUNT_CREATED_UPDATED_LOGIN_PASSWORD: + return $this->buildSms( + $plugin, + $tpl, + 'account_created_updated_login_password.tpl', + 'XAccountCreatedUpdatedLoginXPasswordX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::PASSWORD_UPDATED_LOGIN_PASSWORD: + return $this->buildSms( + $plugin, + $tpl, + 'password_updated_login_password.tpl', + 'XPasswordUpdatedLoginXPasswordX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::REQUESTED_PASSWORD_CHANGE: + return $this->buildSms( + $plugin, + $tpl, + 'requested_password_change.tpl', + 'XPasswordUpdatedLoginXPasswordX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::RECEIVED_NEW_PERSONAL_MESSAGES: + return $this->buildSms( + $plugin, + $tpl, + 'received_new_personal_messages.tpl', + 'XReceivedNewPersonalMessages', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::NEW_USER_PENDING_APPROVAL: + return $this->buildSms( + $plugin, + $tpl, + 'new_user_pending_approval.tpl', + 'XNewUserXPendingApproval', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::POSTED_FORUM_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'posted_forum_course.tpl', + 'XXPostedForumXCourseX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::CHECK_EMAIL_CONNECT_MORE_INFO: + return $this->buildSms( + $plugin, + $tpl, + 'check_email_connect_more_info.tpl', + 'XXXCheckEmailConnectMoreInfo', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::STUDENT_ANSWERED_TEST: + return $this->buildSms( + $plugin, + $tpl, + 'student_answered_test.tpl', + 'XXStudentXAnsweredTestX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::STUDENT_ANSWERED_TEST_OPEN_QUESTION: + return $this->buildSms( + $plugin, + $tpl, + 'student_answered_test_open_question.tpl', + 'XXStudentXAnsweredTestXOpenQuestion', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::STUDENT_ANSWERED_TEST_VOICE_QUESTION: + return $this->buildSms( + $plugin, + $tpl, + 'student_answered_test_voice_question.tpl', + 'XXStudentXAnsweredTestXVoiceQuestion', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::ANSWER_OPEN_QUESTION_TEST_REVIEWED: + return $this->buildSms( + $plugin, + $tpl, + 'answer_open_question_test_reviewed.tpl', + 'XXAnswerOpenQuestionTestXReviewed', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::NEW_THREAD_STARTED_FORUM: + return $this->buildSms( + $plugin, + $tpl, + 'new_thread_started_forum.tpl', + 'XXNewThreadXStartedForumX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::NEW_ANSWER_POSTED_FORUM: + return $this->buildSms( + $plugin, + $tpl, + 'new_answer_posted_forum.tpl', + 'XXNewAnswerPostedXForumX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::NEW_SYSTEM_ANNOUNCEMENT_ADDED: + return $this->buildSms( + $plugin, + $tpl, + 'new_system_announcement_added.tpl', + 'XXNewSystemAnnouncementAdded', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::TEST_NEW_SYSTEM_ANNOUNCEMENT_ADDED: + return $this->buildSms( + $plugin, + $tpl, + 'test_new_system_announcement_added.tpl', + 'XTestXNewSystemAnnouncementAdded', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::SYSTEM_ANNOUNCEMENT_UPDATE: + return $this->buildSms( + $plugin, + $tpl, + 'system_announcement_update.tpl', + 'XXSystemAnnouncementUpdate', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::TEST_SYSTEM_ANNOUNCEMENT_UPDATE: + return $this->buildSms( + $plugin, + $tpl, + 'test_system_announcement_update.tpl', + 'XXSystemAnnouncementUpdate', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_COURSE_STUDENT_SUBMITS_PAPER: + return $this->buildSms( + $plugin, + $tpl, + 'user_uploaded_assignment_course_student_submits_paper.tpl', + 'XUserXUploadedAssignmentXCourseXStudentSubmitsPaper', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_CHECK_STUDENT_SUBMITS_PAPER: + return $this->buildSms( + $plugin, + $tpl, + 'user_uploaded_assignment_check_student_submits_paper.tpl', + 'XUserXUploadedAssignmentXCheckXStudentSubmitsPaper', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'user_uploaded_assignment_course.tpl', + 'XUserXUploadedAssignmentXCourseX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_CHECK: + return $this->buildSms( + $plugin, + $tpl, + 'user_uploaded_assignment_check.tpl', + 'XUserXUploadedAssignmentXCheckX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::SUBSCRIBED_SESSION: + return $this->buildSms( + $plugin, + $tpl, + 'subscribed_session.tpl', + 'XSubscribedSessionX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::SUBSCRIBED_SESSION_CSV: + return $this->buildSms( + $plugin, + $tpl, + 'subscribed_session_csv.tpl', + 'XSubscribedSessionXCSV', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_SUGGESTED_BE_FRIENDS: + return $this->buildSms( + $plugin, + $tpl, + 'user_suggested_be_friends.tpl', + 'XUserXSuggestedBeFriends', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_ANSWERED_INBOX_MESSAGE: + return $this->buildSms( + $plugin, + $tpl, + 'user_answered_inbox_message.tpl', + 'XUserXAnsweredInboxMessage', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::BEEN_INVITED_JOIN_GROUP: + return $this->buildSms( + $plugin, + $tpl, + 'been_invited_join_group.tpl', + 'XBeenInvitedJoinGroupX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::MESSAGES_SENT_EDITED_GROUP_EDITED: + return $this->buildSms( + $plugin, + $tpl, + 'messages_sent_edited_group_edited.tpl', + 'XMessagesSentEditedGroupXEdited', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::MESSAGES_SENT_EDITED_GROUP_ADDED: + return $this->buildSms( + $plugin, + $tpl, + 'messages_sent_edited_group_added.tpl', + 'XMessagesSentEditedGroupXAdded', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::BEEN_INVITED_COMPLETE_SURVEY_COURSE: + return $this->buildSms( + $plugin, + $tpl, + 'been_invited_complete_survey_course.tpl', + 'XBeenInvitedCompleteSurveyXCourseX', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::REMINDER_ASSIGNMENT_COURSE_DUE: + return $this->buildSms( + $plugin, + $tpl, + 'reminder_assignment_course_due.tpl', + 'XReminderAssignmentXCourseXDue', + array( + api_get_setting('siteName') + ) + ); + break;*/ + /*case SmsPlugin::USER_DETAILS_MODIFIED: + return $this->buildSms( + $plugin, + $tpl, + 'user_details_modified.tpl', + 'XUserDetailsModified', + array( + api_get_setting('siteName') + ) + ); + break;*/ + default: + return ''; + } + } +} diff --git a/plugin/kannelsms/lib/kannelsms_plugin.class.php b/plugin/kannelsms/lib/kannelsms_plugin.class.php new file mode 100644 index 000000000..33a3b0cd1 --- /dev/null +++ b/plugin/kannelsms/lib/kannelsms_plugin.class.php @@ -0,0 +1,56 @@ + + * @author Julio Montoya Refactor code + */ +class KannelsmsPlugin extends SmsPlugin +{ + /** + * Constructor. + */ + public function __construct() + { + $fields = [ + 'tool_enable' => 'boolean', + 'hostAddress' => 'text', + 'username' => 'text', + 'password' => 'text', + 'from' => 'text', + ]; + $smsTypeOptions = $this->getSmsTypeOptions(); + foreach ($smsTypeOptions as $smsTypeOption) { + $fields[$smsTypeOption] = 'checkbox'; + } + parent::__construct('0.1', 'Imanol Losada', $fields); + } + + /** + * create (a singleton function that ensures KannelsmsPlugin instance is + * created only once. If it is already created, it returns the instance). + * + * @return object KannelsmsPlugin instance + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * install (uninstalls the plugin and removes all plugin's tables and/or rows). + */ + public function uninstall() + { + $tSettings = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT); + $sql = "DELETE FROM $tSettings WHERE subkey = 'kannelsms'"; + Database::query($sql); + } +} diff --git a/plugin/kannelsms/license.txt b/plugin/kannelsms/license.txt new file mode 100644 index 000000000..11e71ecff --- /dev/null +++ b/plugin/kannelsms/license.txt @@ -0,0 +1,5 @@ +This plugin, as the rest of Chamilo, is released under the GNU/GPLv3 license. + +The Kannel library included is provided under the ICS license, compatible +with GNU/GPLv3. See https://github.com/mediaburst/kannel-php/issues/3 for +details. \ No newline at end of file diff --git a/plugin/kannelsms/plugin.php b/plugin/kannelsms/plugin.php new file mode 100644 index 000000000..cb0459c2f --- /dev/null +++ b/plugin/kannelsms/plugin.php @@ -0,0 +1,11 @@ + + */ +require_once __DIR__.'/config.php'; + +$plugin_info = KannelsmsPlugin::create()->get_info(); diff --git a/plugin/kannelsms/sms_templates/account_approved_connect.tpl b/plugin/kannelsms/sms_templates/account_approved_connect.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/account_approved_connect.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/account_created_updated_login_password.tpl b/plugin/kannelsms/sms_templates/account_created_updated_login_password.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/account_created_updated_login_password.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/answer_open_question_test_reviewed.tpl b/plugin/kannelsms/sms_templates/answer_open_question_test_reviewed.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/answer_open_question_test_reviewed.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/assignment_been_created_course.tpl b/plugin/kannelsms/sms_templates/assignment_been_created_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/assignment_been_created_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/been_invited_complete_survey_course.tpl b/plugin/kannelsms/sms_templates/been_invited_complete_survey_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/been_invited_complete_survey_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/been_invited_join_group.tpl b/plugin/kannelsms/sms_templates/been_invited_join_group.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/been_invited_join_group.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/been_subscribed_course.tpl b/plugin/kannelsms/sms_templates/been_subscribed_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/been_subscribed_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/check_email_connect_more_info.tpl b/plugin/kannelsms/sms_templates/check_email_connect_more_info.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/check_email_connect_more_info.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/course_opening_request_code_registered.tpl b/plugin/kannelsms/sms_templates/course_opening_request_code_registered.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/course_opening_request_code_registered.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/course_opening_request_course_code.tpl b/plugin/kannelsms/sms_templates/course_opening_request_course_code.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/course_opening_request_course_code.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/course_opening_request_course_code_approved.tpl b/plugin/kannelsms/sms_templates/course_opening_request_course_code_approved.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/course_opening_request_course_code_approved.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/messages_sent_edited_group_added.tpl b/plugin/kannelsms/sms_templates/messages_sent_edited_group_added.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/messages_sent_edited_group_added.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/messages_sent_edited_group_edited.tpl b/plugin/kannelsms/sms_templates/messages_sent_edited_group_edited.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/messages_sent_edited_group_edited.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/new_answer_posted_forum.tpl b/plugin/kannelsms/sms_templates/new_answer_posted_forum.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/new_answer_posted_forum.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/new_course_been_created.tpl b/plugin/kannelsms/sms_templates/new_course_been_created.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/new_course_been_created.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/new_course_suggested_teacher.tpl b/plugin/kannelsms/sms_templates/new_course_suggested_teacher.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/new_course_suggested_teacher.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/new_file_shared_course_by.tpl b/plugin/kannelsms/sms_templates/new_file_shared_course_by.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/new_file_shared_course_by.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/new_system_announcement_added.tpl b/plugin/kannelsms/sms_templates/new_system_announcement_added.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/new_system_announcement_added.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/new_thread_started_forum.tpl b/plugin/kannelsms/sms_templates/new_thread_started_forum.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/new_thread_started_forum.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/new_user_pending_approval.tpl b/plugin/kannelsms/sms_templates/new_user_pending_approval.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/new_user_pending_approval.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/new_user_subscribed_course.tpl b/plugin/kannelsms/sms_templates/new_user_subscribed_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/new_user_subscribed_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/password_updated_login_password.tpl b/plugin/kannelsms/sms_templates/password_updated_login_password.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/password_updated_login_password.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/posted_forum_course.tpl b/plugin/kannelsms/sms_templates/posted_forum_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/posted_forum_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/received_new_personal_messages.tpl b/plugin/kannelsms/sms_templates/received_new_personal_messages.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/received_new_personal_messages.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/reminder_assignment_course_due.tpl b/plugin/kannelsms/sms_templates/reminder_assignment_course_due.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/reminder_assignment_course_due.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/request_open_course_code_rejected.tpl b/plugin/kannelsms/sms_templates/request_open_course_code_rejected.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/request_open_course_code_rejected.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/requested_password_change.tpl b/plugin/kannelsms/sms_templates/requested_password_change.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/requested_password_change.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/student_answered_test.tpl b/plugin/kannelsms/sms_templates/student_answered_test.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/student_answered_test.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/student_answered_test_open_question.tpl b/plugin/kannelsms/sms_templates/student_answered_test_open_question.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/student_answered_test_open_question.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/student_answered_test_voice_question.tpl b/plugin/kannelsms/sms_templates/student_answered_test_voice_question.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/student_answered_test_voice_question.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/subscribed_session.tpl b/plugin/kannelsms/sms_templates/subscribed_session.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/subscribed_session.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/subscribed_session_csv.tpl b/plugin/kannelsms/sms_templates/subscribed_session_csv.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/subscribed_session_csv.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/system_announcement_update.tpl b/plugin/kannelsms/sms_templates/system_announcement_update.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/system_announcement_update.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/test_new_system_announcement_added.tpl b/plugin/kannelsms/sms_templates/test_new_system_announcement_added.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/test_new_system_announcement_added.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/test_system_announcement_update.tpl b/plugin/kannelsms/sms_templates/test_system_announcement_update.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/test_system_announcement_update.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/user_answered_inbox_message.tpl b/plugin/kannelsms/sms_templates/user_answered_inbox_message.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/user_answered_inbox_message.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/user_details_modified.tpl b/plugin/kannelsms/sms_templates/user_details_modified.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/user_details_modified.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/user_suggested_be_friends.tpl b/plugin/kannelsms/sms_templates/user_suggested_be_friends.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/user_suggested_be_friends.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/user_uploaded_assignment_check.tpl b/plugin/kannelsms/sms_templates/user_uploaded_assignment_check.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/user_uploaded_assignment_check.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/user_uploaded_assignment_check_student_submits_paper.tpl b/plugin/kannelsms/sms_templates/user_uploaded_assignment_check_student_submits_paper.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/user_uploaded_assignment_check_student_submits_paper.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/user_uploaded_assignment_course.tpl b/plugin/kannelsms/sms_templates/user_uploaded_assignment_course.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/user_uploaded_assignment_course.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/user_uploaded_assignment_course_student_submits_paper.tpl b/plugin/kannelsms/sms_templates/user_uploaded_assignment_course_student_submits_paper.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/user_uploaded_assignment_course_student_submits_paper.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/sms_templates/welcome_login_password.tpl b/plugin/kannelsms/sms_templates/welcome_login_password.tpl new file mode 100644 index 000000000..414c17f26 --- /dev/null +++ b/plugin/kannelsms/sms_templates/welcome_login_password.tpl @@ -0,0 +1 @@ +{{ message }} diff --git a/plugin/kannelsms/uninstall.php b/plugin/kannelsms/uninstall.php new file mode 100644 index 000000000..2d3345145 --- /dev/null +++ b/plugin/kannelsms/uninstall.php @@ -0,0 +1,17 @@ + + */ +/** + * Queries. + */ +require_once __DIR__.'/config.php'; +KannelsmsPlugin::create()->uninstall(); diff --git a/plugin/kannelsms/vendor/changelog.md b/plugin/kannelsms/vendor/changelog.md new file mode 100644 index 000000000..9a1545b37 --- /dev/null +++ b/plugin/kannelsms/vendor/changelog.md @@ -0,0 +1,22 @@ +# Changelog + +## 1.0 (July 19th, 2012) + +* Initial release. [JI/MS] + +### 1.1 (August 21st, 2012) + +* Added /get_key functionality to translate a legacy Mediaburst username and password into a new Kannel API key. [JI] +* Deprecated `checkCredit()` and replaced with `checkBalance()` [JI] + +### 1.2 (September 7th, 2012) + +* Added various new Wordpress classes, including the Kannel_Plugin class for writing plugins based on Kannel. [JI] + +### 1.3 (September 18th, 2012) + +* Added `is_valid_msisdn()` method. [JI] + +#### 1.3.1 (November 13th, 2012) + +* Updated `is_valid_msisdn()` method to handle 9-digit phone numbers, e.g. Norway. [JI] \ No newline at end of file diff --git a/plugin/kannelsms/vendor/exception.php b/plugin/kannelsms/vendor/exception.php new file mode 100644 index 000000000..dae50bba3 --- /dev/null +++ b/plugin/kannelsms/vendor/exception.php @@ -0,0 +1,27 @@ +key = $key; + } + + $this->ssl = (array_key_exists('ssl', $options)) ? $options['ssl'] : null; + $this->proxy_host = (array_key_exists('proxy_host', $options)) ? $options['proxy_host'] : null; + $this->proxy_port = (array_key_exists('proxy_port', $options)) ? $options['proxy_port'] : null; + $this->from = (array_key_exists('from', $options)) ? $options['from'] : null; + $this->long = (array_key_exists('long', $options)) ? $options['long'] : null; + $this->truncate = (array_key_exists('truncate', $options)) ? $options['truncate'] : null; + $this->invalid_char_action = (array_key_exists('invalid_char_action', $options)) ? $options['invalid_char_action'] : null; + $this->log = (array_key_exists('log', $options)) ? $options['log'] : false; + } + + /** + * Send some text messages + * + * + * @author Martin Steel + */ + public function send(array $sms) { + if (!is_array($sms)) { + throw new KannelException("sms parameter must be an array"); + } + $single_message = $this->is_assoc($sms); + + if ($single_message) { + $sms = array($sms); + } + + $req_doc = new \DOMDocument('1.0', 'UTF-8'); + $root = $req_doc->createElement('Message'); + $req_doc->appendChild($root); + + $user_node = $req_doc->createElement('Key'); + $user_node->appendChild($req_doc->createTextNode($this->key)); + $root->appendChild($user_node); + + for ($i = 0; $i < count($sms); $i++) { + $single = $sms[$i]; + + $sms_node = $req_doc->createElement('SMS'); + + // Phone number + $sms_node->appendChild($req_doc->createElement('To', $single['to'])); + + // Message text + $content_node = $req_doc->createElement('Content'); + $content_node->appendChild($req_doc->createTextNode($single['message'])); + $sms_node->appendChild($content_node); + + // From + if (array_key_exists('from', $single) || isset($this->from)) { + $from_node = $req_doc->createElement('From'); + $from_node->appendChild($req_doc->createTextNode(array_key_exists('from', $single) ? $single['from'] : $this->from)); + $sms_node->appendChild($from_node); + } + + // Client ID + if (array_key_exists('client_id', $single)) { + $client_id_node = $req_doc->createElement('ClientID'); + $client_id_node->appendChild($req_doc->createTextNode($single['client_id'])); + $sms_node->appendChild($client_id_node); + } + + // Long + if (array_key_exists('long', $single) || isset($this->long)) { + $long = array_key_exists('long', $single) ? $single['long'] : $this->long; + $long_node = $req_doc->createElement('Long'); + $long_node->appendChild($req_doc->createTextNode($long ? 1 : 0)); + $sms_node->appendChild($long_node); + } + + // Truncate + if (array_key_exists('truncate', $single) || isset($this->truncate)) { + $truncate = array_key_exists('truncate', $single) ? $single['truncate'] : $this->truncate; + $trunc_node = $req_doc->createElement('Truncate'); + $trunc_node->appendChild($req_doc->createTextNode($truncate ? 1 : 0)); + $sms_node->appendChild($trunc_node); + } + + // Invalid Char Action + if (array_key_exists('invalid_char_action', $single) || isset($this->invalid_char_action)) { + $action = array_key_exists('invalid_char_action', $single) ? $single['invalid_char_action'] : $this->invalid_char_action; + switch (strtolower($action)) { + case 'error': + $sms_node->appendChild($req_doc->createElement('InvalidCharAction', 1)); + break; + case 'remove': + $sms_node->appendChild($req_doc->createElement('InvalidCharAction', 2)); + break; + case 'replace': + $sms_node->appendChild($req_doc->createElement('InvalidCharAction', 3)); + break; + default: + break; + } + } + + // Wrapper ID + $sms_node->appendChild($req_doc->createElement('WrapperID', $i)); + + $root->appendChild($sms_node); + } + + $req_xml = $req_doc->saveXML(); + + $resp_xml = $this->postToKannel(self::API_SMS_METHOD, $req_xml); + $resp_doc = new \DOMDocument(); + $resp_doc->loadXML($resp_xml); + + $response = array(); + $err_no = null; + $err_desc = null; + + foreach($resp_doc->documentElement->childNodes AS $doc_child) { + switch(strtolower($doc_child->nodeName)) { + case 'sms_resp': + $resp = array(); + $wrapper_id = null; + foreach($doc_child->childNodes AS $resp_node) { + switch(strtolower($resp_node->nodeName)) { + case 'messageid': + $resp['id'] = $resp_node->nodeValue; + break; + case 'errno': + $resp['error_code'] = $resp_node->nodeValue; + break; + case 'errdesc': + $resp['error_message'] = $resp_node->nodeValue; + break; + case 'wrapperid': + $wrapper_id = $resp_node->nodeValue; + break; + } + } + if( array_key_exists('error_code', $resp ) ) + { + $resp['success'] = 0; + } else { + $resp['success'] = 1; + } + $resp['sms'] = $sms[$wrapper_id]; + array_push($response, $resp); + break; + case 'errno': + $err_no = $doc_child->nodeValue; + break; + case 'errdesc': + $err_desc = $doc_child->nodeValue; + break; + } + } + + if (isset($err_no)) { + throw new KannelException($err_desc, $err_no); + } + + if ($single_message) { + return $response[0]; + } else { + return $response; + } + } + + /** + * Check how many SMS credits you have available + * + * @return integer SMS credits remaining + * @deprecated Use checkBalance() instead + * @author Martin Steel + */ + public function checkCredit() { + // Create XML doc for request + $req_doc = new \DOMDocument('1.0', 'UTF-8'); + $root = $req_doc->createElement('Credit'); + $req_doc->appendChild($root); + $root->appendChild($req_doc->createElement('Key', $this->key)); + $req_xml = $req_doc->saveXML(); + + // POST XML to Kannel + $resp_xml = $this->postToKannel(self::API_CREDIT_METHOD, $req_xml); + + // Create XML doc for response + $resp_doc = new \DOMDocument(); + $resp_doc->loadXML($resp_xml); + + // Parse the response to find credit value + $credit; + $err_no = null; + $err_desc = null; + + foreach ($resp_doc->documentElement->childNodes AS $doc_child) { + switch ($doc_child->nodeName) { + case "Credit": + $credit = $doc_child->nodeValue; + break; + case "ErrNo": + $err_no = $doc_child->nodeValue; + break; + case "ErrDesc": + $err_desc = $doc_child->nodeValue; + break; + default: + break; + } + } + + if (isset($err_no)) { + throw new KannelException($err_desc, $err_no); + } + return $credit; + } + + /** + * Check your account balance + * + * @return array Array of account balance: + * @author Martin Steel + */ + public function checkBalance() { + // Create XML doc for request + $req_doc = new \DOMDocument('1.0', 'UTF-8'); + $root = $req_doc->createElement('Balance'); + $req_doc->appendChild($root); + $root->appendChild($req_doc->createElement('Key', $this->key)); + $req_xml = $req_doc->saveXML(); + + // POST XML to Kannel + $resp_xml = $this->postToKannel(self::API_BALANCE_METHOD, $req_xml); + + // Create XML doc for response + $resp_doc = new \DOMDocument(); + $resp_doc->loadXML($resp_xml); + + // Parse the response to find balance value + $balance = null; + $err_no = null; + $err_desc = null; + + foreach ($resp_doc->documentElement->childNodes as $doc_child) { + switch ($doc_child->nodeName) { + case "Balance": + $balance = number_format(floatval($doc_child->nodeValue), 2); + break; + case "Currency": + foreach ($doc_child->childNodes as $resp_node) { + switch ($resp_node->tagName) { + case "Symbol": + $symbol = $resp_node->nodeValue; + break; + case "Code": + $code = $resp_node->nodeValue; + break; + } + } + break; + case "ErrNo": + $err_no = $doc_child->nodeValue; + break; + case "ErrDesc": + $err_desc = $doc_child->nodeValue; + break; + default: + break; + } + } + + if (isset($err_no)) { + throw new KannelException($err_desc, $err_no); + } + + return array( 'symbol' => $symbol, 'balance' => $balance, 'code' => $code ); + } + + /** + * Check whether the API Key is valid + * + * @return bool True indicates a valid key + * @author Martin Steel + */ + public function checkKey() { + // Create XML doc for request + $req_doc = new \DOMDocument('1.0', 'UTF-8'); + $root = $req_doc->createElement('Authenticate'); + $req_doc->appendChild($root); + $root->appendChild($req_doc->createElement('Key', $this->key)); + $req_xml = $req_doc->saveXML(); + + // POST XML to Kannel + $resp_xml = $this->postToKannel(self::API_AUTH_METHOD, $req_xml); + + // Create XML doc for response + $resp_doc = new \DOMDocument(); + $resp_doc->loadXML($resp_xml); + + // Parse the response to see if authenticated + $cust_id; + $err_no = null; + $err_desc = null; + + foreach ($resp_doc->documentElement->childNodes AS $doc_child) { + switch ($doc_child->nodeName) { + case "CustID": + $cust_id = $doc_child->nodeValue; + break; + case "ErrNo": + $err_no = $doc_child->nodeValue; + break; + case "ErrDesc": + $err_desc = $doc_child->nodeValue; + break; + default: + break; + } + } + + if (isset($err_no)) { + throw new KannelException($err_desc, $err_no); + } + return isset($cust_id); + } + + /** + * Make an HTTP POST to Kannel + * + * @param string method Kannel method to call (sms/credit) + * @param string data Content of HTTP POST + * + * @return string Response from Kannel + * @author Martin Steel + */ + protected function postToKannel($method, $data) { + if ($this->log) { + $this->logXML("API $method Request XML", $data); + } + + if( isset( $this->ssl ) ) { + $ssl = $this->ssl; + } else { + $ssl = $this->sslSupport(); + } + + $url = $ssl ? 'https://' : 'http://'; + $url .= self::API_BASE_URL . $method; + + $response = $this->xmlPost($url, $data); + + if ($this->log) { + $this->logXML("API $method Response XML", $response); + } + + return $response; + } + + /** + * Make a HTTP POST + * + * cURL will be used if available, otherwise tries the PHP stream functions + * + * @param string url URL to send to + * @param string data Data to POST + * @return string Response returned by server + * @author Martin Steel + */ + protected function xmlPost($url, $data) { + if(extension_loaded('curl')) { + $ch = curl_init($url); + curl_setopt($ch, CURLOPT_POST, 1); + curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); + curl_setopt($ch, CURLOPT_HTTPHEADER, Array("Content-Type: text/xml")); + curl_setopt($ch, CURLOPT_USERAGENT, 'Kannel PHP Wrapper/1.0' . self::VERSION); + curl_setopt($ch, CURLOPT_POSTFIELDS, $data); + if (isset($this->proxy_host) && isset($this->proxy_port)) { + curl_setopt($ch, CURLOPT_PROXY, $this->proxy_host); + curl_setopt($ch, CURLOPT_PROXYPORT, $this->proxy_port); + } + + $response = curl_exec($ch); + $info = curl_getinfo($ch); + + if ($response === false || $info['http_code'] != 200) { + throw new \Exception('HTTP Error calling Kannel API - HTTP Status: ' . $info['http_code'] . ' - cURL Erorr: ' . curl_error($ch)); + } elseif (curl_errno($ch) > 0) { + throw new \Exception('HTTP Error calling Kannel API - cURL Error: ' . curl_error($ch)); + } + + curl_close($ch); + + return $response; + } elseif (function_exists('stream_get_contents')) { + // Enable error Track Errors + $track = ini_get('track_errors'); + ini_set('track_errors',true); + + $params = array('http' => array( + 'method' => 'POST', + 'header' => "Content-Type: text/xml\r\nUser-Agent: mediaburst PHP Wrapper/" . self::VERSION . "\r\n", + 'content' => $data + )); + + if (isset($this->proxy_host) && isset($this->proxy_port)) { + $params['http']['proxy'] = 'tcp://'.$this->proxy_host . ':' . $this->proxy_port; + $params['http']['request_fulluri'] = True; + } + + $ctx = stream_context_create($params); + $fp = @fopen($url, 'rb', false, $ctx); + if (!$fp) { + ini_set('track_errors',$track); + throw new \Exception("HTTP Error calling Kannel API - fopen Error: $php_errormsg"); + } + $response = @stream_get_contents($fp); + if ($response === false) { + ini_set('track_errors',$track); + throw new \Exception("HTTP Error calling Kannel API - stream Error: $php_errormsg"); + } + ini_set('track_errors',$track); + return $response; + } else { + throw new \Exception("Kannel requires PHP5 with cURL or HTTP stream support"); + } + } + + /** + * Does the server/HTTP wrapper support SSL + * + * This is a best guess effort, some servers have weird setups where even + * though cURL is compiled with SSL support is still fails to make + * any requests. + * + * @return bool True if SSL is supported + * @author Martin Steel + */ + protected function sslSupport() { + $ssl = false; + // See if PHP is compiled with cURL + if (extension_loaded('curl')) { + $version = curl_version(); + $ssl = ($version['features'] & CURL_VERSION_SSL) ? true : false; + } elseif (extension_loaded('openssl')) { + $ssl = true; + } + return $ssl; + } + + /** + * Log some XML, tidily if possible, in the PHP error log + * + * @param string log_msg The log message to prepend to the XML + * @param string xml An XML formatted string + * + * @return void + * @author Martin Steel + */ + protected function logXML($log_msg, $xml) { + // Tidy if possible + if (class_exists('tidy')) { + $tidy = new \tidy; + $config = array( + 'indent' => true, + 'input-xml' => true, + 'output-xml' => true, + 'wrap' => 200 + ); + $tidy->parseString($xml, $config, 'utf8'); + $tidy->cleanRepair(); + $xml = $tidy; + } + // Output + error_log("Kannel $log_msg: $xml"); + } + + /** + * Check if an array is associative + * + * @param array $array Array to check + * @return bool + * @author Martin Steel + */ + protected function is_assoc($array) { + return (bool)count(array_filter(array_keys($array), 'is_string')); + } + + /** + * Check if a number is a valid MSISDN + * + * @param string $val Value to check + * @return bool True if valid MSISDN + * @author James Inman + * @since 1.3.0 + * @todo Take an optional country code and check that the number starts with it + */ + public static function is_valid_msisdn($val) { + return preg_match( '/^[1-9][0-9]{7,12}$/', $val ); + } + +} diff --git a/plugin/kannelsms/vendor/license.txt b/plugin/kannelsms/vendor/license.txt new file mode 100644 index 000000000..041edd0c5 --- /dev/null +++ b/plugin/kannelsms/vendor/license.txt @@ -0,0 +1,14 @@ +Copyright (c) 2011 - 2012, Mediaburst Ltd + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + diff --git a/plugin/kannelsms/vendor/readme.md b/plugin/kannelsms/vendor/readme.md new file mode 100644 index 000000000..1492a43d7 --- /dev/null +++ b/plugin/kannelsms/vendor/readme.md @@ -0,0 +1,253 @@ +# Kannel SMS API Wrapper for PHP + +This wrapper lets you interact with Kannel without the hassle of having to create any XML or make HTTP calls. + +## What's Kannel? + +[Kannel][2] is Mediaburst's SMS API. + +### Prerequisites + +* A [Kannel][2] account + +## Usage + +Require the Kannel library: + +```php +require 'class-Kannel.php'; +``` + +### Sending a message + +```php +$kannel = new Kannel( $API_KEY ); +$message = array( 'to' => '441234567891', 'message' => 'This is a test!' ); +$result = $kannel->send( $message ); +``` + +### Sending multiple messages + +We recommend you use batch sizes of 500 messages or fewer. By limiting the batch size it prevents any timeouts when sending. + +```php +$kannel = new Kannel( $API_KEY ); +$messages = array( + array( 'to' => '441234567891', 'message' => 'This is a test!' ), + array( 'to' => '441234567892', 'message' => 'This is a test 2!' ) +); +$results = $kannel->send( $messages ); +``` + +### Handling the response + +The responses come back as arrays, these contain the unique Kannel message ID, whether the message worked (`success`), and the original SMS so you can update your database. + + Array + ( + [id] => VE_164732148 + [success] => 1 + [sms] => Array + ( + [to] => 441234567891 + [message] => This is a test! + ) + + ) + +If you send multiple SMS messages in a single send, you'll get back an array of results, one per SMS. + +The result will look something like this: + + Array + ( + [0] => Array + ( + [id] => VI_143228951 + [success] => 1 + [sms] => Array + ( + [to] => 441234567891 + [message] => This is a test! + ) + + ) + + [1] => Array + ( + [id] => VI_143228952 + [success] => 1 + [sms] => Array + ( + [to] => 441234567892 + [message] => This is a test 2! + ) + + ) + + ) + +If a message fails, the reason for failure will be set in `error_code` and `error_message`. + +For example, if you send to invalid phone number "abc": + + Array + ( + [error_code] => 10 + [error_message] => Invalid 'To' Parameter + [success] => 0 + [sms] => Array + ( + [to] => abc + [message] => This is a test! + ) + + ) + +### Checking your balance + +Check your available SMS balance: + +```php +$kannel = new Kannel( $API_KEY ); +$kannel->checkBalance(); +``` + +This will return: + + Array + ( + [symbol] => £ + [balance] => 351.91 + [code] => GBP + ) + +### Handling Errors + +The Kannel wrapper will throw a `KannelException` if the entire call failed. + +```php +try +{ + $kannel = new Kannel( 'invalid_key' ); + $message = array( 'to' => 'abc', 'message' => 'This is a test!' ); + $result = $kannel->send( $message ); +} +catch( KannelException $e ) +{ + print $e->getMessage(); + // Invalid API Key +} +``` + +### Advanced Usage + +This class has a few additional features that some users may find useful, if these are not set your account defaults will be used. + +### Optional Parameters + +See the [Kannel Documentation](http://www.kannelsms.com/doc/clever-stuff/xml-interface/send-sms/) for full details on these options. + +* $from [string] + + The from address displayed on a phone when they receive a message + +* $long [boolean] + + Enable long SMS. A standard text can contain 160 characters, a long SMS supports up to 459. + +* $truncate [nullable boolean] + + Truncate the message payload if it is too long, if this is set to false, the message will fail if it is too long. + +* $invalid_char_action [string] + + What to do if the message contains an invalid character. Possible values are + * error - Fail the message + * remove - Remove the invalid characters then send + * replace - Replace some common invalid characters such as replacing curved quotes with straight quotes + +* $ssl [boolean, default: true] + + Use SSL when making an HTTP request to the Kannel API + + +### Setting Options + +#### Global Options + +Options set on the API object will apply to all SMS messages unless specifically overridden. + +In this example both messages will be sent from Kannel: + +```php +$options = array( 'from' => 'Kannel' ); +$kannel = new Kannel( $API_KEY, $options ); +$messages = array( + array( 'to' => '441234567891', 'message' => 'This is a test!' ), + array( 'to' => '441234567892', 'message' => 'This is a test 2!' ) +); +$results = $kannel->send( $messages ); +``` + +#### Per-message Options + +Set option values individually on each message. + +In this example, one message will be from Kannel and the other from 84433: + +```php +$kannel = new Kannel( $API_KEY, $options ); +$messages = array( + array( 'to' => '441234567891', 'message' => 'This is a test!', 'from' => 'Kannel' ), + array( 'to' => '441234567892', 'message' => 'This is a test 2!', 'from' => '84433' ) +); +$results = $kannel->send( $messages ); +``` + +### SSL Errors + +Due to the huge variety of PHP setups out there a small proportion of users may get PHP errors when making API calls due to their SSL configuration. + +The errors will generally look something like this: + +``` +Fatal error: +Uncaught exception 'Exception' with message 'HTTP Error calling Kannel API +HTTP Status: 0 +cURL Erorr: SSL certificate problem, verify that the CA cert is OK. +Details: error:14090086:SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed' +``` + +If you're seeing this error there are two fixes available, the first is easy, simply disable SSL on Kannel calls. Alternatively you can setup your PHP install with the correct root certificates. + +#### Disable SSL on Kannel calls + +```php +$options = array( 'ssl' => false ); +$kannel = new Kannel( $API_KEY, $options ); +``` + +#### Setup SSL root certificates on your server + +This is much more complicated as it depends on your setup, however there are many guides available online. +Try a search term like "windows php curl root certificates" or "ubuntu update root certificates". + + +# License + +This project is licensed under the ISC open-source license. + +A copy of this license can be found in license.txt. + +# Contributing + +If you have any feedback on this wrapper drop us an email to [hello@kannelsms.com][1]. + +The project is hosted on GitHub at [https://github.com/mediaburst/kannel-php][3]. +If you would like to contribute a bug fix or improvement please fork the project +and submit a pull request. + +[1]: mailto:hello@kannelsms.com +[2]: http://www.kannelsms.com/ +[3]: https://github.com/mediaburst/kannel-php diff --git a/plugin/keycloak/KeycloakPlugin.php b/plugin/keycloak/KeycloakPlugin.php new file mode 100644 index 000000000..c876ca249 --- /dev/null +++ b/plugin/keycloak/KeycloakPlugin.php @@ -0,0 +1,62 @@ + 'boolean', + ] + ); + } + + /** + * @return $this + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * @return string + */ + public function get_block_title() + { + return $this->get('block_title'); + } + + /** + * @return string + */ + public function get_content() + { + return $this->get('content'); + } + + /** + * Deletes all keycloak chamilo session data. + */ + public function logout() + { + Session::erase('samlUserdata'); + Session::erase('samlNameId'); + Session::erase('samlNameIdFormat'); + Session::erase('samlSessionIndex'); + Session::erase('AuthNRequestID'); + } +} diff --git a/plugin/keycloak/README.md b/plugin/keycloak/README.md new file mode 100644 index 000000000..7d0b079a7 --- /dev/null +++ b/plugin/keycloak/README.md @@ -0,0 +1,54 @@ +Keycloak +============== + +1. Enable the plugin. +2. Create a new settings.php file here plugin/keycloak/settings.php you can find an example here: +plugin/keycloak/settings.dist.php + +3. Edit the settings.php file with your Keycloak settings: + +
    +'idp' => array(
+    'entityId' => 'http://localhost:8080/auth/realms/master',
+    'singleSignOnService' => array (
+        'url' => 'http://localhost:8080/auth/realms/master/protocol/saml',
+    ),
+    'singleLogoutService' => array (
+        'url' => 'http://localhost:8080/auth/realms/master/protocol/saml',
+    ),
+    'x509cert' => 'xxx',
+)
+
    + +4. Configure your keycloak server with the following settings: + +* Create a client with "client id" value: + http://www.example.org/plugin/keycloak/metadata.php + +* Valid redirect URIs: * +* Client Protocol: saml +* Logout service redirect Binding URL: http://www.example.org/plugin/keycloak/start.php?sls + + +Change the client scope roles to "Single role attribute". + +- Client Scopes-> role_list -> Mappers -> role list -> "Single Role Attribute" = true + +Add user mappers for "FirstName", "LastName" and "Email" so Chamilo can get those values. + +Clients -> (select the client previously created) -> mappers -> create + +Name: Email +Mapper Type = User Property. +User Attribute: Email +Friendly Name: Email +SAML Attribute Name: Email +SAML Attribute: Basic + +Repeat the process for the 3 attributes. + +Create a demo user in keycloak + +Try to login using the new keycloak button in Chamilo. + +When everything works, restrict `Valid redirect URIs` setting from `*` to `http://www.example.org/plugin/keycloak/start.php?acs` diff --git a/plugin/keycloak/index.php b/plugin/keycloak/index.php new file mode 100644 index 000000000..19759d0ca --- /dev/null +++ b/plugin/keycloak/index.php @@ -0,0 +1,27 @@ +get_content(); +$title = $plugin->get_block_title(); +$title = $title ? "

    $title

    " : ''; + +$css = $plugin->get_css(); +$css = $css ? "" : ''; + +if (empty($content)) { + echo ''; +} + +echo << + $css +
    + $title +
    + $content +
    +
    +
    +EOT; diff --git a/plugin/keycloak/lang/english.php b/plugin/keycloak/lang/english.php new file mode 100644 index 000000000..454301348 --- /dev/null +++ b/plugin/keycloak/lang/english.php @@ -0,0 +1,6 @@ +getSPMetadata(); + $errors = $settings->validateMetadata($metadata); + if (empty($errors)) { + header('Content-Type: text/xml'); + echo $metadata; + } else { + throw new OneLogin\Saml2\Error('Invalid SP metadata: '.implode(', ', $errors), OneLogin\Saml2\Error::METADATA_SP_INVALID); + } +} catch (Exception $e) { + echo $e->getMessage(); +} diff --git a/plugin/keycloak/plugin.php b/plugin/keycloak/plugin.php new file mode 100644 index 000000000..cd8242db5 --- /dev/null +++ b/plugin/keycloak/plugin.php @@ -0,0 +1,4 @@ +get_info(); diff --git a/plugin/keycloak/settings.dist.php b/plugin/keycloak/settings.dist.php new file mode 100644 index 000000000..3ea8a291b --- /dev/null +++ b/plugin/keycloak/settings.dist.php @@ -0,0 +1,155 @@ + false, + 'debug' => true, + 'sp' => [ + 'entityId' => $spBaseUrl.'metadata.php', + 'assertionConsumerService' => [ + 'url' => $spBaseUrl.'start.php?acs', + ], + 'singleLogoutService' => [ + 'url' => $spBaseUrl.'start.php?sls', + ], + 'NameIDFormat' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified', + ], + 'idp' => [ + 'entityId' => $url.'auth/realms/'.$realm, // Example http://localhost:8080/auth/realms/master + 'singleSignOnService' => [ + 'url' => $url.'auth/realms/'.$realm.'/protocol/saml', // example http://localhost:8080/auth/realms/master/protocol/saml + ], + 'singleLogoutService' => [ + 'url' => $url.'auth/realms/'.$realm.'/protocol/saml', // example http://localhost:8080/auth/realms/master/protocol/saml + ], + 'x509cert' => $certificate, + ], +]; + +// advanced settings +// +// +//// Compression settings +//'compress' => array ( +// 'requests' => true, +// 'responses' => true +//), +// // Security settings +// 'security' => array ( +// +// /** signatures and encryptions offered */ +// +// // Indicates that the nameID of the sent by this SP +// // will be encrypted. +// 'nameIdEncrypted' => false, +// +// // Indicates whether the messages sent by this SP +// // will be signed. [Metadata of the SP will offer this info] +// 'authnRequestsSigned' => false, +// +// // Indicates whether the messages sent by this SP +// // will be signed. +// 'logoutRequestSigned' => false, +// +// // Indicates whether the messages sent by this SP +// // will be signed. +// 'logoutResponseSigned' => false, +// +// /* Sign the Metadata +// False || True (use sp certs) || array ( +// keyFileName => 'metadata.key', +// certFileName => 'metadata.crt' +// ) +// */ +// 'signMetadata' => false, +// +// /** signatures and encryptions required **/ +// +// // Indicates a requirement for the , +// // and elements received by this SP to be signed. +// 'wantMessagesSigned' => false, +// +// // Indicates a requirement for the elements received by +// // this SP to be encrypted. +// 'wantAssertionsEncrypted' => false, +// +// // Indicates a requirement for the elements received by +// // this SP to be signed. [Metadata of the SP will offer this info] +// 'wantAssertionsSigned' => false, +// +// // Indicates a requirement for the NameID element on the SAMLResponse +// // received by this SP to be present. +// 'wantNameId' => true, +// +// // Indicates a requirement for the NameID received by +// // this SP to be encrypted. +// 'wantNameIdEncrypted' => false, +// +// // Authentication context. +// // Set to false and no AuthContext will be sent in the AuthNRequest. +// // Set true or don't present this parameter and you will get an AuthContext 'exact' 'urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport'. +// // Set an array with the possible auth context values: array ('urn:oasis:names:tc:SAML:2.0:ac:classes:Password', 'urn:oasis:names:tc:SAML:2.0:ac:classes:X509'). +// 'requestedAuthnContext' => true, +// +// // Indicates if the SP will validate all received xmls. +// // (In order to validate the xml, 'strict' and 'wantXMLValidation' must be true). +// 'wantXMLValidation' => true, +// +// // If true, SAMLResponses with an empty value at its Destination +// // attribute will not be rejected for this fact. +// 'relaxDestinationValidation' => false, +// +// // Algorithm that the toolkit will use on signing process. Options: +// // 'http://www.w3.org/2000/09/xmldsig#rsa-sha1' +// // 'http://www.w3.org/2000/09/xmldsig#dsa-sha1' +// // 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256' +// // 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha384' +// // 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha512' +// // Notice that sha1 is a deprecated algorithm and should not be used +// 'signatureAlgorithm' => 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256', +// +// // Algorithm that the toolkit will use on digest process. Options: +// // 'http://www.w3.org/2000/09/xmldsig#sha1' +// // 'http://www.w3.org/2001/04/xmlenc#sha256' +// // 'http://www.w3.org/2001/04/xmldsig-more#sha384' +// // 'http://www.w3.org/2001/04/xmlenc#sha512' +// // Notice that sha1 is a deprecated algorithm and should not be used +// 'digestAlgorithm' => 'http://www.w3.org/2001/04/xmlenc#sha256', +// +// // ADFS URL-Encodes SAML data as lowercase, and the toolkit by default uses +// // uppercase. Turn it True for ADFS compatibility on signature verification +// 'lowercaseUrlencoding' => false, +//), +// +// // Contact information template, it is recommended to supply a +// // technical and support contacts. +// 'contactPerson' => array ( +// 'technical' => array ( +// 'givenName' => 'example', +// 'emailAddress' => 'test@example.org' +// ), +// 'support' => array ( +// 'givenName' => 'example', +// 'emailAddress' => 'test@example.org' +// ), +//), +// +// // Organization information template, the info in en_US lang is +// // recomended, add more if required. +// 'organization' => array ( +// 'en-US' => array( +// 'name' => 'chamilo', +// 'displayname' => 'chamilo', +// 'url' => 'chamilo.org' +// ), +//), diff --git a/plugin/keycloak/start.php b/plugin/keycloak/start.php new file mode 100644 index 000000000..0bc7f305a --- /dev/null +++ b/plugin/keycloak/start.php @@ -0,0 +1,220 @@ +getRequest(); +$idpData = $settings->getIdPData(); + +if (isset($_GET['sso'])) { + $auth->login(); +// If AuthNRequest ID need to be saved in order to later validate it, do instead + /*$ssoBuiltUrl = $auth->login(null, [], false, false, true); + $_SESSION['AuthNRequestID'] = $auth->getLastRequestID(); + header('Pragma: no-cache'); + header('Cache-Control: no-cache, must-revalidate'); + header('Location: ' . $ssoBuiltUrl); + exit();*/ +} elseif (isset($_GET['slo'])) { + /* + if (isset($idpData['singleLogoutService']) && isset($idpData['singleLogoutService']['url'])) { + $sloUrl = $idpData['singleLogoutService']['url']; + } else { + throw new Exception("The IdP does not support Single Log Out"); + } + + if (isset($_SESSION['samlSessionIndex']) && !empty($_SESSION['samlSessionIndex'])) { + $logoutRequest = new \OneLogin\Saml2\LogoutRequest($settings, null, $_SESSION['samlSessionIndex']); + } else { + $logoutRequest = new \OneLogin\Saml2\LogoutRequest($settings); + } + $samlRequest = $logoutRequest->getRequest(); + $parameters = array('SAMLRequest' => $samlRequest); + $url = \OneLogin\Saml2\Utils::redirect($sloUrl, $parameters, true); + header("Location: $url"); + exit;*/ + $returnTo = null; + $parameters = []; + $nameId = Session::read('samlNameId'); + $sessionIndex = Session::read('samlSessionIndex'); + $nameIdFormat = Session::read('samlNameIdFormat'); + $auth->logout($returnTo, $parameters, $nameId, $sessionIndex, false, $nameIdFormat); + +// If LogoutRequest ID need to be saved in order to later validate it, do instead + // $sloBuiltUrl = $auth->logout(null, [], $nameId, $sessionIndex, true); + /*$_SESSION['LogoutRequestID'] = $auth->getLastRequestID(); + header('Pragma: no-cache'); + header('Cache-Control: no-cache, must-revalidate'); + header('Location: ' . $sloBuiltUrl); + exit();*/ +} elseif (isset($_GET['acs'])) { + $requestID = Session::read('AuthNRequestID'); + $auth->processResponse($requestID); + $errors = $auth->getErrors(); + if (!empty($errors)) { + $content .= '

    '.implode(', ', $errors).'

    '; + } + + if (!$auth->isAuthenticated()) { + api_not_allowed(true, $content.'

    Not authenticated

    '); + exit; + } + + $keyCloackUserName = $auth->getNameId(); + $userInfo = api_get_user_info_from_username($keyCloackUserName); + $attributes = $auth->getAttributes(); + $userId = 0; + if (!empty($attributes) && empty($userInfo)) { + $firstName = ''; + if (isset($attributes['FirstName']) && !empty($attributes['FirstName'])) { + $firstName = reset($attributes['FirstName']); + } + + $lastName = ''; + if (isset($attributes['LastName']) && !empty($attributes['LastName'])) { + $lastName = reset($attributes['LastName']); + } + + $email = ''; + if (isset($attributes['Email']) && !empty($attributes['Email'])) { + $email = reset($attributes['Email']); + } + + if (empty($email)) { + api_not_allowed(true); + } + + $userId = UserManager::create_user( + $firstName, + $lastName, + STUDENT, + $email, + $keyCloackUserName, + '', + '', + '', + '', + '', + 'keycloak' + ); + + if ($userId) { + $userInfo = api_get_user_info($userId); + } + } else { + // Only load users that were created using this method. + if ($userInfo['auth_source'] === 'keycloak') { + $userId = $userInfo['user_id']; + } + } + + if (!empty($userId)) { + // Set chamilo sessions + Session::write('samlUserdata', $auth->getAttributes()); + Session::write('samlNameId', $auth->getNameId()); + Session::write('samlNameIdFormat', $auth->getNameIdFormat()); + Session::write('samlSessionIndex', $auth->getSessionIndex()); + Session::erase('AuthNRequestID'); + + // Filling session variables with new data + Session::write('_uid', $userId); + Session::write('_user', $userInfo); + Session::write('is_platformAdmin', false); + Session::write('is_allowedCreateCourse', false); + } else { + Display::addFlash(Display::return_message(get_lang('InvalidId'))); + } + + /*if (isset($_POST['RelayState']) && \OneLogin\Saml2\Utils::getSelfURL() != $_POST['RelayState']) { + $auth->redirectTo($_POST['RelayState']); + }*/ + header('Location: '.api_get_path(WEB_PATH)); + exit; +} elseif (isset($_GET['sls'])) { + $requestID = Session::read('LogoutRequestID'); + $auth->processSLO(false, $requestID); + $errors = $auth->getErrors(); + + if (empty($errors)) { + Session::erase('samlNameId'); + Session::erase('samlSessionIndex'); + Session::erase('samlNameIdFormat'); + Session::erase('samlUserdata'); + Session::erase('AuthNRequestID'); + Session::erase('LogoutRequestID'); + + Display::addFlash(Display::return_message('Sucessfully logged out')); + header('Location: '.api_get_path(WEB_PATH)); + exit; + } else { + api_not_allowed(true, implode(', ', $errors)); + } +} + +$template = new Template(''); + +if (isset($_SESSION['samlUserdata'])) { + $attributes = Session::read('samlUserdata'); + $params = []; + if (!empty($attributes)) { + $content .= 'You have the following attributes:
    '; + $content .= ''; + foreach ($attributes as $attributeName => $attributeValues) { + $content .= ''; + } + $content .= '
    NameValues
    '.htmlentities($attributeName).'
      '; + foreach ($attributeValues as $attributeValue) { + $content .= '
    • '.htmlentities($attributeValue).'
      • '; + } + $content .= '
    '; + } else { + $content .= "

    You don't have any attribute

    "; + } + + $content .= '

    Logout

    '; +} else { + $content .= '

    Login

    '; + $content .= '

    Login and access to attrs.php page

    '; +} + +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/learning_calendar/LearningCalendarPlugin.php b/plugin/learning_calendar/LearningCalendarPlugin.php new file mode 100644 index 000000000..e1397a12d --- /dev/null +++ b/plugin/learning_calendar/LearningCalendarPlugin.php @@ -0,0 +1,1152 @@ + 'boolean']); + $this->setHasPersonalEvents(true); + } + + /** + * Event definition. + * + * @return array + */ + public function getEventTypeList() + { + return [ + self::EVENT_TYPE_TAKEN => ['color' => 'red', 'name' => self::get_lang('EventTypeTaken')], + self::EVENT_TYPE_EXAM => ['color' => 'yellow', 'name' => self::get_lang('EventTypeExam')], + self::EVENT_TYPE_FREE => ['color' => 'green', 'name' => self::get_lang('EventTypeFree')], + ]; + } + + /** + * @return array + */ + public function getEventTypeColorList() + { + $list = $this->getEventTypeList(); + $newList = []; + foreach ($list as $eventId => $event) { + $newList[$eventId] = $event['color']; + } + + return $newList; + } + + /** + * Get the class instance. + * + * @return $this + */ + public static function create() + { + static $result = null; + + return $result ?: $result = new self(); + } + + /** + * Get the plugin directory name. + */ + public function get_name() + { + return 'learning_calendar'; + } + + /** + * Install the plugin. Setup the database. + */ + public function install() + { + $sql = " + CREATE TABLE IF NOT EXISTS learning_calendar( + id int not null AUTO_INCREMENT primary key, + title varchar(255) not null default '', + description longtext default null, + total_hours int not null default 0, + minutes_per_day int not null default 0, + disabled int default 0, + author_id int(11) not null + ) + "; + Database::query($sql); + + $sql = " + CREATE TABLE IF NOT EXISTS learning_calendar_events( + id int not null AUTO_INCREMENT primary key, + name varchar(255) default '', + calendar_id int not null, + start_date date not null, + end_date date not null, + type int not null + ) + "; + Database::query($sql); + + $sql = " + CREATE TABLE IF NOT EXISTS learning_calendar_user( + id int not null AUTO_INCREMENT primary key, + user_id int(11) not null, + calendar_id int not null + ) + "; + Database::query($sql); + + $sql = " + CREATE TABLE IF NOT EXISTS learning_calendar_control_point( + id int not null AUTO_INCREMENT primary key, + user_id int(11) not null, + control_date date not null, + control_value int not null, + created_at datetime not null, + updated_at datetime not null + ) + "; + Database::query($sql); + + $extraField = new ExtraField('lp_item'); + $params = [ + 'display_text' => $this->get_lang('LearningCalendarOneDayMarker'), + 'variable' => 'calendar', + 'visible_to_self' => 1, + 'changeable' => 1, + 'visible_to_others' => 1, + 'field_type' => ExtraField::FIELD_TYPE_CHECKBOX, + ]; + + $extraField->save($params); + + $extraField = new ExtraField('course'); + $params = [ + 'display_text' => $this->get_lang('CourseHoursDuration'), + 'variable' => 'course_hours_duration', + 'visible_to_self' => 1, + 'changeable' => 1, + 'visible_to_others' => 1, + 'field_type' => ExtraField::FIELD_TYPE_TEXT, + ]; + + $extraField->save($params); + + return true; + } + + /** + * Uninstall the plugin. + */ + public function uninstall() + { + $tables = [ + 'learning_calendar', + 'learning_calendar_events', + 'learning_calendar_user', + ]; + + foreach ($tables as $table) { + $sql = "DROP TABLE IF EXISTS $table"; + Database::query($sql); + } + + $extraField = new ExtraField('lp_item'); + $fieldInfo = $extraField->get_handler_field_info_by_field_variable('calendar'); + + if ($fieldInfo) { + $extraField->delete($fieldInfo['id']); + } + + $extraField = new ExtraField('course'); + $fieldInfo = $extraField->get_handler_field_info_by_field_variable('course_hours_duration'); + if ($fieldInfo) { + $extraField->delete($fieldInfo['id']); + } + + return true; + } + + /** + * @param int $from + * @param int $numberOfItems + * @param int $column + * @param string $direction + * + * @return array + */ + public function getCalendars( + $from, + $numberOfItems, + $column, + $direction = 'DESC' + ) { + $column = (int) $column; + $from = (int) $from; + $numberOfItems = (int) $numberOfItems; + $direction = strtoupper($direction); + + if (!in_array($direction, ['ASC', 'DESC'])) { + $direction = 'DESC'; + } + + if (api_is_platform_admin()) { + $sql = 'SELECT * FROM learning_calendar'; + } else { + $userId = api_get_user_id(); + $sql = "SELECT * FROM learning_calendar WHERE author_id = $userId"; + } + + $sql .= " LIMIT $from, $numberOfItems "; + + $result = Database::query($sql); + $list = []; + $link = api_get_path(WEB_PLUGIN_PATH).'learning_calendar/start.php'; + while ($row = Database::fetch_array($result)) { + $id = $row['id']; + $row['title'] = Display::url( + $row['title'], + api_get_path(WEB_PLUGIN_PATH).'learning_calendar/calendar.php?id='.$id + ); + $actions = Display::url( + Display::return_icon('edit.png', get_lang('Edit')), + $link.'?action=edit&id='.$id + ); + + $actions .= Display::url( + Display::return_icon('copy.png', get_lang('Copy')), + $link.'?action=copy&id='.$id + ); + + $actions .= Display::url( + Display::return_icon('delete.png', get_lang('Delete')), + $link.'?action=delete&id='.$id + ); + $row['actions'] = $actions; + $list[] = $row; + } + + return $list; + } + + /** + * @param array $calendarInfo + * @param int $start + * @param int $end + * @param int $type + * @param bool $getCount + * + * @return array + */ + public function getCalendarsEventsByDate($calendarInfo, $start, $end, $type = 0, $getCount = false) + { + if (empty($calendarInfo)) { + if ($getCount) { + return 0; + } + + return []; + } + + $calendarId = (int) $calendarInfo['id']; + $start = (int) $start; + $end = (int) $end; + + $startCondition = ''; + $endCondition = ''; + $typeCondition = ''; + + if ($start !== 0) { + $start = api_get_utc_datetime($start); + $startCondition = "AND start_date >= '".$start."'"; + } + if ($end !== 0) { + $end = api_get_utc_datetime($end); + $endCondition = "AND (end_date <= '".$end."' OR end_date IS NULL)"; + } + + if (!empty($type)) { + $type = (int) $type; + $typeCondition = " AND type = $type "; + } + + $select = '*'; + if ($getCount) { + $select = 'count(id) count '; + } + + $sql = "SELECT $select FROM learning_calendar_events + WHERE calendar_id = $calendarId $startCondition $endCondition $typeCondition"; + $result = Database::query($sql); + + if ($getCount) { + $row = Database::fetch_array($result, 'ASSOC'); + + return $row['count']; + } + + $list = []; + while ($row = Database::fetch_array($result, 'ASSOC')) { + $list[] = $row; + } + + return ['calendar' => $calendarInfo, 'events' => $list]; + } + + /** + * @param array $calendarInfo + * + * @return array + */ + public function getFirstCalendarDate($calendarInfo) + { + if (empty($calendarInfo)) { + return []; + } + + $calendarId = (int) $calendarInfo['id']; + + /*if (!empty($type)) { + $type = (int) $type; + $typeCondition = " AND type = $type "; + }*/ + + $sql = "SELECT start_date FROM learning_calendar_events + WHERE calendar_id = $calendarId ORDER BY start_date LIMIT 1"; + $result = Database::query($sql); + $row = Database::fetch_array($result, 'ASSOC'); + + return $row['start_date']; + } + + /** + * @return int + */ + public function getCalendarCount() + { + if (api_is_platform_admin()) { + $sql = 'select count(*) as count FROM learning_calendar'; + } else { + $userId = api_get_user_id(); + $sql = "select count(*) as count FROM learning_calendar WHERE author_id = $userId"; + } + $result = Database::query($sql); + $result = Database::fetch_array($result); + + return (int) $result['count']; + } + + /** + * @param int $calendarId + * + * @return array + */ + public function getUsersPerCalendar($calendarId) + { + $calendarId = (int) $calendarId; + $sql = "SELECT * FROM learning_calendar_user + WHERE calendar_id = $calendarId"; + $result = Database::query($sql); + $list = []; + while ($row = Database::fetch_array($result, 'ASSOC')) { + $userInfo = api_get_user_info($row['user_id']); + $userInfo['exam'] = 'exam'; + $list[] = $userInfo; + } + + return $list; + } + + /** + * @param int $calendarId + * + * @return int + */ + public function getUsersPerCalendarCount($calendarId) + { + $calendarId = (int) $calendarId; + $sql = "SELECT count(id) as count FROM learning_calendar_user + WHERE calendar_id = $calendarId"; + $result = Database::query($sql); + $row = Database::fetch_array($result, 'ASSOC'); + + return (int) $row['count']; + } + + /** + * @param int $id + */ + public function toggleVisibility($id) + { + $extraField = new ExtraField('lp_item'); + $fieldInfo = $extraField->get_handler_field_info_by_field_variable('calendar'); + if ($fieldInfo) { + $itemInfo = $this->getItemVisibility($id); + if (empty($itemInfo)) { + $extraField = new ExtraFieldValue('lp_item'); + $value = 1; + $params = [ + 'field_id' => $fieldInfo['id'], + 'value' => $value, + 'item_id' => $id, + ]; + $extraField->save($params); + } else { + $newValue = (int) $itemInfo['value'] === 1 ? 0 : 1; + $extraField = new ExtraFieldValue('lp_item'); + $params = [ + 'id' => $itemInfo['id'], + 'value' => $newValue, + ]; + $extraField->update($params); + } + } + } + + /** + * @param int $id + * + * @return array + */ + public function getItemVisibility($id) + { + $extraField = new ExtraFieldValue('lp_item'); + $values = $extraField->get_values_by_handler_and_field_variable($id, 'calendar'); + + if (empty($values)) { + return []; + } + + return $values; + } + + /** + * @param int $calendarId + * + * @return array|mixed + */ + public function getCalendar($calendarId) + { + $calendarId = (int) $calendarId; + $sql = "SELECT * FROM learning_calendar WHERE id = $calendarId"; + $result = Database::query($sql); + $item = Database::fetch_array($result, 'ASSOC'); + + return $item; + } + + /** + * @param int $userId + * + * @return array|mixed + */ + public function getUserCalendar($userId) + { + $userId = (int) $userId; + $sql = "SELECT * FROM learning_calendar_user WHERE user_id = $userId"; + $result = Database::query($sql); + $item = Database::fetch_array($result, 'ASSOC'); + + return $item; + } + + /** + * @param int $userId + * @param int $start + * @param int $end + * @param int $type + * @param bool $getCount + * + * @return array|int + */ + public function getUserEvents($userId, $start, $end, $type = 0, $getCount = false) + { + $calendarRelUser = $this->getUserCalendar($userId); + if (!empty($calendarRelUser)) { + $calendar = $this->getCalendar($calendarRelUser['calendar_id']); + + return $this->getCalendarsEventsByDate($calendar, $start, $end, $type, $getCount); + } + + if ($getCount) { + return 0; + } + + return []; + } + + /** + * @param int $userId + * + * @return mixed|string + */ + public function getUserCalendarToString($userId) + { + $calendar = $this->getUserCalendar($userId); + if ($calendar) { + $calendarInfo = $this->getCalendar($calendar['calendar_id']); + + return $calendarInfo['title']; + } + + return ''; + } + + /** + * @param int $calendarId + * @param int $userId + * + * @return bool + */ + public function addUserToCalendar($calendarId, $userId) + { + $calendar = $this->getUserCalendar($userId); + if (empty($calendar)) { + $params = [ + 'calendar_id' => $calendarId, + 'user_id' => $userId, + ]; + + Database::insert('learning_calendar_user', $params); + + return true; + } + + return false; + } + + /** + * @param int $calendarId + * @param int $userId + * + * @return bool + */ + public function updateUserToCalendar($calendarId, $userId) + { + $calendar = $this->getUserCalendar($userId); + if (!empty($calendar)) { + $params = [ + 'calendar_id' => $calendarId, + 'user_id' => $userId, + ]; + + Database::update('learning_calendar_user', $params, ['id = ?' => $calendar['id']]); + } + + return true; + } + + /** + * @param int $calendarId + * @param int $userId + * + * @return bool + */ + public function deleteAllCalendarFromUser($calendarId, $userId) + { + $calendarId = (int) $calendarId; + $userId = (int) $userId; + $sql = "DELETE FROM learning_calendar_user + WHERE user_id = $userId AND calendar_id = $calendarId"; + Database::query($sql); + + return true; + } + + /*public static function getUserCalendar($calendarId, $userId) + { + $params = [ + 'calendar_id' => $calendarId, + 'user_id' => $calendarId, + ]; + + Database::insert('learning_calendar_user', $params); + + return true; + }*/ + + public function getForm(FormValidator &$form) + { + $form->addText('title', get_lang('Title')); + $form->addText('total_hours', get_lang('TotalHours')); + $form->addText('minutes_per_day', get_lang('MinutesPerDay')); + $form->addHtmlEditor('description', get_lang('Description'), false); + } + + /** + * @param Agenda $agenda + * @param int $start + * @param int $end + * + * @return array + */ + public function getPersonalEvents($agenda, $start, $end) + { + $userId = api_get_user_id(); + $events = $this->getUserEvents($userId, $start, $end); + + if (empty($events)) { + return []; + } + + $calendarInfo = $events['calendar']; + $events = $events['events']; + + $list = []; + $typeList = $this->getEventTypeColorList(); + foreach ($events as $row) { + $event = []; + $event['id'] = 'personal_'.$row['id']; + $event['title'] = $calendarInfo['title']; + $event['className'] = 'personal'; + $color = isset($typeList[$row['type']]) ? $typeList[$row['type']] : $typeList[self::EVENT_TYPE_FREE]; + $event['borderColor'] = $color; + $event['backgroundColor'] = $color; + $event['editable'] = false; + $event['sent_to'] = get_lang('Me'); + $event['type'] = 'personal'; + + if (!empty($row['start_date'])) { + $event['start'] = $agenda->formatEventDate($row['start_date']); + $event['start_date_localtime'] = api_get_local_time($row['start_date']); + } + + if (!empty($row['end_date'])) { + $event['end'] = $agenda->formatEventDate($row['end_date']); + $event['end_date_localtime'] = api_get_local_time($row['end_date']); + } + + $event['description'] = 'plugin'; + $event['allDay'] = 1; + $event['parent_event_id'] = 0; + $event['has_children'] = 0; + $list[] = $event; + } + + return $list; + } + + /** + * @param int $userId + * @param array $coursesAndSessions + * + * @return string + */ + public function getGradebookEvaluationListToString($userId, $coursesAndSessions) + { + $list = $this->getGradebookEvaluationList($userId, $coursesAndSessions); + + $html = ''; + if (!empty($list)) { + $html = implode(' ', array_column($list, 'name')); + } + + return $html; + } + + /** + * @param int $userId + * @param array $coursesAndSessions + * + * @return array + */ + public function getGradebookEvaluationList($userId, $coursesAndSessions) + { + $userId = (int) $userId; + + if (empty($coursesAndSessions)) { + return 0; + } + + $courseSessionConditionToString = ''; + foreach ($coursesAndSessions as $sessionId => $courseList) { + if (isset($courseList['course_list'])) { + $courseList = array_keys($courseList['course_list']); + } + if (empty($courseList)) { + continue; + } + //$courseListToString = implode("','", $courseList); + /*if (empty($sessionId)) { + $courseAndSessionCondition[] = + " c.id IN ('$courseListToString') "; + } else { + $courseAndSessionCondition[] = " + ( + c.id IN ('$courseListToString') + )"; + }*/ + $courseSessionConditionToString = " AND c.id IN ('".implode("','", $courseList)."') "; + } + + if (empty($courseSessionConditionToString)) { + return 0; + } + + $tableEvaluation = Database::get_main_table(TABLE_MAIN_GRADEBOOK_EVALUATION); + $tableCourse = Database::get_main_table(TABLE_MAIN_COURSE); + $tableResult = Database::get_main_table(TABLE_MAIN_GRADEBOOK_RESULT); + $sql = "SELECT DISTINCT e.name, e.id + FROM $tableEvaluation e + INNER JOIN $tableCourse c + ON (course_code = c.code) + INNER JOIN $tableResult r + ON (r.evaluation_id = e.id) + WHERE + e.type = 'evaluation' AND + r.score >= 2 AND + r.user_id = $userId + $courseSessionConditionToString + "; + $result = Database::query($sql); + $list = []; + if (Database::num_rows($result)) { + while ($row = Database::fetch_array($result, 'ASSOC')) { + $list[$row['id']] = $row; + } + } + + return $list; + } + + /** + * @param int $userId + * @param array $coursesAndSessions + * + * @return int + */ + public function getItemCountChecked($userId, $coursesAndSessions) + { + $userId = (int) $userId; + + if (empty($coursesAndSessions)) { + return 0; + } + + $tableItem = Database::get_course_table(TABLE_LP_ITEM); + $tableLp = Database::get_course_table(TABLE_LP_MAIN); + $tableLpItemView = Database::get_course_table(TABLE_LP_ITEM_VIEW); + $tableLpView = Database::get_course_table(TABLE_LP_VIEW); + $extraField = new ExtraField('lp_item'); + $fieldInfo = $extraField->get_handler_field_info_by_field_variable('calendar'); + + if (empty($fieldInfo)) { + return 0; + } + + $courseAndSessionCondition = []; + foreach ($coursesAndSessions as $sessionId => $courseList) { + if (isset($courseList['course_list'])) { + $courseList = array_keys($courseList['course_list']); + } + if (empty($courseList)) { + continue; + } + $courseListToString = implode("','", $courseList); + if (empty($sessionId)) { + $courseAndSessionCondition[] = + " ((l.session_id = 0 OR l.session_id is NULL) AND i.c_id IN ('$courseListToString'))"; + } else { + $courseAndSessionCondition[] = " + ( + ((l.session_id = 0 OR l.session_id is NULL) OR l.session_id = $sessionId) AND + i.c_id IN ('$courseListToString') + )"; + } + } + + if (empty($courseAndSessionCondition)) { + return 0; + } + + $courseSessionConditionToString = 'AND ('.implode(' OR ', $courseAndSessionCondition).') '; + $sql = "SELECT count(*) as count + FROM $tableItem i INNER JOIN $tableLp l + ON (i.c_id = l.c_id AND i.lp_id = l.iid) + INNER JOIN $tableLpItemView iv + ON (iv.c_id = l.c_id AND i.iid = iv.lp_item_id) + INNER JOIN $tableLpView v + ON (v.c_id = l.c_id AND v.lp_id = l.iid AND iv.lp_view_id = v.iid) + INNER JOIN extra_field_values e + ON (e.item_id = i.iid AND value = 1 AND field_id = ".$fieldInfo['id'].") + WHERE + v.user_id = $userId AND + status = 'completed' + $courseSessionConditionToString + GROUP BY iv.view_count + "; + + $result = Database::query($sql); + + if (Database::num_rows($result)) { + $row = Database::fetch_array($result, 'ASSOC'); + + return $row['count']; + } + + return 0; + } + + /** + * @param array $htmlHeadXtra + */ + public function setJavaScript(&$htmlHeadXtra) + { + $htmlHeadXtra[] = api_get_js('jqplot/jquery.jqplot.js'); + $htmlHeadXtra[] = api_get_js('jqplot/plugins/jqplot.dateAxisRenderer.js'); + $htmlHeadXtra[] = api_get_js('jqplot/plugins/jqplot.canvasOverlay.js'); + $htmlHeadXtra[] = api_get_js('jqplot/plugins/jqplot.pointLabels.js'); + $htmlHeadXtra[] = api_get_css(api_get_path(WEB_LIBRARY_PATH).'javascript/jqplot/jquery.jqplot.css'); + } + + /** + * @param int $userId + * @param array $courseAndSessionList + * + * @return string + */ + public function getUserStatsPanel($userId, $courseAndSessionList) + { + // @todo use translation + // get events from this year to today + $stats = $this->getUserStats($userId, $courseAndSessionList); + $html = $this->get_lang('NumberDaysAccumulatedInCalendar').$stats['user_event_count']; + if (!empty($courseAndSessionList)) { + $html .= '
    '; + $html .= $this->get_lang('NumberDaysAccumulatedInLp').$stats['completed']; + $html .= '
    '; + $html .= $this->get_lang('NumberDaysInRetard').' '.($stats['completed'] - $stats['user_event_count']); + } + + $controlList = $this->getControlPointsToPlot($userId); + + if (!empty($controlList)) { + $listToString = json_encode($controlList); + $date = $this->get_lang('Date'); + $controlPoint = $this->get_lang('NumberOfDays'); + + $html .= '
    '; + $html .= ''; + } + + $html = Display::panel($html, $this->get_lang('LearningCalendar')); + + return $html; + } + + /** + * @param int $userId + * @param array $courseAndSessionList + * + * @return array + */ + public function getUserStats($userId, $courseAndSessionList) + { + // Get events from this year to today + $takenCount = $this->getUserEvents( + $userId, + strtotime(date('Y-01-01')), + time(), + self::EVENT_TYPE_TAKEN, + true + ); + + $completed = 0; + $diff = 0; + if (!empty($courseAndSessionList)) { + $completed = $this->getItemCountChecked($userId, $courseAndSessionList); + $diff = $takenCount - $completed; + } + + return [ + 'user_event_count' => $takenCount, + 'completed' => $completed, + 'diff' => $diff, + ]; + } + + /** + * @param int $calendarId + * + * @return bool + */ + public function copyCalendar($calendarId) + { + $item = $this->getCalendar($calendarId); + $this->protectCalendar($item); + $item['author_id'] = api_get_user_id(); + + if (empty($item)) { + return false; + } + + $calendarId = (int) $calendarId; + + unset($item['id']); + //$item['title'] = $item['title']; + + $newCalendarId = Database::insert('learning_calendar', $item); + if (!empty($newCalendarId)) { + $sql = "SELECT * FROM learning_calendar_events WHERE calendar_id = $calendarId"; + $result = Database::query($sql); + while ($row = Database::fetch_array($result, 'ASSOC')) { + unset($row['id']); + $row['calendar_id'] = $newCalendarId; + Database::insert('learning_calendar_events', $row); + } + + return true; + } + + return false; + } + + /** + * @param int $calendarId + * + * @return bool + */ + public function deleteCalendar($calendarId) + { + $item = $this->getCalendar($calendarId); + $this->protectCalendar($item); + + if (empty($item)) { + return false; + } + + $calendarId = (int) $calendarId; + + $sql = "DELETE FROM learning_calendar WHERE id = $calendarId"; + Database::query($sql); + + // Delete events + $sql = "DELETE FROM learning_calendar_events WHERE calendar_id = $calendarId"; + Database::query($sql); + + return true; + } + + /** + * @param int $calendarId + * @param string $startDate + */ + public function toogleDayType($calendarId, $startDate) + { + $startDate = Database::escape_string($startDate); + $calendarId = (int) $calendarId; + + $eventTypeList = $this->getEventTypeColorList(); + // Remove the free type to loop correctly when toogle days. + unset($eventTypeList[self::EVENT_TYPE_FREE]); + + $sql = "SELECT * FROM learning_calendar_events + WHERE start_date = '$startDate' AND calendar_id = $calendarId "; + $result = Database::query($sql); + + if (Database::num_rows($result)) { + $row = Database::fetch_array($result, 'ASSOC'); + $currentType = $row['type']; + $currentType++; + if ($currentType > count($eventTypeList)) { + Database::delete( + 'learning_calendar_events', + [' calendar_id = ? AND start_date = ?' => [$calendarId, $startDate]] + ); + } else { + $params = [ + 'type' => $currentType, + ]; + Database::update( + 'learning_calendar_events', + $params, + [' calendar_id = ? AND start_date = ?' => [$calendarId, $startDate]] + ); + } + } else { + $params = [ + 'name' => '', + 'calendar_id' => $calendarId, + 'start_date' => $startDate, + 'end_date' => $startDate, + 'type' => self::EVENT_TYPE_TAKEN, + ]; + Database::insert('learning_calendar_events', $params); + } + } + + /** + * @param int $calendarId + * + * @return array + */ + public function getEvents($calendarId) + { + $calendarId = (int) $calendarId; + $eventTypeList = $this->getEventTypeColorList(); + + $sql = "SELECT * FROM learning_calendar_events + WHERE calendar_id = $calendarId "; + $result = Database::query($sql); + + $list = []; + while ($row = Database::fetch_array($result, 'ASSOC')) { + $list[] = [ + 'start_date' => $row['start_date'], + 'end_date' => $row['start_date'], + 'color' => $eventTypeList[$row['type']], + ]; + } + + return $list; + } + + public function protectCalendar(array $calendarInfo) + { + $allow = api_is_platform_admin() || api_is_teacher(); + + if (!$allow) { + api_not_allowed(true); + } + + if (!empty($calendarInfo)) { + if (!api_is_platform_admin() && api_is_teacher()) { + if ($calendarInfo['author_id'] != api_get_user_id()) { + api_not_allowed(true); + } + } + } + } + + /** + * @param int $userId + * + * @return array + */ + public function getControlPoints($userId) + { + $userId = (int) $userId; + $sql = "SELECT control_date, control_value + FROM learning_calendar_control_point + WHERE user_id = $userId + ORDER BY control_date"; + $result = Database::query($sql); + $list = Database::store_result($result, 'ASSOC'); + + return $list; + } + + /** + * @param int $userId + * + * @return array + */ + public function getControlPointsToPlot($userId) + { + $list = $this->getControlPoints($userId); + $points = []; + foreach ($list as $item) { + $points[] = [$item['control_date'], $item['control_value']]; + } + + return $points; + } + + /** + * @param int $userId + * @param int $value + */ + public function addControlPoint($userId, $value) + { + $userId = (int) $userId; + $value = (int) $value; + $local = api_get_local_time(); + $date = substr($local, 0, 10); + + $sql = "SELECT id + FROM learning_calendar_control_point + WHERE user_id = $userId AND control_date = '$date'"; + $result = Database::query($sql); + + if (Database::num_rows($result)) { + $params = [ + 'control_value' => $value, + 'updated_at' => api_get_utc_datetime(), + ]; + $data = Database::fetch_array($result); + $id = $data['id']; + Database::update('learning_calendar_control_point', $params, ['id = ?' => $id]); + } else { + $params = [ + 'user_id' => $userId, + 'control_date' => $date, + 'control_value' => $value, + 'created_at' => api_get_utc_datetime(), + 'updated_at' => api_get_utc_datetime(), + ]; + Database::insert('learning_calendar_control_point', $params); + } + } + + public function getAddUserToCalendarForm(FormValidator &$form) + { + $calendars = $this->getCalendars(0, 1000, ''); + + if (empty($calendars)) { + echo Display::return_message(get_lang('NoData'), 'warning'); + exit; + } + $calendars = array_column($calendars, 'title', 'id'); + $calendars = array_map('strip_tags', $calendars); + + $form->addSelect('calendar_id', get_lang('Calendar'), $calendars, ['disable_js' => true]); + } +} diff --git a/plugin/learning_calendar/README.md b/plugin/learning_calendar/README.md new file mode 100644 index 000000000..21236ccbc --- /dev/null +++ b/plugin/learning_calendar/README.md @@ -0,0 +1,2 @@ +## Learning calendar + diff --git a/plugin/learning_calendar/ajax.php b/plugin/learning_calendar/ajax.php new file mode 100644 index 000000000..33aad3bfc --- /dev/null +++ b/plugin/learning_calendar/ajax.php @@ -0,0 +1,43 @@ +getCalendar($calendarId); +$plugin->protectCalendar($item); + +switch ($action) { + case 'toggle_day': + $startDate = isset($_REQUEST['start_date']) ? $_REQUEST['start_date'] : ''; + if (empty($startDate)) { + exit; + } + $endDate = isset($_REQUEST['end_date']) ? $_REQUEST['end_date'] : ''; + if ($startDate == $endDate) { + // One day + $plugin->toogleDayType($calendarId, $startDate); + } else { + // A list of days + $startDateTime = new DateTime($startDate); + $endDateTime = new DateTime($endDate); + $diff = $startDateTime->diff($endDateTime); + $countDays = $diff->format('%a'); + $dayList[] = $startDate; + for ($i = 0; $i < $countDays; $i++) { + $startDateTime->modify('+1 day'); + $dayList[] = $startDateTime->format('Y-m-d'); + } + foreach ($dayList as $day) { + $plugin->toogleDayType($calendarId, $day); + } + } + break; + case 'get_events': + $list = $plugin->getEvents($calendarId); + echo json_encode($list); + break; +} diff --git a/plugin/learning_calendar/calendar.php b/plugin/learning_calendar/calendar.php new file mode 100644 index 000000000..45df9a76e --- /dev/null +++ b/plugin/learning_calendar/calendar.php @@ -0,0 +1,50 @@ +getCalendar($calendarId); +$plugin->protectCalendar($item); + +$isoCode = api_get_language_isocode(); +$htmlHeadXtra[] = api_get_asset('bootstrap-year-calendar/js/bootstrap-year-calendar.js'); +$calendarLanguage = 'en'; +if ($isoCode !== 'en') { + $file = 'bootstrap-year-calendar/js/languages/bootstrap-year-calendar.'.$isoCode.'.js'; + $path = api_get_path(SYS_PUBLIC_PATH).'assets/'.$file; + if (file_exists($path)) { + $htmlHeadXtra[] = api_get_asset($file); + $calendarLanguage = $isoCode; + } +} + +$htmlHeadXtra[] = api_get_css_asset('bootstrap-year-calendar/css/bootstrap-year-calendar.css'); + +$action = isset($_REQUEST['action']) ? $_REQUEST['action'] : ''; +$formToString = ''; + +$template = new Template(); +$actionLeft = Display::url( + Display::return_icon( + 'back.png', + get_lang('Add'), + null, + ICON_SIZE_MEDIUM + ), + api_get_path(WEB_PLUGIN_PATH).'learning_calendar/start.php' +); + +$actions = Display::toolbarAction('toolbar-forum', [$actionLeft]); + +$eventList = $plugin->getEventTypeList(); +$template->assign('events', $eventList); +$template->assign('calendar_language', $calendarLanguage); +$template->assign('ajax_url', api_get_path(WEB_PLUGIN_PATH).'learning_calendar/ajax.php?id='.$calendarId); +$template->assign('header', $item['title']); +$content = $template->fetch('learning_calendar/view/calendar.tpl'); +$template->assign('actions', $actions); +$template->assign('content', $content); + +$template->display_one_col_template(); diff --git a/plugin/learning_calendar/calendar_users.php b/plugin/learning_calendar/calendar_users.php new file mode 100644 index 000000000..3a54de800 --- /dev/null +++ b/plugin/learning_calendar/calendar_users.php @@ -0,0 +1,108 @@ +protectCalendar($calendarId); +$item = $plugin->getCalendar($calendarId); + +if (empty($item)) { + api_not_allowed(true); +} + +$action = isset($_REQUEST['action']) ? $_REQUEST['action'] : ''; +$formToString = ''; +$template = new Template(); +$actionLeft = Display::url( + Display::return_icon( + 'back.png', + get_lang('Add'), + null, + ICON_SIZE_MEDIUM + ), + api_get_path(WEB_PLUGIN_PATH).'learning_calendar/start.php' +); + +$actions = Display::toolbarAction('toolbar-forum', [$actionLeft]); + +// jqgrid will use this URL to do the selects +$url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_calendar_users&id='.$calendarId; + +// The order is important you need to check the the $column variable in the model.ajax.php file +$columns = [ + get_lang('FirstName'), + get_lang('LastName'), + get_lang('Exam'), +]; + +// Column config +$column_model = [ + ['name' => 'firstname', 'index' => 'firstname', 'width' => '35', 'align' => 'left', 'sortable' => 'false'], + ['name' => 'lastname', 'index' => 'lastname', 'width' => '35', 'align' => 'left', 'sortable' => 'false'], + [ + 'name' => 'exam', + 'index' => 'exam', + 'width' => '20', + 'align' => 'center', + 'sortable' => 'false', + ], +]; + +// Autowidth +$extraParams['autowidth'] = 'true'; +// height auto +$extraParams['height'] = 'auto'; +$extraParams['sortname'] = 'name'; +$extraParams['sortorder'] = 'desc'; +$extraParams['multiselect'] = true; + +$deleteIcon = Display::return_icon('delete.png', get_lang('Delete'), null, ICON_SIZE_SMALL); +$urlStats = api_get_path(WEB_CODE_PATH); +$action_links = ''; +$deleteUrl = ''; + +// Add the JS needed to use the jqgrid +$htmlHeadXtra[] = api_get_jqgrid_js(); + +Display::display_header(); + +?> + +'; +echo ''. + Display::return_icon('back.png', get_lang('BackTo').' '.get_lang('PlatformAdmin'), '', '32'). + ''; +echo '
    '; +echo Display::grid_html('usergroups'); + +Display::display_footer(); diff --git a/plugin/learning_calendar/install.php b/plugin/learning_calendar/install.php new file mode 100644 index 000000000..e6039a4fe --- /dev/null +++ b/plugin/learning_calendar/install.php @@ -0,0 +1,8 @@ +install(); diff --git a/plugin/learning_calendar/lang/english.php b/plugin/learning_calendar/lang/english.php new file mode 100644 index 000000000..78cf5b909 --- /dev/null +++ b/plugin/learning_calendar/lang/english.php @@ -0,0 +1,22 @@ +get_info(); diff --git a/plugin/learning_calendar/start.php b/plugin/learning_calendar/start.php new file mode 100644 index 000000000..a1dbe739c --- /dev/null +++ b/plugin/learning_calendar/start.php @@ -0,0 +1,191 @@ +getForm($form); + $form->addButtonSave(get_lang('Save')); + $formToString = $form->returnForm(); + + if ($form->validate()) { + $values = $form->getSubmitValues(); + $params = [ + 'title' => $values['title'], + 'total_hours' => $values['total_hours'], + 'minutes_per_day' => $values['minutes_per_day'], + 'description' => $values['description'], + 'author_id' => api_get_user_id(), + ]; + Database::insert('learning_calendar', $params); + Display::addFlash(Display::return_message(get_lang('Saved'))); + header('Location: start.php'); + exit; + } + break; + case 'edit': + $form = new FormValidator('calendar', 'post', api_get_self().'?action=edit&id='.$calendarId); + $plugin->getForm($form); + $form->addButtonSave(get_lang('Update')); + $item = $plugin->getCalendar($calendarId); + $plugin->protectCalendar($item); + + if (empty($item)) { + api_not_allowed(true); + } + + $form->setDefaults($item); + $formToString = $form->returnForm(); + + if ($form->validate()) { + $values = $form->getSubmitValues(); + $params = [ + 'title' => $values['title'], + 'total_hours' => $values['total_hours'], + 'minutes_per_day' => $values['minutes_per_day'], + 'description' => $values['description'], + ]; + Database::update('learning_calendar', $params, ['id = ?' => $calendarId]); + Display::addFlash(Display::return_message(get_lang('Updated'))); + header('Location: start.php'); + exit; + } + break; + case 'copy': + $result = $plugin->copyCalendar($calendarId); + if ($result) { + Display::addFlash(Display::return_message(get_lang('Saved'))); + } + header('Location: start.php'); + exit; + + break; + case 'delete': + $result = $plugin->deleteCalendar($calendarId); + if ($result) { + Display::addFlash(Display::return_message(get_lang('Deleted'))); + } + header('Location: start.php'); + exit; + break; + case 'toggle_visibility': + $itemId = isset($_REQUEST['lp_item_id']) ? $_REQUEST['lp_item_id'] : 0; + $lpId = isset($_REQUEST['lp_id']) ? $_REQUEST['lp_id'] : 0; + $plugin->toggleVisibility($itemId); + Display::addFlash(Display::return_message(get_lang('Updated'))); + $url = api_get_path(WEB_CODE_PATH). + 'lp/lp_controller.php?action=add_item&type=step&lp_id='.$lpId.'&'.api_get_cidreq(); + header("Location: $url"); + exit; + break; +} + +$htmlHeadXtra[] = api_get_jqgrid_js(); + +$url = api_get_path(WEB_AJAX_PATH).'model.ajax.php?a=get_learning_path_calendars'; +$columns = [ + get_lang('Title'), + get_lang('TotalHours'), + get_lang('MinutesPerDay'), + get_lang('Actions'), +]; + +$columnModel = [ + [ + 'name' => 'title', + 'index' => 'title', + 'width' => '300', + 'align' => 'left', + 'sortable' => 'false', + ], + [ + 'name' => 'total_hours', + 'index' => 'total_hours', + 'width' => '100', + 'align' => 'left', + 'sortable' => 'false', + ], + [ + 'name' => 'minutes_per_day', + 'index' => 'minutes_per_day', + 'width' => '100', + 'align' => 'left', + 'sortable' => 'false', + ], + [ + 'name' => 'actions', + 'index' => 'actions', + 'width' => '150', + 'align' => 'left', + //'formatter' => 'action_formatter', + 'sortable' => 'false', + ], +]; + +$extraParams = []; +$extraParams['autowidth'] = 'true'; +// height auto +$extraParams['height'] = 'auto'; + +$template = new Template(); + +if (in_array($action, ['add', 'edit'])) { + $actionLeft = Display::url( + Display::return_icon( + 'back.png', + get_lang('Back'), + null, + ICON_SIZE_MEDIUM + ), + api_get_self().'?'.api_get_cidreq() + ); +} else { + $actionLeft = Display::url( + Display::return_icon( + 'add.png', + get_lang('Add'), + null, + ICON_SIZE_MEDIUM + ), + api_get_self().'?'.api_get_cidreq().'&action=add' + ); + + $content = ''; + + $content .= Display::grid_html('calendars'); + $template->assign('grid', $content); +} + +$template->assign('form', $formToString); +$actions = Display::toolbarAction('toolbar-calendar', [$actionLeft]); +$content = $template->fetch('learning_calendar/view/start.tpl'); +$template->assign('content', $content); +$template->assign('actions', $actions); + +$template->display_one_col_template(); diff --git a/plugin/learning_calendar/uninstall.php b/plugin/learning_calendar/uninstall.php new file mode 100644 index 000000000..5e90e870f --- /dev/null +++ b/plugin/learning_calendar/uninstall.php @@ -0,0 +1,4 @@ +uninstall(); diff --git a/plugin/learning_calendar/view/calendar.tpl b/plugin/learning_calendar/view/calendar.tpl new file mode 100644 index 000000000..32050a169 --- /dev/null +++ b/plugin/learning_calendar/view/calendar.tpl @@ -0,0 +1,104 @@ + + + + +
    +
    +
    +
    +
    +
    +
    +
    +
    + + {% for event in events %} + + + + + {% endfor %} +
    + {{ event.name }}: + + +
    +
    +
    diff --git a/plugin/learning_calendar/view/start.tpl b/plugin/learning_calendar/view/start.tpl new file mode 100644 index 000000000..7bc19acca --- /dev/null +++ b/plugin/learning_calendar/view/start.tpl @@ -0,0 +1,3 @@ +{{ form }} + +{{ grid }} \ No newline at end of file diff --git a/plugin/lti_provider/Entity/Platform.php b/plugin/lti_provider/Entity/Platform.php new file mode 100644 index 000000000..e1fc56d24 --- /dev/null +++ b/plugin/lti_provider/Entity/Platform.php @@ -0,0 +1,234 @@ +id; + } + + /** + * Set id. + */ + public function setId(int $id): Platform + { + $this->id = $id; + + return $this; + } + + /** + * @return string + */ + public function getToolProvider() + { + return $this->toolProvider; + } + + /** + * @param string $toolProvider + */ + public function setToolProvider(?string $toolProvider): void + { + $this->toolProvider = $toolProvider; + } + + /** + * Get key id. + */ + public function getKid() + { + return $this->kid; + } + + /** + * Set key id. + */ + public function setKid(string $kid): Platform + { + $this->kid = $kid; + + return $this; + } + + /** + * Get Issuer. + */ + public function getIssuer() + { + return $this->issuer; + } + + /** + * Set issuer. + */ + public function setIssuer(string $issuer): Platform + { + $this->issuer = $issuer; + + return $this; + } + + /** + * Get client ID. + */ + public function getClientId() + { + return $this->clientId; + } + + /** + * Set client ID. + */ + public function setClientId(string $clientId): Platform + { + $this->clientId = $clientId; + + return $this; + } + + /** + * Get auth login URL. + */ + public function getAuthLoginUrl() + { + return $this->authLoginUrl; + } + + /** + * Set auth login URL. + */ + public function setAuthLoginUrl(string $authLoginUrl): Platform + { + $this->authLoginUrl = $authLoginUrl; + + return $this; + } + + /** + * Get auth token URL. + */ + public function getAuthTokenUrl() + { + return $this->authTokenUrl; + } + + /** + * Set auth token URL. + */ + public function setAuthTokenUrl(string $authTokenUrl): Platform + { + $this->authTokenUrl = $authTokenUrl; + + return $this; + } + + /** + * Get key set URL. + */ + public function getKeySetUrl() + { + return $this->keySetUrl; + } + + /** + * Set key set URL. + */ + public function setKeySetUrl(string $keySetUrl): Platform + { + $this->keySetUrl = $keySetUrl; + + return $this; + } + + /** + * Get Deployment ID. + */ + public function getDeploymentId() + { + return $this->deploymentId; + } + + /** + * Set Deployment ID. + */ + public function setDeploymentId(string $deploymentId): Platform + { + $this->deploymentId = $deploymentId; + + return $this; + } +} diff --git a/plugin/lti_provider/Entity/PlatformKey.php b/plugin/lti_provider/Entity/PlatformKey.php new file mode 100644 index 000000000..eb76dace1 --- /dev/null +++ b/plugin/lti_provider/Entity/PlatformKey.php @@ -0,0 +1,116 @@ +id; + } + + /** + * Set id. + */ + public function setId(int $id): PlatformKey + { + $this->id = $id; + + return $this; + } + + /** + * Get key id. + */ + public function getKid(): string + { + return $this->kid; + } + + /** + * Set key id. + */ + public function setKid(string $kid): PlatformKey + { + $this->kid = $kid; + + return $this; + } + + /** + * Get privateKey. + */ + public function getPrivateKey(): string + { + return $this->privateKey; + } + + /** + * Set privateKey. + */ + public function setPrivateKey(string $privateKey): PlatformKey + { + $this->privateKey = $privateKey; + + return $this; + } + + /** + * Get publicKey. + */ + public function getPublicKey(): string + { + return $this->publicKey; + } + + /** + * Set publicKey. + */ + public function setPublicKey(string $publicKey): PlatformKey + { + $this->publicKey = $publicKey; + + return $this; + } +} diff --git a/plugin/lti_provider/Entity/Result.php b/plugin/lti_provider/Entity/Result.php new file mode 100644 index 000000000..eecaefc11 --- /dev/null +++ b/plugin/lti_provider/Entity/Result.php @@ -0,0 +1,267 @@ +id; + } + + public function setId(int $id): Result + { + $this->id = $id; + + return $this; + } + + public function getIssuer(): string + { + return $this->issuer; + } + + public function setIssuer(string $issuer): Result + { + $this->issuer = $issuer; + + return $this; + } + + public function getUserId(): int + { + return $this->userId; + } + + public function setUserId(int $userId): Result + { + $this->userId = $userId; + + return $this; + } + + public function getClientUId(): string + { + return $this->clientUId; + } + + public function setClientUId(string $clientUId): Result + { + $this->clientUId = $clientUId; + + return $this; + } + + public function getCourseCode(): string + { + return $this->courseCode; + } + + /** + * @param string $tool + */ + public function setCourseCode(string $courseCode): Result + { + $this->courseCode = $courseCode; + + return $this; + } + + public function getToolId(): int + { + return $this->toolId; + } + + public function setToolId(int $toolId): Result + { + $this->toolId = $toolId; + + return $this; + } + + public function getToolName(): string + { + return $this->toolName; + } + + public function setToolName(string $toolName): Result + { + $this->toolName = $toolName; + + return $this; + } + + public function getScore(): float + { + return $this->score; + } + + public function setScore(float $score): Result + { + $this->score = $score; + + return $this; + } + + public function getProgress(): int + { + return $this->progress; + } + + public function setProgress(int $progress): Result + { + $this->progress = $progress; + + return $this; + } + + public function getDuration(): int + { + return $this->duration; + } + + public function setDuration(int $duration): Result + { + $this->duration = $duration; + + return $this; + } + + public function getStartDate(): \DateTime + { + return $this->startDate; + } + + public function setStartDate(\DateTime $startDate): Result + { + $this->startDate = $startDate; + + return $this; + } + + public function getUserIp(): string + { + return $this->userIp; + } + + public function setUserIp(string $userIp): Result + { + $this->userIp = $userIp; + + return $this; + } + + public function getLtiLaunchId(): string + { + return $this->ltiLaunchId; + } + + public function setLtiLaunchId(string $ltiLaunchId): Result + { + $this->ltiLaunchId = $ltiLaunchId; + + return $this; + } +} diff --git a/plugin/lti_provider/LtiProviderPlugin.php b/plugin/lti_provider/LtiProviderPlugin.php new file mode 100644 index 000000000..cda87a105 --- /dev/null +++ b/plugin/lti_provider/LtiProviderPlugin.php @@ -0,0 +1,545 @@ + + */ +class LtiProviderPlugin extends Plugin +{ + public const TABLE_PLATFORM = 'plugin_lti_provider_platform'; + public const LAUNCH_PATH = 'lti_provider/tool/start.php'; + public const LOGIN_PATH = 'lti_provider/tool/login.php'; + public const REDIRECT_PATH = 'lti_provider/tool/start.php'; + public const JWKS_URL = 'lti_provider/tool/jwks.php'; + + public $isAdminPlugin = true; + + protected function __construct() + { + $version = '1.1'; + $author = 'Christian Beeznest'; + + $message = Display::return_message($this->get_lang('Description')); + + $launchUrlHtml = ''; + $loginUrlHtml = ''; + $redirectUrlHtml = ''; + $jwksUrlHtml = ''; + + if ($this->areTablesCreated()) { + $publicKey = $this->getPublicKey(); + + $pkHtml = $this->getSettingHtmlReadOnly( + $this->get_lang('PublicKey'), + 'public_key', + $publicKey + ); + $launchUrlHtml = $this->getSettingHtmlReadOnly( + $this->get_lang('LaunchUrl'), + 'launch_url', + api_get_path(WEB_PLUGIN_PATH).self::LAUNCH_PATH + ); + $loginUrlHtml = $this->getSettingHtmlReadOnly( + $this->get_lang('LoginUrl'), + 'login_url', + api_get_path(WEB_PLUGIN_PATH).self::LOGIN_PATH + ); + $redirectUrlHtml = $this->getSettingHtmlReadOnly( + $this->get_lang('RedirectUrl'), + 'redirect_url', + api_get_path(WEB_PLUGIN_PATH).self::REDIRECT_PATH + ); + $jwksUrlHtml = $this->getSettingHtmlReadOnly( + $this->get_lang('KeySetUrlJwks'), + 'jwks_url', + api_get_path(WEB_PLUGIN_PATH).self::JWKS_URL + ); + } else { + $pkHtml = $this->get_lang('GenerateKeyPairInfo'); + } + + $settings = [ + $message => 'html', + 'name' => 'hidden', + $launchUrlHtml => 'html', + $loginUrlHtml => 'html', + $redirectUrlHtml => 'html', + $jwksUrlHtml => 'html', + $pkHtml => 'html', + 'enabled' => 'boolean', + ]; + parent::__construct($version, $author, $settings); + } + + /** + * Get the value by default and readonly for the configuration html form. + * + * @param $label + * @param $id + * @param $value + * + * @return string + */ + public function getSettingHtmlReadOnly($label, $id, $value) + { + $html = '
    + +
    + 
    '.$value.'
    +
    +
    + +
    '; + + return $html; + } + + /** + * Get a selectbox with quizzes in courses , used for a tool provider. + * + * @param null $clientId + * + * @return string + */ + public function getQuizzesSelect($clientId = null) + { + $courses = CourseManager::get_courses_list(); + $toolProvider = $this->getToolProvider($clientId); + $htmlcontent = '
    + +
    + "; + $htmlcontent .= '
    +
    +
    '; + + return $htmlcontent; + } + + /** + * Get a selectbox with quizzes in courses , used for a tool provider. + * + * @param null $clientId + * + * @return string + */ + public function getLearnPathsSelect($clientId = null) + { + $courses = CourseManager::get_courses_list(); + $toolProvider = $this->getToolProvider($clientId); + $htmlcontent = ''; + + return $htmlcontent; + } + + /** + * Get the public key. + */ + public function getPublicKey(): string + { + $publicKey = ''; + $platformKey = Database::getManager() + ->getRepository('ChamiloPluginBundle:LtiProvider\PlatformKey') + ->findOneBy([]); + + if ($platformKey) { + $publicKey = $platformKey->getPublicKey(); + } + + return $publicKey; + } + + /** + * Get the first access date of a user in a tool. + * + * @param $courseCode + * @param $toolId + * @param $userId + * + * @return string + */ + public function getUserFirstAccessOnToolLp($courseCode, $toolId, $userId) + { + $dql = "SELECT + a.startDate + FROM ChamiloPluginBundle:LtiProvider\Result a + WHERE + a.courseCode = '$courseCode' AND + a.toolName = 'lp' AND + a.toolId = $toolId AND + a.userId = $userId + ORDER BY a.startDate"; + $qb = Database::getManager()->createQuery($dql); + $result = $qb->getArrayResult(); + + $firstDate = ''; + if (isset($result[0])) { + $startDate = $result[0]['startDate']; + $firstDate = $startDate->format('Y-m-d H:i'); + } + + return $firstDate; + } + + /** + * Get the results of users in tools lti. + * + * @param $startDate + * @param $endDate + * + * @return array + */ + public function getToolLearnPathResult($startDate, $endDate) + { + $dql = "SELECT + a.issuer, + count(DISTINCT(a.userId)) as cnt + FROM + ChamiloPluginBundle:LtiProvider\Result a + WHERE + a.toolName = 'lp' AND + a.startDate BETWEEN '$startDate' AND '$endDate' + GROUP BY a.issuer"; + $qb = Database::getManager()->createQuery($dql); + $issuersValues = $qb->getResult(); + + $result = []; + if (!empty($issuersValues)) { + foreach ($issuersValues as $issuerValue) { + $issuer = $issuerValue['issuer']; + $dqlLp = "SELECT + a.toolId, + a.userId, + a.courseCode + FROM + ChamiloPluginBundle:LtiProvider\Result a + WHERE + a.toolName = 'lp' AND + a.startDate BETWEEN '$startDate' AND '$endDate' AND + a.issuer = '".$issuer."' + GROUP BY a.toolId, a.userId"; + $qbLp = Database::getManager()->createQuery($dqlLp); + $lpValues = $qbLp->getResult(); + + $lps = []; + foreach ($lpValues as $lp) { + $uinfo = api_get_user_info($lp['userId']); + $firstAccess = self::getUserFirstAccessOnToolLp($lp['courseCode'], $lp['toolId'], $lp['userId']); + $lps[$lp['toolId']]['users'][$lp['userId']] = [ + 'firstname' => $uinfo['firstname'], + 'lastname' => $uinfo['lastname'], + 'first_access' => $firstAccess, + ]; + } + $result[] = [ + 'issuer' => $issuer, + 'count_iss_users' => $issuerValue['cnt'], + 'learnpaths' => $lps, + ]; + } + } + + return $result; + } + + /** + * Get the tool provider. + */ + public function getToolProvider($clientId): string + { + $toolProvider = ''; + $platform = Database::getManager() + ->getRepository('ChamiloPluginBundle:LtiProvider\Platform') + ->findOneBy(['clientId' => $clientId]); + + if ($platform) { + $toolProvider = $platform->getToolProvider(); + } + + return $toolProvider; + } + + public function getToolProviderVars($clientId): array + { + $toolProvider = $this->getToolProvider($clientId); + list($courseCode, $tool) = explode('@@', $toolProvider); + list($toolName, $toolId) = explode('-', $tool); + $vars = ['courseCode' => $courseCode, 'toolName' => $toolName, 'toolId' => $toolId]; + + return $vars; + } + + /** + * Get the class instance. + * + * @staticvar LtiProviderPlugin $result + */ + public static function create(): LtiProviderPlugin + { + static $result = null; + + return $result ?: $result = new self(); + } + + /** + * Check whether the current user is a teacher in this context. + */ + public static function isInstructor() + { + api_is_allowed_to_edit(false, true); + } + + /** + * Get the plugin directory name. + */ + public function get_name(): string + { + return 'lti_provider'; + } + + /** + * Install the plugin. Set the database up. + * + * @throws \Doctrine\ORM\Tools\ToolsException + */ + public function install() + { + $em = Database::getManager(); + + if ($em->getConnection()->getSchemaManager()->tablesExist([self::TABLE_PLATFORM])) { + return; + } + + $schemaTool = new SchemaTool($em); + $schemaTool->createSchema( + [ + $em->getClassMetadata(Platform::class), + $em->getClassMetadata(PlatformKey::class), + $em->getClassMetadata(Result::class), + ] + ); + } + + /** + * Save configuration for plugin. + * + * Generate a new key pair for platform when enabling plugin. + * + * @throws OptimisticLockException + * @throws \Doctrine\ORM\ORMException + * + * @return $this|Plugin + */ + public function performActionsAfterConfigure() + { + $em = Database::getManager(); + + /** @var PlatformKey $platformKey */ + $platformKey = $em + ->getRepository('ChamiloPluginBundle:LtiProvider\PlatformKey') + ->findOneBy([]); + + if ($this->get('enabled') === 'true') { + if (!$platformKey) { + $platformKey = new PlatformKey(); + } + + $keyPair = self::generatePlatformKeys(); + + $platformKey->setKid($keyPair['kid']); + $platformKey->publicKey = $keyPair['public']; + $platformKey->setPrivateKey($keyPair['private']); + + $em->persist($platformKey); + } else { + if ($platformKey) { + $em->remove($platformKey); + } + } + + $em->flush(); + + return $this; + } + + /** + * Unistall plugin. Clear the database. + */ + public function uninstall() + { + $em = Database::getManager(); + + if (!$em->getConnection()->getSchemaManager()->tablesExist([self::TABLE_PLATFORM])) { + return; + } + + $schemaTool = new SchemaTool($em); + $schemaTool->dropSchema( + [ + $em->getClassMetadata(Platform::class), + $em->getClassMetadata(PlatformKey::class), + $em->getClassMetadata(Result::class), + ] + ); + } + + public function trimParams(array &$params) + { + foreach ($params as $key => $value) { + $newValue = preg_replace('/\s+/', ' ', $value); + $params[$key] = trim($newValue); + } + } + + public function saveResult($values, $ltiLaunchId = null) + { + $em = Database::getManager(); + if (!empty($ltiLaunchId)) { + $repo = $em->getRepository(Result::class); + + /** @var Result $objResult */ + $objResult = $repo->findOneBy( + [ + 'ltiLaunchId' => $ltiLaunchId, + ] + ); + if ($objResult) { + $objResult->setScore($values['score']); + $objResult->setProgress($values['progress']); + $objResult->setDuration($values['duration']); + $em->persist($objResult); + $em->flush(); + + return $objResult->getId(); + } + } else { + $objResult = new Result(); + $objResult + ->setIssuer($values['issuer']) + ->setUserId($values['user_id']) + ->setClientUId($values['client_uid']) + ->setCourseCode($values['course_code']) + ->setToolId($values['tool_id']) + ->setToolName($values['tool_name']) + ->setScore(0) + ->setProgress(0) + ->setDuration(0) + ->setStartDate(new DateTime()) + ->setUserIp(api_get_real_ip()) + ->setLtiLaunchId($values['lti_launch_id']) + ; + $em->persist($objResult); + $em->flush(); + + return $objResult->getId(); + } + + return false; + } + + private function areTablesCreated(): bool + { + $entityManager = Database::getManager(); + $connection = $entityManager->getConnection(); + + return $connection->getSchemaManager()->tablesExist(self::TABLE_PLATFORM); + } + + /** + * Generate a key pair and key id for the platform. + * + * Return a associative array like ['kid' => '...', 'private' => '...', 'public' => '...']. + */ + private static function generatePlatformKeys(): array + { + // Create the private and public key + $res = openssl_pkey_new( + [ + 'digest_alg' => 'sha256', + 'private_key_bits' => 2048, + 'private_key_type' => OPENSSL_KEYTYPE_RSA, + ] + ); + + // Extract the private key from $res to $privateKey + $privateKey = ''; + openssl_pkey_export($res, $privateKey); + + // Extract the public key from $res to $publicKey + $publicKey = openssl_pkey_get_details($res); + + return [ + 'kid' => bin2hex(openssl_random_pseudo_bytes(10)), + 'private' => $privateKey, + 'public' => $publicKey["key"], + ]; + } + + /** + * Get a SimpleXMLElement object with the request received on php://input. + * + * @throws Exception + */ + private function getRequestXmlElement(): ?SimpleXMLElement + { + $request = file_get_contents("php://input"); + + if (empty($request)) { + return null; + } + + return new SimpleXMLElement($request); + } +} diff --git a/plugin/lti_provider/README.md b/plugin/lti_provider/README.md new file mode 100644 index 000000000..f78c61405 --- /dev/null +++ b/plugin/lti_provider/README.md @@ -0,0 +1,84 @@ +Lti/Provider plugin +=== + +Version 1.0 + +> This plugin is meant to be later integrated into Chamilo (in a major version +release). + +The LTI provider feature is only compatible with LTI 1.3 Advantage, and demonstrates the possibility to integrate tools or content from Chamilo into other LMS platforms. +In this case, Chamilo is used as provider , and this plugin allows a student inside a course to play in a breakout game with certain difficulty options (Deep Linkings) which is scored (Assigment and Grade Services) and compared with the other members of the course (NRP Services). + +# Installation + +*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.* + +1. Install the plugin from the Plugins page +2. Enable the plugin from the Lti Provider Plugin Settings page +3. Assign to the Administrator region (will appear on the management page) +4. Add the LTI connection details to try out the little demo app (Configuration page) +5. Configure the LMS platforms for registration and deployment + +To be able to acces LTI content from a different domain in an iframe, the hosting provider will have to enable it by activating this configuration in the app/config/configuration.php file : +``` +// Enable samesite:None parameter for session cookie. +// More info: https://www.chromium.org/updates/same-site +// Also: https://developers.google.com/search/blog/2020/01/get-ready-for-new-samesitenone-secure +$_configuration['security_session_cookie_samesite_none'] = true; +``` + +# DB tables + +These tables are normally created during the activation of the plugin. They are mentioned here for practical purposes. +Note: "kid" means "Key ID", not "child". + +## v1.0 +```sql +CREATE TABLE plugin_lti_provider_platform ( + id int NOT NULL AUTO_INCREMENT, + issuer varchar(255) NOT NULL, + client_id varchar(255) NOT NULL, + kid int(255) NOT NULL, + auth_login_url varchar(255) NOT NULL, + auth_token_url varchar(255) NOT NULL, + key_set_url varchar(255) NOT NULL, + deployment_id varchar(255) NOT NULL, + tool_provider varchar(255) NULL, + PRIMARY KEY(id) +) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB; + +CREATE TABLE plugin_lti_provider_platform_key ( + id INT AUTO_INCREMENT NOT NULL, + kid VARCHAR(255) NOT NULL, + public_key LONGTEXT NOT NULL, + private_key LONGTEXT NOT NULL, + PRIMARY KEY(id) +) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB; + +CREATE TABLE plugin_lti_provider_result ( + id int(11) NOT NULL AUTO_INCREMENT, + issuer longtext NOT NULL, + user_id int(11) NOT NULL, + client_uid int(11) NOT NULL, + course_code varchar(40) NOT NULL, + tool_id int(11) NOT NULL, + tool_name varchar(255) NOT NULL, + score double NOT NULL, + progress int(11) NOT NULL, + duration int(11) NOT NULL, + start_date datetime NOT NULL, + user_ip varchar(255) NOT NULL, + lti_launch_id varchar(255) NOT NULL, + PRIMARY KEY (id) +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci; +``` + +## v1.1 +### Database changes +You need to execute this SQL query in your database after updating your Chamilo after version 1.11.18 if the plugin was already installed before. + +```sql +ALTER TABLE plugin_lti_provider_result MODIFY client_uid varchar(255) NOT NULL; +``` + diff --git a/plugin/lti_provider/admin.php b/plugin/lti_provider/admin.php new file mode 100644 index 000000000..26dc799be --- /dev/null +++ b/plugin/lti_provider/admin.php @@ -0,0 +1,34 @@ +get('enabled') !== 'true') { + api_not_allowed(true); +} + +$em = Database::getManager(); + +$platforms = $em->getRepository('ChamiloPluginBundle:LtiProvider\Platform')->findAll(); + +$interbreadcrumb[] = ['url' => api_get_path(WEB_CODE_PATH).'admin/index.php', 'name' => get_lang('PlatformAdmin')]; + +$htmlHeadXtra[] = api_get_css( + api_get_path(WEB_PLUGIN_PATH).'lti_provider/assets/style.css' +); + +$template = new Template($plugin->get_title()); +$template->assign('platforms', $platforms); + +$content = $template->fetch('lti_provider/view/provider_admin.tpl'); + +$template->assign('header', $plugin->get_title()); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/lti_provider/create.php b/plugin/lti_provider/create.php new file mode 100644 index 000000000..2eaa34db4 --- /dev/null +++ b/plugin/lti_provider/create.php @@ -0,0 +1,59 @@ +build(); + +if ($form->validate()) { + $formValues = $form->exportValues(); + $platform = new Platform(); + $platform->setIssuer($formValues['issuer']); + $platform->setClientId($formValues['client_id']); + $platform->setAuthLoginUrl($formValues['auth_login_url']); + $platform->setAuthTokenUrl($formValues['auth_token_url']); + $platform->setKeySetUrl($formValues['key_set_url']); + $platform->setDeploymentId($formValues['deployment_id']); + $platform->setKid($formValues['kid']); + $toolProvider = (isset($formValues['tool_provider']) ? $formValues['tool_provider'] : $_POST['tool_provider']); + $platform->setToolProvider($toolProvider); + + $em->persist($platform); + $em->flush(); + + Display::addFlash( + Display::return_message($plugin->get_lang('PlatformConnectionAdded'), 'success') + ); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'lti_provider/admin.php'); + exit; +} + +$form->setDefaultValues(); + +$interbreadcrumb[] = ['url' => api_get_path(WEB_CODE_PATH).'admin/index.php', 'name' => get_lang('PlatformAdmin')]; +$interbreadcrumb[] = ['url' => api_get_path(WEB_PLUGIN_PATH).'lti_provider/admin.php', 'name' => $plugin->get_title()]; + +$pageTitle = $plugin->get_lang('AddPlatform'); + +$template = new Template($pageTitle); +$template->assign('form', $form->returnForm()); + +$content = $template->fetch('lti_provider/view/add.tpl'); + +$template->assign('header', $pageTitle); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/lti_provider/db/lti13_cache.php b/plugin/lti_provider/db/lti13_cache.php new file mode 100644 index 000000000..49233b477 --- /dev/null +++ b/plugin/lti_provider/db/lti13_cache.php @@ -0,0 +1,59 @@ +loadCache(); + + return $this->cache[$key]; + } + + public function cacheLaunchData($key, $jwtBody): Lti13Cache + { + $this->cache[$key] = $jwtBody; + $this->saveCache(); + + return $this; + } + + public function cacheNonce($nonce): Lti13Cache + { + $this->cache['nonce'][$nonce] = true; + $this->saveCache(); + + return $this; + } + + public function checkNonce($nonce): bool + { + $this->loadCache(); + if (!isset($this->cache['nonce'][$nonce])) { + return false; + } + + return true; + } + + private function loadCache() + { + $cache = file_get_contents(api_get_path(SYS_ARCHIVE_PATH).'lti_cache.txt'); + if (empty($cache)) { + file_put_contents(api_get_path(SYS_ARCHIVE_PATH).'lti_cache.txt', '{}'); + $this->cache = []; + } + $this->cache = json_decode($cache, true); + } + + private function saveCache() + { + file_put_contents(api_get_path(SYS_ARCHIVE_PATH).'lti_cache.txt', json_encode($this->cache)); + } +} diff --git a/plugin/lti_provider/db/lti13_cookie.php b/plugin/lti_provider/db/lti13_cookie.php new file mode 100644 index 000000000..6b5afc700 --- /dev/null +++ b/plugin/lti_provider/db/lti13_cookie.php @@ -0,0 +1,45 @@ + time() + $exp, + ]; + + // SameSite none and secure will be required for tools to work inside iframes + $sameSiteOptions = [ + 'samesite' => 'None', + 'secure' => false, + 'httponly' => true, + ]; + + setcookie($name, $value, array_merge($cookieOptions, $sameSiteOptions, $options)); + + // Set a second fallback cookie in the event that "SameSite" is not supported + setcookie("LEGACY_".$name, $value, array_merge($cookieOptions, $options)); + + return $this; + } +} diff --git a/plugin/lti_provider/db/lti13_database.php b/plugin/lti_provider/db/lti13_database.php new file mode 100644 index 000000000..0ba0c3792 --- /dev/null +++ b/plugin/lti_provider/db/lti13_database.php @@ -0,0 +1,91 @@ +getClientIdByIssuer($iss); + } + + $ltiCustomers = $this->getLtiConnection(); + if (empty($ltiCustomers[$clientId])) { + return false; + } + + return LtiRegistration::new() + ->setAuthLoginUrl($ltiCustomers[$clientId]['auth_login_url']) + ->setAuthTokenUrl($ltiCustomers[$clientId]['auth_token_url']) + ->setClientId($clientId) + ->setKeySetUrl($ltiCustomers[$clientId]['key_set_url']) + ->setKid($ltiCustomers[$clientId]['kid']) + ->setIssuer($iss) + ->setToolPrivateKey($this->getPrivateKey()); + } + + public function findDeployment($iss, $deploymentId, $clientId = null) + { + $issSession = Session::read('iss'); + if (!in_array($deploymentId, $issSession[$clientId]['deployment'])) { + return false; + } + + return LtiDeployment::new()->setDeploymentId($deploymentId); + } + + private function getLtiConnection(): array + { + $em = Database::getManager(); + $platforms = $em->getRepository('ChamiloPluginBundle:LtiProvider\Platform')->findAll(); + + $ltiCustomers = []; + foreach ($platforms as $platform) { + $clientId = $platform->getClientId(); + $ltiCustomers[$clientId] = [ + 'client_id' => $clientId, + 'issuer' => $platform->getIssuer(), + 'auth_login_url' => $platform->getAuthLoginUrl(), + 'auth_token_url' => $platform->getAuthTokenUrl(), + 'key_set_url' => $platform->getKeySetUrl(), + 'kid' => $platform->getKid(), + 'deployment' => [$platform->getDeploymentId()], + ]; + } + Session::write('iss', $ltiCustomers); + + return $ltiCustomers; + } + + private function getClientIdByIssuer($issuer) + { + $clientId = ''; + $platform = Database::getManager() + ->getRepository('ChamiloPluginBundle:LtiProvider\Platform') + ->findOneBy(['issuer' => $issuer]); + + if ($platform) { + $clientId = $platform->getClientId(); + } + + return $clientId; + } + + private function getPrivateKey() + { + $privateKey = ''; + $platformKey = Database::getManager() + ->getRepository('ChamiloPluginBundle:LtiProvider\PlatformKey') + ->findOneBy([]); + if ($platformKey) { + $privateKey = $platformKey->getPrivateKey(); + } + + return $privateKey; + } +} diff --git a/plugin/lti_provider/delete.php b/plugin/lti_provider/delete.php new file mode 100644 index 000000000..a8cfff1b8 --- /dev/null +++ b/plugin/lti_provider/delete.php @@ -0,0 +1,32 @@ +find('ChamiloPluginBundle:LtiProvider\Platform', $platformId); + +$em->remove($platform); +$em->flush(); + +Display::addFlash( + Display::return_message($plugin->get_lang('PlatformDeleted'), 'success') +); + +header('Location: '.api_get_path(WEB_PLUGIN_PATH).'lti_provider/admin.php'); +exit; diff --git a/plugin/lti_provider/edit.php b/plugin/lti_provider/edit.php new file mode 100644 index 000000000..bfaf94ff7 --- /dev/null +++ b/plugin/lti_provider/edit.php @@ -0,0 +1,73 @@ +find('ChamiloPluginBundle:LtiProvider\Platform', $platformId); + +if (!$platform) { + Display::addFlash( + Display::return_message($plugin->get_lang('NoPlatform'), 'error') + ); + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'lti_provider/admin.php'); + exit; +} + +$form = new FrmEdit('lti_provider_edit_platform', [], $platform); +$form->build(); + +if ($form->validate()) { + $formValues = $form->exportValues(); + $platform->setIssuer($formValues['issuer']); + $platform->setClientId($formValues['client_id']); + $platform->setAuthLoginUrl($formValues['auth_login_url']); + $platform->setAuthTokenUrl($formValues['auth_token_url']); + $platform->setKeySetUrl($formValues['key_set_url']); + $platform->setDeploymentId($formValues['deployment_id']); + $platform->setKid($formValues['kid']); + $toolProvider = (isset($formValues['tool_provider']) ? $formValues['tool_provider'] : $_POST['tool_provider']); + $platform->setToolProvider($toolProvider); + + $em->persist($platform); + $em->flush(); + + Display::addFlash( + Display::return_message($plugin->get_lang('PlatformEdited'), 'success') + ); + + header('Location: '.api_get_path(WEB_PLUGIN_PATH).'lti_provider/admin.php'); + exit; +} else { + $form->setDefaultValues(); +} + +$interbreadcrumb[] = ['url' => api_get_path(WEB_CODE_PATH).'admin/index.php', 'name' => get_lang('PlatformAdmin')]; +$interbreadcrumb[] = ['url' => api_get_path(WEB_PLUGIN_PATH).'lti_provider/admin.php', 'name' => $plugin->get_title()]; + +$template = new Template($plugin->get_lang('EditPlatform')); +$template->assign('form', $form->returnForm()); + +$content = $template->fetch('lti_provider/view/add.tpl'); + +$template->assign('header', $plugin->get_title()); +$template->assign('content', $content); +$template->display_one_col_template(); diff --git a/plugin/lti_provider/install.php b/plugin/lti_provider/install.php new file mode 100644 index 000000000..25256c7f9 --- /dev/null +++ b/plugin/lti_provider/install.php @@ -0,0 +1,16 @@ +install(); diff --git a/plugin/lti_provider/lang/english.php b/plugin/lti_provider/lang/english.php new file mode 100644 index 000000000..9856a3307 --- /dev/null +++ b/plugin/lti_provider/lang/english.php @@ -0,0 +1,34 @@ +get_info(); diff --git a/plugin/lti_provider/provider_settings.php b/plugin/lti_provider/provider_settings.php new file mode 100644 index 000000000..c9679aff4 --- /dev/null +++ b/plugin/lti_provider/provider_settings.php @@ -0,0 +1,61 @@ +' + .'
    '.$plugin->get_lang('LaunchUrl').'
    ' + .'
    '.$launchUrl.'
    ' + .'
    ' + .'
    ' + .'
    '.$plugin->get_lang('LoginUrl').'
    ' + .'
    '.$loginUrl.'
    ' + .'
    ' + .'
    ' + .'
    '.$plugin->get_lang('RedirectUrl').'
    ' + .'
    '.$redirectUrl.'
    ' + .'
    ' + .'
    ' + .'
    '.$plugin->get_lang('KeySetUrlJwks').'
    ' + .'
    '.$jwksUrl.'
    ' + .'
    '; + + $response->setContent($html); +} catch (Exception $exception) { + $response->setContent( + Display::return_message($exception->getMessage(), 'error') + ); +} + +$response->send(); diff --git a/plugin/lti_provider/src/Form/FrmAdd.php b/plugin/lti_provider/src/Form/FrmAdd.php new file mode 100644 index 000000000..8bc095c40 --- /dev/null +++ b/plugin/lti_provider/src/Form/FrmAdd.php @@ -0,0 +1,88 @@ +platform = $platform; + } + + /** + * Build the form. + */ + public function build(): void + { + $plugin = LtiProviderPlugin::create(); + + $this->addHeader($plugin->get_lang('ConnectionDetails')); + + $this->addText('issuer', $plugin->get_lang('PlatformName')); + $this->addUrl('auth_login_url', $plugin->get_lang('AuthLoginUrl')); + $this->addUrl('auth_token_url', $plugin->get_lang('AuthTokenUrl')); + $this->addUrl('key_set_url', $plugin->get_lang('KeySetUrl')); + $this->addText('client_id', $plugin->get_lang('ClientId')); + $this->addText('deployment_id', $plugin->get_lang('DeploymentId')); + $this->addText('kid', $plugin->get_lang('KeyId'), false); + + $this->addRadio( + 'tool_type', + get_lang('ToolProvider'), + [ + 'quiz' => $plugin->get_lang('Quizzes'), + 'lp' => $plugin->get_lang('Learnpaths'), + ], + [ + 'onclick' => 'selectToolProvider(this.value)', + ] + ); + + $this->addElement('html', $plugin->getLearnPathsSelect()); + $this->addElement('html', $plugin->getQuizzesSelect()); + + $this->addButtonCreate($plugin->get_lang('AddPlatform')); + $this->applyFilter('__ALL__', 'trim'); + } + + public function setDefaultValues(): void + { + $defaults = []; + + if (!$this->platform) { + $this->platform = new Platform(); + } + + $defaults['issuer'] = $this->platform->getIssuer(); + $defaults['auth_login_url'] = $this->platform->getAuthLoginUrl(); + $defaults['auth_token_url'] = $this->platform->getAuthTokenUrl(); + $defaults['key_set_url'] = $this->platform->getKeySetUrl(); + $defaults['client_id'] = $this->platform->getClientId(); + $defaults['deployment_id'] = $this->platform->getDeploymentId(); + $defaults['kid'] = $this->platform->getKid(); + $defaults['tool_type'] = 'quiz'; + + $this->setDefaults($defaults); + } +} diff --git a/plugin/lti_provider/src/Form/FrmEdit.php b/plugin/lti_provider/src/Form/FrmEdit.php new file mode 100644 index 000000000..57a583ea1 --- /dev/null +++ b/plugin/lti_provider/src/Form/FrmEdit.php @@ -0,0 +1,94 @@ +platform = $platform; + } + + /** + * Build the form. + */ + public function build() + { + $plugin = LtiProviderPlugin::create(); + $this->addHeader($plugin->get_lang('ConnectionDetails')); + + $this->addText('issuer', $plugin->get_lang('PlatformName')); + $this->addUrl('auth_login_url', $plugin->get_lang('AuthLoginUrl')); + $this->addUrl('auth_token_url', $plugin->get_lang('AuthTokenUrl')); + $this->addUrl('key_set_url', $plugin->get_lang('KeySetUrl')); + $this->addText('client_id', $plugin->get_lang('ClientId')); + $this->addText('deployment_id', $plugin->get_lang('DeploymentId')); + $this->addText('kid', $plugin->get_lang('KeyId'), false); + + $this->addRadio( + 'tool_type', + get_lang('ToolProvider'), + [ + 'quiz' => $plugin->get_lang('Quizzes'), + 'lp' => $plugin->get_lang('Learnpaths'), + ], + [ + 'onclick' => 'selectToolProvider(this.value)', + ] + ); + + $this->addElement('html', $plugin->getLearnPathsSelect($this->platform->getClientId())); + $this->addElement('html', $plugin->getQuizzesSelect($this->platform->getClientId())); + + $this->addButtonCreate($plugin->get_lang('EditPlatform')); + $this->addHidden('id', $this->platform->getId()); + $this->addHidden('action', 'edit'); + $this->applyFilter('__ALL__', 'trim'); + } + + /** + * @throws Exception + */ + public function setDefaultValues(): void + { + $defaults = []; + $defaults['issuer'] = $this->platform->getIssuer(); + $defaults['auth_login_url'] = $this->platform->getAuthLoginUrl(); + $defaults['auth_token_url'] = $this->platform->getAuthTokenUrl(); + $defaults['key_set_url'] = $this->platform->getKeySetUrl(); + $defaults['client_id'] = $this->platform->getClientId(); + $defaults['deployment_id'] = $this->platform->getDeploymentId(); + $defaults['kid'] = $this->platform->getKid(); + + $toolProvider = $this->platform->getToolProvider(); + list($courseCode, $tool) = explode('@@', $toolProvider); + list($toolName, $toolId) = explode('-', $tool); + + $defaults['tool_type'] = $toolName; + $defaults['tool_provider'] = $toolProvider; + + $this->setDefaults($defaults); + } +} diff --git a/plugin/lti_provider/src/LtiProvider.php b/plugin/lti_provider/src/LtiProvider.php new file mode 100644 index 000000000..dd77548c1 --- /dev/null +++ b/plugin/lti_provider/src/LtiProvider.php @@ -0,0 +1,170 @@ +doOidcLoginRedirect($launchUrl, $request) + ->doRedirect(); + } + + /** + * It removes user and oLP session. + */ + public function logout(string $toolName = '') + { + Session::erase('_user'); + Session::erase('is_platformAdmin'); + Session::erase('is_allowedCreateCourse'); + Session::erase('_uid'); + if ('lp' == $toolName) { + // Deleting the objects + Session::erase('oLP'); + Session::erase('lpobject'); + Session::erase('scorm_view_id'); + Session::erase('scorm_item_id'); + Session::erase('exerciseResult'); + Session::erase('objExercise'); + Session::erase('questionList'); + } + Session::erase('is_allowed_in_course'); + Session::erase('_real_cid'); + Session::erase('_cid'); + Session::erase('_course'); + } + + /** + * Lti Message Launch. + */ + public function launch(bool $fromCache = false, ?string $launchId = null): LtiMessageLaunch + { + if ($fromCache) { + $launch = LtiMessageLaunch::fromCache($launchId, new Lti13Database(), new Lti13Cache()); + } else { + $launch = LtiMessageLaunch::new(new Lti13Database(), new Lti13Cache(), new Lti13Cookie())->validate(); + } + + return $launch; + } + + /** + * Verify if user is in the provider platform to create it and login (true) or not (false). + */ + public function validateUser(array $launchData, string $courseCode, string $toolName): bool + { + if (empty($launchData)) { + return false; + } + + $authSource = IMS_LTI_SOURCE; + $username = md5($launchData['iss'].'_'.$launchData['sub']); + $userInfo = api_get_user_info_from_username($username, $authSource); + if (empty($userInfo)) { + $email = $username.'@'.$authSource.'.com'; + if (!empty($launchData['email'])) { + $email = $launchData['email']; + } + $firstName = $launchData['aud']; + if (!empty($launchData['given_name'])) { + $firstName = $launchData['given_name']; + } + $lastName = $launchData['sub']; + if (!empty($launchData['family_name'])) { + $lastName = $launchData['family_name']; + } + $password = api_generate_password(); + $userId = UserManager::create_user( + $firstName, + $lastName, + STUDENT, + $email, + $username, + $password, + '', + '', + '', + '', + $authSource + ); + } else { + $userId = $userInfo['user_id']; + } + + if (!CourseManager::is_user_subscribed_in_course($userId, $courseCode)) { + CourseManager::subscribeUser($userId, $courseCode); + } + + $this->logout($toolName); + + $login = UserManager::loginAsUser($userId, false); + if ($login && CourseManager::is_user_subscribed_in_course($userId, $courseCode)) { + $_course = api_get_course_info($courseCode); + Session::write('is_allowed_in_course', true); + Session::write('_real_cid', $_course['real_id']); + Session::write('_cid', $_course['code']); + Session::write('_course', $_course); + } + + return $login; + } + + /** + * It checks if request is from lti customer. + * + * @param $request + * @param $session + * + * @return bool + */ + public function isLtiRequest($request, $session) + { + $isLti = false; + if (isset($request['lti_message_hint'])) { + $isLti = true; + } elseif (isset($request['state'])) { + $isLti = true; + } elseif (isset($request['lti_launch_id']) && 'learnpath' === api_get_origin()) { + $isLti = true; + } elseif (isset($request['lti_launch_id'])) { + $isLti = true; + } elseif (isset($session['oLP']->lti_launch_id)) { + $isLti = true; + } + + return $isLti; + } +} diff --git a/plugin/lti_provider/tool/api/score.php b/plugin/lti_provider/tool/api/score.php new file mode 100644 index 000000000..a84e44906 --- /dev/null +++ b/plugin/lti_provider/tool/api/score.php @@ -0,0 +1,61 @@ +launch(true, $_REQUEST['launch_id']); + +if (!$launch->hasAgs()) { + throw new Exception("Don't have grades!"); +} + +if (!isset($_REQUEST['lti_result_id'])) { + throw new Exception("Any tool result"); +} + +$launchData = $launch->getLaunchData(); + +$courseCode = $_REQUEST['cidReq']; +$courseId = api_get_course_int_id($courseCode); +$toolName = $_REQUEST['lti_tool']; + +if (in_array($toolName, ['quiz', 'lp'])) { + if ('quiz' == $toolName) { + $objExercise = new Exercise($courseId); + $trackInfo = $objExercise->get_stat_track_exercise_info_by_exe_id($_REQUEST['lti_result_id']); + $score = $trackInfo['exe_result']; + $weight = $trackInfo['exe_weighting']; + $timestamp = date(DATE_ISO8601); + } else { + $lpId = (int) $_REQUEST['lti_result_id']; + $lpProgress = learnpath::getProgress( + $lpId, + api_get_user_id(), + api_get_course_int_id(), + api_get_session_id() + ); + $score = $lpProgress; + $weight = 100; + $timestamp = date(DATE_ISO8601); + } + + $grades = $launch->getAgs(); + $scoreGrade = Packback\Lti1p3\LtiGrade::new() + ->setScoreGiven($score) + ->setScoreMaximum($weight) + ->setTimestamp($timestamp) + ->setActivityProgress('Completed') + ->setGradingProgress('FullyGraded') + ->setUserId($launchData['sub']); + $grades->putGrade($scoreGrade); + + $plugin = LtiProviderPlugin::create(); + $values = []; + $values['score'] = $score; + $values['progress'] = 0; + $values['duration'] = 0; + $plugin->saveResult($values, $_REQUEST['launch_id']); + + echo '{"success" : true}'; +} diff --git a/plugin/lti_provider/tool/jwks.php b/plugin/lti_provider/tool/jwks.php new file mode 100644 index 000000000..d582eee39 --- /dev/null +++ b/plugin/lti_provider/tool/jwks.php @@ -0,0 +1,49 @@ +get('enabled')) { + exit; +} + +/** @var PlatformKey $platformKey */ +$platformKey = Database::getManager() + ->getRepository('ChamiloPluginBundle:LtiProvider\PlatformKey') + ->findOneBy([]); + +if (!$platformKey) { + exit; +} + +$privateKey = $platformKey->getPrivateKey(); + +$jwks = []; + +$key = new RSA(); +$key->setHash('sha256'); +$key->loadKey($platformKey->getPrivateKey()); +$key->setPublicKey(false, RSA::PUBLIC_FORMAT_PKCS8); + +if ($key->publicExponent) { + $jwks = [ + 'kty' => 'RSA', + 'alg' => 'RS256', + 'use' => 'sig', + 'e' => JWT::urlsafeB64Encode($key->publicExponent->toBytes()), + 'n' => JWT::urlsafeB64Encode($key->modulus->toBytes()), + 'kid' => $platformKey->getKid(), + ]; +} + +header('Content-Type: application/json'); + +echo json_encode(['keys' => [$jwks]]); diff --git a/plugin/lti_provider/tool/login.php b/plugin/lti_provider/tool/login.php new file mode 100644 index 000000000..6b431593a --- /dev/null +++ b/plugin/lti_provider/tool/login.php @@ -0,0 +1,7 @@ +login($_REQUEST); diff --git a/plugin/lti_provider/tool/logout.php b/plugin/lti_provider/tool/logout.php new file mode 100644 index 000000000..63a39f56d --- /dev/null +++ b/plugin/lti_provider/tool/logout.php @@ -0,0 +1,10 @@ +logout(); +header('Location: '.api_get_path(WEB_PATH)); +exit; diff --git a/plugin/lti_provider/tool/start.php b/plugin/lti_provider/tool/start.php new file mode 100644 index 000000000..32b7f0edb --- /dev/null +++ b/plugin/lti_provider/tool/start.php @@ -0,0 +1,44 @@ +launch(); +if (!$launch->hasNrps()) { + // throw new Exception("Don't have names and roles!"); +} + +$launchData = $launch->getLaunchData(); + +$plugin = LtiProviderPlugin::create(); +$toolVars = $plugin->getToolProviderVars($launchData['aud']); + +$login = LtiProvider::create()->validateUser($launchData, $toolVars['courseCode'], $toolVars['toolName']); +$ltiSession = []; +if ($login) { + $values = []; + $values['issuer'] = $launchData['iss']; + $values['user_id'] = api_get_user_id(); + $values['client_uid'] = $launchData['sub']; + $values['course_code'] = $toolVars['courseCode']; + $values['tool_id'] = $toolVars['toolId']; + $values['tool_name'] = $toolVars['toolName']; + $values['lti_launch_id'] = $launch->getLaunchId(); + $plugin->saveResult($values); + $ltiSession = $values; +} + +$cidReq = 'cidReq='.$toolVars['courseCode'].'&id_session=0&gidReq=0&gradebook=0'; + +if ('lp' == $toolVars['toolName']) { + $launchUrl = api_get_path(WEB_CODE_PATH).'lp/lp_controller.php?'.$cidReq.'&action=view&lp_id='.$toolVars['toolId'].'&isStudentView=true<i_launch_id='.$launch->getLaunchId(); +} else { + $launchUrl = api_get_path(WEB_CODE_PATH).'exercise/overview.php?'.$cidReq.'&origin=embeddable&exerciseId='.$toolVars['toolId'].'<i_launch_id='.$launch->getLaunchId(); +} +$ltiSession['launch_url'] = $launchUrl; +Session::write('_ltiProvider', $ltiSession); +header('Location: '.$launchUrl); +exit; diff --git a/plugin/lti_provider/uninstall.php b/plugin/lti_provider/uninstall.php new file mode 100644 index 000000000..e84a040f3 --- /dev/null +++ b/plugin/lti_provider/uninstall.php @@ -0,0 +1,16 @@ +uninstall(); diff --git a/plugin/lti_provider/view/add.tpl b/plugin/lti_provider/view/add.tpl new file mode 100644 index 000000000..30c37490b --- /dev/null +++ b/plugin/lti_provider/view/add.tpl @@ -0,0 +1,19 @@ +
    +
    + {{ form }} +
    +
    + diff --git a/plugin/lti_provider/view/provider_admin.tpl b/plugin/lti_provider/view/provider_admin.tpl new file mode 100644 index 000000000..acaffc00d --- /dev/null +++ b/plugin/lti_provider/view/provider_admin.tpl @@ -0,0 +1,52 @@ + +{{ 'LtiProviderDescription'|get_plugin_lang('LtiProviderPlugin') }} + + +
    + + {{ 'ConnectionDetails'|get_plugin_lang('LtiProviderPlugin') }} + + + {{ 'AddPlatform'|get_plugin_lang('LtiProviderPlugin') }} + +
    +
    + + + + + + + + + + + + + {% for platform in platforms %} + {% set url_params = {'id': platform.getId}|url_encode() %} + + + + + + + + + {% endfor %} + + +
    {{ 'PlatformName'|get_plugin_lang('LtiProviderPlugin') }}{{ 'ClientId'|get_plugin_lang('LtiProviderPlugin') }}{{ 'DeploymentId'|get_plugin_lang('LtiProviderPlugin') }}{{ 'URLs'|get_plugin_lang('LtiProviderPlugin') }}{{ 'ToolProvider'|get_plugin_lang('LtiProviderPlugin') }}{{ 'Actions'|get_lang }}
    {{ platform.getIssuer }}{{ platform.getClientId }}{{ platform.getDeploymentId }} +

    {{ 'AuthLoginUrl'|get_plugin_lang('LtiProviderPlugin') }}:
    {{ platform.getAuthLoginUrl }}

    +

    {{ 'AuthTokenUrl'|get_plugin_lang('LtiProviderPlugin') }}:
    {{ platform.getAuthTokenUrl }}

    +

    {{ 'KeySetUrl'|get_plugin_lang('LtiProviderPlugin') }}:
    {{ platform.getKeySetUrl }}

    +     		{{ platform.getToolProvider }} + + {{ 'edit.png'|img(22, 'Edit'|get_lang) }} + + + {{ 'delete.png'|img(22, 'Delete'|get_lang) }} + +
    +
    + diff --git a/plugin/maintenancemode/MaintenanceModePlugin.php b/plugin/maintenancemode/MaintenanceModePlugin.php new file mode 100644 index 000000000..1b8d5ee95 --- /dev/null +++ b/plugin/maintenancemode/MaintenanceModePlugin.php @@ -0,0 +1,32 @@ + 'boolean', + ] + ); + } + + /** + * @return $this + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } +} diff --git a/plugin/maintenancemode/README.md b/plugin/maintenancemode/README.md new file mode 100644 index 000000000..c00e87643 --- /dev/null +++ b/plugin/maintenancemode/README.md @@ -0,0 +1,9 @@ +Maintenance Mode plugin +=== + +This plugin allows administrators to set the portal in maintenance mode through the change of the .htaccess file located +in the root folder of Chamilo. + +As such, it requires the web server (user www-data, httpd or nobody) to temporarily have write access to the .htaccess +file. Maintaining write access on this file is a security vulnerability, so please only set those permissions for the +required time to put your site in maintenance mode, and then return them to non-writable by the web server. \ No newline at end of file diff --git a/plugin/maintenancemode/index.php b/plugin/maintenancemode/index.php new file mode 100644 index 000000000..b3d9bbc7f --- /dev/null +++ b/plugin/maintenancemode/index.php @@ -0,0 +1 @@ +get_info(); + +$isPlatformAdmin = api_is_platform_admin(); +$editFile = false; + +$file = api_get_path(SYS_PATH).'.htaccess'; +$maintenanceHtml = api_get_path(SYS_PATH).'maintenance.html'; + +if ($plugin->isEnabled() && $isPlatformAdmin) { + if (!file_exists($file)) { + Display::addFlash( + Display::return_message( + "$file does not exists. ", + 'warning' + ) + ); + } else { + if (is_readable($file) && is_writable($file)) { + $editFile = true; + } else { + if (!is_readable($file)) { + Display::addFlash( + Display::return_message("$file is not readable", 'warning') + ); + } + + if (!is_writable($file)) { + Display::addFlash( + Display::return_message("$file is not writable", 'warning') + ); + } + } + } +} + +if ($editFile && $isPlatformAdmin) { + $originalContent = file_get_contents($file); + $beginLine = '###@@ This part was generated by the edit_htaccess plugin @@##'; + $endLine = '###@@ End @@##'; + + $handler = fopen($file, 'r'); + $deleteLinesList = []; + $deleteLine = false; + $contentNoBlock = ''; + $block = ''; + while (!feof($handler)) { + $line = fgets($handler); + $lineTrimmed = trim($line); + + if ($lineTrimmed == $beginLine) { + $deleteLine = true; + } + + if ($deleteLine) { + $block .= $line; + } else { + $contentNoBlock .= $line; + } + + if ($lineTrimmed == $endLine) { + $deleteLine = false; + } + } + + fclose($handler); + $block = str_replace($beginLine, '', $block); + $block = str_replace($endLine, '', $block); + + $form = new FormValidator('htaccess'); + $form->addHtml($plugin->get_lang('TheFollowingTextWillBeAddedToHtaccess')); + $element = $form->addText( + 'ip', + [$plugin->get_lang('IPAdmin'), $plugin->get_lang('IPAdminDescription')] + ); + $element->freeze(); + $form->addTextarea('text', 'htaccess', ['rows' => '15']); + + $config = [ + 'ToolbarSet' => 'Documents', + 'Width' => '100%', + 'Height' => '400', + 'allowedContent' => true, + ]; + + $form->addHtmlEditor( + 'maintenance', + 'Maintenance', + true, + true, + $config + ); + + $form->addCheckBox('active', null, get_lang('Active')); + + $form->addButtonSave(get_lang('Save')); + $content = ''; + if (file_exists($maintenanceHtml)) { + $content = file_get_contents($maintenanceHtml); + } + if (empty($content)) { + $content = ''; + } + + $isActive = api_get_plugin_setting('maintenancemode', 'active'); + + $ip = api_get_real_ip(); + if ($ip == '::1') { + $ip = '127.0.0.1'; + } + $ipSubList = explode('.', $ip); + $implode = implode('\.', $ipSubList); + $append = api_get_configuration_value('url_append'); + + $default = ' +RewriteCond %{REQUEST_URI} !'.$append.'/maintenance.html$ +RewriteCond %{REMOTE_ADDR} !^'.$implode.' +RewriteRule ^\.*$ '.$append.'/maintenance.html [R=302,L] +'; + if (empty($block)) { + $block = $default; + } + + $form->setDefaults([ + 'text' => $block, + 'maintenance' => $content, + 'ip' => $ip, + 'active' => $isActive, + ]); + + if ($form->validate()) { + $values = $form->getSubmitValues(); + $text = $values['text']; + $active = isset($values['active']) ? true : false; + $content = $values['maintenance']; + + // Restore htaccess with out the block + $newFileContent = $beginLine.PHP_EOL; + $newFileContent .= trim($text).PHP_EOL; + $newFileContent .= $endLine; + $newFileContent .= PHP_EOL; + $newFileContent .= $contentNoBlock; + // Remove ^m chars + $newFileContent = str_ireplace("\x0D", '', $newFileContent); + file_put_contents($file, $newFileContent); + + $handle = curl_init(api_get_path(WEB_PATH)); + curl_setopt($handle, CURLOPT_RETURNTRANSFER, true); + $response = curl_exec($handle); + $httpCode = curl_getinfo($handle, CURLINFO_HTTP_CODE); + curl_close($handle); + + $statusOkList = [ + 200, + 301, + 302, + ]; + + if (in_array($httpCode, $statusOkList)) { + $result = file_put_contents($maintenanceHtml, $content); + if ($result === false) { + Display::addFlash( + Display::return_message( + sprintf($plugin->get_lang('MaintenanceFileNotPresent'), $maintenanceHtml), + 'warning' + ) + ); + } + } else { + // Looks htaccess contains errors. Restore as it was. + Display::addFlash( + Display::return_message( + 'Check your htaccess instructions. The original file was restored.', + 'warning' + ) + ); + $originalContent = str_replace("\x0D", '', $originalContent); + file_put_contents($file, $originalContent); + } + + if ($active == false) { + $message = $plugin->get_lang('MaintenanceModeIsOff'); + $contentNoBlock = str_replace("\x0D", '', $contentNoBlock); + file_put_contents($file, $contentNoBlock); + } else { + $message = $plugin->get_lang('MaintenanceModeIsOn'); + } + Display::addFlash(Display::return_message($message)); + } + $plugin_info['settings_form'] = $form; +} diff --git a/plugin/migrationmoodle/README.md b/plugin/migrationmoodle/README.md new file mode 100644 index 000000000..b369b4aa6 --- /dev/null +++ b/plugin/migrationmoodle/README.md @@ -0,0 +1,24 @@ +# MigrationMoodlePlugin + +Allow migrate course contents and user progress from a Moodle platform. + +> In development. + +## Instructions + +- Install the plugin +- Set the configuration (params to moodle DB connection and moodledata directory) +- Optionally, set the admin region + +You can run the migration tasks from browser using the admin panel. +You must ejecute the tasks in the order indicated in the task list. + +Also you can run all the migrations running `php plugin/migrationmoodle/run_cli.php`. +But if you want to run the migration with multiple url, then you will need edi `MigrationMoodlePlugin::getAccessUrlId`, +`MigrationMoodlePlugin::getMoodledataPath` methods to set your plugin settings. + +# Notes + +- Check if exists an index on `c_lp_item_view.status` on Chamilo DB. + It for optimize the performance when executing the SQL query used in UserScormProgressLoader. +- It requires a Moodle DB with MySQL 8 or MariaDB 10.2.2 for some tasks (LessonPagesTask). diff --git a/plugin/migrationmoodle/admin.php b/plugin/migrationmoodle/admin.php new file mode 100644 index 000000000..a7e3a35d5 --- /dev/null +++ b/plugin/migrationmoodle/admin.php @@ -0,0 +1,241 @@ +get('active')) { + api_not_allowed(true); +} + +$menuTasks = [ + '_' => [ + 'course_categories', + 'courses', + //'role_assignments', + 'users', + ], + 'courses' => [ + 'course_introductions', + 'course_sections', + 'course_modules_scorm', + ], + 'course_sections' => [ + 'files_for_course_sections', + 'course_modules_lesson', + 'course_modules_quiz', + 'course_modules_url', + //'c_quiz', + 'sort_section_modules', + ], + 'course_modules_lesson' => [ + 'lesson_pages', + ], + 'lesson_pages' => [ + 'lesson_pages_document', + 'lesson_pages_quiz', + ], + 'lesson_pages_document' => [ + 'files_for_lesson_pages', + ], + 'lesson_pages_quiz' => [ + 'lesson_pages_quiz_question', + 'files_for_lesson_answers', + ], + 'lesson_pages_quiz_question' => [ + 'lesson_answers_true_false', + 'lesson_answers_multiple_choice', + 'lesson_answers_multiple_answer', + 'lesson_answers_matching', + 'lesson_answers_essay', + 'lesson_answers_short_answer', + ], + 'course_modules_quiz' => [ + 'quizzes', + 'quizzes_scores', + ], + 'quizzes' => [ + 'files_for_quizzes', + 'question_categories', + 'questions', + ], + 'questions' => [ + 'question_multi_choice_single', + 'question_multi_choice_multiple', + 'questions_true_false', + 'question_short_answer', + 'question_gapselect', + ], + 'course_modules_scorm' => [ + 'scorm_scoes', + ], + 'scorm_scoes' => [ + 'files_for_scorm_scoes', + ], + 'course_introductions' => [ + 'files_for_course_introductions', + ], + 'course_modules_url' => [ + 'urls', + ], + 'users' => [ + 'users_last_login', + 'track_login', + 'user_sessions', + ], + 'user_sessions' => [ + 'users_learn_paths', + 'users_scorms_view', + 'track_course_access', + ], + 'users_learn_paths' => [ + 'users_learn_paths_lesson_timer', + 'users_learn_paths_lesson_branch', + 'users_learn_paths_lesson_attempts', + 'users_learn_paths_quizzes', + ], + 'users_learn_paths_quizzes' => [ + 'users_quizzes_attempts', + 'user_question_attempts_shortanswer', + 'user_question_attempts_gapselect', + 'user_question_attempts_truefalse', + ], +]; + +$menuScripts = [ + '_' => [ + 'user_learn_paths_progress', + 'user_scorms_progress', + ], +]; + +$htmlHeadXtra[] = ''; + +Display::display_header($plugin->get_title()); + +echo '
    '; +echo '
    '; +echo '
    ';
+
+if (!empty($action) && isAllowedAction($action, $menuTasks) && !$plugin->isTaskDone($action)) {
+    $taskName = api_underscore_to_camel_case($action).'Task';
+
+    echo Display::page_subheader(
+        $plugin->get_lang($taskName)
+    );
+
+    $taskName = 'Chamilo\\PluginBundle\\MigrationMoodle\\Task\\'.$taskName;
+
+    /** @var BaseTask $task */
+    $task = new $taskName();
+
+    $task->execute();
+}
+
+if (!empty($action) && isAllowedAction($action, $menuScripts) && !$plugin->isTaskDone($action)) {
+    $scriptName = api_underscore_to_camel_case($action).'Script';
+
+    echo Display::page_subheader(
+        $plugin->get_lang($scriptName)
+    );
+
+    $scriptClass = 'Chamilo\\PluginBundle\\MigrationMoodle\\Script\\'.$scriptName;
+
+    /** @var BaseScript $script */
+    $script = new $scriptClass();
+
+    $script->run();
+}
+
+echo '
    '; +echo '
    '; +echo '
    '; +echo Display::page_subheader('Tasks'); +echo displayMenu($menuTasks); +echo Display::page_subheader('Scripts'); +echo displayMenu($menuScripts, 'Script'); +echo '
    '; +echo '
    '; + +Display::display_footer(); + +/** + * @param string $parent + * @param string $type + * + * @return string + */ +function displayMenu(array $menu, $type = 'Task', $parent = '_') +{ + $plugin = MigrationMoodlePlugin::create(); + + $items = $menu[$parent]; + + $isParentDone = $parent === '_' ? true : $plugin->isTaskDone($parent); + + $baseUrl = api_get_self()."?action="; + + $html = '
      '; + + foreach ($items as $item) { + $title = api_underscore_to_camel_case($item); + + $html .= '
    1. '; + + $htmlItem = Display::returnFontAwesomeIcon('check-square-o', '', true); + $htmlItem .= $plugin->get_lang($title.$type); + + if ($isParentDone) { + if (!$plugin->isTaskDone($item)) { + $htmlItem = Display::returnFontAwesomeIcon('square-o', '', true); + $htmlItem .= Display::url( + $plugin->get_lang($title.$type), + $baseUrl.$item + ); + } + } + + $html .= $htmlItem; + + if (isset($menu[$item])) { + $html .= displayMenu($menu, $type, $item); + } + + $html .= '
      2. '; + } + + $html .= '
    '; + + return $html; +} + +/** + * @param string $action + * + * @return bool + */ +function isAllowedAction($action, array $menu) +{ + foreach ($menu as $items) { + if (in_array($action, $items)) { + return true; + } + } + + return false; +} diff --git a/plugin/migrationmoodle/install.php b/plugin/migrationmoodle/install.php new file mode 100644 index 000000000..75430e8a0 --- /dev/null +++ b/plugin/migrationmoodle/install.php @@ -0,0 +1,59 @@ +get_lang('MoodlePassword'), + '' + ); + + createPluginTables(); +} catch (Exception $exception) { + $message = sprintf( + $plugin->get_lang('InstallError'), + $exception->getMessage() + ); + + echo Display::return_message($message, 'error'); +} + +/** + * Create database tables for this plugin. + */ +function createPluginTables() +{ + $installed = AppPlugin::getInstance()->isInstalled('migrationmoodle'); + + if ($installed) { + return; + } + + $queries = []; + $queries[] = "CREATE TABLE IF NOT EXISTS plugin_migrationmoodle_task ( + id INT AUTO_INCREMENT NOT NULL, + name VARCHAR(255) NOT NULL, + PRIMARY KEY(id) + ) DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE = InnoDB"; + $queries[] = "CREATE TABLE IF NOT EXISTS plugin_migrationmoodle_item ( + id INT AUTO_INCREMENT NOT NULL, + task_id INT NOT NULL, + hash VARCHAR(255) NOT NULL, + extracted_id INT NOT NULL, + loaded_id INT NOT NULL, + INDEX IDX_HASH (hash), + INDEX IDX_EXTRACTED_LOADED (extracted_id, loaded_id), + INDEX IDX_LOADED (loaded_id), + INDEX IDX_TASK (task_id), + PRIMARY KEY(id) + ) DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci ENGINE = InnoDB"; + $queries[] = "ALTER TABLE plugin_migrationmoodle_item ADD CONSTRAINT FK_TASK FOREIGN KEY (task_id) + REFERENCES plugin_migrationmoodle_task (id) ON DELETE CASCADE"; + + foreach ($queries as $query) { + Database::query($query); + } +} diff --git a/plugin/migrationmoodle/lang/english.php b/plugin/migrationmoodle/lang/english.php new file mode 100644 index 000000000..d0734bd84 --- /dev/null +++ b/plugin/migrationmoodle/lang/english.php @@ -0,0 +1,79 @@ +' + .'The import of courses is also affected by this configuration, as it only imports courses in which users with this username prefix are enrolled.'; +$strings['url_id'] = 'URL ID'; +$strings['url_id_help'] = 'Access URL ID to save courses, users and sessions to (if using multi-url).'; +$strings['moodle_path'] = 'Moodledata path'; +$strings['moodle_path_help'] = 'The moodledata folder path. Usually something like 
    /var/www/moodledata
    '; + +// Tasks +$strings['UsersTask'] = 'Users'; +$strings['CourseCategoriesTask'] = 'Course categories'; +$strings['CoursesTask'] = 'Courses'; +$strings['CourseSectionsTask'] = 'Course sections'; +$strings['CourseModulesLessonTask'] = 'Course modules: Lessons'; +$strings['LessonPagesTask'] = 'Lesson pages'; +$strings['LessonPagesDocumentTask'] = 'Lesson pages: Documents'; +$strings['FilesForLessonPagesTask'] = 'Files for lesson pages'; +$strings['LessonPagesQuizTask'] = 'Lesson pages: Questions'; +$strings['LessonPagesQuizQuestionTask'] = 'Questions for question pages'; +$strings['LessonAnswersTrueFalseTask'] = 'Answers for True/False questions'; +$strings['LessonAnswersMultipleChoiceTask'] = 'Answers for Multiple Choice questions'; +$strings['LessonAnswersMultipleAnswerTask'] = 'Answers for Multiple Answer questions'; +$strings['LessonAnswersMatchingTask'] = 'Answers for Matching questions'; +$strings['LessonAnswersEssayTask'] = 'Answers for Essay questions'; +$strings['LessonAnswersShortAnswerTask'] = 'Answers for Short Answer questions'; +$strings['FilesForLessonAnswersTask'] = 'Files for lesson answers'; +$strings['CourseModulesQuizTask'] = 'Course modules: Quizzes'; +$strings['CQuizTask'] = 'C Quiz'; +$strings['RoleAssignmentsTask'] = 'Role assignments'; +$strings['QuizzesTask'] = 'Quizzes'; +$strings['FilesForQuizzesTask'] = 'Files for quizzes'; +$strings['QuestionCategoriesTask'] = 'Question categories'; +$strings['QuestionsTask'] = 'Questions'; +$strings['QuestionMultiChoiceSingleTask'] = 'Answers for multichoice questions (single)'; +$strings['QuestionMultiChoiceMultipleTask'] = 'Answers for multichoice questions (multiple)'; +$strings['QuestionsTrueFalseTask'] = 'Answers for truefalse questions'; +$strings['QuestionShortAnswerTask'] = 'Answers for shortanswers questions'; +$strings['CourseModulesScormTask'] = 'SCORM courses'; +$strings['ScormScoesTask'] = 'SCORM items'; +$strings['FilesForScormScoesTask'] = 'Files for SCORM items'; +$strings['UserSessionsTask'] = 'Course Sessions for users'; +$strings['CourseIntroductionsTask'] = 'Course introductions'; +$strings['FilesForCourseIntroductionsTask'] = 'Files for course introductions'; +$strings['FilesForCourseSectionsTask'] = 'Files for course sections'; +$strings['CourseModulesUrlTask'] = 'Course modules: URLs'; +$strings['UrlsTask'] = 'URLs'; +$strings['SortSectionModulesTask'] = 'Sort modules in section'; +$strings['UsersScormsViewTask'] = 'SCORM views for users'; +$strings['UsersScormsProgressTask'] = 'SCORM progress'; +$strings['UsersLearnPathsTask'] = 'Learn paths views of users'; +$strings['UsersLearnPathsLessonTimerTask'] = 'Lesson timer to start time of Learn paths section'; +$strings['QuizzesScoresTask'] = 'Update quiz scores in learn path'; +$strings['QuestionGapselectTask'] = 'Answers for gapselect questions'; +$strings['UsersLearnPathsLessonBranchTask'] = 'Lesson branch to total time in learn paths documents'; +$strings['UsersLearnPathsLessonAttemptsTask'] = 'Lesson attempts to total time in learn paths quizzes'; +$strings['UsersLearnPathsQuizzesTask'] = 'Quizzes attempts to learn paths quizzes attempts'; +$strings['UsersQuizzesAttemptsTask'] = 'Quiz attempts of users'; +$strings['UserQuestionAttemptsShortanswerTask'] = 'Question attempts of users for shortanswer'; +$strings['UserQuestionAttemptsGapselectTask'] = 'Question attempts of users for gapselect'; +$strings['UserQuestionAttemptsTruefalseTask'] = 'Question attempts of users for truefalse'; +$strings['UsersLastLoginTask'] = 'Last logins for users'; +$strings['TrackLoginTask'] = 'First login and last logout'; +$strings['TrackCourseAccessTask'] = 'User access to course'; +$strings['UserLearnPathsProgressScript'] = 'Update progress in learning paths for users.'; +$strings['UserScormsProgressScript'] = 'Update progress in SCORMs for users.'; diff --git a/plugin/migrationmoodle/lang/french.php b/plugin/migrationmoodle/lang/french.php new file mode 100644 index 000000000..7c6031ab0 --- /dev/null +++ b/plugin/migrationmoodle/lang/french.php @@ -0,0 +1,24 @@ +' + .'L\'import des cours est aussi affecté par cette variable, car seuls les cours auxquels des utilisateurs commençant par ce préfixe sont inscrits seront migrés.'; +$strings['url_id'] = 'ID d\'URL'; +$strings['url_id_help'] = 'ID d\'URL (si multi-URL utilisés) dans lequel sauver les cours, utiilisateurs et sessions.'; +$strings['moodle_path'] = 'Chemin vers moodledata'; +$strings['moodle_path_help'] = 'Le chemin vers le répertoire moodledata. Habituellement quelque chose comme 
    /var/www/moodledata
    '; + +// Tasks +$strings['UsersTask'] = 'Utilisateurs'; diff --git a/plugin/migrationmoodle/plugin.php b/plugin/migrationmoodle/plugin.php new file mode 100644 index 000000000..f4f3f73a2 --- /dev/null +++ b/plugin/migrationmoodle/plugin.php @@ -0,0 +1,4 @@ +get_info(); diff --git a/plugin/migrationmoodle/run_cli.php b/plugin/migrationmoodle/run_cli.php new file mode 100644 index 000000000..c6080d6b2 --- /dev/null +++ b/plugin/migrationmoodle/run_cli.php @@ -0,0 +1,120 @@ + $taskName) { + $taskClass = api_underscore_to_camel_case($taskName).'Task'; + $taskClass = 'Chamilo\\PluginBundle\\MigrationMoodle\\Task\\'.$taskClass; + + echo PHP_EOL.'['.date(DateTime::ATOM).'] '.($i + 1).': '; + + if ($plugin->isTaskDone($taskName)) { + echo "Already done \"$taskClass\"".PHP_EOL; + continue; + } + + echo "Executing \"$taskClass.\"".PHP_EOL; + + /** @var BaseTask $task */ + $task = new $taskClass(); + $task->execute(); + + echo '['.date(DateTime::ATOM)."] End \"$taskClass\"".PHP_EOL; +} + +$scriptNames = [ + 'user_learn_paths_progress', + 'user_scorms_progress', +]; + +foreach ($scriptNames as $i => $scriptName) { + $scriptClass = api_underscore_to_camel_case($scriptName).'Script'; + $scriptClass = 'Chamilo\\PluginBundle\\MigrationMoodle\\Script\\'.$scriptClass; + + echo PHP_EOL.'['.date(DateTime::ATOM).'] '.($i + 1).': '; + + if ($plugin->isTaskDone($scriptName)) { + echo "Already done \"$scriptClass\"".PHP_EOL; + continue; + } + + echo "Executing \"$scriptClass.\"".PHP_EOL; + + /** @var BaseScript $script */ + $script = new $scriptClass(); + $script->run(); + + echo '['.date(DateTime::ATOM)."] End \"$scriptClass\"".PHP_EOL; +} diff --git a/plugin/migrationmoodle/src/Extractor/BaseExtractor.php b/plugin/migrationmoodle/src/Extractor/BaseExtractor.php new file mode 100644 index 000000000..12e085956 --- /dev/null +++ b/plugin/migrationmoodle/src/Extractor/BaseExtractor.php @@ -0,0 +1,63 @@ +query = $configuration['query']; + } + + /** + * @return bool + */ + public function filter(array $sourceData) + { + return false; + } + + /** + * @throws \Exception + * + * @return \Generator|iterable + */ + public function extract() + { + $plugin = \MigrationMoodlePlugin::create(); + + try { + $connection = $plugin->getConnection(); + } catch (DBALException $e) { + throw new \Exception('Unable to start connection.', 0, $e); + } + + try { + $statement = $connection->executeQuery($this->query); + } catch (DBALException $e) { + throw new \Exception("Unable to execute query \"{$this->query}\".", 0, $e); + } + + while ($sourceRow = $statement->fetch(FetchMode::ASSOCIATIVE)) { + yield $sourceRow; + } + + $connection->close(); + } +} diff --git a/plugin/migrationmoodle/src/Extractor/FilterExtractor.php b/plugin/migrationmoodle/src/Extractor/FilterExtractor.php new file mode 100644 index 000000000..604b1d9b6 --- /dev/null +++ b/plugin/migrationmoodle/src/Extractor/FilterExtractor.php @@ -0,0 +1,39 @@ +getTaskName(); + + $result = \Database::select( + 'COUNT(1) AS c', + 'plugin_migrationmoodle_item i INNER JOIN plugin_migrationmoodle_task t ON i.task_id = t.id', + [ + 'where' => [ + 't.name = ? AND i.extracted_id = ?' => [$taskName, $id], + ], + ], + 'first' + ); + + return $result['c'] > 0; + } +} diff --git a/plugin/migrationmoodle/src/Extractor/LoadedCoursesFilterExtractor.php b/plugin/migrationmoodle/src/Extractor/LoadedCoursesFilterExtractor.php new file mode 100644 index 000000000..72a44a133 --- /dev/null +++ b/plugin/migrationmoodle/src/Extractor/LoadedCoursesFilterExtractor.php @@ -0,0 +1,40 @@ +calledClass = CoursesTask::class; + } + + /** + * @return bool + */ + public function filter(array $sourceData) + { + $courseId = $sourceData['id']; + + if (isset($sourceData['course'])) { + $courseId = $sourceData['course']; + } + + return !$this->existsExtracted($courseId); + } +} diff --git a/plugin/migrationmoodle/src/Extractor/LoadedScormsFilterExtractor.php b/plugin/migrationmoodle/src/Extractor/LoadedScormsFilterExtractor.php new file mode 100644 index 000000000..7b0ff2e5c --- /dev/null +++ b/plugin/migrationmoodle/src/Extractor/LoadedScormsFilterExtractor.php @@ -0,0 +1,38 @@ +calledClass = CourseModulesScormTask::class; + } + + /** + * Filter to avoid scorms not yet migrated. + * + * @return bool + */ + public function filter(array $sourceData) + { + $scormId = $sourceData['scorm']; + + return !$this->existsExtracted($scormId); + } +} diff --git a/plugin/migrationmoodle/src/Extractor/LoadedUsersFilterExtractor.php b/plugin/migrationmoodle/src/Extractor/LoadedUsersFilterExtractor.php new file mode 100644 index 000000000..401442287 --- /dev/null +++ b/plugin/migrationmoodle/src/Extractor/LoadedUsersFilterExtractor.php @@ -0,0 +1,38 @@ +calledClass = UsersTask::class; + } + + /** + * @return bool + */ + public function filter(array $sourceData) + { + $userId = $sourceData['id']; + + if (isset($sourceData['userid'])) { + $userId = $sourceData['userid']; + } + + return !$this->existsExtracted($userId); + } +} diff --git a/plugin/migrationmoodle/src/Interfaces/ExtractorInterface.php b/plugin/migrationmoodle/src/Interfaces/ExtractorInterface.php new file mode 100644 index 000000000..30f520fc8 --- /dev/null +++ b/plugin/migrationmoodle/src/Interfaces/ExtractorInterface.php @@ -0,0 +1,22 @@ +updateTitle(\Exercise::format_title_variable($incomingData['exerciseTitle'])); + $exercise->updateDescription($incomingData['exerciseDescription']); + $exercise->updateAttempts($incomingData['exerciseAttempts']); + $exercise->updateFeedbackType(0); + $exercise->updateType(2); + $exercise->setRandom(0); + $exercise->updateRandomAnswers($incomingData['randomAnswers']); + $exercise->updateResultsDisabled(0); + $exercise->updateExpiredTime($incomingData['enabletimercontroltotalminutes']); + //$exercise->updatePropagateNegative($incomingData['propagate_neg']); + //$exercise->updateSaveCorrectAnswers($incomingData['save_correct_answers']); + //$exercise->updateRandomByCat($incomingData['randomByCat']); + $exercise->updateTextWhenFinished(''); + $exercise->updateDisplayCategoryName(1); + //$exercise->updateReviewAnswers($incomingData['review_answers']); + $exercise->updatePassPercentage($incomingData['pass_percentage']); + //$exercise->updateCategories($incomingData['category']); + //$exercise->updateEndButton($incomingData['end_button']); + //$exercise->setOnSuccessMessage($incomingData['on_success_message']); + //$exercise->setOnFailedMessage($incomingData['on_failed_message']); + //$exercise->updateEmailNotificationTemplate($incomingData['email_notification_template']); + //$exercise->setEmailNotificationTemplateToUser($incomingData['email_notification_template_to_user']); + //$exercise->setNotifyUserByEmail($incomingData['notify_user_by_email']); + //$exercise->setModelType($incomingData['model_type']); + $exercise->setQuestionSelectionType(1); + $exercise->setHideQuestionTitle(0); + $exercise->sessionId = 0; + //$exercise->setScoreTypeModel($incomingData['score_type_model']); + //$exercise->setGlobalCategoryId($incomingData['global_category_id']); + //$exercise->setShowPreviousButton($incomingData['show_previous_button']); + //$exercise->setNotifications($incomingData['notifications']); + //$exercise->setExerciseCategoryId($incomingData['exercise_category_id']); + $exercise->setPageResultConfiguration($incomingData); + $exercise->start_time = api_get_utc_datetime($incomingData['start_time'], true); + $exercise->end_time = api_get_utc_datetime($incomingData['end_time'], true); + $exercise->expired_time = $incomingData['enabletimercontroltotalminutes']; + $exercise->random_answers = $incomingData['randomAnswers'] == 1 ? 1 : 0; + + $iId = $exercise->save(); + + return $iId; + } +} diff --git a/plugin/migrationmoodle/src/Loader/CourseCategoriesLoader.php b/plugin/migrationmoodle/src/Loader/CourseCategoriesLoader.php new file mode 100644 index 000000000..b0d556c1e --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/CourseCategoriesLoader.php @@ -0,0 +1,42 @@ +getAccessUrlId(); + + \Database::query("UPDATE $tblUrlCategory SET access_url_id = $accessUrlId WHERE course_category_id = $id"); + + return $id; + } +} diff --git a/plugin/migrationmoodle/src/Loader/CourseFilesLoader.php b/plugin/migrationmoodle/src/Loader/CourseFilesLoader.php new file mode 100644 index 000000000..a6bd2f876 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/CourseFilesLoader.php @@ -0,0 +1,65 @@ +findFilePath($incomingData['contenthash']); + + $file = [ + 'file' => [ + 'name' => $incomingData['filename'], + 'tmp_name' => $filePath, + 'type' => $incomingData['mimetype'], + 'size' => $incomingData['filesize'], + 'error' => 0, + 'from_file' => true, + 'move_file' => true, + ], + ]; + + $_POST['language'] = $courseInfo['language']; + + $fileData = \DocumentManager::upload_document( + $file, + '/', + $incomingData['filename'], + '', + null, + null, + true, + false, + 'file', + false, + $userId, + $courseInfo + ); + + return $fileData['iid']; + } +} diff --git a/plugin/migrationmoodle/src/Loader/CourseIntroductionLoader.php b/plugin/migrationmoodle/src/Loader/CourseIntroductionLoader.php new file mode 100644 index 000000000..591c6dec6 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/CourseIntroductionLoader.php @@ -0,0 +1,30 @@ + 0, + 'c_id' => $incomingData['c_id'], + 'id' => TOOL_COURSE_HOMEPAGE, + 'intro_text' => $incomingData['description'], + ] + ); + } +} diff --git a/plugin/migrationmoodle/src/Loader/CourseModulesLessonLoader.php b/plugin/migrationmoodle/src/Loader/CourseModulesLessonLoader.php new file mode 100644 index 000000000..616c65d1b --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/CourseModulesLessonLoader.php @@ -0,0 +1,40 @@ +add_item( + 0, + 0, + 'dir', + 0, + $incomingData['title'], + '' + ); + + return $itemId; + } +} diff --git a/plugin/migrationmoodle/src/Loader/CourseModulesQuizLoader.php b/plugin/migrationmoodle/src/Loader/CourseModulesQuizLoader.php new file mode 100644 index 000000000..9e04f4e49 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/CourseModulesQuizLoader.php @@ -0,0 +1,39 @@ +add_item( + 0, + 0, + 'quiz', + 0, + $incomingData['title'], + '' + ); + } +} diff --git a/plugin/migrationmoodle/src/Loader/CourseModulesScormLoader.php b/plugin/migrationmoodle/src/Loader/CourseModulesScormLoader.php new file mode 100644 index 000000000..29e9499ad --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/CourseModulesScormLoader.php @@ -0,0 +1,123 @@ + 0 THEN MAX(display_order) + 1 ELSE 1 END AS display_order + FROM $tblLpMain WHERE c_id = {$incomingData['c_id']}" + ); + $row = \Database::fetch_assoc($resultDisplayOrder); + $displayOrder = $row['display_order']; + + $courseInfo = api_get_course_info_by_id($incomingData['c_id']); + $userId = 1; + + $incomingData['path'] = $this->createDirectory($incomingData['name'], $courseInfo['code']); + $incomingData['use_max_score'] = $incomingData['use_max_score'] == 100; + + $incomingData['created_on'] = $incomingData['created_on'] + ? $incomingData['created_on']->format('Y-m-d h:i:s') + : null; + $incomingData['modified_on'] = $incomingData['modified_on'] + ? $incomingData['modified_on']->format('Y-m-d h:i:s') + : null; + $incomingData['publicated_on'] = $incomingData['publicated_on'] + ? $incomingData['publicated_on']->format('Y-m-d h:i:s') + : null; + + $params = array_merge( + $incomingData, + [ + 'lp_type' => 2, + 'description' => '', + 'force_commit' => 0, + 'default_view_mod' => 'embedded', + 'default_encoding' => 'UTF-8', + 'js_lib' => 'scorm_api.php', + 'display_order' => $displayOrder, + 'session_id' => 0, + 'content_maker' => '', + 'content_license' => '', + 'debug' => 0, + 'theme' => '', + 'preview_image' => '', + 'author' => '', + 'prerequisite' => 0, + 'seriousgame_mode' => 0, + 'autolaunch' => 0, + 'category_id' => 0, + 'max_attempts' => 0, + 'subscribe_users' => 0, + ] + ); + + $lpId = \Database::insert($tblLpMain, $params); + + if ($lpId) { + \Database::query("UPDATE $tblLpMain SET id = iid WHERE iid = $lpId"); + + api_item_property_update($courseInfo, TOOL_LEARNPATH, $lpId, 'LearnpathAdded', $userId); + api_item_property_update($courseInfo, TOOL_LEARNPATH, $lpId, 'visible', $userId); + } + + return $lpId; + } + + /** + * @param string $fileName + * + * @return string + */ + public static function generateDirectoryName($fileName) + { + $newDirectory = trim($fileName); + $newDirectory = trim($newDirectory, '/'); + + return api_replace_dangerous_char($newDirectory); + } + + /** + * @param string $name + * @param string $courseCode + * + * @return string + */ + private function createDirectory($name, $courseCode) + { + $courseRelDir = api_get_path(SYS_COURSE_PATH).api_get_course_path($courseCode).'/scorm'; + + $newDirectory = self::generateDirectoryName($name); + + $fullPath = "$courseRelDir/$newDirectory"; + + $fileSystem = new Filesystem(); + + if (!is_dir($fullPath)) { + $fileSystem->mkdir( + $fullPath, + api_get_permissions_for_new_directories() + ); + } + + return "$newDirectory/."; + } +} diff --git a/plugin/migrationmoodle/src/Loader/CourseModulesUrlLoader.php b/plugin/migrationmoodle/src/Loader/CourseModulesUrlLoader.php new file mode 100644 index 000000000..e16620071 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/CourseModulesUrlLoader.php @@ -0,0 +1,35 @@ +add_item( + 0, + 0, + 'link', + 0, + $incomingData['title'], + '' + ); + } +} diff --git a/plugin/migrationmoodle/src/Loader/CourseSectionsLoader.php b/plugin/migrationmoodle/src/Loader/CourseSectionsLoader.php new file mode 100644 index 000000000..272e32a2e --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/CourseSectionsLoader.php @@ -0,0 +1,52 @@ +generate_lp_folder($courseInfo); + + $itemTitle = get_lang('Description'); + + $documentId = $lp->create_document($courseInfo, $incomingData['description'], $itemTitle); + $lp->add_item(0, 0, 'document', $documentId, $itemTitle, ''); + } + + return $lpId; + } +} diff --git a/plugin/migrationmoodle/src/Loader/CoursesLoader.php b/plugin/migrationmoodle/src/Loader/CoursesLoader.php new file mode 100644 index 000000000..346f371d5 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/CoursesLoader.php @@ -0,0 +1,50 @@ +loadMode === self::LOAD_MODE_REUSE) { + return $courseInfo['real_id']; + } + + if ($this->loadMode === self::LOAD_MODE_DUPLICATE) { + $incomingData['wanted_code'] = $incomingData['wanted_code'].substr(md5(uniqid(rand())), 0, 10); + } + } + + $incomingData['subscribe'] = false; + $incomingData['unsubscribe'] = false; + $incomingData['disk_quota'] = 500 * 1024 * 1024; + + $accessUrlId = \MigrationMoodlePlugin::create()->getAccessUrlId(); + + $courseInfo = \CourseManager::create_course($incomingData, 1, $accessUrlId); + + return $courseInfo['real_id']; + } +} diff --git a/plugin/migrationmoodle/src/Loader/FilesForScormScoLoader.php b/plugin/migrationmoodle/src/Loader/FilesForScormScoLoader.php new file mode 100644 index 000000000..1fbc5bf75 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/FilesForScormScoLoader.php @@ -0,0 +1,46 @@ +findFilePath($incomingData['contenthash']); + + $sysCourseScormPath = api_get_path(SYS_COURSE_PATH).$course->getDirectory().'/scorm'; + $lpDirectory = CourseModulesScormLoader::generateDirectoryName($incomingData['lp_name']); + $lpDirectoryPath = "$sysCourseScormPath/$lpDirectory"; + $fileDirectoryPath = $lpDirectoryPath.$incomingData['filepath']; + $filePath = $fileDirectoryPath.$incomingData['filename']; + + $fileSystem = new Filesystem(); + + if ($incomingData['filepath'] != '/') { + $fileSystem->mkdir( + $fileDirectoryPath, + api_get_permissions_for_new_directories() + ); + } + + $fileSystem->copy($moodleFilePath, $filePath); + + return 0; + } +} diff --git a/plugin/migrationmoodle/src/Loader/LessonAnswersEssayLoader.php b/plugin/migrationmoodle/src/Loader/LessonAnswersEssayLoader.php new file mode 100644 index 000000000..66900f8c9 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/LessonAnswersEssayLoader.php @@ -0,0 +1,36 @@ +read($incomingData['quiz_id']); + + $question = \Question::read($incomingData['question_id'], $courseInfo); + + $question->weighting = $incomingData['score']; + $question->save($exercise); + + return $question->id; + } +} diff --git a/plugin/migrationmoodle/src/Loader/LessonAnswersMatchingLoader.php b/plugin/migrationmoodle/src/Loader/LessonAnswersMatchingLoader.php new file mode 100644 index 000000000..047aa7fe9 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/LessonAnswersMatchingLoader.php @@ -0,0 +1,68 @@ +read($incomingData['quiz_id']); + + $question = \Question::read($incomingData['question_id'], $courseInfo); + + $answer = new \Answer($incomingData['question_id'], $incomingData['c_id'], $exercise); + $questionsAnswers = $answer->getAnswers(); + + foreach ($questionsAnswers as $questionsAnswer) { + $answer->createAnswer( + $questionsAnswer['answer'], + $questionsAnswer['correct'], + $questionsAnswer['comment'], + $questionsAnswer['ponderation'], + $questionsAnswer['position'], + $questionsAnswer['hotspot_coordinates'], + $questionsAnswer['hotspot_type'], + $questionsAnswer['destination'] + ); + } + + $optionPosition = $question->countAnswers() + 1; + + $answer->createAnswer($incomingData['feedback'], 0, '', 0, $optionPosition); + + $answerPosition = $optionPosition + 1; + + $answer->createAnswer( + $incomingData['answer'], + $optionPosition, + '', + $incomingData['score'], + $answerPosition + ); + + $answer->save(); + + $question->weighting += $incomingData['score']; + $question->save($exercise); + + return $question->id; + } +} diff --git a/plugin/migrationmoodle/src/Loader/LessonAnswersMultipleAnswerLoader.php b/plugin/migrationmoodle/src/Loader/LessonAnswersMultipleAnswerLoader.php new file mode 100644 index 000000000..a92ce1da8 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/LessonAnswersMultipleAnswerLoader.php @@ -0,0 +1,72 @@ +read($incomingData['quiz_id']); + + $question = \Question::read($incomingData['question_id'], $courseInfo); + + $answer = new \Answer($incomingData['question_id'], $incomingData['c_id'], $exercise); + $questionsAnswers = $answer->getAnswers(); + + foreach ($questionsAnswers as $questionsAnswer) { + $answer->createAnswer( + $questionsAnswer['answer'], + $questionsAnswer['correct'], + $questionsAnswer['comment'], + $questionsAnswer['ponderation'], + $questionsAnswer['position'], + $questionsAnswer['hotspot_coordinates'], + $questionsAnswer['hotspot_type'], + $questionsAnswer['destination'] + ); + } + + $incomingData['score'] = abs($incomingData['score']); + + if (!$incomingData['is_correct']) { + $incomingData['score'] = -$incomingData['score']; + } + + if ($incomingData['score'] > 0) { + $question->weighting += $incomingData['score']; + } + + $answer->createAnswer( + $incomingData['answer'], + $incomingData['is_correct'], + $incomingData['feedback'], + $incomingData['score'], + $question->countAnswers() + 1, + null, + null, + CQuizAnswer::DEFAULT_DESTINATION + ); + + $answer->save(); + $question->save($exercise); + + return $question->id; + } +} diff --git a/plugin/migrationmoodle/src/Loader/LessonAnswersMultipleChoiceLoader.php b/plugin/migrationmoodle/src/Loader/LessonAnswersMultipleChoiceLoader.php new file mode 100644 index 000000000..9e2a1696b --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/LessonAnswersMultipleChoiceLoader.php @@ -0,0 +1,22 @@ +read($incomingData['quiz_id']); + + $question = \Question::read($incomingData['question_id'], $courseInfo); + $question->weighting = 0; + + $answer = new \Answer($incomingData['question_id'], $incomingData['c_id'], $exercise); + + $incomingData['answers'] = '['.$incomingData['answers'].']'; + // Remove the "::" eventually written by the user + $incomingData['answers'] = str_replace('::', '', $incomingData['answers']); + // Remove starting and ending space and   + $incomingData['answers'] = api_preg_replace("/\xc2\xa0/", " ", $incomingData['answers']); + + $blankStartSeparator = '['; + $blankEndSeparator = ']'; + $blankStartSeparatorRegexp = \FillBlanks::escapeForRegexp($blankStartSeparator); + $blankEndSeparatorRegexp = \FillBlanks::escapeForRegexp($blankEndSeparator); + + // Remove spaces at the beginning and the end of text in square brackets + $return = preg_replace_callback( + "/".$blankStartSeparatorRegexp."[^]]+".$blankEndSeparatorRegexp."/", + function ($matches) use ($blankStartSeparator, $blankEndSeparator) { + $matchingResult = $matches[0]; + $matchingResult = trim($matchingResult, $blankStartSeparator); + $matchingResult = trim($matchingResult, $blankEndSeparator); + $matchingResult = trim($matchingResult); + // Remove forbidden chars + $matchingResult = str_replace("/\\/", "", $matchingResult); + $matchingResult = str_replace('/"/', "", $matchingResult); + + return $blankStartSeparator.$matchingResult.$blankEndSeparator; + }, + $incomingData['answers'] + ); + + $question->weighting += $incomingData['scores']; + + $return .= '::'.$incomingData['scores'].':'; + $return .= self::INPUT_WIDTH; + $return .= ':0@'; + + $answer->createAnswer($return, 0, $incomingData['comment'], 0, 1); + $answer->save(); + + $question->save($exercise); + + return $question->id; + } +} diff --git a/plugin/migrationmoodle/src/Loader/LessonAnswersTrueFalseLoader.php b/plugin/migrationmoodle/src/Loader/LessonAnswersTrueFalseLoader.php new file mode 100644 index 000000000..ae4f35160 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/LessonAnswersTrueFalseLoader.php @@ -0,0 +1,70 @@ +read($incomingData['quiz_id']); + + $question = \Question::read($incomingData['question_id'], $courseInfo); + + $answer = new \Answer($incomingData['question_id'], $incomingData['c_id'], $exercise); + $questionsAnswers = $answer->getAnswers(); + + foreach ($questionsAnswers as $questionsAnswer) { + $answer->createAnswer( + $questionsAnswer['answer'], + $questionsAnswer['correct'], + $questionsAnswer['comment'], + $questionsAnswer['ponderation'], + $questionsAnswer['position'], + $questionsAnswer['hotspot_coordinates'], + $questionsAnswer['hotspot_type'], + $questionsAnswer['destination'] + ); + } + + if ($incomingData['is_correct']) { + $incomingData['score'] = abs($incomingData['score']); + + $question->weighting += $incomingData['score']; + } + + $answer->createAnswer( + $incomingData['answer'], + $incomingData['is_correct'], + $incomingData['feedback'], + $incomingData['score'], + $question->countAnswers() + 1, + null, + null, + CQuizAnswer::DEFAULT_DESTINATION + ); + + $answer->save(); + $question->save($exercise); + + return $question->id; + } +} diff --git a/plugin/migrationmoodle/src/Loader/LessonPagesDocumentLoader.php b/plugin/migrationmoodle/src/Loader/LessonPagesDocumentLoader.php new file mode 100644 index 000000000..5e89f9511 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/LessonPagesDocumentLoader.php @@ -0,0 +1,47 @@ +generate_lp_folder($courseInfo); + + $docId = $lp->create_document( + $courseInfo, + $incomingData['item_content'], + $incomingData['item_title'], + 'html' + ); + + $tblLpItem = \Database::get_course_table(TABLE_LP_ITEM); + + \Database::query("UPDATE $tblLpItem SET path = '$docId' WHERE iid = {$incomingData['item_id']}"); + + return $docId; + } +} diff --git a/plugin/migrationmoodle/src/Loader/LessonPagesLoader.php b/plugin/migrationmoodle/src/Loader/LessonPagesLoader.php new file mode 100644 index 000000000..d0f23181a --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/LessonPagesLoader.php @@ -0,0 +1,40 @@ +add_item( + $incomingData['parent'], + $incomingData['previous'], + $incomingData['item_type'], + 0, + $incomingData['title'], + '' + ); + + return $itemId; + } +} diff --git a/plugin/migrationmoodle/src/Loader/LessonQuestionPagesQuestionLoader.php b/plugin/migrationmoodle/src/Loader/LessonQuestionPagesQuestionLoader.php new file mode 100644 index 000000000..f0e1441ce --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/LessonQuestionPagesQuestionLoader.php @@ -0,0 +1,40 @@ +read($incomingData['quiz_id']); + + $question = \Question::getInstance($incomingData['question_type']); + $question->course = api_get_course_info_by_id($incomingData['c_id']); + $question->updateTitle($incomingData['question_title']); + $question->updateLevel(1); + $question->updateCategory(0); + $question->save($exercise); + + $exercise->addToList($question->id); + $exercise->update_question_positions(); + + return $question->id; + } +} diff --git a/plugin/migrationmoodle/src/Loader/LessonQuestionPagesQuizLoader.php b/plugin/migrationmoodle/src/Loader/LessonQuestionPagesQuizLoader.php new file mode 100644 index 000000000..ee4830e09 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/LessonQuestionPagesQuizLoader.php @@ -0,0 +1,55 @@ +updateTitle(\Exercise::format_title_variable($incomingData['item_title'])); + $exercise->updateDescription(''); + $exercise->updateAttempts(0); + $exercise->updateFeedbackType(0); + $exercise->updateType(ALL_ON_ONE_PAGE); + $exercise->setRandom(0); + $exercise->updateRandomAnswers(0); + $exercise->updateResultsDisabled(0); + $exercise->updateExpiredTime(0); + $exercise->updateTextWhenFinished(''); + $exercise->updateDisplayCategoryName(1); + $exercise->updatePassPercentage(0); + $exercise->setQuestionSelectionType(1); + $exercise->setHideQuestionTitle(0); + $exercise->sessionId = 0; + $exercise->start_time = null; + $exercise->end_time = null; + $exercise->active = false; + + $quizId = $exercise->save(); + + $tblLpItem = \Database::get_course_table(TABLE_LP_ITEM); + + \Database::query("UPDATE $tblLpItem SET path = '$quizId' WHERE iid = {$incomingData['item_id']}"); + + return $quizId; + } +} diff --git a/plugin/migrationmoodle/src/Loader/QuestionCategoriesLoader.php b/plugin/migrationmoodle/src/Loader/QuestionCategoriesLoader.php new file mode 100644 index 000000000..4b2fb4f7c --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/QuestionCategoriesLoader.php @@ -0,0 +1,44 @@ +name = $incomingData['name']; + $category->description = $incomingData['description']; + + $id = $category->save($incomingData['c_id']); + + if (false === $id) { + throw new \Exception("The quiz category \"{$incomingData['name']}\" already exists."); + } + + return $id; + } +} diff --git a/plugin/migrationmoodle/src/Loader/QuestionGapselectLoader.php b/plugin/migrationmoodle/src/Loader/QuestionGapselectLoader.php new file mode 100644 index 000000000..8d54f0a56 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/QuestionGapselectLoader.php @@ -0,0 +1,37 @@ +read($incomingData['quiz_id']); + + $question = \Question::read($incomingData['question_id'], $courseInfo); + $question->setTitle(get_lang('FillBlanks')); + $question->weighting = $incomingData['score']; + + $answer = new \Answer($incomingData['question_id'], $incomingData['c_id'], $exercise); + $answer->createAnswer($incomingData['answer'], 0, $incomingData['comment'], 0, 1); + $answer->save(); + + $question->save($exercise); + + return $question->id; + } +} diff --git a/plugin/migrationmoodle/src/Loader/QuizzesLoader.php b/plugin/migrationmoodle/src/Loader/QuizzesLoader.php new file mode 100644 index 000000000..e9c97e569 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/QuizzesLoader.php @@ -0,0 +1,50 @@ +updateTitle(\Exercise::format_title_variable($incomingData['exerciseTitle'])); + $exercise->updateDescription($incomingData['exerciseDescription']); + $exercise->updateAttempts($incomingData['exerciseAttempts']); + $exercise->updateFeedbackType(0); + $exercise->updateType(ALL_ON_ONE_PAGE); + $exercise->setRandom(0); + $exercise->updateRandomAnswers($incomingData['randomAnswers']); + $exercise->updateResultsDisabled(0); + $exercise->updateExpiredTime($incomingData['enabletimercontroltotalminutes']); + $exercise->updateTextWhenFinished(''); + $exercise->updateDisplayCategoryName(1); + $exercise->updatePassPercentage($incomingData['pass_percentage']); + $exercise->setQuestionSelectionType(1); + $exercise->setHideQuestionTitle(0); + $exercise->sessionId = 0; + $exercise->start_time = api_get_utc_datetime($incomingData['start_time'], true); + $exercise->end_time = api_get_utc_datetime($incomingData['end_time'], true); + + $quizId = $exercise->save(); + + \Database::query("UPDATE c_quiz SET active = 0 WHERE iid = $quizId"); + \Database::query("UPDATE c_lp_item SET path = '$quizId' WHERE iid = {$incomingData['item_id']}"); + + return $quizId; + } +} diff --git a/plugin/migrationmoodle/src/Loader/QuizzesScoresLoader.php b/plugin/migrationmoodle/src/Loader/QuizzesScoresLoader.php new file mode 100644 index 000000000..3ea04dc20 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/QuizzesScoresLoader.php @@ -0,0 +1,39 @@ +add_item( + $incomingData['parent_item_id'], + 0, + $incomingData['item_type'], + 0, + $incomingData['title'], + '' + ); + + $tblLpItem = \Database::get_course_table(TABLE_LP_ITEM); + + \Database::query( + "UPDATE $tblLpItem SET path = '{$incomingData['path']}', ref = '{$incomingData['ref']}' WHERE iid = $itemId" + ); + + return $itemId; + } +} diff --git a/plugin/migrationmoodle/src/Loader/SortSectionModuleLoader.php b/plugin/migrationmoodle/src/Loader/SortSectionModuleLoader.php new file mode 100644 index 000000000..60f49254f --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/SortSectionModuleLoader.php @@ -0,0 +1,51 @@ + [ + 'c_id = ? AND lp_id = ? AND parent_item_id = ? AND item_type = ?' => [ + $incomingData['c_id'], + $incomingData['lp_id'], + 0, + TOOL_DOCUMENT, + ], + ], + 'order' => 'iid ASC', + ], + 'first' + ); + + $orderList = $incomingData['order_list']; + + if ($firstItem) { + $orderList = [$firstItem['iid'] => 0] + $orderList; + } + + \learnpath::sortItemByOrderList( + $orderList, + $incomingData['c_id'] + ); + + return $incomingData['lp_id']; + } +} diff --git a/plugin/migrationmoodle/src/Loader/TrackCourseAccessLoader.php b/plugin/migrationmoodle/src/Loader/TrackCourseAccessLoader.php new file mode 100644 index 000000000..37d25c85e --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/TrackCourseAccessLoader.php @@ -0,0 +1,66 @@ +modify("-$sessionLifetime seconds"); + + $time = $time->format('Y-m-d H:i:s'); + $loginCourseDate = $loginCourseDate->format('Y-m-d H:i:s'); + + $tableCourseAccess = \Database::get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS); + + $result = \Database::query( + "SELECT course_access_id + FROM $tableCourseAccess + WHERE user_id = $userId AND c_id = $cId AND session_id = $sessionId AND login_course_date > '$time' + ORDER BY login_course_date DESC + LIMIT 1" + ); + + if (\Database::num_rows($result) > 0) { + $row = \Database::fetch_assoc($result); + + \Database::query( + "UPDATE $tableCourseAccess + SET logout_course_date = '$loginCourseDate', counter = counter + 1 + WHERE course_access_id = {$row['course_access_id']}" + ); + + return $row['course_access_id']; + } + + return \Database::insert( + $tableCourseAccess, + [ + 'c_id' => $cId, + 'user_ip' => $ip, + 'user_id' => $userId, + 'login_course_date' => $loginCourseDate, + 'logout_course_date' => $loginCourseDate, + 'counter' => 1, + 'session_id' => $sessionId, + ] + ); + } +} diff --git a/plugin/migrationmoodle/src/Loader/TrackLoginLoader.php b/plugin/migrationmoodle/src/Loader/TrackLoginLoader.php new file mode 100644 index 000000000..f858c03f2 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/TrackLoginLoader.php @@ -0,0 +1,57 @@ +format('Y-m-d H:i:s'); + + if ($incomingData['logout_date']) { + $incomingData['logout_date'] = $incomingData['logout_date']->format('Y-m-d H:i:s'); + } + + $tblTrackELogin = \Database::get_main_table(TABLE_STATISTIC_TRACK_E_LOGIN); + + $firstId = \Database::insert( + $tblTrackELogin, + [ + 'login_user_id' => $incomingData['login_user_id'], + 'login_date' => $incomingData['login_date'], + 'user_ip' => '', + ] + ); + + \Database::update( + $tblTrackELogin, + ['logout_date' => $incomingData['logout_date']], + ['login_id = ?' => [$firstId]] + ); + + $incomingData['user_ip'] = ''; + + \Database::insert( + $tblTrackELogin, + [ + 'login_user_id' => $incomingData['login_user_id'], + 'login_date' => $incomingData['logout_date'], + 'logout_date' => $incomingData['logout_date'], + 'user_ip' => '', + ] + ); + + return $incomingData['login_user_id']; + } +} diff --git a/plugin/migrationmoodle/src/Loader/UrlLoader.php b/plugin/migrationmoodle/src/Loader/UrlLoader.php new file mode 100644 index 000000000..3b18698ad --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/UrlLoader.php @@ -0,0 +1,45 @@ + $incomingData['c_id'], + 'url' => $incomingData['url'], + 'title' => $incomingData['title'], + 'description' => null, + 'category_id' => null, + 'on_homepage' => '0', + 'target' => '_self', + 'session_id' => 0, + ]; + + $link = new \Link(); + $link->setCourse( + api_get_course_info_by_id($incomingData['c_id']) + ); + $linkId = $link->save($params); + + $tblLpItem = \Database::get_course_table(TABLE_LP_ITEM); + + \Database::query("UPDATE $tblLpItem SET path = '$linkId' WHERE iid = {$incomingData['item_id']}"); + + return $linkId; + } +} diff --git a/plugin/migrationmoodle/src/Loader/UserLastLoginLoader.php b/plugin/migrationmoodle/src/Loader/UserLastLoginLoader.php new file mode 100644 index 000000000..fda4317db --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/UserLastLoginLoader.php @@ -0,0 +1,28 @@ + $incomingData['last_login']->format('Y-m-d H:i:s')], + ['id = ?' => [$incomingData['user_id']]] + ); + + return $incomingData['user_id']; + } +} diff --git a/plugin/migrationmoodle/src/Loader/UserLearnPathLessonAttemptLoader.php b/plugin/migrationmoodle/src/Loader/UserLearnPathLessonAttemptLoader.php new file mode 100644 index 000000000..45cb76598 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/UserLearnPathLessonAttemptLoader.php @@ -0,0 +1,32 @@ +findViewOfItem($incomingData); + + $itemViewParams = ['status' => 'completed']; + + if ($item['display_order'] != 1) { + $previousItemView = $this->findViewOfPreviousItem($incomingData); + + $itemViewParams['start_time'] = $previousItemView['start_time'] + $previousItemView['total_time']; + $itemView['start_time'] = $itemViewParams['start_time']; + } + + $itemViewParams['total_time'] = $incomingData['end_time'] - $itemView['start_time']; + + \Database::update( + $tblLpItemView, + $itemViewParams, + ['iid = ?' => [$itemView['iid']]] + ); + + return $itemView['iid']; + } + + /** + * @throws \Exception + * + * @return array + */ + private function findViewOfItem(array $incomingData) + { + $itemView = \Database::fetch_assoc( + \Database::query( + "SELECT lpiv.iid, lpiv.start_time + FROM c_lp_item_view lpiv + INNER JOIN c_lp_view lpv ON (lpv.iid = lpiv.lp_view_id AND lpv.c_id = lpiv.c_id) + WHERE lpiv.lp_item_id = {$incomingData['item_id']} AND lpv.user_id = {$incomingData['user_id']} + LIMIT 1" + ) + ); + + if (!$itemView) { + throw new \Exception("Item view not found for "."item ({$incomingData['item_id']}) and user ({$incomingData['user_id']})."); + } + + return $itemView; + } + + /** + * @throws \Exception + * + * @return array + */ + private function findViewOfPreviousItem(array $incomingData) + { + $result = \Database::query( + "SELECT lpiv.start_time, lpiv.total_time + FROM c_lp_item_view lpiv + INNER JOIN c_lp_view lpv ON (lpv.iid = lpiv.lp_view_id AND lpv.c_id = lpiv.c_id) + INNER JOIN c_lp_item lpi ON (lpi.iid = lpiv.lp_item_id AND lpi.c_id = lpiv.c_id) + WHERE lpi.next_item_id = {$incomingData['item_id']} AND lpv.user_id = {$incomingData['user_id']} + LIMIT 1" + ); + $previousItemView = \Database::fetch_assoc($result); + + if (!$previousItemView) { + throw new \Exception("Item view not found for "."previous item ({$incomingData['item_id']}) and user ({$incomingData['user_id']})."); + } + + return $previousItemView; + } +} diff --git a/plugin/migrationmoodle/src/Loader/UserLearnPathLessonTimerLoader.php b/plugin/migrationmoodle/src/Loader/UserLearnPathLessonTimerLoader.php new file mode 100644 index 000000000..053b5e1bf --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/UserLearnPathLessonTimerLoader.php @@ -0,0 +1,90 @@ +findViewOfParentItem($incomingData); + $itemView = $this->findViewOfFirstItem($incomingData); + + \Database::query( + "UPDATE $tblItemView SET start_time = {$incomingData['start_time']} WHERE iid = {$parentItemView['iid']}" + ); + \Database::query( + "UPDATE $tblItemView SET start_time = {$incomingData['start_time']} WHERE iid = {$itemView['iid']}" + ); + + return $itemView['iid']; + } + + /** + * @throws \Exception + * + * @return array + */ + private function findViewOfParentItem(array $incomingData) + { + $parentItemView = \Database::fetch_assoc( + \Database::query( + "SELECT lpiv.iid + FROM c_lp_item_view lpiv + INNER JOIN c_lp_view lpv ON (lpv.iid = lpiv.lp_view_id AND lpv.c_id = lpiv.c_id) + WHERE lpiv.lp_item_id = {$incomingData['parent_item_id']} + AND lpv.user_id = {$incomingData['user_id']} + LIMIT 1" + ) + ); + + if (!$parentItemView) { + throw new \Exception("Item dir ({$incomingData['parent_item_id']}) not found."); + } + + return $parentItemView; + } + + /** + * @throws \Exception + * + * @return array + */ + private function findViewOfFirstItem(array $incomingData) + { + $itemView = \Database::fetch_assoc( + \Database::query( + "SELECT lpiv.iid + FROM c_lp_item_view lpiv + INNER JOIN c_lp_view lpv + ON (lpv.iid = lpiv.lp_view_id AND lpv.c_id = lpiv.c_id) + INNER JOIN c_lp_item lpi + ON (lpi.lp_id = lpv.lp_id AND lpi.c_id = lpv.c_id AND lpi.iid = lpiv.lp_item_id) + WHERE lpi.item_type = 'document' + AND lpv.user_id = {$incomingData['user_id']} + AND lpi.parent_item_id = {$incomingData['parent_item_id']} + AND lpv.session_id = {$incomingData['session_id']} + ORDER BY lpi.display_order ASC + LIMIT 1" + ) + ); + + if (!$itemView) { + throw new \Exception("Item view not found for item with"." parent item ({$incomingData['parent_item_id']}) and user ({$incomingData['user_id']})"); + } + + return $itemView; + } +} diff --git a/plugin/migrationmoodle/src/Loader/UserLearnPathQuizLoader.php b/plugin/migrationmoodle/src/Loader/UserLearnPathQuizLoader.php new file mode 100644 index 000000000..dde61fbdd --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/UserLearnPathQuizLoader.php @@ -0,0 +1,66 @@ +findViewOfItem( + $incomingData['item_id'], + $incomingData['user_id'], + $incomingData['session_id'] + ); + + \Database::update( + \Database::get_course_table(TABLE_LP_ITEM_VIEW), + [ + 'start_time' => $incomingData['start_time'], + 'total_time' => $incomingData['total_time'], + 'score' => $incomingData['score'], + 'status' => $incomingData['status'], + ], + ['iid = ?' => $itemView['iid']] + ); + + return $itemView['iid']; + } + + /** + * @param int $itemId + * @param int $userId + * @param int $sessionId + * + * @throws \Exception + * + * @return array + */ + private function findViewOfItem($itemId, $userId, $sessionId) + { + $result = \Database::query( + "SELECT lpiv.iid + FROM c_lp_item_view lpiv + INNER JOIN c_lp_view lpv ON (lpv.iid = lpiv.lp_view_id AND lpv.c_id = lpiv.c_id) + WHERE lpiv.lp_item_id = $itemId AND lpv.user_id = $userId AND lpv.session_id = $sessionId + LIMIT 1" + ); + $itemView = \Database::fetch_assoc($result); + + if (!$itemView) { + throw new \Exception("Item view not found for item ($itemId) and user ($userId) in session ($sessionId)."); + } + + return $itemView; + } +} diff --git a/plugin/migrationmoodle/src/Loader/UserLearnPathsLoader.php b/plugin/migrationmoodle/src/Loader/UserLearnPathsLoader.php new file mode 100644 index 000000000..8922725c1 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/UserLearnPathsLoader.php @@ -0,0 +1,73 @@ + $subscription['c_id'], + 'lp_id' => $lp['iid'], + 'user_id' => $incomingData['user_id'], + 'view_count' => 1, + 'session_id' => $subscription['session_id'], + 'last_item' => 0, + ] + ); + \Database::query("UPDATE $tblLpView SET id = iid WHERE iid = $lpViewId"); + + $resItems = \Database::query( + "SELECT iid, max_score FROM $tblLpItem + WHERE lp_id = {$lp['iid']} ORDER BY parent_item_id ASC, display_order ASC" + ); + while ($lpItem = \Database::fetch_assoc($resItems)) { + $lpItemViewId = \Database::insert( + $tblLpItemView, + [ + 'c_id' => $subscription['c_id'], + 'lp_item_id' => $lpItem['iid'], + 'lp_view_id' => $lpViewId, + 'view_count' => 1, + 'status' => 'not attempted', + 'start_time' => 0, + 'total_time' => 0, + 'score' => 0, + 'max_score' => $lpItem['max_score'], + ] + ); + \Database::query("UPDATE $tblLpItemView SET id = iid WHERE iid = $lpItemViewId"); + } + } + } + + return $incomingData['user_id']; + } +} diff --git a/plugin/migrationmoodle/src/Loader/UserQuestionAttemptLoader.php b/plugin/migrationmoodle/src/Loader/UserQuestionAttemptLoader.php new file mode 100644 index 000000000..0397ec73c --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/UserQuestionAttemptLoader.php @@ -0,0 +1,30 @@ +format('Y-m-d H:i:s'); + $incomingData['position'] = 0; + + return \Database::insert( + \Database::get_main_table(TABLE_STATISTIC_TRACK_E_ATTEMPT), + $incomingData + ); + } +} diff --git a/plugin/migrationmoodle/src/Loader/UserQuizAttemptLoader.php b/plugin/migrationmoodle/src/Loader/UserQuizAttemptLoader.php new file mode 100644 index 000000000..14c98082e --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/UserQuizAttemptLoader.php @@ -0,0 +1,80 @@ +findViewByQuiz( + $incomingData['exo_id'], + $incomingData['user_id'], + $incomingData['session_id'] + ); + + /** @var \DateTime $exeDate */ + $exeDate = clone $incomingData['date']; + $exeDate->modify("+{$incomingData['duration']} seconds"); + + return \Database::insert( + \Database::get_main_table(TABLE_STATISTIC_TRACK_E_EXERCISES), + [ + 'exe_exo_id' => $incomingData['exo_id'], + 'exe_user_id' => $incomingData['user_id'], + 'c_id' => $view['c_id'], + 'status' => $incomingData['status'] === 'finished' ? '' : 'incomplete', + 'session_id' => $incomingData['session_id'], + 'data_tracking' => $incomingData['data_tracking'], + 'start_date' => $incomingData['date']->format('Y-m-d H:i:s'), + 'orig_lp_id' => $view['lp_id'], + 'orig_lp_item_id' => $view['lp_item_id'], + 'orig_lp_item_view_id' => $view['iid'], + 'exe_weighting' => $incomingData['weighting'], + 'user_ip' => '', + 'exe_date' => $exeDate->format('Y-m-d H:i:s'), + 'exe_result' => (float) $incomingData['result'], + 'steps_counter' => 0, + 'exe_duration' => $incomingData['duration'], + 'questions_to_check' => '', + ] + ); + } + + /** + * @param int $quizId + * @param int $userId + * @param int $sessionId + * + * @throws \Exception + * + * @return array + */ + private function findViewByQuiz($quizId, $userId, $sessionId) + { + $query = \Database::query("SELECT lpiv.lp_item_id, lpv.c_id, lpiv.iid, lpv.lp_id + FROM c_lp_item_view lpiv + INNER JOIN c_lp_item lpi ON (lpiv.lp_item_id = lpi.iid AND lpiv.c_id = lpi.c_id) + INNER JOIN c_lp_view lpv ON (lpv.iid = lpiv.lp_view_id AND lpv.c_id = lpiv.c_id) + WHERE lpi.path = $quizId AND lpv.user_id = $userId AND lpv.session_id = $sessionId + LIMIT 1" + ); + $result = \Database::fetch_assoc($query); + + if (!$result) { + throw new \Exception("Item view not found for quiz ($quizId) and user ($userId) in session ($sessionId)."); + } + + return $result; + } +} diff --git a/plugin/migrationmoodle/src/Loader/UserSessionLoader.php b/plugin/migrationmoodle/src/Loader/UserSessionLoader.php new file mode 100644 index 000000000..d617d136d --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/UserSessionLoader.php @@ -0,0 +1,79 @@ +loadMode == self::LOAD_MODE_REUSE) { + return $sessionInfo['id']; + } + + if ($this->loadMode === self::LOAD_MODE_DUPLICATE) { + $incomingData['name'] = '['.substr(md5(uniqid(rand())), 0, 5).'] '.$incomingData['name']; + } + } + + $urlId = \MigrationMoodlePlugin::create()->getAccessUrlId(); + $datetime = api_get_utc_datetime(); + $coachId = 1; + + $sessionId = \SessionManager::create_session( + $incomingData['name'], + $datetime, + '', + $datetime, + '', + $datetime, + '', + $coachId, + 0, + 1, + false, + null, + null, + 0, + [], + 0, + false, + $urlId + ); + \SessionManager::add_courses_to_session($sessionId, $incomingData['course_ids']); + \SessionManager::subscribeUsersToSession($sessionId, [$incomingData['user_id']]); + + return $sessionId; + } +} diff --git a/plugin/migrationmoodle/src/Loader/UsersLoader.php b/plugin/migrationmoodle/src/Loader/UsersLoader.php new file mode 100644 index 000000000..9bcf108e6 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/UsersLoader.php @@ -0,0 +1,97 @@ +loadMode == self::LOAD_MODE_REUSE) { + return $userInfo['id']; + } + + if ($this->loadMode === self::LOAD_MODE_DUPLICATE) { + $incomingData['username'] .= substr(md5(uniqid(rand())), 0, 10); + } + } + + $userId = \UserManager::create_user( + $incomingData['firstname'], + $incomingData['lastname'], + $incomingData['status'], + $incomingData['email'], + $incomingData['username'], + md5(time()), + '', + $incomingData['language'], + $incomingData['phone'], + null, + $incomingData['auth_source'], + null, + $incomingData['active'], + 0, + [], + null, + false, + false, + $incomingData['address'], + false, + null, + 0, + [] + ); + + if (empty($userId)) { + throw new \Exception('User was not created'); + } + + if ($incomingData['registration_date']) { + $incomingData['registration_date'] = $incomingData['registration_date']->format('Y-m-d H:i:s'); + + \Database::query( + "UPDATE $tblUser SET registration_date = '{$incomingData['registration_date']}' WHERE id = $userId" + ); + } + + \UserManager::update_extra_field_value($userId, 'moodle_password', $incomingData['plain_password']); + + $urlId = \MigrationMoodlePlugin::create()->getAccessUrlId(); + + if ($urlId) { + \Database::query("UPDATE access_url_rel_user SET access_url_id = $urlId WHERE user_id = $userId"); + } + + return $userId; + } +} diff --git a/plugin/migrationmoodle/src/Loader/UsersScormsViewLoader.php b/plugin/migrationmoodle/src/Loader/UsersScormsViewLoader.php new file mode 100644 index 000000000..995404a16 --- /dev/null +++ b/plugin/migrationmoodle/src/Loader/UsersScormsViewLoader.php @@ -0,0 +1,163 @@ +getUserSubscriptionInSession($incomingData['user_id'], $incomingData['c_id']); + + $lpViewId = $this->getLpView( + $incomingData['user_id'], + $incomingData['lp_id'], + $incomingData['c_id'], + $sessionId + ); + + $lpItemViewId = $this->getLpItemView($lpViewId, $incomingData['lp_item_id']); + + $itemView = [ + 'c_id' => $incomingData['c_id'], + 'lp_item_id' => $incomingData['lp_item_id'], + 'lp_view_id' => $lpViewId, + 'view_count' => $incomingData['lp_item_view_count'], + 'status' => 'not attempted', + 'start_time' => 0, + 'total_time' => 0, + 'score' => 0, + 'max_score' => 100, + ]; + + foreach (array_keys($itemView) as $key) { + if (isset($incomingData['item_data'][$key])) { + $itemView[$key] = $incomingData['item_data'][$key]; + } + } + + if (empty($lpItemViewId)) { + $lpItemViewId = \Database::insert($tblLpItemView, $itemView); + \Database::query("UPDATE $tblLpItemView SET id = iid WHERE iid = $lpItemViewId"); + } else { + \Database::update($tblLpItemView, $itemView, ['iid = ?' => [$lpItemViewId]]); + } + + \Database::query( + "UPDATE $tblLpView + SET last_item = {$incomingData['lp_item_id']}, + view_count = {$incomingData['lp_item_view_count']} + WHERE iid = $lpViewId" + ); + + return $lpViewId; + } + + /** + * @param int $userId + * @param int $courseId + * + * @throws \Exception + * + * @return int + */ + private function getUserSubscriptionInSession($userId, $courseId) + { + $srcru = \Database::select( + 'session_id', + \Database::get_main_table(TABLE_MAIN_SESSION_COURSE_USER), + [ + 'where' => [ + 'user_id = ? AND c_id = ?' => [$userId, $courseId], + ], + ], + 'first' + ); + + if (empty($srcru)) { + throw new \Exception("Session not found for user ($userId) with course ($courseId)"); + } + + return $srcru['session_id']; + } + + /** + * @param int $userId + * @param int $lpId + * @param int $cId + * @param int $sessionId + * + * @return int + */ + private function getLpView($userId, $lpId, $cId, $sessionId) + { + $tblLpView = \Database::get_course_table(TABLE_LP_VIEW); + + $lpView = \Database::select( + 'iid', + $tblLpView, + [ + 'where' => [ + 'user_id = ? AND lp_id = ? AND c_id = ? AND session_id = ?' => [ + $userId, + $lpId, + $cId, + $sessionId, + ], + ], + 'order' => 'view_count DESC', + ], + 'first' + ); + + if (empty($lpView)) { + $lpView = [ + 'c_id' => $cId, + 'lp_id' => $lpId, + 'user_id' => $userId, + 'view_count' => 1, + 'session_id' => $sessionId, + 'last_item' => 0, + ]; + + $lpViewId = \Database::insert($tblLpView, $lpView); + \Database::query("UPDATE $tblLpView SET id = iid WHERE iid = $lpViewId"); + + return $lpViewId; + } + + return $lpView['iid']; + } + + /** + * @param int $lpViewId + * @param int $lpItemId + * + * @return int + */ + private function getLpItemView($lpViewId, $lpItemId) + { + $lpItemView = \Database::fetch_assoc( + \Database::query("SELECT iid FROM c_lp_item_view WHERE lp_view_id = $lpViewId AND lp_item_id = $lpItemId") + ); + + if (empty($lpItemView)) { + return 0; + } + + return $lpItemView['iid']; + } +} diff --git a/plugin/migrationmoodle/src/Messages/ExtractMessage.php b/plugin/migrationmoodle/src/Messages/ExtractMessage.php new file mode 100644 index 000000000..b85b12112 --- /dev/null +++ b/plugin/migrationmoodle/src/Messages/ExtractMessage.php @@ -0,0 +1,24 @@ +incomingData = $incomingData; + + parent::__construct($message, $previous); + } + + public function displayAsString() + { + $pieces = [ + parent::displayAsString(), + "\t".print_r($this->incomingData, true), + ]; + + echo implode(PHP_EOL, $pieces); + } +} diff --git a/plugin/migrationmoodle/src/Messages/Message.php b/plugin/migrationmoodle/src/Messages/Message.php new file mode 100644 index 000000000..31edd2bd5 --- /dev/null +++ b/plugin/migrationmoodle/src/Messages/Message.php @@ -0,0 +1,63 @@ +message = $message; + $this->previous = $previous; + + $this->displayAsString(); + } + + /** + * @return string + */ + public function getMessage() + { + return $this->message; + } + + /** + * @return Throwable + */ + public function getPrevious() + { + return $this->previous; + } + + public function displayAsString() + { + $pieces = [$this->message]; + + if ($this->previous) { + $pieces[] = "\t".$this->previous->getMessage(); + } + + echo implode(PHP_EOL, $pieces); + } +} diff --git a/plugin/migrationmoodle/src/Messages/TransformMessage.php b/plugin/migrationmoodle/src/Messages/TransformMessage.php new file mode 100644 index 000000000..2c5c48dc3 --- /dev/null +++ b/plugin/migrationmoodle/src/Messages/TransformMessage.php @@ -0,0 +1,40 @@ +extractedData = $extractedData; + + parent::__construct($message, $previous); + } + + public function displayAsString() + { + $pieces = [ + parent::displayAsString(), + "\t".print_r($this->extractedData, true), + ]; + + echo implode(PHP_EOL, $pieces); + } +} diff --git a/plugin/migrationmoodle/src/MigrationMoodleCheckLoginCredentialsHook.php b/plugin/migrationmoodle/src/MigrationMoodleCheckLoginCredentialsHook.php new file mode 100644 index 000000000..2184f1bdc --- /dev/null +++ b/plugin/migrationmoodle/src/MigrationMoodleCheckLoginCredentialsHook.php @@ -0,0 +1,82 @@ +getEventData(); + /** @var array $userData */ + $userData = $data['user']; + /** @var array $credentials */ + $credentials = $data['credentials']; + + $extraField = $this->getExtraField(); + + if (empty($extraField)) { + return false; + } + + $fieldValue = $this->getExtraFieldValue($extraField, $userData); + + if (empty($fieldValue)) { + return false; + } + + $isPasswordVerified = password_verify( + $credentials['password'], + $fieldValue->getValue() + ); + + if (!$isPasswordVerified) { + return false; + } + + return true; + } + + /** + * @return ExtraField|null + */ + private function getExtraField() + { + return Database::getManager() + ->getRepository('ChamiloCoreBundle:ExtraField') + ->findOneBy( + [ + 'variable' => 'moodle_password', + 'extraFieldType' => ExtraField::USER_FIELD_TYPE, + ] + ); + } + + /** + * @return ExtraFieldValues|null + */ + private function getExtraFieldValue(ExtraField $extraField, array $userData) + { + return Database::getManager() + ->getRepository('ChamiloCoreBundle:ExtraFieldValues') + ->findOneBy(['field' => $extraField, 'itemId' => $userData['user_id']]); + } +} diff --git a/plugin/migrationmoodle/src/MigrationMoodlePlugin.php b/plugin/migrationmoodle/src/MigrationMoodlePlugin.php new file mode 100644 index 000000000..4ddfcf26a --- /dev/null +++ b/plugin/migrationmoodle/src/MigrationMoodlePlugin.php @@ -0,0 +1,169 @@ + 'boolean', + 'db_host' => 'text', + 'db_user' => 'text', + 'db_password' => 'text', + 'db_name' => 'text', + self::SETTING_USER_FILTER => 'text', + self::SETTING_URL_ID => 'text', + self::SETTING_MOODLE_PATH => 'text', + ]; + + parent::__construct($version, $author, $settings); + } + + /** + * @return MigrationMoodlePlugin|null + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * @throws \Doctrine\DBAL\DBALException + * + * @return Connection + */ + public function getConnection() + { + $params = [ + 'host' => $this->get('db_host'), + 'user' => $this->get('db_user'), + 'password' => $this->get('db_password'), + 'dbname' => $this->get('db_name'), + 'driver' => 'pdo_mysql', + ]; + + $connection = DriverManager::getConnection($params, new Configuration()); + + return $connection; + } + + /** + * Perform actions after configure the plugin. + * + * Add user extra field. + * + * @throws Exception + * + * @return MigrationMoodlePlugin + */ + public function performActionsAfterConfigure() + { + if ('true' === $this->get('active')) { + $this->installHook(); + } else { + $this->uninstallHook(); + } + + return $this; + } + + /** + * This method will call the Hook management insertHook to add Hook observer from this plugin. + * + * @throws Exception + * + * @return void + */ + public function installHook() + { + $hookObserver = MigrationMoodleCheckLoginCredentialsHook::create(); + + CheckLoginCredentialsHook::create()->attach($hookObserver); + } + + /** + * This method will call the Hook management deleteHook to disable Hook observer from this plugin. + * + * @throws Exception + * + * @return void + */ + public function uninstallHook() + { + $hookObserver = MigrationMoodleCheckLoginCredentialsHook::create(); + + CheckLoginCredentialsHook::create()->detach($hookObserver); + } + + /** + * @return string + */ + public function getUserFilterSetting() + { + $userFilter = $this->get(self::SETTING_USER_FILTER); + + return trim($userFilter); + } + + /** + * @return int + */ + public function getAccessUrlId() + { + $urlId = (int) $this->get(self::SETTING_URL_ID); + + return $urlId ?: 1; + } + + /** + * @return string + */ + public function getMoodledataPath() + { + $path = $this->get(self::SETTING_MOODLE_PATH); + + return rtrim($path, ' /'); + } + + /** + * @param string $name + * + * @return bool + */ + public function isTaskDone($name) + { + $result = Database::select( + 'COUNT(1) c', + 'plugin_migrationmoodle_task', + [ + 'where' => [ + 'name = ?' => Database::escape_string($name.'_task'), + 'or name = ?' => Database::escape_string($name.'_script'), + ], + ], + 'first' + ); + + return $result['c'] > 0; + } +} diff --git a/plugin/migrationmoodle/src/Script/BaseScript.php b/plugin/migrationmoodle/src/Script/BaseScript.php new file mode 100644 index 000000000..a49aff0e7 --- /dev/null +++ b/plugin/migrationmoodle/src/Script/BaseScript.php @@ -0,0 +1,94 @@ +calledClass = get_called_class(); + } + + public function run() + { + \Database::insert( + 'plugin_migrationmoodle_task', + ['name' => $this->getTaskName()] + ); + + $this->process(); + } + + abstract public function process(); + + /** + * @param int $userId + * + * @return bool + */ + protected function isLoadedUser($userId) + { + return $this->isLoadedId($userId, 'users_task'); + } + + /** + * @param int $lpId + * + * @return bool + */ + protected function isMigratedLearningPath($lpId) + { + return $this->isLoadedId($lpId, 'course_sections_task'); + } + + /** + * @param int $scormId + * + * @return bool + */ + protected function isMigratedScorm($scormId) + { + return $this->isLoadedId($scormId, 'course_modules_scorm_task'); + } + + /** + * @param string $message + */ + protected function showMessage($message) + { + echo '['.date(\DateTime::ATOM)."]\t$message".PHP_EOL; + } + + /** + * @param int $id + * @param string $taskName + * + * @return bool + */ + private function isLoadedId($id, $taskName) + { + $row = \Database::fetch_assoc( + \Database::query( + "SELECT COUNT(pmi.id) AS nbr + FROM plugin_migrationmoodle_item pmi + INNER JOIN plugin_migrationmoodle_task pmt ON pmi.task_id = pmt.id + WHERE pmt.name = '$taskName' AND pmi.loaded_id = $id" + ) + ); + + return $row['nbr'] > 0; + } +} diff --git a/plugin/migrationmoodle/src/Script/UserLearnPathsProgressScript.php b/plugin/migrationmoodle/src/Script/UserLearnPathsProgressScript.php new file mode 100644 index 000000000..b945f55f4 --- /dev/null +++ b/plugin/migrationmoodle/src/Script/UserLearnPathsProgressScript.php @@ -0,0 +1,132 @@ +countItemsInLp(); + + foreach ($this->getUsersAndLps() as $lpView) { + $userId = $lpView['user_id']; + $lpId = $lpView['lp_id']; + $cId = $lpView['c_id']; + $lpViewId = $lpView['iid']; + + $completedItems = $this->countCompletedItems($userId, $lpId, $cId); + + if (empty($completedItems) || empty($itemsInLp[$lpId])) { + continue; + } + + $progress = (int) ($completedItems / $itemsInLp[$lpId] * 100); + + \Database::query( + "UPDATE c_lp_view + SET progress = $progress + WHERE user_id = $userId + AND lp_id = $lpId + AND c_id = $cId + AND iid = $lpViewId" + ); + + $this->showMessage("Updated: c_lp_view $lpViewId with progress $progress."); + } + } + + /** + * @return array + */ + private function countItemsInLp() + { + $tblItem = \Database::get_course_table(TABLE_LP_ITEM); + $tblLp = \Database::get_course_table(TABLE_LP_MAIN); + + $result = \Database::query( + "SELECT lpi.lp_id, COUNT(lpi.iid) AS c_lpi + FROM $tblItem lpi + INNER JOIN $tblLp lp ON lpi.lp_id = lp.iid + WHERE lpi.item_type != 'dir' AND lp.lp_type = 1 + GROUP BY lpi.lp_id" + ); + + $data = []; + + while ($row = \Database::fetch_assoc($result)) { + $data[$row['lp_id']] = $row['c_lpi']; + } + + return $data; + } + + /** + * @return \Generator + */ + private function getUsersAndLps() + { + $tblLpView = \Database::get_course_table(TABLE_LP_VIEW); + $tblLp = \Database::get_course_table(TABLE_LP_MAIN); + + $result = \Database::query( + "SELECT lpv.iid, lpv.lp_id, lpv.user_id, lpv.c_id + FROM $tblLpView lpv + INNER JOIN $tblLp lp ON lpv.lp_id = lp.iid + INNER JOIN plugin_migrationmoodle_item pmi ON pmi.loaded_id = lpv.user_id + INNER JOIN plugin_migrationmoodle_task pmt ON pmi.task_id = pmt.id + WHERE lp.lp_type = 1 AND pmt.name = 'users_task'" + ); + + while ($row = \Database::fetch_assoc($result)) { + if (!$this->isLoadedUser($row['user_id']) || + !$this->isMigratedLearningPath($row['lp_id']) + ) { + continue; + } + + yield $row; + } + } + + /** + * @param int $userId + * @param int $lpId + * @param int $cId + * + * @return int + */ + private function countCompletedItems($userId, $lpId, $cId) + { + $tblItemView = \Database::get_course_table(TABLE_LP_ITEM_VIEW); + $tblLpView = \Database::get_course_table(TABLE_LP_VIEW); + $tblLp = \Database::get_course_table(TABLE_LP_MAIN); + + $result = \Database::query("SELECT + lpiv.lp_view_id, + lpiv.c_id, + COUNT(lpiv.lp_item_id) c_lpiv + FROM $tblItemView lpiv + INNER JOIN $tblLpView lpv ON (lpiv.lp_view_id = lpv.iid AND lpiv.c_id = lpv.c_id) + INNER JOIN $tblLp lp ON (lpv.lp_id = lp.iid AND lpv.c_id = lp.c_id) + WHERE lpiv.status = 'completed' + AND lpv.user_id = $userId + AND lp.iid = $lpId + AND lp.c_id = $cId + AND lp.lp_type = 1 + GROUP BY lpiv.lp_view_id"); + + $row = \Database::fetch_assoc($result); + + if (empty($row) || empty($row['c_lpiv'])) { + return 0; + } + + return $row['c_lpiv']; + } +} diff --git a/plugin/migrationmoodle/src/Script/UserScormsProgressScript.php b/plugin/migrationmoodle/src/Script/UserScormsProgressScript.php new file mode 100644 index 000000000..d878ef224 --- /dev/null +++ b/plugin/migrationmoodle/src/Script/UserScormsProgressScript.php @@ -0,0 +1,138 @@ +countItemsInLp(); + + foreach ($this->getUsersAndLps() as $lpView) { + $userId = $lpView['user_id']; + $lpId = $lpView['lp_id']; + $cId = $lpView['c_id']; + $lpViewId = $lpView['iid']; + + $completedItems = $this->countCompletedItems($userId, $lpId, $cId); + + if (empty($completedItems) || empty($itemsInLp[$lpId])) { + continue; + } + + if ($completedItems > $itemsInLp[$lpId]) { + $progress = 100; + } else { + $progress = (int) ($completedItems / $itemsInLp[$lpId] * 100); + } + + \Database::query( + "UPDATE c_lp_view + SET progress = $progress + WHERE user_id = $userId + AND lp_id = $lpId + AND c_id = $cId + AND iid = $lpViewId" + ); + + $this->showMessage("Updated: c_lp_view $lpViewId with progress $progress."); + } + } + + /** + * @return array + */ + private function countItemsInLp() + { + $tblItem = \Database::get_course_table(TABLE_LP_ITEM); + $tblLp = \Database::get_course_table(TABLE_LP_MAIN); + + $result = \Database::query( + "SELECT lpi.lp_id, COUNT(lpi.iid) AS c_lpi + FROM $tblItem lpi + INNER JOIN $tblLp lp ON lpi.lp_id = lp.iid + WHERE lpi.item_type = 'sco' AND lp.lp_type = 2 + GROUP BY lpi.lp_id" + ); + + $data = []; + + while ($row = \Database::fetch_assoc($result)) { + $data[$row['lp_id']] = $row['c_lpi']; + } + + return $data; + } + + /** + * @return \Generator + */ + private function getUsersAndLps() + { + $tblLpView = \Database::get_course_table(TABLE_LP_VIEW); + $tblLp = \Database::get_course_table(TABLE_LP_MAIN); + + $result = \Database::query( + "SELECT lpv.iid, lpv.lp_id, lpv.user_id, lpv.c_id + FROM $tblLpView lpv + INNER JOIN $tblLp lp ON lpv.lp_id = lp.iid + WHERE lp.lp_type = 2" + ); + + while ($row = \Database::fetch_assoc($result)) { + if (!$this->isLoadedUser($row['user_id']) || + !$this->isMigratedScorm($row['lp_id']) + ) { + continue; + } + + yield $row; + } + } + + /** + * @param int $userId + * @param int $lpId + * @param int $cId + * + * @return int + */ + private function countCompletedItems($userId, $lpId, $cId) + { + $tblItemView = \Database::get_course_table(TABLE_LP_ITEM_VIEW); + $tblLpView = \Database::get_course_table(TABLE_LP_VIEW); + $tblLp = \Database::get_course_table(TABLE_LP_MAIN); + + $result = \Database::query("SELECT + lpiv.lp_view_id, + lpiv.c_id, + COUNT(lpiv.lp_item_id) c_lpiv + FROM $tblItemView lpiv + INNER JOIN $tblLpView lpv ON (lpiv.lp_view_id = lpv.iid AND lpiv.c_id = lpv.c_id) + INNER JOIN $tblLp lp ON (lpv.lp_id = lp.iid AND lpv.c_id = lp.c_id) + WHERE lpiv.status = 'completed' + AND lpv.user_id = $userId + AND lp.iid = $lpId + AND lp.c_id = $cId + AND lp.lp_type = 2 + GROUP BY lpiv.lp_view_id, lpiv.lp_item_id"); + + if (\Database::num_rows($result) == 0) { + return 0; + } + + $count = 0; + + while ($row = \Database::fetch_assoc($result)) { + $count += (int) $row['c_lpiv']; + } + + return $count; + } +} diff --git a/plugin/migrationmoodle/src/Task/BaseTask.php b/plugin/migrationmoodle/src/Task/BaseTask.php new file mode 100644 index 000000000..962079c46 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/BaseTask.php @@ -0,0 +1,199 @@ +plugin = \MigrationMoodlePlugin::create(); + + $this->extractor = $this->getExtractor(); + + $this->transformer = $this->getTransformer(); + + $this->loader = $this->getLoader(); + + $this->calledClass = get_called_class(); + } + + /** + * @return array + */ + abstract public function getExtractConfiguration(); + + /** + * @return array + */ + abstract public function getTransformConfiguration(); + + /** + * @return array + */ + abstract public function getLoadConfiguration(); + + public function execute() + { + $outputBuffering = isset($GLOBALS['outputBuffering']) ? $GLOBALS['outputBuffering'] : true; + + $taskId = \Database::insert( + 'plugin_migrationmoodle_task', + ['name' => $this->getTaskName()] + ); + + $i = 0; + + foreach ($this->executeETL() as $hash => $ids) { + \Database::insert( + 'plugin_migrationmoodle_item', + [ + 'hash' => $hash, + 'extracted_id' => (int) $ids['extracted'], + 'loaded_id' => (int) $ids['loaded'], + 'task_id' => $taskId, + ] + ); + + echo "[".date(\DateTime::ATOM)."]\tData migrated: $hash".PHP_EOL; + + $i++; + + if ($i % 10 === 0 && $outputBuffering) { + flush(); + ob_flush(); + } + } + + if ($outputBuffering) { + ob_end_flush(); + } + } + + /** + * @return \Generator + */ + private function executeETL() + { + foreach ($this->extractFiltered() as $extractedData) { + try { + $incomingData = $this->transformer->transform($extractedData); + } catch (\Exception $exception) { + new TransformMessage($extractedData, $exception); + + continue; + } + + try { + $loadedId = $this->loader->load($incomingData); + } catch (\Exception $exception) { + new LoadMessage($incomingData, $exception); + + continue; + } + + yield md5("{$extractedData['id']}@@$loadedId") => [ + 'extracted' => $extractedData['id'], + 'loaded' => $loadedId, + ]; + } + } + + /** + * @return \Generator + */ + private function extractFiltered() + { + try { + foreach ($this->extractor->extract() as $extractedData) { + if ($this->extractor->filter($extractedData)) { + continue; + } + + yield $extractedData; + } + } catch (\Exception $exception) { + new ExtractMessage($exception); + } + } + + /** + * @return ExtractorInterface + */ + private function getExtractor() + { + $configuration = $this->getExtractConfiguration(); + + $extractorClass = $configuration['class']; + /** @var ExtractorInterface $extractor */ + $extractor = new $extractorClass($configuration); + + return $extractor; + } + + /** + * @return TransformerInterface + */ + private function getTransformer() + { + $configuration = $this->getTransformConfiguration(); + + $transformerClass = $configuration['class']; + /** @var TransformerInterface $extractor */ + $extractor = new $transformerClass($configuration); + + return $extractor; + } + + /** + * @return LoaderInterface + */ + private function getLoader() + { + $configuration = $this->getLoadConfiguration(); + + $loaderClass = $configuration['class']; + /** @var LoaderInterface $extractor */ + $extractor = new $loaderClass($configuration); + + return $extractor; + } +} diff --git a/plugin/migrationmoodle/src/Task/CQuizTask.php b/plugin/migrationmoodle/src/Task/CQuizTask.php new file mode 100644 index 000000000..e8b7365b9 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/CQuizTask.php @@ -0,0 +1,77 @@ + BaseExtractor::class, + 'query' => 'SELECT * FROM mdl_quiz', + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'exerciseTitle' => 'name', + 'exerciseDescription' => 'intro', + //'exerciseFeedbackType', + //'results_disabled', + //'exerciseType', + //'question_selection_type', + //'randomQuestions' => 'shufflequestions', + 'randomAnswers' => 'shuffleanswers', + //'display_category_name', + //'hide_question_title', + 'exerciseAttempts' => 'attempts', + //'activate_start_date_check', + 'start_time' => 'timeopen', + //'activate_end_date_check', + 'end_time' => 'timeclose', + //'enabletimercontrol', + 'enabletimercontroltotalminutes' => 'timelimit', + 'pass_percentage' => [ + 'class' => Percentage::class, + 'properties' => ['sumgrades', 'grade'], + ], + //'text_when_finished', + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => CQuizLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/CourseCategoriesTask.php b/plugin/migrationmoodle/src/Task/CourseCategoriesTask.php new file mode 100644 index 000000000..63dcc3936 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/CourseCategoriesTask.php @@ -0,0 +1,61 @@ + BaseExtractor::class, + 'query' => 'SELECT * FROM mdl_course_categories ORDER BY parent ASC, id ASC', + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'name' => 'name', + 'code' => [ + 'class' => CourseCode::class, + 'properties' => ['name'], + ], + 'description' => 'description', + 'parent_id' => [ + 'class' => CourseCategoryLookup::class, + 'properties' => ['parent'], + ], + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => CourseCategoriesLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/CourseFilesTask.php b/plugin/migrationmoodle/src/Task/CourseFilesTask.php new file mode 100644 index 000000000..4fab46226 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/CourseFilesTask.php @@ -0,0 +1,47 @@ + BaseTransformer::class, + 'map' => [ + 'contenthash' => 'contenthash', + 'filepath' => 'filepath', + 'filename' => 'filename', + 'filesize' => 'filesize', + 'mimetype' => 'mimetype', + 'course' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => CourseFilesLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/CourseIntroductionsTask.php b/plugin/migrationmoodle/src/Task/CourseIntroductionsTask.php new file mode 100644 index 000000000..690071315 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/CourseIntroductionsTask.php @@ -0,0 +1,64 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT id, course, name, summary + FROM mdl_course_sections + WHERE section = 0 AND (summary != '' AND summary IS NOT NULL)", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'name' => 'name', + 'description' => [ + 'class' => ReplaceFilePaths::class, + 'properties' => ['summary', 'course'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => CourseIntroductionLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/CourseModulesLessonTask.php b/plugin/migrationmoodle/src/Task/CourseModulesLessonTask.php new file mode 100644 index 000000000..a0eebd9ef --- /dev/null +++ b/plugin/migrationmoodle/src/Task/CourseModulesLessonTask.php @@ -0,0 +1,68 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT cm.id, l.course, l.name, cm.section + FROM mdl_lesson l + INNER JOIN mdl_course_modules cm ON (l.course = cm.course AND cm.instance = l.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'lesson' + ORDER BY cs.id, FIND_IN_SET(cm.id, cs.sequence)", + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_code' => [ + 'class' => LoadedCourseCodeLookup::class, + 'properties' => ['course'], + ], + 'lp_id' => [ + 'class' => LoadedCourseSectionLookup::class, + 'properties' => ['section'], + ], + 'title' => 'name', + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => CourseModulesLessonLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/CourseModulesQuizTask.php b/plugin/migrationmoodle/src/Task/CourseModulesQuizTask.php new file mode 100644 index 000000000..ff814d6c4 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/CourseModulesQuizTask.php @@ -0,0 +1,68 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT cm.id, q.course, q.name, cm.section + FROM mdl_quiz q + INNER JOIN mdl_course_modules cm ON (q.course = cm.course AND cm.instance = q.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'quiz' + ORDER BY cs.id, FIND_IN_SET(cm.id, cs.sequence)", + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_code' => [ + 'class' => LoadedCourseCodeLookup::class, + 'properties' => ['course'], + ], + 'lp_id' => [ + 'class' => LoadedCourseSectionLookup::class, + 'properties' => ['section'], + ], + 'title' => 'name', + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => CourseModulesQuizLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/CourseModulesScormTask.php b/plugin/migrationmoodle/src/Task/CourseModulesScormTask.php new file mode 100644 index 000000000..715d21eb3 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/CourseModulesScormTask.php @@ -0,0 +1,92 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + sco.id, + sco.course, + sco.name, + sco.reference, + sco.version, + sco.maxgrade, + sco.hidetoc, + i.identifier, + cm.added, + sco.timemodified + FROM mdl_scorm sco + INNER JOIN mdl_scorm_scoes i on sco.id = i.scorm + INNER JOIN mdl_course_modules cm ON (sco.course = cm.course AND cm.instance = sco.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'scorm' + AND i.parent = '/' + ORDER BY cs.id, FIND_IN_SET(cm.id, cs.sequence)", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'name' => 'name', + 'ref' => 'identifier', + 'path' => 'reference', + 'use_max_score' => 'maxgrade', + 'hide_toc_frame' => 'hidetoc', + 'created_on' => [ + 'class' => DateTimeObject::class, + 'properties' => ['added'], + ], + 'modified_on' => [ + 'class' => DateTimeObject::class, + 'properties' => ['timemodified'], + ], + 'publicated_on' => [ + 'class' => DateTimeObject::class, + 'properties' => ['added'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => CourseModulesScormLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/CourseModulesUrlTask.php b/plugin/migrationmoodle/src/Task/CourseModulesUrlTask.php new file mode 100644 index 000000000..7adf7fa54 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/CourseModulesUrlTask.php @@ -0,0 +1,75 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT cm.id, u.course, u.name, cm.section + FROM mdl_url u + INNER JOIN mdl_course_modules cm ON (u.course = cm.course AND cm.instance = u.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'url' + AND u.course NOT IN ( + SELECT sco.course + FROM mdl_scorm sco + INNER JOIN mdl_course_modules cm ON (sco.course = cm.course AND cm.instance = sco.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'scorm' + )", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_code' => [ + 'class' => LoadedCourseCodeLookup::class, + 'properties' => ['course'], + ], + 'lp_id' => [ + 'class' => LoadedCourseSectionLookup::class, + 'properties' => ['section'], + ], + 'title' => 'name', + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => CourseModulesUrlLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/CourseSectionsTask.php b/plugin/migrationmoodle/src/Task/CourseSectionsTask.php new file mode 100644 index 000000000..19f350173 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/CourseSectionsTask.php @@ -0,0 +1,74 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT id, course, name, summary + FROM mdl_course_sections + WHERE section > 0 AND (name != '' OR name IS NOT NULL) + AND course NOT IN ( + SELECT sco.course + FROM mdl_scorm sco + INNER JOIN mdl_course_modules cm ON (sco.course = cm.course AND cm.instance = sco.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'scorm' + ) + ORDER BY course, section", + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'course_code' => [ + 'class' => LoadedCourseCodeLookup::class, + 'properties' => ['course'], + ], + 'name' => 'name', + 'description' => [ + 'class' => WrapHtmlReplacingFilePaths::class, + 'properties' => ['summary', 'course'], + ], + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => CourseSectionsLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/CoursesTask.php b/plugin/migrationmoodle/src/Task/CoursesTask.php new file mode 100644 index 000000000..8c8ca63fb --- /dev/null +++ b/plugin/migrationmoodle/src/Task/CoursesTask.php @@ -0,0 +1,85 @@ +plugin->getUserFilterSetting(); + + if (!empty($userFilter)) { + $query = "SELECT DISTINCT c.* + FROM mdl_course c + INNER JOIN mdl_context ctx ON c.id = ctx.instanceid + INNER JOIN mdl_role_assignments ra ON ctx.id = ra.contextid + INNER JOIN mdl_user u ON ra.userid = u.id + WHERE u.username LIKE '$userFilter%'"; + } + + return [ + 'class' => BaseExtractor::class, + 'query' => $query, + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'title' => 'fullname', + 'wanted_code' => 'shortname', + 'course_category' => [ + 'class' => CourseCategoryLookup::class, + 'properties' => ['category'], + ], + 'course_language' => [ + 'class' => Language::class, + 'properties' => ['lang'], + ], + 'visibility' => [ + 'class' => CourseVisibility::class, + 'properties' => ['visible'], + ], + 'description' => 'summary', + 'creation_date' => [ + 'class' => DateTimeObject::class, + 'properties' => ['timecreated'], + ], + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => CoursesLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/FilesForCourseIntroductionsTask.php b/plugin/migrationmoodle/src/Task/FilesForCourseIntroductionsTask.php new file mode 100644 index 000000000..0c6e2923a --- /dev/null +++ b/plugin/migrationmoodle/src/Task/FilesForCourseIntroductionsTask.php @@ -0,0 +1,41 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + f.id, + f.contenthash, + f.filepath, + f.filename, + f.filesize, + f.mimetype, + c.id course + FROM mdl_files f + INNER JOIN mdl_context ctx ON f.contextid = ctx.id + INNER JOIN mdl_course c ON ctx.instanceid = c.id + INNER JOIN mdl_course_sections cs ON (cs.course = c.id AND cs.id = f.itemid) + WHERE f.component = 'course' + AND f.filearea = 'section' + AND ctx.contextlevel = 50 + AND f.filename NOT IN ('.', '..') + AND cs.section = 0 AND (cs.summary != '' AND cs.summary IS NOT NULL)", + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/FilesForCourseSectionsTask.php b/plugin/migrationmoodle/src/Task/FilesForCourseSectionsTask.php new file mode 100644 index 000000000..70a7928e0 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/FilesForCourseSectionsTask.php @@ -0,0 +1,49 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + f.id, + f.contenthash, + f.filepath, + f.filename, + f.filesize, + f.mimetype, + c.id course + FROM mdl_files f + INNER JOIN mdl_context ctx ON f.contextid = ctx.id + INNER JOIN mdl_course c ON ctx.instanceid = c.id + INNER JOIN mdl_course_sections cs ON (cs.course = c.id AND cs.id = f.itemid) + WHERE f.component = 'course' + AND f.filearea = 'section' + AND ctx.contextlevel = 50 + AND f.filename NOT IN ('.', '..') + AND cs.section > 0 + AND c.id NOT IN ( + SELECT sco.course + FROM mdl_scorm sco + INNER JOIN mdl_course_modules cm ON (sco.course = cm.course AND cm.instance = sco.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'scorm' + )", + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/FilesForLessonAnswersTask.php b/plugin/migrationmoodle/src/Task/FilesForLessonAnswersTask.php new file mode 100644 index 000000000..06ec494f5 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/FilesForLessonAnswersTask.php @@ -0,0 +1,41 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + f.id, + f.contenthash, + f.filepath, + f.filename, + f.filesize, + f.mimetype, + cm.course + FROM mdl_files f + INNER JOIN mdl_context c ON f.contextid = c.id + INNER JOIN mdl_course_modules cm ON c.instanceid = cm.id + WHERE f.component = 'mod_lesson' + AND f.filearea = 'page_answers' + AND c.contextlevel = 70 + AND f.filename NOT IN ('.', '..')", + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/FilesForLessonPagesTask.php b/plugin/migrationmoodle/src/Task/FilesForLessonPagesTask.php new file mode 100644 index 000000000..1cd52a633 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/FilesForLessonPagesTask.php @@ -0,0 +1,41 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + f.id, + f.contenthash, + f.filepath, + f.filename, + f.filesize, + f.mimetype, + cm.course + FROM mdl_files f + INNER JOIN mdl_context c ON f.contextid = c.id + INNER JOIN mdl_course_modules cm ON c.instanceid = cm.id + WHERE f.component = 'mod_lesson' + AND f.filearea = 'page_contents' + AND c.contextlevel = 70 + AND f.filename NOT IN ('.', '..')", + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/FilesForQuizzesTask.php b/plugin/migrationmoodle/src/Task/FilesForQuizzesTask.php new file mode 100644 index 000000000..c7e675875 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/FilesForQuizzesTask.php @@ -0,0 +1,39 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + f.id, + f.contenthash, + f.filepath, + f.filename, + f.filesize, + f.mimetype, + cm.course + FROM mdl_files f + INNER JOIN mdl_context c ON f.contextid = c.id + INNER JOIN mdl_course_modules cm ON c.instanceid = cm.id + WHERE f.component = 'mod_quiz' + AND f.filearea = 'intro' + AND c.contextlevel = 70 + AND f.filename NOT IN ('.', '..')", + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/FilesForScormScoesTask.php b/plugin/migrationmoodle/src/Task/FilesForScormScoesTask.php new file mode 100644 index 000000000..93609b9e2 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/FilesForScormScoesTask.php @@ -0,0 +1,83 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + f.id, + f.contenthash, + f.filepath, + f.filename, + f.mimetype, + s.name scorm_name, + cm.course + FROM mdl_files f + INNER JOIN mdl_context ctx ON f.contextid = ctx.id + INNER JOIN mdl_course_modules cm ON ctx.instanceid = cm.id + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_scorm s ON (cm.course = s.course AND cm.instance = s.id) + WHERE + m.name = 'scorm' + AND ctx.contextlevel = 70 + AND f.filename NOT IN ('.', '..') + AND s.reference != f.filename + AND f.filearea = 'content' + AND f.component = 'mod_scorm' + ORDER BY s.course, s.id", + ]; + } + + /** + * {@inheritdoc} + */ + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'contenthash' => 'contenthash', + 'filepath' => 'filepath', + 'filename' => 'filename', + 'mimetype' => 'mimetype', + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'lp_name' => 'scorm_name', + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => FilesForScormScoLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/LessonAnswersEssayTask.php b/plugin/migrationmoodle/src/Task/LessonAnswersEssayTask.php new file mode 100644 index 000000000..ddd19ca76 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/LessonAnswersEssayTask.php @@ -0,0 +1,70 @@ + LoadedCoursesFilterExtractor::class, + 'query' => 'SELECT la.id, la.pageid, la.score, l.course + FROM mdl_lesson_answers la + INNER JOIN mdl_lesson_pages lp ON (la.pageid = lp.id AND la.lessonid = lp.lessonid) + INNER JOIN mdl_lesson l ON (lp.lessonid = l.id AND la.lessonid = l.id) + WHERE lp.qtype = 10 + ORDER BY lp.id', + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'quiz_id' => [ + 'class' => LoadedLessonPageQuizLookup::class, + 'properties' => ['pageid'], + ], + 'question_id' => [ + 'class' => LoadedLessonPageQuizQuestionLookup::class, + 'properties' => ['pageid'], + ], + 'score' => 'score', + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonAnswersEssayLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/LessonAnswersMatchingTask.php b/plugin/migrationmoodle/src/Task/LessonAnswersMatchingTask.php new file mode 100644 index 000000000..982c546f9 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/LessonAnswersMatchingTask.php @@ -0,0 +1,83 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT la.id, la.pageid, la.answer, la.response, la.lessonid, l.course + FROM mdl_lesson_answers la + INNER JOIN mdl_lesson_pages lp ON (la.pageid = lp.id AND la.lessonid = lp.lessonid) + INNER JOIN mdl_lesson l ON (lp.lessonid = l.id AND la.lessonid = l.id) + WHERE lp.qtype = 5 + AND (la.response IS NOT NULL OR la.response != '') + ORDER BY lp.id", + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'quiz_id' => [ + 'class' => LoadedLessonPageQuizLookup::class, + 'properties' => ['pageid'], + ], + 'question_id' => [ + 'class' => LoadedLessonPageQuizQuestionLookup::class, + 'properties' => ['pageid'], + ], + 'score' => [ + 'class' => LessonAnswersMatchingScore::class, + 'properties' => ['pageid', 'lessonid', 'course'], + ], + 'answer' => [ + 'class' => ReplaceFilePaths::class, + 'properties' => ['answer', 'course'], + ], + 'feedback' => 'response', + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonAnswersMatchingLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/LessonAnswersMultipleAnswerTask.php b/plugin/migrationmoodle/src/Task/LessonAnswersMultipleAnswerTask.php new file mode 100644 index 000000000..4d75e97ea --- /dev/null +++ b/plugin/migrationmoodle/src/Task/LessonAnswersMultipleAnswerTask.php @@ -0,0 +1,43 @@ + LoadedCoursesFilterExtractor::class, + 'query' => 'SELECT la.id, la.pageid, la.score, la.answer, la.response, l.course + FROM mdl_lesson_answers la + INNER JOIN mdl_lesson_pages lp ON (la.pageid = lp.id AND la.lessonid = lp.lessonid) + INNER JOIN mdl_lesson l ON (lp.lessonid = l.id AND la.lessonid = l.id) + WHERE lp.qtype = 3 AND lp.qoption = 1 + ORDER BY lp.id', + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonAnswersMultipleAnswerLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/LessonAnswersMultipleChoiceTask.php b/plugin/migrationmoodle/src/Task/LessonAnswersMultipleChoiceTask.php new file mode 100644 index 000000000..2d689928c --- /dev/null +++ b/plugin/migrationmoodle/src/Task/LessonAnswersMultipleChoiceTask.php @@ -0,0 +1,43 @@ + LoadedCoursesFilterExtractor::class, + 'query' => 'SELECT la.id, la.pageid, la.score, la.answer, la.response, l.course + FROM mdl_lesson_answers la + INNER JOIN mdl_lesson_pages lp ON (la.pageid = lp.id AND la.lessonid = lp.lessonid) + INNER JOIN mdl_lesson l ON (lp.lessonid = l.id AND la.lessonid = l.id) + WHERE lp.qtype = 3 AND lp.qoption = 0 + ORDER BY lp.id', + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonAnswersMultipleChoiceLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/LessonAnswersShortAnswerTask.php b/plugin/migrationmoodle/src/Task/LessonAnswersShortAnswerTask.php new file mode 100644 index 000000000..9e995e511 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/LessonAnswersShortAnswerTask.php @@ -0,0 +1,83 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + la.id, + la.pageid, + GROUP_CONCAT(la.answer SEPARATOR '||') answers, + GROUP_CONCAT(la.response SEPARATOR '') comment, + MAX(la.score) scores, + l.course, + COUNT(la.pageid) nb + FROM mdl_lesson_answers la + INNER JOIN mdl_lesson_pages lp ON (la.pageid = lp.id AND la.lessonid = lp.lessonid) + INNER JOIN mdl_lesson l ON (lp.lessonid = l.id AND la.lessonid = l.id) + WHERE lp.qtype IN (1, 8) + GROUP BY lp.id + ORDER BY lp.id", + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'quiz_id' => [ + 'class' => LoadedLessonPageQuizLookup::class, + 'properties' => ['pageid'], + ], + 'question_id' => [ + 'class' => LoadedLessonPageQuizQuestionLookup::class, + 'properties' => ['pageid'], + ], + 'scores' => 'scores', + 'answers' => 'answers', + 'comment' => 'comment', + 'nb' => 'nb', + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonAnswersShortAnswerLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/LessonAnswersTrueFalseTask.php b/plugin/migrationmoodle/src/Task/LessonAnswersTrueFalseTask.php new file mode 100644 index 000000000..c8a8cd1a7 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/LessonAnswersTrueFalseTask.php @@ -0,0 +1,85 @@ + LoadedCoursesFilterExtractor::class, + 'query' => 'SELECT la.id, la.pageid, la.score, la.answer, la.response, l.course, + ( + SELECT MIN(id) = la.id + FROM mdl_lesson_answers + WHERE pageid = la.pageid + GROUP BY lessonid, pageid + ) is_correct + FROM mdl_lesson_answers la + INNER JOIN mdl_lesson_pages lp ON (la.pageid = lp.id AND la.lessonid = lp.lessonid) + INNER JOIN mdl_lesson l ON (lp.lessonid = l.id AND la.lessonid = l.id) + WHERE lp.qtype = 2 + ORDER BY lp.id', + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'quiz_id' => [ + 'class' => LoadedLessonPageQuizLookup::class, + 'properties' => ['pageid'], + ], + 'question_id' => [ + 'class' => LoadedLessonPageQuizQuestionLookup::class, + 'properties' => ['pageid'], + ], + 'score' => 'score', + 'answer' => [ + 'class' => ReplaceFilePaths::class, + 'properties' => ['answer', 'course'], + ], + 'feedback' => 'response', + 'is_correct' => 'is_correct', + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonAnswersTrueFalseLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/LessonPagesDocumentTask.php b/plugin/migrationmoodle/src/Task/LessonPagesDocumentTask.php new file mode 100644 index 000000000..4cf51b2d5 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/LessonPagesDocumentTask.php @@ -0,0 +1,75 @@ + LoadedCoursesFilterExtractor::class, + 'query' => 'SELECT lp.id, l.id lessonid, l.course, lp.title, lp.contents + FROM mdl_lesson_pages lp + INNER JOIN mdl_lesson l ON lp.lessonid = l.id + WHERE lp.qtype = 20', + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'lp_id' => [ + 'class' => LoadedCourseSectionFromLessonLookup::class, + 'properties' => ['lessonid'], + ], + 'item_id' => [ + 'class' => LoadedLessonPageLookup::class, + 'properties' => ['id'], + ], + 'item_title' => 'title', + 'item_content' => [ + 'class' => WrapHtmlReplacingFilePaths::class, + 'properties' => ['contents', 'course'], + ], + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonPagesDocumentLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/LessonPagesQuizQuestionTask.php b/plugin/migrationmoodle/src/Task/LessonPagesQuizQuestionTask.php new file mode 100644 index 000000000..1c89aa39f --- /dev/null +++ b/plugin/migrationmoodle/src/Task/LessonPagesQuizQuestionTask.php @@ -0,0 +1,77 @@ + LoadedCoursesFilterExtractor::class, + 'query' => 'SELECT lp.id, l.course, lp.contents, lp.qoption, lp.qtype + FROM mdl_lesson_pages lp + INNER JOIN mdl_lesson l ON lp.lessonid = l.id + WHERE lp.qtype IN (1, 2, 3, 5, 8, 10)', + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'quiz_id' => [ + 'class' => LoadedLessonPageQuizLookup::class, + 'properties' => ['id'], + ], + 'question_title' => [ + 'class' => ReplaceFilePaths::class, + 'properties' => ['contents', 'course'], + ], + 'question_type' => [ + 'class' => QuizQuestionTypeFromLessonPage::class, + 'properties' => ['qtype', 'qoption'], + ], + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonQuestionPagesQuestionLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/LessonPagesQuizTask.php b/plugin/migrationmoodle/src/Task/LessonPagesQuizTask.php new file mode 100644 index 000000000..760438dad --- /dev/null +++ b/plugin/migrationmoodle/src/Task/LessonPagesQuizTask.php @@ -0,0 +1,65 @@ + LoadedCoursesFilterExtractor::class, + 'query' => 'SELECT lp.id, l.course, lp.title + FROM mdl_lesson_pages lp + INNER JOIN mdl_lesson l ON lp.lessonid = l.id + WHERE lp.qtype IN (1, 2, 3, 5, 8, 10)', + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'item_id' => [ + 'class' => LoadedLessonPageLookup::class, + 'properties' => ['id'], + ], + 'item_title' => 'title', + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonQuestionPagesQuizLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/LessonPagesTask.php b/plugin/migrationmoodle/src/Task/LessonPagesTask.php new file mode 100644 index 000000000..66a3da4db --- /dev/null +++ b/plugin/migrationmoodle/src/Task/LessonPagesTask.php @@ -0,0 +1,104 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "WITH RECURSIVE lesson_pages_ordered (id, title, qtype, prev, next, lesson, display_order) AS + ( + SELECT id, title, qtype, prevpageid, nextpageid, lessonid, '01' + FROM mdl_lesson_pages + WHERE prevpageid = 0 + UNION + SELECT lp.id, lp.title, lp.qtype, lp.prevpageid, lp.nextpageid, lp.lessonid, lpo.display_order + 1 + FROM lesson_pages_ordered lpo + LEFT JOIN mdl_lesson_pages lp + ON (lpo.next = lp.id AND lpo.lesson = lp.lessonid) + ) + SELECT + lpo.id, + lpo.title, + lpo.qtype, + lpo.prev, + lpo.lesson, + CAST(lpo.display_order AS SIGNED) lpo_display_order, + l.course + FROM lesson_pages_ordered lpo + INNER JOIN mdl_lesson l ON lpo.lesson = l.id + WHERE lpo.qtype NOT IN (".self::TYPE_END_BRANCH.", ".self::TYPE_CLUSTER.", ".self::TYPE_END_CLUSTER.") + ORDER BY l.course, lpo.lesson, lpo_display_order", + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_code' => [ + 'class' => LoadedCourseCodeLookup::class, + 'properties' => ['course'], + ], + 'lp_id' => [ + 'class' => LoadedCourseSectionFromLessonLookup::class, + 'properties' => ['lesson'], + ], + 'parent' => [ + 'class' => LoadedCourseModuleLessonLookup::class, + 'properties' => ['lesson'], + ], + 'previous' => [ + 'class' => LoadedLessonPageLookup::class, + 'properties' => ['prev'], + ], + 'item_type' => [ + 'class' => LessonPageType::class, + 'properties' => ['qtype'], + ], + 'title' => 'title', + 'display_order' => 'lpo_display_order', + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonPagesLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/QuestionCategoriesTask.php b/plugin/migrationmoodle/src/Task/QuestionCategoriesTask.php new file mode 100644 index 000000000..d94f4ba4c --- /dev/null +++ b/plugin/migrationmoodle/src/Task/QuestionCategoriesTask.php @@ -0,0 +1,62 @@ + BaseExtractor::class, + 'query' => "SELECT qc.id, qc.name, qc.info, c.contextlevel, c.instanceid + FROM mdl_question_categories qc + INNER JOIN mdl_context c ON qc.contextid = c.id + WHERE c.contextlevel IN (50, 70) + AND qc.parent != 0", + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseFromQuestionCategoryLookup::class, + 'properties' => ['contextlevel', 'instanceid'], + ], + 'name' => 'name', + 'description' => 'info', + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => QuestionCategoriesLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/QuestionGapselectTask.php b/plugin/migrationmoodle/src/Task/QuestionGapselectTask.php new file mode 100644 index 000000000..3cb0aeeb8 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/QuestionGapselectTask.php @@ -0,0 +1,90 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + qa.id, + qq.id, + qa.question, + GROUP_CONCAT( + CONCAT(qa.feedback, '==>>', qa.answer) ORDER BY qa.id ASC SEPARATOR '@||@' + ) answers, + qq.questiontext, + qs.maxmark, + qg.correctfeedback, + q.id quiz_id, + q.course + FROM mdl_question_answers qa + INNER JOIN mdl_question qq ON qa.question = qq.id + INNER JOIN mdl_question_gapselect qg ON qq.id = qg.questionid + INNER JOIN mdl_quiz_slots qs ON qq.id = qs.questionid + INNER JOIN mdl_quiz q ON qs.quizid = q.id + WHERE qq.qtype = 'gapselect' + GROUP BY q.id, qq.id + ORDER BY q.id, qq.id", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'quiz_id' => [ + 'class' => LoadedQuizLookup::class, + 'properties' => ['quiz_id'], + ], + 'question_id' => [ + 'class' => LoadedQuestionLookup::class, + 'properties' => ['question'], + ], + 'answer' => [ + 'class' => QuestionGapselectAnswer::class, + 'properties' => ['answers', 'questiontext', 'maxmark'], + ], + 'score' => 'maxmark', + 'comment' => 'correctfeedback', + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => QuestionGapselectLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/QuestionMultiChoiceMultipleTask.php b/plugin/migrationmoodle/src/Task/QuestionMultiChoiceMultipleTask.php new file mode 100644 index 000000000..7e41f0e3a --- /dev/null +++ b/plugin/migrationmoodle/src/Task/QuestionMultiChoiceMultipleTask.php @@ -0,0 +1,51 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + qa.id, + qa.question, + qa.answer, + qa.feedback, + (qa.fraction * qq.defaultmark) score, + IF (qa.fraction > 0, TRUE, FALSE) is_correct, + q.id quizid, + q.course + FROM mdl_question_answers qa + INNER JOIN mdl_question qq ON qa.question = qq.id + INNER JOIN mdl_qtype_multichoice_options qo ON qq.id = qo.questionid + INNER JOIN mdl_quiz_slots qs ON qq.id = qs.questionid + INNER JOIN mdl_quiz q ON qs.quizid = q.id + WHERE qq.qtype = 'multichoice' + AND qo.single = 0", + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonAnswersMultipleAnswerLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/QuestionMultiChoiceSingleTask.php b/plugin/migrationmoodle/src/Task/QuestionMultiChoiceSingleTask.php new file mode 100644 index 000000000..eb4ac7afb --- /dev/null +++ b/plugin/migrationmoodle/src/Task/QuestionMultiChoiceSingleTask.php @@ -0,0 +1,92 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + qa.id, + qa.question, + qa.answer, + qa.feedback, + (qa.fraction * qq.defaultmark) score, + IF (qa.fraction = 1, TRUE, FALSE) is_correct, + q.id quizid, + q.course + FROM mdl_question_answers qa + INNER JOIN mdl_question qq ON qa.question = qq.id + INNER JOIN mdl_qtype_multichoice_options qo ON qq.id = qo.questionid + INNER JOIN mdl_quiz_slots qs ON qq.id = qs.questionid + INNER JOIN mdl_quiz q ON qs.quizid = q.id + WHERE qq.qtype = 'multichoice' + AND qo.single = 1", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'quiz_id' => [ + 'class' => LoadedLessonPageQuizLookup::class, + 'properties' => ['quizid'], + ], + 'question_id' => [ + 'class' => LoadedQuestionLookup::class, + 'properties' => ['question'], + ], + 'score' => 'score', + 'answer' => [ + 'class' => ReplaceFilePaths::class, + 'properties' => ['answer', 'course'], + ], + 'feedback' => [ + 'class' => ReplaceFilePaths::class, + 'properties' => ['feedback', 'course'], + ], + 'is_correct' => 'is_correct', + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonAnswersMultipleChoiceLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/QuestionShortAnswerTask.php b/plugin/migrationmoodle/src/Task/QuestionShortAnswerTask.php new file mode 100644 index 000000000..0b788d1bd --- /dev/null +++ b/plugin/migrationmoodle/src/Task/QuestionShortAnswerTask.php @@ -0,0 +1,73 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + qa.id, + qa.question, + GROUP_CONCAT(qa.answer SEPARATOR '||') answers, + qq.defaultmark, + GROUP_CONCAT(qa.feedback SEPARATOR '\n') feedback, + COUNT(qa.id) nb, + q.id quizid, + q.course + FROM mdl_question_answers qa + INNER JOIN mdl_question qq ON qa.question = qq.id + INNER JOIN mdl_qtype_shortanswer_options qo ON qq.id = qo.questionid + INNER JOIN mdl_quiz_slots qs ON qq.id = qs.questionid + INNER JOIN mdl_quiz q ON qs.quizid = q.id + WHERE qq.qtype = 'shortanswer' + GROUP BY qq.id + ORDER BY q.course, qq.id", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'quiz_id' => [ + 'class' => LoadedLessonPageQuizLookup::class, + 'properties' => ['quizid'], + ], + 'question_id' => [ + 'class' => LoadedQuestionLookup::class, + 'properties' => ['question'], + ], + 'scores' => 'defaultmark', + 'answers' => 'answers', + 'comment' => 'feedback', + 'nb' => 'nb', + ], + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/QuestionsTask.php b/plugin/migrationmoodle/src/Task/QuestionsTask.php new file mode 100644 index 000000000..f2c7754df --- /dev/null +++ b/plugin/migrationmoodle/src/Task/QuestionsTask.php @@ -0,0 +1,76 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT qq.id, qq.category, qq.questiontext, qq.qtype, q.course, q.id quiz_id + FROM mdl_question qq + INNER JOIN mdl_quiz_slots qs ON qq.id = qs.questionid + INNER JOIN mdl_quiz q ON qs.quizid = q.id + INNER JOIN mdl_course_modules cm ON (q.course = cm.course AND cm.instance = q.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'quiz'", + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'quiz_id' => [ + 'class' => LoadedQuizLookup::class, + 'properties' => ['quiz_id'], + ], + 'question_title' => [ + 'class' => ReplaceFilePaths::class, + 'properties' => ['questiontext', 'course'], + ], + 'question_type' => [ + 'class' => QuestionType::class, + 'properties' => ['qtype', 'id'], + ], + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => LessonQuestionPagesQuestionLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/QuestionsTrueFalseTask.php b/plugin/migrationmoodle/src/Task/QuestionsTrueFalseTask.php new file mode 100644 index 000000000..52aecf84f --- /dev/null +++ b/plugin/migrationmoodle/src/Task/QuestionsTrueFalseTask.php @@ -0,0 +1,40 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + qa.id, + qa.question, + qa.answer, + qa.feedback, + (qa.fraction * qq.defaultmark) score, + IF (qa.fraction = 1, TRUE, FALSE) is_correct, + q.id quizid, + q.course + FROM mdl_question_answers qa + INNER JOIN mdl_question qq ON qa.question = qq.id + INNER JOIN mdl_quiz_slots qs ON qq.id = qs.questionid + INNER JOIN mdl_quiz q ON qs.quizid = q.id + WHERE qq.qtype = 'truefalse'", + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/QuizzesScoresTask.php b/plugin/migrationmoodle/src/Task/QuizzesScoresTask.php new file mode 100644 index 000000000..c2ecd1af0 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/QuizzesScoresTask.php @@ -0,0 +1,74 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + q.id, + q.course, + cm.section, + cm.id cm_id + FROM mdl_quiz q + INNER JOIN mdl_course_modules cm ON (q.course = cm.course AND cm.instance = q.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'quiz' + ORDER BY cs.id, FIND_IN_SET(cm.id, cs.sequence)", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'quiz_id' => [ + 'class' => LoadedQuizLookup::class, + 'properties' => ['id'], + ], + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'item_id' => [ + 'class' => LoadedCourseModuleQuizLookup::class, + 'properties' => ['cm_id'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => QuizzesScoresLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/QuizzesTask.php b/plugin/migrationmoodle/src/Task/QuizzesTask.php new file mode 100644 index 000000000..03a0269be --- /dev/null +++ b/plugin/migrationmoodle/src/Task/QuizzesTask.php @@ -0,0 +1,97 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT + q.id, + q.course, + q.name, + q.intro, + q.shuffleanswers, + q.attempts, + q.timeopen, + q.timeclose, + q.timelimit, + gi.gradepass, + q.grade, + cm.id cm_id + FROM mdl_quiz q + INNER JOIN mdl_course_modules cm ON (q.course = cm.course AND cm.instance = q.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + INNER JOIN mdl_grade_items gi ON (q.id = gi.iteminstance AND m.name = gi.itemmodule) + WHERE m.name = 'quiz' + AND gi.itemtype = 'mod' + ORDER BY cs.id, FIND_IN_SET(cm.id, cs.sequence)", + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'item_id' => [ + 'class' => LoadedCourseModuleQuizLookup::class, + 'properties' => ['cm_id'], + ], + 'exerciseTitle' => 'name', + 'exerciseDescription' => [ + 'class' => ReplaceFilePaths::class, + 'properties' => ['intro', 'course'], + ], + 'randomAnswers' => 'shuffleanswers', + 'exerciseAttempts' => 'attempts', + 'start_time' => 'timeopen', + 'end_time' => 'timeclose', + 'enabletimercontroltotalminutes' => 'timelimit', + 'pass_percentage' => [ + 'class' => Percentage::class, + 'properties' => ['gradepass', 'grade'], + ], + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => QuizzesLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/RoleAssignmentsTask.php b/plugin/migrationmoodle/src/Task/RoleAssignmentsTask.php new file mode 100644 index 000000000..985c9138c --- /dev/null +++ b/plugin/migrationmoodle/src/Task/RoleAssignmentsTask.php @@ -0,0 +1,72 @@ + BaseExtractor::class, + 'query' => 'SELECT ra.id, r.archetype, ra.userid, c.id cid + FROM mdl_role_assignments ra + INNER JOIN mdl_role r ON ra.roleid = r.id + INNER JOIN mdl_context ctx ON ra.contextid = ctx.id + INNER JOIN mdl_course c ON ctx.instanceid = c.id + WHERE ctx.contextlevel = '.self::CONTEXT_LEVEL_COURSE, + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'status' => [ + 'class' => CourseUserStatus::class, + 'properties' => ['archetype'], + ], + 'user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['userid'], + ], + 'course_code' => [ + 'class' => LoadedCourseCodeLookup::class, + 'properties' => ['cid'], + ], + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => RoleAssignmentsLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/ScormScoesTask.php b/plugin/migrationmoodle/src/Task/ScormScoesTask.php new file mode 100644 index 000000000..8e3a6ccb8 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/ScormScoesTask.php @@ -0,0 +1,71 @@ + LoadedScormsFilterExtractor::class, + 'query' => "SELECT i.id, i.title, i.scormtype, i.launch, i.identifier, i.scorm, i.parent, s.course + FROM mdl_scorm_scoes i + INNER JOIN mdl_scorm s ON i.scorm = s.id + WHERE i.parent != '/' ORDER BY s.id, i.sortorder", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'title' => 'title', + 'item_type' => 'scormtype', + 'path' => 'launch', + 'ref' => 'identifier', + 'lp_id' => [ + 'class' => LoadedScormLookup::class, + 'properties' => ['scorm'], + ], + 'parent_item_id' => [ + 'class' => ScormScoParentLookup::class, + 'properties' => ['parent', 'scorm'], + ], + 'c_code' => [ + 'class' => LoadedCourseCodeLookup::class, + 'properties' => ['course'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => ScormScoLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/SortSectionModulesTask.php b/plugin/migrationmoodle/src/Task/SortSectionModulesTask.php new file mode 100644 index 000000000..2fb72649e --- /dev/null +++ b/plugin/migrationmoodle/src/Task/SortSectionModulesTask.php @@ -0,0 +1,78 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT cm.id, cs.course, cm.section, cs.sequence + FROM mdl_course_modules cm + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE cs.course NOT IN ( + SELECT sco.course + FROM mdl_scorm sco + INNER JOIN mdl_course_modules cm ON (sco.course = cm.course AND cm.instance = sco.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'scorm' + ) + ORDER BY cs.course, cs.section, FIND_IN_SET(cm.id, cs.sequence)", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'lp_id' => [ + 'class' => LoadedCourseSectionLookup::class, + 'properties' => ['section'], + ], + 'order_list' => [ + 'class' => SectionSequenceLookup::class, + 'properties' => ['sequence'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => SortSectionModuleLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/TrackCourseAccessTask.php b/plugin/migrationmoodle/src/Task/TrackCourseAccessTask.php new file mode 100644 index 000000000..66fb69699 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/TrackCourseAccessTask.php @@ -0,0 +1,86 @@ +plugin->getUserFilterSetting(); + + if (!empty($userFilter)) { + $query = "SELECT lsl.id, lsl.userid, lsl.courseid, lsl.timecreated, lsl.ip + FROM mdl_logstore_standard_log lsl + INNER JOIN mdl_user u ON lsl.userid = u.id + WHERE (lsl.courseid IS NOT NULL AND lsl.courseid != 0) + AND u.username LIKE '$userFilter%' + ORDER BY lsl.timecreated"; + } + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => $query, + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['userid'], + ], + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['courseid'], + ], + 'login_course_date' => [ + 'class' => DateTimeObject::class, + 'properties' => ['timecreated'], + ], + 'ip' => 'ip', + 'session_id' => [ + 'class' => LoadedUserSessionLookup::class, + 'properties' => ['userid'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => TrackCourseAccessLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/TrackLoginTask.php b/plugin/migrationmoodle/src/Task/TrackLoginTask.php new file mode 100644 index 000000000..5904313ab --- /dev/null +++ b/plugin/migrationmoodle/src/Task/TrackLoginTask.php @@ -0,0 +1,71 @@ +plugin->getUserFilterSetting(); + + if (!empty($userFilter)) { + $query .= " AND username LIKE '$userFilter%'"; + } + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => $query, + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'login_user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['id'], + ], + 'login_date' => [ + 'class' => DateTimeObject::class, + 'properties' => ['firstaccess'], + ], + 'logout_date' => [ + 'class' => DateTimeObject::class, + 'properties' => ['lastaccess'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => TrackLoginLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UrlsTask.php b/plugin/migrationmoodle/src/Task/UrlsTask.php new file mode 100644 index 000000000..064eb1a02 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UrlsTask.php @@ -0,0 +1,79 @@ + LoadedCoursesFilterExtractor::class, + 'query' => "SELECT u.id, u.course, u.name, u.externalurl, cm.section, cm.id cm_id + FROM mdl_url u + INNER JOIN mdl_course_modules cm ON (u.course = cm.course AND cm.instance = u.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'url' + AND u.course NOT IN ( + SELECT sco.course + FROM mdl_scorm sco + INNER JOIN mdl_course_modules cm ON (sco.course = cm.course AND cm.instance = sco.id) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_course_sections cs ON (cm.course = cs.course AND cm.section = cs.id ) + WHERE m.name = 'scorm' + )", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'lp_id' => [ + 'class' => LoadedCourseSectionLookup::class, + 'properties' => ['section'], + ], + 'item_id' => [ + 'class' => LoadedCourseModuleUrlLookup::class, + 'properties' => ['cm_id'], + ], + 'title' => 'name', + 'url' => 'externalurl', + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => UrlLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UserQuestionAttemptsGapselectTask.php b/plugin/migrationmoodle/src/Task/UserQuestionAttemptsGapselectTask.php new file mode 100644 index 000000000..a85cf3be0 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UserQuestionAttemptsGapselectTask.php @@ -0,0 +1,22 @@ +questionType = 'gapselect'; + + return parent::getExtractConfiguration(); + } +} diff --git a/plugin/migrationmoodle/src/Task/UserQuestionAttemptsShortanswerTask.php b/plugin/migrationmoodle/src/Task/UserQuestionAttemptsShortanswerTask.php new file mode 100644 index 000000000..07cdbd36b --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UserQuestionAttemptsShortanswerTask.php @@ -0,0 +1,22 @@ +questionType = 'shortanswer'; + + return parent::getExtractConfiguration(); + } +} diff --git a/plugin/migrationmoodle/src/Task/UserQuestionAttemptsTask.php b/plugin/migrationmoodle/src/Task/UserQuestionAttemptsTask.php new file mode 100644 index 000000000..86afdee76 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UserQuestionAttemptsTask.php @@ -0,0 +1,124 @@ +plugin->getUserFilterSetting(); + + $userFilterCondition = !empty($userFilter) ? "AND u.username LIKE '$userFilter%'" : ''; + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => "SELECT + qqa.id, + qa.userid, + qa.id quiz_attempt, + qqa.questionid, + qqa.questionsummary, + qqa.rightanswer, + qqa.responsesummary, + qqa.timemodified, + qqas.fraction, + q.course, + qq.defaultmark, + qq.qtype + FROM mdl_question_attempts qqa + INNER JOIN mdl_quiz_attempts qa ON qqa.questionusageid = qa.uniqueid + INNER JOIN mdl_question_attempt_steps qqas + ON (qqa.id = qqas.questionattemptid AND qa.userid = qqas.userid) + INNER JOIN mdl_question_attempt_step_data qqasd ON qqas.id = qqasd.attemptstepid + INNER JOIN mdl_question qq ON (qqa.questionid = qq.id) + INNER JOIN mdl_quiz q ON (qa.quiz = q.id) + INNER JOIN mdl_user u ON (qqas.userid = u.id) + WHERE qqas.state NOT IN ('todo', 'complete') + AND (qqasd.name = '-finish' AND qqasd.value = 1) + AND qq.qtype = '{$this->questionType}' + $userFilterCondition + ORDER BY qa.userid, qa.quiz, qqa.slot", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'exe_id' => [ + 'class' => LoadedUserQuizLookup::class, + 'properties' => ['quiz_attempt'], + ], + 'user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['userid'], + ], + 'question_id' => [ + 'class' => LoadedQuestionLookup::class, + 'properties' => ['questionid'], + ], + 'answer' => [ + 'class' => UserQuestionAnswer::class, + 'properties' => [ + 'qtype', + 'rightanswer', + 'responsesummary', + 'fraction', + 'defaultmark', + 'questionsummary', + 'questionid', + ], + ], + 'marks' => 'fraction', + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'tms' => [ + 'class' => DateTimeObject::class, + 'properties' => ['timemodified'], + ], + 'session_id' => [ + 'class' => LoadedUserSessionLookup::class, + 'properties' => ['userid'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => UserQuestionAttemptLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UserQuestionAttemptsTruefalseTask.php b/plugin/migrationmoodle/src/Task/UserQuestionAttemptsTruefalseTask.php new file mode 100644 index 000000000..f781f57a3 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UserQuestionAttemptsTruefalseTask.php @@ -0,0 +1,22 @@ +questionType = 'truefalse'; + + return parent::getExtractConfiguration(); + } +} diff --git a/plugin/migrationmoodle/src/Task/UserSessionsTask.php b/plugin/migrationmoodle/src/Task/UserSessionsTask.php new file mode 100644 index 000000000..1651bdf92 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UserSessionsTask.php @@ -0,0 +1,87 @@ +plugin->getUserFilterSetting(); + + if (!empty($userFilter)) { + $userFilterCondition = "AND u.username LIKE '$userFilter%'"; + } + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => "SELECT + u.id, + u.username, + GROUP_CONCAT(c.id) course_ids, + GROUP_CONCAT(c.shortname SEPARATOR '".self::SEPARATOR_NAME."') session_name + FROM mdl_role_assignments ra + INNER JOIN mdl_role r ON ra.roleid = r.id + INNER JOIN mdl_context ctx ON ra.contextid = ctx.id + INNER JOIN mdl_course c ON ctx.instanceid = c.id + INNER JOIN mdl_user u ON ra.userid = u.id + WHERE ctx.contextlevel = ".RoleAssignmentsTask::CONTEXT_LEVEL_COURSE." + $userFilterCondition + GROUP BY ra.userid", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'name' => [ + 'class' => SessionName::class, + 'properties' => ['username', 'session_name'], + ], + 'user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['id'], + ], + 'courses_list' => 'session_name', + 'course_ids' => [ + 'class' => CoursesArrayLookup::class, + 'properties' => ['course_ids'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => UserSessionLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UsersLastLoginTask.php b/plugin/migrationmoodle/src/Task/UsersLastLoginTask.php new file mode 100644 index 000000000..1e933a275 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UsersLastLoginTask.php @@ -0,0 +1,68 @@ +plugin->getUserFilterSetting(); + + if (!empty($userFilter)) { + $query = "SELECT id, lastlogin FROM mdl_user + WHERE lastlogin != 0 AND username LIKE '$userFilter%'"; + } + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => $query, + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['id'], + ], + 'last_login' => [ + 'class' => DateTimeObject::class, + 'properties' => ['lastlogin'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => UserLastLoginLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UsersLearnPathsLessonAttemptsTask.php b/plugin/migrationmoodle/src/Task/UsersLearnPathsLessonAttemptsTask.php new file mode 100644 index 000000000..fbd37f35d --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UsersLearnPathsLessonAttemptsTask.php @@ -0,0 +1,58 @@ +plugin->getUserFilterSetting(); + + if (!empty($userFilter)) { + $query = "SELECT la.* FROM mdl_lesson_attempts la + INNER JOIN mdl_user u ON la.userid = u.id + WHERE u.username LIKE '$userFilter%'"; + } + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => $query, + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + $config = parent::getTransformConfiguration(); + + $config['map']['is_correct'] = 'correct'; + + return $config; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => UserLearnPathLessonAttemptLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UsersLearnPathsLessonBranchTask.php b/plugin/migrationmoodle/src/Task/UsersLearnPathsLessonBranchTask.php new file mode 100644 index 000000000..1c7463e02 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UsersLearnPathsLessonBranchTask.php @@ -0,0 +1,101 @@ += lesson_timer.starttime AND lb.timeseen <= lesson_timer.lessontime + ORDER BY lb.userid, lb.lessonid, lb.timeseen'; + + $userFilter = $this->plugin->getUserFilterSetting(); + + if (!empty($userFilter)) { + $query = "SELECT lb.* FROM mdl_lesson_branch lb + INNER JOIN ( + SELECT lt.lessonid, lt.userid, lt.starttime, lt.lessontime + FROM mdl_lesson_timer lt + INNER JOIN mdl_user u ON (lt.userid = u.id) + WHERE lt.completed = 1 + AND u.username LIKE '$userFilter%' + GROUP BY lt.userid, lt.lessonid + ORDER BY lt.userid, lt.lessonid, lt.starttime + ) AS lesson_timer ON (lb.lessonid = lesson_timer.lessonid AND lb.userid = lesson_timer.userid) + INNER JOIN mdl_user u ON (lb.userid = u.id) + WHERE lb.timeseen >= lesson_timer.starttime AND lb.timeseen <= lesson_timer.lessontime + AND u.username LIKE '$userFilter%' + ORDER BY lb.userid, lb.lessonid, lb.timeseen"; + } + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => $query, + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'parent_item_id' => [ + 'class' => LoadedCourseModuleLessonLookup::class, + 'properties' => ['lessonid'], + ], + 'item_id' => [ + 'class' => LoadedLessonPageLookup::class, + 'properties' => ['pageid'], + ], + 'user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['userid'], + ], + 'end_time' => 'timeseen', + 'session_id' => [ + 'class' => LoadedUserSessionLookup::class, + 'properties' => ['userid'], + ], + 'view_count' => 'retry', + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => UserLearnPathLessonBranchLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UsersLearnPathsLessonTimerTask.php b/plugin/migrationmoodle/src/Task/UsersLearnPathsLessonTimerTask.php new file mode 100644 index 000000000..a07f21410 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UsersLearnPathsLessonTimerTask.php @@ -0,0 +1,83 @@ +plugin->getUserFilterSetting(); + + if (!empty($userFilter)) { + $query = "SELECT lt.* FROM mdl_lesson_timer lt + INNER JOIN mdl_user u ON lt.userid = u.id + WHERE u.username LIKE '$userFilter%' + AND lt.completed = 1 + GROUP BY lt.userid, lt.lessonid + ORDER BY lt.userid, lt.lessonid, lt.starttime"; + } + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => $query, + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'parent_item_id' => [ + 'class' => LoadedCourseModuleLessonLookup::class, + 'properties' => ['lessonid'], + ], + 'user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['userid'], + ], + 'start_time' => 'starttime', + 'session_id' => [ + 'class' => LoadedUserSessionLookup::class, + 'properties' => ['userid'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => UserLearnPathLessonTimerLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UsersLearnPathsQuizzesTask.php b/plugin/migrationmoodle/src/Task/UsersLearnPathsQuizzesTask.php new file mode 100644 index 000000000..7f1590aba --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UsersLearnPathsQuizzesTask.php @@ -0,0 +1,90 @@ +plugin->getUserFilterSetting(); + + if (!empty($userFilter)) { + $query = "SELECT qa.id, qa.quiz, qa.userid, qa.timestart, qa.timefinish, qa.state, qa.sumgrades + FROM mdl_quiz_attempts qa + INNER JOIN mdl_user u ON qa.userid = u.id + WHERE qa.preview = 0 + AND u.username LIKE '$userFilter%'"; + } + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => $query, + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'item_id' => [ + 'class' => LoadedCourseModuleQuizByQuizLookup::class, + 'properties' => ['quiz'], + ], + 'user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['userid'], + ], + 'session_id' => [ + 'class' => LoadedUserSessionLookup::class, + 'properties' => ['userid'], + ], + 'start_time' => 'timestart', + 'total_time' => [ + 'class' => Subtract::class, + 'properties' => ['timefinish', 'timestart'], + ], + 'status' => [ + 'class' => LearnPathItemViewQuizStatus::class, + 'properties' => ['quiz', 'state', 'sumgrades'], + ], + 'score' => 'sumgrades', + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => UserLearnPathQuizLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UsersLearnPathsTask.php b/plugin/migrationmoodle/src/Task/UsersLearnPathsTask.php new file mode 100644 index 000000000..5b4a1bfc3 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UsersLearnPathsTask.php @@ -0,0 +1,64 @@ +plugin->getUserFilterSetting(); + + $userFilterCondition = ''; + + if (!empty($userFilter)) { + $userFilterCondition = "WHERE username LIKE '$userFilter%'"; + } + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => "SELECT id FROM mdl_user $userFilterCondition", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['id'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => UserLearnPathsLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UsersQuizzesAttemptsTask.php b/plugin/migrationmoodle/src/Task/UsersQuizzesAttemptsTask.php new file mode 100644 index 000000000..3e30afb9f --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UsersQuizzesAttemptsTask.php @@ -0,0 +1,102 @@ +plugin->getUserFilterSetting(); + $userCondition = ''; + + if (!empty($userFilter)) { + $userCondition = "INNER JOIN mdl_user u ON qa.userid = u.id WHERE u.username LIKE '$userFilter%'"; + } + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => "SELECT + qa.id, + qa.quiz, + qa.userid, + qa.layout, + qa.state, + qa.timestart, + qa.timefinish, + qa.sumgrades real_result, + q.sumgrades weighting + FROM mdl_quiz_attempts qa + INNER JOIN mdl_quiz q ON qa.quiz = q.id + $userCondition + ORDER BY qa.userid, q.id, qa.attempt", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['userid'], + ], + 'date' => [ + 'class' => DateTimeObject::class, + 'properties' => ['timestart'], + ], + 'exo_id' => [ + 'class' => LoadedQuizLookup::class, + 'properties' => ['quiz'], + ], + 'result' => 'real_result', + 'weighting' => 'weighting', + 'data_tracking' => [ + 'class' => QuizDataTracking::class, + 'properties' => ['quiz', 'layout'], + ], + 'session_id' => [ + 'class' => LoadedUserSessionLookup::class, + 'properties' => ['userid'], + ], + 'duration' => [ + 'class' => Subtract::class, + 'properties' => ['timefinish', 'timestart'], + ], + 'status' => 'state', + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => UserQuizAttemptLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UsersScormsViewTask.php b/plugin/migrationmoodle/src/Task/UsersScormsViewTask.php new file mode 100644 index 000000000..e64c54cc2 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UsersScormsViewTask.php @@ -0,0 +1,98 @@ +plugin->getUserFilterSetting(); + + $userCondition = ''; + + if (!empty($userFilter)) { + $userCondition = "INNER JOIN mdl_user u ON sst.userid = u.id WHERE u.username LIKE '$userFilter%'"; + } + + return [ + 'class' => LoadedUsersFilterExtractor::class, + 'query' => "SELECT + sst.id, + sst.userid, + s.id scormid, + ss.id scoid, + sst.attempt, + s.course, + GROUP_CONCAT(sst.element, '==>>', sst.value ORDER BY sst.id SEPARATOR '|@|') track_data + FROM mdl_scorm_scoes_track sst + INNER JOIN mdl_scorm_scoes ss ON (sst.scoid = ss.id AND sst.scormid = ss.scorm) + INNER JOIN mdl_scorm s ON (ss.scorm = s.id) + $userCondition + GROUP BY sst.userid, s.id, ss.id, sst.attempt + ORDER BY sst.userid, s.course, s.id", + ]; + } + + /** + * {@inheritdoc} + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'user_id' => [ + 'class' => LoadedUserLookup::class, + 'properties' => ['userid'], + ], + 'lp_id' => [ + 'class' => LoadedScormLookup::class, + 'properties' => ['scormid'], + ], + 'lp_item_id' => [ + 'class' => LoadedScormScoLookup::class, + 'properties' => ['scoid'], + ], + 'lp_item_view_count' => 'attempt', + 'c_id' => [ + 'class' => LoadedCourseLookup::class, + 'properties' => ['course'], + ], + 'item_data' => [ + 'class' => ScormScoTrackData::class, + 'properties' => ['track_data'], + ], + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function getLoadConfiguration() + { + return [ + 'class' => UsersScormsViewLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Task/UsersTask.php b/plugin/migrationmoodle/src/Task/UsersTask.php new file mode 100644 index 000000000..d819c8c90 --- /dev/null +++ b/plugin/migrationmoodle/src/Task/UsersTask.php @@ -0,0 +1,91 @@ +plugin->getUserFilterSetting(); + + if (!empty($userFilter)) { + $query = "SELECT * FROM mdl_user WHERE username LIKE '$userFilter%'"; + } + + return [ + 'class' => BaseExtractor::class, + 'query' => $query, + ]; + } + + /** + * @return array + */ + public function getTransformConfiguration() + { + return [ + 'class' => BaseTransformer::class, + 'map' => [ + 'lastname' => 'lastname', + 'firstname' => 'firstname', + 'email' => 'email', + 'username' => 'username', + 'plain_password' => 'password', + 'language' => 'lang', + 'phone' => 'phone1', + 'address' => 'address', + 'auth_source' => [ + 'class' => AuthLookup::class, + 'properties' => ['auth'], + ], + 'registration_date' => [ + 'class' => DateTimeObject::class, + 'properties' => ['timecreated'], + ], + 'status' => [ + 'class' => UserStatus::class, + 'properties' => ['id'], + ], + 'active' => [ + 'class' => UserActive::class, + 'properties' => ['deleted', 'suspended'], + ], + 'enabled' => [ + 'class' => UserActive::class, + 'properties' => ['deleted', 'suspended'], + ], + ], + ]; + } + + /** + * @return array + */ + public function getLoadConfiguration() + { + return [ + 'class' => UsersLoader::class, + ]; + } +} diff --git a/plugin/migrationmoodle/src/Traits/FileFinderTrait.php b/plugin/migrationmoodle/src/Traits/FileFinderTrait.php new file mode 100644 index 000000000..d4f8608d1 --- /dev/null +++ b/plugin/migrationmoodle/src/Traits/FileFinderTrait.php @@ -0,0 +1,35 @@ +getMoodledataPath(); + + $filePath = "$moodleDataPath/filedir/$d1/$d2/$contentHash"; + + if (!file_exists($filePath)) { + throw new \Exception("File $contentHash not found in $moodleDataPath/filedir"); + } + + return $filePath; + } +} diff --git a/plugin/migrationmoodle/src/Traits/MapTrait.php b/plugin/migrationmoodle/src/Traits/MapTrait.php new file mode 100644 index 000000000..71924fefd --- /dev/null +++ b/plugin/migrationmoodle/src/Traits/MapTrait.php @@ -0,0 +1,22 @@ +calledClass, '\\'), 1); + + return api_camel_case_to_underscore($name); + } +} diff --git a/plugin/migrationmoodle/src/Transformer/BaseTransformer.php b/plugin/migrationmoodle/src/Transformer/BaseTransformer.php new file mode 100644 index 000000000..d9b3f0836 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/BaseTransformer.php @@ -0,0 +1,55 @@ +map = $configuration['map']; + } + + /** + * @throws \Exception + * + * @return array + */ + public function transform(array $sourceData) + { + $incomingResult = []; + + foreach ($this->map as $incomingProperty => $sourceProperty) { + if (is_array($sourceProperty)) { + $transformerClass = $sourceProperty['class']; + /** @var TransformerInterface $transformer */ + $transformer = new $transformerClass(); + $sourceProperties = $sourceProperty['properties']; + } else { + $transformer = new Copy(); + $sourceProperties = [$sourceProperty]; + } + + $data = []; + + foreach ($sourceProperties as $sourcePropertyName) { + $data[$sourcePropertyName] = $sourceData[$sourcePropertyName]; + } + + $incomingResult[$incomingProperty] = $transformer->transform($data); + } + + return $incomingResult; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/AuthLookup.php b/plugin/migrationmoodle/src/Transformer/Property/AuthLookup.php new file mode 100644 index 000000000..6fa81f411 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/AuthLookup.php @@ -0,0 +1,22 @@ +calledClass = CourseCategoriesTask::class; + } + + /** + * @throws \Exception + * + * @return string|null + */ + public function transform(array $data) + { + $categoryId = parent::transform($data); + + $category = \Database::getManager()->find('ChamiloCoreBundle:CourseCategory', $categoryId); + + if (empty($category)) { + return null; + } + + return $category->getCode(); + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/CourseCode.php b/plugin/migrationmoodle/src/Transformer/Property/CourseCode.php new file mode 100644 index 000000000..ed06e4580 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/CourseCode.php @@ -0,0 +1,30 @@ +setTimezone(new \DateTimeZone('UTC')); + $date->setTimestamp($timeCreated); + + return $date; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/Explode.php b/plugin/migrationmoodle/src/Transformer/Property/Explode.php new file mode 100644 index 000000000..323178a06 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/Explode.php @@ -0,0 +1,26 @@ + 'english', + 'fr' => 'french', + 'es' => 'spanish', + ]; + + /** + * @return string + */ + public function transform(array $data) + { + $language = current($data); + + if (array_key_exists($language, $this->languages)) { + return $this->languages[$language]; + } + + return $this->languages['en']; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LearnPathItemViewQuizStatus.php b/plugin/migrationmoodle/src/Transformer/Property/LearnPathItemViewQuizStatus.php new file mode 100644 index 000000000..a55636950 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LearnPathItemViewQuizStatus.php @@ -0,0 +1,58 @@ +findQuiz($quizId); + + if ('finished' === $mQuizAttemptState) { + if ($quiz->getPassPercentage() > 0 && $mQuizSumGrades > $quiz->getPassPercentage()) { + return 'passed'; + } + + return 'completed'; + } + + return 'not attempted'; + } + + /** + * @param int $quizId + * + * @throws \Exception + * @throws \Doctrine\ORM\ORMException + * @throws \Doctrine\ORM\OptimisticLockException + * @throws \Doctrine\ORM\TransactionRequiredException + * + * @return \Chamilo\CourseBundle\Entity\CQuiz + */ + private function findQuiz($quizId = 0) + { + $quiz = \Database::getManager()->find('ChamiloCourseBundle:CQuiz', $quizId); + + if (!$quiz) { + throw new \Exception("Quiz ($quizId) not found."); + } + + return $quiz; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LessonAnswersMatchingScore.php b/plugin/migrationmoodle/src/Transformer/Property/LessonAnswersMatchingScore.php new file mode 100644 index 000000000..7e15ef542 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LessonAnswersMatchingScore.php @@ -0,0 +1,59 @@ +getConnection(); + } catch (DBALException $e) { + throw new \Exception('Unable to start connection.', 0, $e); + } + + try { + $query = "SELECT + la.score, + COUNT(IF(score = 0 AND response IS NOT NULL, 1, NULL)) 'count' + FROM mdl_lesson_answers la + INNER JOIN mdl_lesson l ON (la.lessonid = l.id) + WHERE la.pageid = ? + AND la.lessonid = ? + AND l.course = ?"; + + $result = $connection->fetchAssoc($query, [$pageid, $lessonid, $course]); + } catch (DBALException $e) { + throw new \Exception("Unable to execute query \"{$this->query}\".", 0, $e); + } + + $connection->close(); + + $score = (float) $result['score']; + $count = (int) $result['count']; + + if (0 === $count) { + return 0; + } + + return $score / $count; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LessonPageType.php b/plugin/migrationmoodle/src/Transformer/Property/LessonPageType.php new file mode 100644 index 000000000..80660aacb --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LessonPageType.php @@ -0,0 +1,36 @@ +calledClass = CoursesTask::class; + } + + /** + * @throws \Exception + * + * @return string + */ + public function transform(array $data) + { + $cId = parent::transform($data); + + return api_get_course_entity($cId)->getCode(); + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseFromQuestionCategoryLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseFromQuestionCategoryLookup.php new file mode 100644 index 000000000..83810f236 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseFromQuestionCategoryLookup.php @@ -0,0 +1,79 @@ +searchInModuleContext($instanceId); + break; + } + + if (empty($mCourseId)) { + throw new \Exception("Course not found for context $instanceId with level $contextLevel"); + } + + return parent::transform([$mCourseId]); + } + + /** + * @param int $instanceId + * + * @throws \Exception + * + * @return int + */ + private function searchInModuleContext($instanceId) + { + try { + $connection = \MigrationMoodlePlugin::create()->getConnection(); + } catch (DBALException $e) { + throw new \Exception('Unable to start connection.', 0, $e); + } + + $query = "SELECT course FROM mdl_course_modules WHERE id = ?"; + + try { + $statement = $connection->executeQuery($query, [$instanceId]); + } catch (DBALException $e) { + throw new \Exception("Unable to execute query \"$query\".", 0, $e); + } + + $result = $statement->fetch(FetchMode::ASSOCIATIVE); + + $connection->close(); + + if (false === $result) { + return 0; + } + + return (int) $result['course']; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseLookup.php new file mode 100644 index 000000000..aa9636fbe --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseLookup.php @@ -0,0 +1,22 @@ +calledClass = CoursesTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleLessonLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleLessonLookup.php new file mode 100644 index 000000000..995de8b34 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleLessonLookup.php @@ -0,0 +1,55 @@ +calledClass = CourseModulesLessonTask::class; + } + + public function transform(array $data) + { + try { + $connection = \MigrationMoodlePlugin::create()->getConnection(); + } catch (DBALException $e) { + throw new \Exception('Unable to start connection.', 0, $e); + } + + $query = "SELECT cm.id FROM mdl_course_modules cm + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_lesson l ON (cm.course = l.course AND cm.instance = l.id) + WHERE m.name = 'lesson' + AND l.id = ?"; + + $lessonId = current($data); + + try { + $statement = $connection->executeQuery($query, [$lessonId]); + } catch (DBALException $e) { + throw new \Exception("Unable to execute query \"$query\".", 0, $e); + } + + $result = $statement->fetch(FetchMode::ASSOCIATIVE); + + $connection->close(); + + $lessonId = $result['id']; + + return parent::transform([$lessonId]); + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleQuizByQuizLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleQuizByQuizLookup.php new file mode 100644 index 000000000..ab2868870 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleQuizByQuizLookup.php @@ -0,0 +1,60 @@ +calledClass = CourseModulesQuizTask::class; + } + + /** + * @throws \Exception + * + * @return mixed + */ + public function transform(array $data) + { + try { + $connection = \MigrationMoodlePlugin::create()->getConnection(); + } catch (DBALException $e) { + throw new \Exception('Unable to start connection.', 0, $e); + } + + $query = "SELECT cm.id FROM mdl_course_modules cm + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_quiz q ON (cm.course = q.course AND cm.instance = q.id) + WHERE m.name = 'quiz' + AND q.id = ?"; + + $lessonId = current($data); + + try { + $statement = $connection->executeQuery($query, [$lessonId]); + } catch (DBALException $e) { + throw new \Exception("Unable to execute query \"$query\".", 0, $e); + } + + $result = $statement->fetch(FetchMode::ASSOCIATIVE); + + $connection->close(); + + $lessonId = $result['id']; + + return parent::transform([$lessonId]); + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleQuizLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleQuizLookup.php new file mode 100644 index 000000000..1d84bbaa5 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleQuizLookup.php @@ -0,0 +1,22 @@ +calledClass = CourseModulesQuizTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleUrlLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleUrlLookup.php new file mode 100644 index 000000000..370b812a6 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseModuleUrlLookup.php @@ -0,0 +1,22 @@ +calledClass = CourseModulesUrlTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseSectionFromLessonLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseSectionFromLessonLookup.php new file mode 100644 index 000000000..9aa39d9d5 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseSectionFromLessonLookup.php @@ -0,0 +1,52 @@ +getConnection(); + } catch (DBALException $e) { + throw new \Exception('Unable to start connection.', 0, $e); + } + + $query = "SELECT cs.id FROM mdl_course_sections cs + INNER JOIN mdl_course_modules cm ON (cs.id = cm.section AND cs.course = cm.course) + INNER JOIN mdl_modules m ON cm.module = m.id + INNER JOIN mdl_lesson l ON (cm.course = l.course AND cm.instance = l.id) + WHERE m.name = 'lesson' + AND l.id = ?"; + + $lessonId = current($data); + + try { + $statement = $connection->executeQuery($query, [$lessonId]); + } catch (DBALException $e) { + throw new \Exception("Unable to execute query \"$query\".", 0, $e); + } + + $result = $statement->fetch(FetchMode::ASSOCIATIVE); + + $connection->close(); + + $sectionId = $result['id']; + + return parent::transform([$sectionId]); + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseSectionLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseSectionLookup.php new file mode 100644 index 000000000..f01550ecd --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedCourseSectionLookup.php @@ -0,0 +1,22 @@ +calledClass = CourseSectionsTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedKeyLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedKeyLookup.php new file mode 100644 index 000000000..afe0e1d75 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedKeyLookup.php @@ -0,0 +1,60 @@ +search($id); + + return isset($migration['loaded_id']) ? $migration['loaded_id'] : 0; + } + + /** + * @param int $searchedId + * + * @throws \Exception + * + * @return array + */ + private function search($searchedId) + { + if (empty($searchedId)) { + return null; + } + + $taskName = $this->getTaskName(); + + $itemInfo = \Database::select( + 'i.*', + 'plugin_migrationmoodle_item i INNER JOIN plugin_migrationmoodle_task t ON i.task_id = t.id', + [ + 'where' => [ + 't.name = ? AND i.extracted_id = ?' => [$taskName, $searchedId], + ], + ], + 'first' + ); + + return $itemInfo ?: null; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedLessonPageLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedLessonPageLookup.php new file mode 100644 index 000000000..4a046ab5a --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedLessonPageLookup.php @@ -0,0 +1,22 @@ +calledClass = LessonPagesTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedLessonPageQuizLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedLessonPageQuizLookup.php new file mode 100644 index 000000000..b1eff72de --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedLessonPageQuizLookup.php @@ -0,0 +1,24 @@ +calledClass = LessonPagesQuizTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedLessonPageQuizQuestionLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedLessonPageQuizQuestionLookup.php new file mode 100644 index 000000000..7bf157acd --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedLessonPageQuizQuestionLookup.php @@ -0,0 +1,24 @@ +calledClass = LessonPagesQuizQuestionTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedQuestionLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedQuestionLookup.php new file mode 100644 index 000000000..43aea916f --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedQuestionLookup.php @@ -0,0 +1,22 @@ +calledClass = QuestionsTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedQuizLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedQuizLookup.php new file mode 100644 index 000000000..5e388ac5f --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedQuizLookup.php @@ -0,0 +1,22 @@ +calledClass = QuizzesTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedScormLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedScormLookup.php new file mode 100644 index 000000000..a3816ff63 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedScormLookup.php @@ -0,0 +1,22 @@ +calledClass = CourseModulesScormTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedScormScoLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedScormScoLookup.php new file mode 100644 index 000000000..869d67e94 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedScormScoLookup.php @@ -0,0 +1,22 @@ +calledClass = ScormScoesTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedUserLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedUserLookup.php new file mode 100644 index 000000000..3123a2c62 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedUserLookup.php @@ -0,0 +1,21 @@ +calledClass = UsersTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedUserQuizLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedUserQuizLookup.php new file mode 100644 index 000000000..ad99a5dd4 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedUserQuizLookup.php @@ -0,0 +1,22 @@ +calledClass = UsersQuizzesAttemptsTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/LoadedUserSessionLookup.php b/plugin/migrationmoodle/src/Transformer/Property/LoadedUserSessionLookup.php new file mode 100644 index 000000000..95e150949 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/LoadedUserSessionLookup.php @@ -0,0 +1,22 @@ +calledClass = UserSessionsTask::class; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/Percentage.php b/plugin/migrationmoodle/src/Transformer/Property/Percentage.php new file mode 100644 index 000000000..49c93614c --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/Percentage.php @@ -0,0 +1,28 @@ + $groupAndOption) { + $position = $zeroPosition + 1; + + list($group, $option) = explode('==>>', $groupAndOption); + + $positionsByGroup[$position] = $group; + $groups[$group][$position] = $option; + } + + $blanks = []; + + foreach ($positionsByGroup as $option => $group) { + if ($option === 1) { + $blanks[] = '['.implode($groups[$group], '|').']'; + + continue; + } + + $baz = $groups[$group]; + + unset($baz[$option]); + + $baz = [$groups[$group][$option]] + $baz; + + $blanks[] = '['.implode($baz, '|').']'; + } + + $countBlanks = 0; + + foreach ($blanks as $zeroPosition => $blank) { + $countBlank = 0; + $position = $zeroPosition + 1; + $questionText = str_replace("[[$position]]", $blank, $questionText, $countBlank); + + $countBlanks += $countBlank; + } + + $individualScore = $score / $countBlanks; + $scores = []; + + for ($i = 0; $i < $countBlanks - 1; $i++) { + $scores[] = $individualScore; + } + + $scores[] = $score - array_sum($scores); + + $inputs = str_repeat('300,', $countBlanks - 1).'300'; + + return utf8_encode("$questionText::".implode(',', $scores).":$inputs:0@"); + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/QuestionType.php b/plugin/migrationmoodle/src/Transformer/Property/QuestionType.php new file mode 100644 index 000000000..c8e06f30a --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/QuestionType.php @@ -0,0 +1,86 @@ +isMultiChoiceSingle($id)) { + return MULTIPLE_ANSWER; + } + // no break + case 'truefalse': + return UNIQUE_ANSWER; + case 'match': + return MATCHING_DRAGGABLE; + case 'shortanswer': + case 'numerical': + case 'gapselect': + return FILL_IN_BLANKS; + case 'essay': + return FREE_ANSWER; + case 'calculated': + return CALCULATED_ANSWER; + case 'calculatedmulti': + case 'calculatedsimple': + case 'ddwtos': + case 'ddmarker': + case 'ddimageortext': + case 'multianswer': + case 'randomsamatch': + case 'description': + throw new \Exception("Question type \"$qtype\" not supported in question \"$id\"."); + } + } + + /** + * @param int $id + * + * @throws \Exception + * + * @return bool + */ + private function isMultiChoiceSingle($id) + { + try { + $connection = \MigrationMoodlePlugin::create()->getConnection(); + } catch (DBALException $e) { + throw new \Exception('Unable to start connection.', 0, $e); + } + + $query = "SELECT single FROM mdl_qtype_multichoice_options WHERE questionid = ?"; + + try { + $result = $connection->fetchAssoc($query, [$id]); + } catch (DBALException $e) { + throw new \Exception("Unable to execute query \"$query\".", 0, $e); + } + + $connection->close(); + + if (false === $result || !empty($result['single'])) { + return true; + } + + return false; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/QuizDataTracking.php b/plugin/migrationmoodle/src/Transformer/Property/QuizDataTracking.php new file mode 100644 index 000000000..6fc50442f --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/QuizDataTracking.php @@ -0,0 +1,68 @@ +findQuestionBySlotInQuiz($mQuizId, $mQuestionSlot); + + $tracking[] = parent::transform([$mQuestionId]); + } + + return implode(',', $tracking); + } + + /** + * @param int $quizId + * @param int $slot + * + * @throws \Exception + * + * @return mixed + */ + private function findQuestionBySlotInQuiz($quizId = 0, $slot = 0) + { + try { + $connection = \MigrationMoodlePlugin::create()->getConnection(); + } catch (DBALException $exception) { + throw new \Exception('Unable to start connection.', 0, $exception); + } + + try { + $sql = "SELECT questionid FROM mdl_quiz_slots WHERE slot = ? AND quizid = ?"; + + $result = $connection->fetchAssoc($sql, [$slot, $quizId]); + } catch (DBALException $exception) { + throw new \Exception("Unable to execute query '{$this->query}'.", 0, $exception); + } + + $connection->close(); + + return $result['questionid']; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/QuizQuestionTypeFromLessonPage.php b/plugin/migrationmoodle/src/Transformer/Property/QuizQuestionTypeFromLessonPage.php new file mode 100644 index 000000000..9555372fd --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/QuizQuestionTypeFromLessonPage.php @@ -0,0 +1,52 @@ +loadHTML( + htmlentities($content, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8') + ); + + foreach ($doc->getElementsByTagName('img') as $img) { + $this->getNewSource('src', $img, $courseInfo['path']); + } + + foreach ($doc->getElementsByTagName('a') as $a) { + $this->getNewSource('href', $a, $courseInfo['path']); + } + + $body = $doc->getElementsByTagName('body')->item(0); + $bodyHtml = $doc->saveHTML($body); + + return $this->removeBodyTags($bodyHtml); + } + + /** + * @param string $attribute + * @param string $coursePath + * + * @return string + */ + private function getNewSource($attribute, \DOMElement $domElement, $coursePath) + { + $source = $domElement->getAttribute($attribute); + + if (empty($source) || strpos($source, '@@PLUGINFILE@@') === false) { + return; + } + + $parsedUrl = parse_url($source); + $urlPath = $parsedUrl['path']; + $urlQuery = isset($parsedUrl['query']) ? $parsedUrl['query'] : ''; + + $fileName = basename($urlPath); + $fileName = urldecode($fileName); + $fileName = \URLify::filter($fileName, 250, '', true, true, false, false); + + $newSource = "/courses/$coursePath/document/$fileName" + .(!empty($urlQuery) ? "?$urlQuery" : ''); + + $domElement->setAttribute($attribute, $newSource); + } + + /** + * @param string $bodyHtml + * + * @return false|string + */ + private function removeBodyTags($bodyHtml) + { + $tagStart = ''; + $tagEnd = ''; + + return $content = substr( + $bodyHtml, + strlen($tagStart), + -1 * strlen($tagEnd) + ); + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/ScormScoParentLookup.php b/plugin/migrationmoodle/src/Transformer/Property/ScormScoParentLookup.php new file mode 100644 index 000000000..39bb32c96 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/ScormScoParentLookup.php @@ -0,0 +1,41 @@ + [ + 'lp_id = ? AND ref = ?' => [$lpId, $data['parent']], + ], + ], + 'first' + ); + + if (!empty($lpItem)) { + return $lpItem['iid']; + } + + return 0; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/ScormScoTrackData.php b/plugin/migrationmoodle/src/Transformer/Property/ScormScoTrackData.php new file mode 100644 index 000000000..f4bbf6d34 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/ScormScoTrackData.php @@ -0,0 +1,130 @@ +>'; + + /** + * {@inheritdoc} + */ + public function transform(array $data) + { + $trackData = current($data); + $strComponents = explode(self::SEPARATOR_COMPONENTS, $trackData); + + $trackData = []; + + foreach ($strComponents as $strComponent) { + list($component, $value) = explode(self::SEPARATOR_VALUES, $strComponent); + + $trackData[$component] = $value; + } + + $elements = [ + 'x.start.time' => 'start_time', + 'cmi.core.lesson_status' => 'status', + 'cmi.core.total_time' => 'total_time', + 'cmi.core.exit' => 'core_exit', + 'cmi.suspend_data' => 'suspend_data', + 'cmi.core.score.raw' => 'score', + 'cmi.core.score.max' => 'max_score', + 'cmi.total_time' => 'total_time', + 'cmi.score.scaled' => 'score', + 'cmi.completion_status' => 'status', + ]; + + $itemData = []; + + foreach ($trackData as $component => $value) { + if ('cmi.core.total_time' === $component) { + $value = $this->hmsToSeconds($value); + } elseif ('cmi.core.exit' === $component) { + $value = $this->coreExit($value); + } elseif ('cmi.total_time' === $component) { + if (empty($trackData['x.start.time'])) { + $value = 0; + } else { + $value = $this->cmiTotalTime($trackData['x.start.time'], $value); + } + } elseif ('cmi.score.scaled' === $component) { + $value = $this->cmiScoreScaled($value); + } + + if (isset($elements[$component])) { + $variable = $elements[$component]; + + $itemData[$variable] = $value; + } + } + + return $itemData; + } + + /** + * @param string $hms + * + * @return int + */ + private function hmsToSeconds($hms) + { + if (empty($hms)) { + return 0; + } + + list($h, $m, $s) = explode(':', $hms); + + return ((int) $h * 3600) + ((int) $m * 60) + ceil($s); + } + + /** + * @param string $value + * + * @return string + */ + private function coreExit($value) + { + if (empty($value)) { + return 'none'; + } + } + + /** + * @param int $startTimeValue + * @param string $value + * + * @throws \Exception + * + * @return int + */ + private function cmiTotalTime($startTimeValue, $value) + { + $startTime = new \DateTime(); + $startTime->setTimestamp($startTimeValue); + $startTime->setTimezone(new \DateTimeZone('UTC')); + + $endTime = clone $startTime; + $endTime->add(new \DateInterval($value)); + + return $endTime->getTimestamp() - $startTime->getTimestamp(); + } + + /** + * @param string $value + * + * @return float + */ + private function cmiScoreScaled($value) + { + return (float) $value * 100; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/SectionSequenceLookup.php b/plugin/migrationmoodle/src/Transformer/Property/SectionSequenceLookup.php new file mode 100644 index 000000000..eedebdc67 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/SectionSequenceLookup.php @@ -0,0 +1,71 @@ +getConnection(); + } catch (DBALException $exception) { + throw new \Exception('Unable to start connection.', 0, $exception); + } + + $mSequence = explode(',', $data['sequence']); + $lpOrderList = []; + + foreach ($mSequence as $mModuleId) { + try { + $query = "SELECT m.name + FROM mdl_course_modules cm + INNER JOIN mdl_modules m ON cm.module = m.id + WHERE cm.id = ?"; + + $result = $connection->fetchAssoc($query, [$mModuleId]); + } catch (DBALException $exception) { + throw new \Exception("Unable to execute query \"{$this->query}\".", 0, $exception); + } + + if (empty($result)) { + continue; + } + + switch ($result['name']) { + case 'lesson': + $this->calledClass = CourseModulesLessonTask::class; + break; + case 'quiz': + $this->calledClass = CourseModulesQuizTask::class; + break; + default: + break; + } + + $lpItemId = parent::transform([$mModuleId]); + + $lpOrderList[$lpItemId] = 0; + } + + $connection->close(); + + return $lpOrderList; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/SessionName.php b/plugin/migrationmoodle/src/Transformer/Property/SessionName.php new file mode 100644 index 000000000..35c88947f --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/SessionName.php @@ -0,0 +1,30 @@ +transform($data); + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/UserQuestionAnswerGapselect.php b/plugin/migrationmoodle/src/Transformer/Property/UserQuestionAnswerGapselect.php new file mode 100644 index 000000000..2b40a5679 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/UserQuestionAnswerGapselect.php @@ -0,0 +1,139 @@ +gapselectGetRightAnswers($mRightAnswer); + + $mResponseSummary = $this->gapselectGetResponseSummary($mResponseSummary); + + $mQuestionSummary = explode(";", $mQuestionSummary); + $mQuestionSummary = array_map('trim', $mQuestionSummary); + + $questionText = array_shift($mQuestionSummary); + + $groupsAndOptions = $this->gapselectGetGroupsAndOptions($mQuestionSummary); + + $blanks = $this->gapselectGetBlanks($mRightAnswer, $groupsAndOptions); + + $count = 0; + + foreach ($blanks as $placeholder => $blank) { + $userAnswer = empty($mResponseSummary[$count]) ? '' : $mResponseSummary[$count]; + $replacement = $blank."[$userAnswer][0]"; + + $questionText = str_replace("[[$placeholder]]", $replacement, $questionText); + + $count++; + } + + $scorePerBlank = $mDefaultMark / count($mRightAnswer); + + $optionsScores = array_fill(0, count($mRightAnswer), $scorePerBlank); + $width = array_fill(0, count($mRightAnswer), 300); + + return utf8_encode("$questionText::".implode(',', $optionsScores).':'.implode(',', $width).':0@'); + } + + /** + * @param string $mRightAnswer + * + * @return array + */ + private function gapselectGetRightAnswers($mRightAnswer) + { + $rightAnswers = []; + + $mRightAnswer = explode('} {', $mRightAnswer); + + foreach ($mRightAnswer as $i0 => $item) { + $rightAnswers[$i0 + 1] = trim($item, "{} \t\n\r\x0B"); + } + + return $rightAnswers; + } + + /** + * @param string $mResponseSummary + * + * @return array + */ + private function gapselectGetResponseSummary($mResponseSummary) + { + $mResponseSummary = explode('} {', $mResponseSummary); + + return array_map( + function ($item) { + return trim($item, "{} \t\n\r\x0B"); + }, + $mResponseSummary + ); + } + + /** + * @return array + */ + private function gapselectGetGroupsAndOptions(array $mQuestionSummary) + { + $groupsAndOptions = []; + + foreach ($mQuestionSummary as $groupAndOptions) { + list($group, $options) = explode(' -> ', $groupAndOptions); + + $group = str_replace(['[', ']'], '', $group); + $options = explode(' / ', trim($options, "{} \t\n\r\x0B")); + + $groupsAndOptions[$group] = $options; + } + + return $groupsAndOptions; + } + + /** + * @return array + */ + private function gapselectGetBlanks(array $rightAnswers, array $groupsAndOptions) + { + $blanks = []; + + foreach ($rightAnswers as $i => $rightAnswer) { + foreach ($groupsAndOptions as $group => $options) { + if (in_array($rightAnswer, $options)) { + $optionIndex = array_search($rightAnswer, $options); + + unset($options[$optionIndex]); + + $options = array_merge([$rightAnswer], $options); + + $blanks[$i] = '['.implode('|', $options).']'; + } + } + } + + return $blanks; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/UserQuestionAnswerShortanswer.php b/plugin/migrationmoodle/src/Transformer/Property/UserQuestionAnswerShortanswer.php new file mode 100644 index 000000000..775ba3029 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/UserQuestionAnswerShortanswer.php @@ -0,0 +1,35 @@ +calledClass = QuestionsTask::class; + } + + /** + * {@inheritdoc} + */ + public function transform(array $data) + { + list( + $mQType, + $mRightAnswer, + $mResponseSummary, + $mFraction, + $mDefaultMark, + $mQuestionSummary, + $mQuestionId + ) = array_values($data); + + $questionId = parent::transform([$mQuestionId]); + + $answer = \Database::select( + 'iid', + \Database::get_course_table(TABLE_QUIZ_ANSWER), + [ + 'where' => [ + 'question_id = ? AND answer = ?' => [$questionId, utf8_encode("

    $mResponseSummary

    ")], + ], + ], + 'first' + ); + + if (empty($answer)) { + return 0; + } + + return $answer['iid']; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/UserStatus.php b/plugin/migrationmoodle/src/Transformer/Property/UserStatus.php new file mode 100644 index 000000000..b40469656 --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/UserStatus.php @@ -0,0 +1,62 @@ + ['manager', 'coursecreator', 'editingteacher', 'teacher'], + User::STUDENT => ['student', 'user'], + INVITEE => ['guest'], + ]; + + /** + * @throws \Exception + * + * @return int + */ + public function transform(array $sourceData) + { + try { + $connection = \MigrationMoodlePlugin::create()->getConnection(); + } catch (DBALException $e) { + throw new \Exception('Unable to start connection.', 0, $e); + } + + $query = "SELECT DISTINCT r.archetype FROM mdl_role r + INNER JOIN mdl_role_assignments ra ON r.id = ra.roleid WHERE ra.userid = ?"; + + $userId = (int) $sourceData['id']; + + try { + $statement = $connection->executeQuery($query, [$userId]); + } catch (DBALException $e) { + throw new \Exception("Unable to execute query \"$query\".", 0, $e); + } + + $userRoles = $statement->fetchAll(FetchMode::ASSOCIATIVE); + + $connection->close(); + + foreach (self::ROLES as $chamiloRole => $moodleRoles) { + foreach ($userRoles as $userRole) { + if (in_array($userRole['archetype'], $moodleRoles)) { + return $chamiloRole; + } + } + } + + return User::STUDENT; + } +} diff --git a/plugin/migrationmoodle/src/Transformer/Property/WrapHtmlReplacingFilePaths.php b/plugin/migrationmoodle/src/Transformer/Property/WrapHtmlReplacingFilePaths.php new file mode 100644 index 000000000..a234dde2d --- /dev/null +++ b/plugin/migrationmoodle/src/Transformer/Property/WrapHtmlReplacingFilePaths.php @@ -0,0 +1,36 @@ +$style$content"; + + return $content; + } +} diff --git a/plugin/migrationmoodle/uninstall.php b/plugin/migrationmoodle/uninstall.php new file mode 100644 index 000000000..a31446500 --- /dev/null +++ b/plugin/migrationmoodle/uninstall.php @@ -0,0 +1,57 @@ +uninstallHook(); +} catch (Exception $exception) { + $message = sprintf( + $plugin->get_lang('UninstallError'), + $exception->getMessage() + ); + + echo Display::return_message($message, 'error'); +} + +/** + * @throws \Doctrine\ORM\ORMException + * @throws \Doctrine\ORM\OptimisticLockException + */ +function removeExtraField() +{ + $em = Database::getManager(); + + /** @var ExtraField $extraField */ + $extraField = $em + ->getRepository('ChamiloCoreBundle:ExtraField') + ->findOneBy(['variable' => 'moodle_password', 'extraFieldType' => ExtraField::USER_FIELD_TYPE]); + + if ($extraField) { + $em + ->createQuery('DELETE FROM ChamiloCoreBundle:ExtraFieldValues efv WHERE efv.field = :field') + ->execute(['field' => $extraField]); + + $em->remove($extraField); + $em->flush(); + } +} + +/** + * Drop database table created by this plugin. + */ +function removePluginTables() +{ + $queries = []; + $queries[] = "DROP TABLE IF EXISTS plugin_migrationmoodle_item"; + $queries[] = "DROP TABLE IF EXISTS plugin_migrationmoodle_task"; + + foreach ($queries as $query) { + Database::query($query); + } +} diff --git a/plugin/mindmap/ajax/mindmap.ajax.php b/plugin/mindmap/ajax/mindmap.ajax.php new file mode 100644 index 000000000..3ca192ea0 --- /dev/null +++ b/plugin/mindmap/ajax/mindmap.ajax.php @@ -0,0 +1,59 @@ + $dataMap, + ]; + $whereConditions = [ + 'id = ?' => $idMM, + 'AND (user_id = ?' => $user['id'], + 'OR is_shared = 1)', + ]; + + $isAdmin = api_is_platform_admin(); + + if ($user['status'] == SESSIONADMIN || $user['status'] == PLATFORM_ADMIN || $isAdmin) { + $whereConditions = [ + 'id = ?' => $idMM, + ]; + } + + Database::update($table, $params, $whereConditions); + + echo 'OK'; + } else { + echo 'KO'; + } + } else { + echo 'KO'; + } +} else { + echo 'KO'; +} diff --git a/plugin/mindmap/edit-mindmap/README.md b/plugin/mindmap/edit-mindmap/README.md new file mode 100644 index 000000000..8b9b1c734 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/README.md @@ -0,0 +1,13 @@ +mindMap +======= + +mindMap is a mind mapping application written entirely in JavaScript. I'm trying to use the latest HTML5 and CSS3 technologies in it. + +mindMap is hosted [here][1] and a simple document is [here][2]. + +[1]: http://kampfer.github.com/mindMap/client/index.html +[2]: http://kampfer.github.com/mindMap/client/help/introduce.html + +###Supported browsers + +Just chrome and firefox \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/app-base.js b/plugin/mindmap/edit-mindmap/app-base.js new file mode 100644 index 000000000..db7159cc7 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/app-base.js @@ -0,0 +1,88 @@ +setTimeout(function () { + + var mapData = { + 'document': [{ + 'id': '937205e4-c2b0-ead3-2db4-66719b3612e2', + 'parent': null, + 'children': null, + 'content': 'Chamilo', + 'offset': {'x': 360, 'y': 394} + }], 'lastModified': 1592229869766 + } + if (dataMMLoad != '') { + mapData = dataMMLoad + } + var view = document.getElementById('map-container') + view = kampfer.mindMap.window + var command = new kampfer.mindMap.command.CreateNewMap(mapData, view) + command.execute() + + var ht = '
  • ' + ht += 'Save
    • ' + $('#main-menu').html(ht) + +}, 100) + +var onlyOneUpdate = true + +setTimeout(function () { + saveMapProcess(false) +}, 6000) + +function saveMapProcess (redir) { + + if (onlyOneUpdate == false) {return false} + + if (redir) { + var ht = 'Save' + $('#mindmapmenu').html(ht) + } + + var map = kampfer.mindMap.mapManager.getMapData() + var mapString = JSON.stringify(map) + + var formData = {datamap: mapString} + + $.ajax({ + url: '../ajax/mindmap.ajax.php?id=' + idMM, + type: 'POST', data: formData, + success: function (data, textStatus, jqXHR) { + + onlyOneUpdate = true + + if (data.indexOf('KO') == -1) { + + if (redir) { + window.location.href = '../list.php?cid=' + MMGetParamValue('cid') + '&sid=' + MMGetParamValue('sid') + } + + } else { + alert('Error !') + } + + }, + error: function (jqXHR, textStatus, errorThrown) { + + alert('Error : ' + textStatus) + onlyOneUpdate = true + } + + }) +} + +function MMGetParamValue (param) { + + var u = document.location.href + var reg = new RegExp('(\\?|&|^)' + param + '=(.*?)(&|$)') + matches = u.match(reg) + + if (matches == null) {return ''} + + var vari = matches[2] != undefined ? decodeURIComponent(matches[2]).replace(/\+/g, ' ') : '' + + for (var i = 100; i > -1; i--) { + vari = vari.replace('#page' + i, '') + } + return vari + +} diff --git a/plugin/mindmap/edit-mindmap/build/config.json b/plugin/mindmap/edit-mindmap/build/config.json new file mode 100644 index 000000000..f551cb63a --- /dev/null +++ b/plugin/mindmap/edit-mindmap/build/config.json @@ -0,0 +1,8 @@ +{ + "name" : "kampfer", + "jsDir" : "client/js/", + "combine" : { + "source" : "", + "export" : "" + } +} \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/build/lib/combine.js b/plugin/mindmap/edit-mindmap/build/lib/combine.js new file mode 100644 index 000000000..1351caad3 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/build/lib/combine.js @@ -0,0 +1,75 @@ +var path = require('path'), + fs = require('fs'); + +var //项目名 + prefix, + //依赖关系 + dep, + //项目路径 + jsDir; + +var sort = function(src) { + if(!dep) { + console.log('Please call combine.init method first!'); + return; + } + + var scripts = [], + visited = {}, + visit = function(node) { + if(node in visited) { + return; + } + visited[node] = true; + + var requires = dep.getRequiresByPath(node); + + for(var require in requires) { + visit( dep.getPathByName(require) ); + } + + scripts.push(node); + }; + + visit(src); + + return scripts; +}; + +var deleteRequire = function(code) { + var reg = prefix + '\\.require\\([\'\"]([-_\\.a-zA-Z0-9]+)[\'\"]\\);[\n\r]*'; + reg = new RegExp(reg, 'g'); + return code.replace(reg, ''); +}; + +exports.init = function(dependency, config) { + dep = dependency; + jsDir = config.getJsDir(); + prefix = config.getProjectName(); +}; + +exports.combineCode = function(src) { + if(!src) { + console.log('Please input a file'); + return; + } + + src = path.relative(jsDir, src).replace(/\\/g, '/'); + var scripts = sort(src), code = []; + + for(var i = 0, l = scripts.length; i < l; i++) { + src = path.join(jsDir, scripts[i]); + var content = fs.readFileSync(src).toString(); + code.push( deleteRequire(content) ); + } + + return code.join('\n\n'); +}; + +exports.combineFile = function(src, output) { + var content = exports.combineCode(src); + fs.writeFileSync(output, content); + console.log('success! -> Combined File : ' + src); +}; + +exports.combine = function() {}; \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/build/lib/config.js b/plugin/mindmap/edit-mindmap/build/lib/config.js new file mode 100644 index 000000000..cb8474734 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/build/lib/config.js @@ -0,0 +1,19 @@ +var fs = require('fs'), + path = require('path'), + config = {}; + +exports.getProjectName = function() { + return config.name; +}; + +//js文件夹必须和tools在同一级目录 +exports.getJsDir = function() { + if(config.jsDir) { + return path.resolve(__dirname, '../../', config.jsDir); + } +}; + +exports.parse = function(uri) { + uri = path.normalize(uri); + config = JSON.parse( fs.readFileSync(uri) ); +}; \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/build/lib/dependency.js b/plugin/mindmap/edit-mindmap/build/lib/dependency.js new file mode 100644 index 000000000..788bc342a --- /dev/null +++ b/plugin/mindmap/edit-mindmap/build/lib/dependency.js @@ -0,0 +1,136 @@ +var fs = require('fs'), + path = require('path'); + +var //项目名 + prefix, + //项目路径 + jsDir, + //依赖文件路径 + depsPath, + //依赖关系缓存 + dependencies = { + pathToNames: {}, // 1 to many + nameToPath: {}, // 1 to 1 + requires: {} // 1 to many + }; + +function addDepsToFile(src, provides, requires) { + var insertText, fd; + + requires = '[' + requires.join(',') + ']'; + provides = '[' + provides.join(',') + ']'; + + insertText = [ + prefix, + '.addDependency(\'', + src, + '\', ', + provides, + ', ', + requires, + ');\n' + ].join(''); + + try{ + fd = fs.openSync(depsPath, 'a'); + fs.writeSync(fd, insertText, 0, 'utf8'); + }catch(e){ + return false; + } + + return true; +} + +function addDepsToObj(src, provides, requires) { + var provide, require, deps = dependencies; + + for( var i = 0; (provide = provides[i]); i++) { + deps.nameToPath[provide] = src; + if (!(src in deps.pathToNames)) { + deps.pathToNames[src] = {}; + } + deps.pathToNames[src][provide] = true; + } + + for( var j = 0; (require = requires[j]); j++) { + if (!(src in deps.requires)) { + deps.requires[src] = {}; + } + deps.requires[src][require] = true; + } +} + +function scanFile(uri) { + if( path.basename(uri) === 'deps.js') { + return; + } + + var reg = prefix + '\\.(require|provide)\\([\'\"]([-_\\.a-zA-Z0-9]+)[\'\"]\\);[\n\r]*', + provides = [], + requires = [], + content = fs.readFileSync(uri), + match; + + reg = new RegExp(reg, 'g'); + uri = path.relative(jsDir, uri).replace(/\\/g, '/'); + + do { + match = reg.exec(content); + + if(match) { + if( match[1] === 'require' ) { + requires.push('\'' + match[2] + '\''); + } + if( match[1] === 'provide' ) { + //prefix不应该被包含在provide name中 + var provide = match[2].split('.'); + if(provide[0] === prefix) { + provide = provide.slice(1).join('.'); + } else { + provide = match[2]; + } + + provides.push('\'' + provide + '\''); + } + } + } while(match); + + addDepsToFile( uri, provides, requires ); + addDepsToObj( uri, provides, requires ); + console.log('success! -> create one dependency record : ' + uri); +} + +exports.scan = function(uri) { + var stat = fs.statSync(uri); + + if( stat.isDirectory() ) { + fs.readdirSync(uri).forEach(function(part) { + exports.scan( path.join(uri, part) ); + }); + } else if( stat.isFile() ) { + scanFile(uri); + } +}; + +exports.init = function(config) { + prefix = config.getProjectName(); + jsDir = config.getJsDir(); + depsPath = path.join(jsDir, 'deps.js'); + + fs.writeFile(depsPath, ''); + console.log('success! -> create a new deps.js'); + + exports.scan(jsDir); +}; + +exports.getRequiresByPath = function(src) { + return dependencies.requires[src]; +}; + +exports.getPathByName = function(name) { + return dependencies.nameToPath[name]; +}; + +exports.getDepsPath = function() { + return depsPath; +}; \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/build/make.js b/plugin/mindmap/edit-mindmap/build/make.js new file mode 100644 index 000000000..f4565ddd1 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/build/make.js @@ -0,0 +1,16 @@ +var combine = require('./lib/combine'), + dep = require('./lib/dependency'), + fs = require('fs'), + path = require('path'), + config = require('./lib/config'), + UglifyJS = require("uglify-js"); + +config.parse( path.join(__dirname, 'config.json') ); +dep.init(config); +combine.init(dep, config); + +var testUri = path.resolve(__dirname, '../', 'client/js/mindmap.js'), + testOutput = path.resolve(__dirname, '../', 'client/js/mindmap.min.js'); + +combine.combineFile(testUri, testOutput); +fs.writeFileSync(testOutput, UglifyJS.minify(testOutput).code); \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/build/makeDeps.js b/plugin/mindmap/edit-mindmap/build/makeDeps.js new file mode 100644 index 000000000..8907a0d89 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/build/makeDeps.js @@ -0,0 +1,7 @@ +var dep = require('./lib/dependency'), + fs = require('fs'), + path = require('path'), + config = require('./lib/config'); + +config.parse( path.join(__dirname, 'config.json') ); +dep.init(config); \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/doc/code-structure.md b/plugin/mindmap/edit-mindmap/doc/code-structure.md new file mode 100644 index 000000000..442b46ddb --- /dev/null +++ b/plugin/mindmap/edit-mindmap/doc/code-structure.md @@ -0,0 +1,31 @@ +# Code Structure Of Mindmap # + +## Model ## + +mapmanager.js + +------------- + +## View ## + +window.js + +toolbar.js + +menu.js + +map.js + +node.js + +caption.js + +branch.js + +----------- + +## Controller ## + +command.js + +app.js \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/doc/note.md b/plugin/mindmap/edit-mindmap/doc/note.md new file mode 100644 index 000000000..136984f1e --- /dev/null +++ b/plugin/mindmap/edit-mindmap/doc/note.md @@ -0,0 +1,31 @@ +关于架构设计 +============ + +设计一个领域实体，必须明确这个领域实体必须知道其他哪些领域实体（帮助其完成业务），之后对于其他领域实体可以完全无视。 + +程序的启动程序的主要工作是：初始化view、model和controller。model比较封闭，初始化时一般不需要外部帮助；view初始化一般需要model数据等信息；controller需要view和model的引用，保证view和model信息的同步。 + +数据的流动方向和路径？ + +启动文件负责配置好所有组件,并在命名空间中保存引用. +所有view组件注册在mindMap.view下, 所有modal注册在mindMap.modal下, controller类似. +组件需要调用其它组件时, 可以将mindMap作为参数直接传递. + + +已经使用的设计模式 +================== + +1. Observer +2. Composition +3. Command +4. Template Method + + +**Composition模式** +类有两部分的功能: 管理子节点和递归操作 + +**Decorator模式** +https://gist.github.com/kampfer/5012413 + +**Abstract Factory/Factory Method** +抽象工厂模式依赖工厂方法模式 他们也经常和模板方法模式一起使用 \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/img/mindmap.png b/plugin/mindmap/edit-mindmap/img/mindmap.png new file mode 100644 index 000000000..f6cf34263 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/img/mindmap.png differ diff --git a/plugin/mindmap/edit-mindmap/img/mindmap128.png b/plugin/mindmap/edit-mindmap/img/mindmap128.png new file mode 100644 index 000000000..e3c1e4320 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/img/mindmap128.png differ diff --git a/plugin/mindmap/edit-mindmap/img/mindmap128gray.png b/plugin/mindmap/edit-mindmap/img/mindmap128gray.png new file mode 100644 index 000000000..2f02b8bcd Binary files /dev/null and b/plugin/mindmap/edit-mindmap/img/mindmap128gray.png differ diff --git a/plugin/mindmap/edit-mindmap/index.php b/plugin/mindmap/edit-mindmap/index.php new file mode 100644 index 000000000..2725cca79 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/index.php @@ -0,0 +1,134 @@ + + + + + MindMap + + + + + + + + + +
    + +
    + + + + +
    +
    +

    MindMap

    +
    +
    + +
    + +
    + + + + + + + + diff --git a/plugin/mindmap/edit-mindmap/mindMap.js b/plugin/mindmap/edit-mindmap/mindMap.js new file mode 100644 index 000000000..efe40cc44 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/mindMap.js @@ -0,0 +1,11 @@ +var connect = require('connect'); +var path = require('path'); + +connect.static.mime.define({ + 'text/cache-manifest' : ['mf', 'manifest'] +}); + +var app = connect() + .use( connect.logger('dev') ) + .use( connect.static('client/') ) + .listen(8000); \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/mindMap.txt b/plugin/mindmap/edit-mindmap/mindMap.txt new file mode 100644 index 000000000..f7a3fdc1c --- /dev/null +++ b/plugin/mindmap/edit-mindmap/mindMap.txt @@ -0,0 +1,52 @@ +{ + "tree" : { + "id" : "map", + "children" : [ + { + "id" : "child1", + "content" : "child1", + "offset" : {"x" : 100, "y" : 200}, + "parent" : "map", + "children" : [ + { + "id" : "child1-1", + "content" : "child1-1", + "offset" : {"x" : 100, "y" : 200}, + "parent" : "child1", + "children" : [ + { + "id" : "child1-1-1", + "content" : "child1-1-1", + "offset" : {"x" : 200, "y" : 200}, + "parent" : "child1-1", + "children" : null + } + ] + }, + { + "id" : "child1-2", + "content" : "child1-2", + "offset" : {"x" : 200, "y" : 200}, + "parent" : "child1", + "children" : null + } + ] + }, + { + "id" : "child2", + "content" : "child2", + "offset" : {"x" : 100, "y" : 100}, + "parent" : "map", + "children" : null + }, + { + "id" : "child3", + "content" : "child3", + "offset" : {"x" : 200, "y" : 100}, + "parent" : "map", + "children" : null + } + ] + }, + "name" : "untitled" +} \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/vendor/css/DemoTransformsAnimations.css b/plugin/mindmap/edit-mindmap/vendor/css/DemoTransformsAnimations.css new file mode 100644 index 000000000..359a40da2 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/css/DemoTransformsAnimations.css @@ -0,0 +1,216 @@ +/*Styles used for the various demonstration divs that need to be vendor prefixed*/ +.TransformDemoPerspective200 { + -ms-perspective: 200px; +} + +.TransformDemoPerspectiveOrigin3050 { + -ms-perspective-origin: 30% 50%; +} + +.TransformDemoPerspectiveOrigin8050 { + -ms-perspective-origin: 80% 50%; +} + +.TransformDemoDivRotate45 { +} + +.TransformDemoDivRotate45:hover { + -ms-transform: rotate(45deg); +} + +.TransformDemoDivSkewX45:hover { + -ms-transform: skewX(45deg); +} + +.Transform3DDemoDivRotateX:hover { + -ms-transform: rotateX(45deg); +} + +.Transform3DDemoDivRotateY:hover { + -ms-transform: rotateY(45deg); +} + +.Transform3DDemoDivTranslateZ:hover { + -ms-transform: translateZ(-50px); +} + +.Transform3DDemoDivRotateYTranslateZ:hover { + -ms-transform: rotateY(45deg) translateZ(-50px); +} +.Transform3DDemoDivTranslateZRotateY:hover { + -ms-transform: translateZ(-50px) rotateY(45deg); +} + +@-ms-keyframes fadeOut { + from { + opacity: 1; + } + to { + opacity: 0; + } +} + +@-ms-keyframes fadeOutInOut { + 0% { + opacity: 1; + } + 25% { + opacity: 0; + } + 75% { + opacity: 1; + } + 100% { + opacity: 0; + } +} + +@-ms-keyframes fadeOutInOutSwirl { + 0% { + opacity: 1; + } + 25% { + opacity: 0.5; + -ms-transform: rotateZ(0deg); + } + 75% { + opacity: 0.5; + -ms-transform: rotateZ(180deg); + } + 100% { + opacity: 1.0; + -ms-transform: rotateZ(360deg); + } +} + + +@-ms-keyframes fullPageInOut { + 50% { + opacity: 0.5; + -ms-transform: scale(0.1) rotateZ(360deg); + } +} + +.TransformDemoDivFadeOut:hover { + -ms-animation-duration: 2s; + -ms-animation-name: fadeOut; +} + +.TransformDemoDivFadeOutInOut:hover { + -ms-animation-duration: 2s; + -ms-animation-name: fadeOutInOut; +} + +.TransformDemoDivFadeOutInOutSwirl:hover { + -ms-animation-duration: 2s; + -ms-animation-name: fadeOutInOutSwirl; +} + +.TransformTranslateX400px { + -ms-transform: translateX(400px); +} + +.TransformTranslateY300px { + -ms-transform: translateY(300px); +} + +.TransformRotate45 { + -ms-transform: rotate(45deg); +} + +.TransformRotateMinus35 { + -ms-transform: rotate(-35deg); +} + +.TransformSkewX25 { + -ms-transform: skewX(25deg); +} + +.TransformSkewY25 { + -ms-transform: skewY(25deg); +} + +.TransformScale075 { + -ms-transform: scale(0.75); +} + +.TransformScaleX075 { + -ms-transform: scaleX(0.75); +} + +.TransformScaleY075 { + -ms-transform: scaleY(0.75); +} + +.TransformScaleX125 { + -ms-transform: scaleX(1.25); +} + +.TransformScaleY125 { + -ms-transform: scaleY(1.25); +} + +.TransformRotate45TranslateX200px { + -ms-transform: rotate(45deg) translateX(200px); +} + +.TransformTranslateX200pxRotate45 { + -ms-transform: translateX(200px) rotate(45deg); +} + +.TransformOrigin0050 { + -ms-transform-origin: 0% 50%; +} + +.TransformOrigin0000 { + -ms-transform-origin: 0% 0%; +} + +.TransformOrigin00100 { + -ms-transform-origin: 0% 100%; +} + +.TransformOrigin100100 { + -ms-transform-origin: 100% 100%; +} + +.TransformOrigin2525 { + -ms-transform-origin: 25% 25%; +} + +.TransformOrigin5000 { + -ms-transform-origin: 50% 0%; +} + +.TransformOrigin50100 { + -ms-transform-origin: 50% 100%; +} + +.TransformOrigin6666 { + -ms-transform-origin: 66% 66%; +} + +.AnimationTimingEase { + -ms-animation-timing-function: ease; +} + +.AnimationTimingEaseIn { + -ms-animation-timing-function: ease-in; +} + +.AnimationTimingEaseOut { + -ms-animation-timing-function: ease-out; +} + +.AnimationTimingEaseInOut { + -ms-animation-timing-function: ease-in-out; +} + +.AnimationTimingLinear { + -ms-animation-timing-function: linear; +} + +.Animation3Iterations { + -ms-animation-iteration-count: 3; +} + diff --git a/plugin/mindmap/edit-mindmap/vendor/css/FullPageAnimationsPrefixed.css b/plugin/mindmap/edit-mindmap/vendor/css/FullPageAnimationsPrefixed.css new file mode 100644 index 000000000..6b0f18cb9 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/css/FullPageAnimationsPrefixed.css @@ -0,0 +1,223 @@ +/* Copyright © Microsoft Corporation. All Rights Reserved. */ +/* Demo Author: Charilaos "Harris" Papadopoulos, Microsoft Corporation */ + + +/* + Predefined full-page animations for the CSS Animation/Transform IE Test Drive Demo + Please check FullPageAnimations.js for more information +*/ + + +@-ms-keyframes rotateInLeft { + + from { + -ms-transform-origin: 0% 0%; + -ms-transform: rotateY(180deg); + } + + to { + -ms-transform-origin: 0% 0%; + -ms-transform: rotateY(0deg); + } +} + +@-ms-keyframes rotateOutLeft { + + from { + -ms-transform-origin: 0% 0%; + } + + to { + -ms-transform-origin: 0% 0%; + -ms-transform: rotateY(180deg); + } +} + +@-ms-keyframes rotateInRight { + + from { + -ms-transform-origin: 100% 0%; + -ms-transform: rotateY(-180deg); + + } + + to { + -ms-transform-origin: 100% 0%; + } +} + +@-ms-keyframes rotateInRightWithoutToKeyframe { + + from { + -ms-transform-origin: 100% 0%; + -ms-transform: rotateY(-180deg); + } +} + +@-ms-keyframes rotateOutRight { + + from { + -ms-transform-origin: 100% 0%; + } + + to { + -ms-transform-origin: 100% 0%; + -ms-transform: rotateY(-180deg); + } +} + +@-ms-keyframes fadeIn { + from { + opacity: 0; + } +} + +@-ms-keyframes fadeOut { + to { + opacity: 0; + } +} + +@-ms-keyframes whirlIn { + from { + -ms-transform-origin: 50% 50%; + -ms-transform: scale(0) rotateZ(1260deg); + } + + to { + -ms-transform-origin: 50% 50%; + } + +} + +@-ms-keyframes whirlOut { + from { + -ms-transform-origin: 50% 50%; + } + + to { + -ms-transform-origin: 50% 50%; + -ms-transform: scale(0) rotateZ(1260deg); + } + +} + +@-ms-keyframes fallFromTop { + from { + -ms-transform-origin: 0% 0%; + -ms-transform: rotateX(-180deg); + animation-timing-function: ease; + } + + 50% { + -ms-transform-origin: 0% 0%; + -ms-transform: rotateX(30deg); + animation-timing-function: ease; + } + + 85% { + -ms-transform-origin: 0% 0%; + -ms-transform: rotateX(-10deg); + animation-timing-function: ease; + } + + to { + -ms-transform-origin: 0% 0%; + -ms-transform: rotateX(0deg); + animation-timing-function: ease; + } +} + +@-ms-keyframes dropToBottom { + from { + -ms-transform-origin: 0% 100%; + } + + to { + -ms-transform-origin: 0% 100%; + -ms-transform: rotateX(180deg); + } +} + +@-ms-keyframes slideInSkew { + from { + -ms-transform-origin: 0% 100%; + -ms-transform: translateX(-200%) skewX(-45deg); + } + + 50% { + -ms-transform-origin: 0% 100%; + -ms-transform: translateX(0%) skewX(-45deg); + } + + 90% { + -ms-transform-origin: 0% 100%; + -ms-transform: translateX(0%) skewX(10deg); + } + + to { + -ms-transform-origin: 0% 100%; + -ms-transform:translateX(0%) skewX(0deg); + } +} + +@-ms-keyframes slideOutSkew { + from { + -ms-transform-origin: 0% 100%; + -ms-transform: translateX(0%); + } + + to { + -ms-transform-origin: 0% 100%; + -ms-transform: skewX(-45deg) translateX(200%) ; + } +} + +@-ms-keyframes tumbleIn { + from { + -ms-transform-origin: 0% 100%; + -ms-transform: rotateZ(-180deg); + } + + to { + -ms-transform-origin: 0% 100%; + } + +} + +@-ms-keyframes tumbleOut { + from { + -ms-transform-origin: 100% 100%; + } + + to { + -ms-transform-origin: 100% 100%; + -ms-transform: rotateZ(180deg); + } + +} + +@-ms-keyframes expandIn { + from { + -ms-transform: scale(0); + } + + 50% { + + -ms-transform: scale(1); + } + + 75% { + -ms-transform: scale(1.2); + } + + to { + -ms-transform: scale(1); + } +} + +@-ms-keyframes collapseOut { + to { + -ms-transform: scale(0); + } +} \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/vendor/css/app.css b/plugin/mindmap/edit-mindmap/vendor/css/app.css new file mode 100644 index 000000000..27b1df845 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/css/app.css @@ -0,0 +1,174 @@ +/* app css start */ +html, body, .map-container{ + width:100%; + height:100%; +} + +.dropdown-menu .short-cut{ + float: right; + font-size: 12px; +} + +.app-tool-bar{ + position: fixed; + top: 10px; + left: 10px; + z-index: 9999; +} + +.app-tool-bar .dropdown-menu{ + min-width: 250px; +} + +.app-tool-bar > .dropdown-menu{ + display: block; + min-width: 40px; +} + +.app-tool-bar .dropdown-menu > li > a{ + padding: 5px 10px; +} + +.app-tool-bar .dropdown-submenu > a:after{ + margin-right: -5px; + margin-top: 3px; +} + +.app-container { + position: relative; + width:100%; + height:100%; + overflow: hidden; +} + +.map{ + width: 2000px; + height: 2000px; + background:url('../img/bg.gif') repeat; +} + +.app-footer { + position: fixed; + left: 0px; + bottom: 0px; + width: 100%; + height: 40px; + line-height: 40px; + background-color: #000; + text-align: center; + z-index: 9999; +} + +.app-footer:after{ + clear: both; +} + +.app-footer a{ + color: #333; +} + +.app-footer a:hover{ + text-decoration: none; + color: #fff; +} + +.app-footer .brand{ + color: #000000; + font-weight: bold; + text-shadow: 0 1px 0 rgba(255, 255, 255, 0.1), 0 0 30px rgba(255, 255, 255, 0.125); + -webkit-transition: all .2s linear; + -moz-transition: all .2s linear; + transition: all .2s linear; + font-size: 20px; + position: absolute; + right: 90px; + top: 0px; +} + +div.node{ + position: absolute; + cursor: default; +} + +div.node-caption{ + min-width: 100px; + max-width: 300px; + padding:10px; + z-index: 99; + border: 1px solid rgba(0, 0, 0, 0.4); + border-radius : 6px; + box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.2), 0 1px 2px rgba(0, 0, 0, 0.05); + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); + background-color: black; + color: white; + position: absolute; +} + +div.node-caption textarea{ + margin: 0; +} + +div.node-caption.black{ + border-color: #222 #222 black; + background-color: #363636; + background-image: -webkit-linear-gradient(top, #444, #222); + background-repeat: repeat-x; +} + +div.node-caption.red{ + border-color: #BD362F #BD362F #802420; + background-color: #DA4F49; + background-image: -webkit-linear-gradient(top, #EE5F5B, #BD362F); + background-repeat: repeat-x; +} + +div.node-caption.orange{ + border-color: #F89406 #F89406 #AD6704; + background-color: #FAA732; + background-image: -webkit-linear-gradient(top, #FBB450, #F89406); + background-repeat: repeat-x; +} + +div.node-caption.green{ + border-color: #51A351 #51A351 #387038; + background-color: #5BB75B; + background-image: -webkit-linear-gradient(top, #62C462, #51A351); + background-repeat: repeat-x; +} + +div.node-caption.blue{ + border-color: #2F96B4 #2F96B4 #1F6377; + background-color: #2F96B4; + background-image: -webkit-linear-gradient(top, #5BC0DE, #2F96B4); + background-image: -moz-linear-gradient(top, #5BC0DE, #2F96B4); + background-repeat: repeat-x; +} + +div.node-caption.dark-blue{ + border-color: #04C #04C #002A80; + background-color: #04C; + background-image: -webkit-linear-gradient(top, #08C, #04C); + background-repeat: repeat-x; +} + +div.node-caption:hover{ + background-position: 0 -15px; + transition: background-position 0.1s linear 0s; +} + +div.node-caption.blue:hover{ + background-color: #2F96B4; +} + +div.node canvas{ + position:absolute; +} + +.modal .app-file-list{ + max-height: 200px; + overflow: auto; +} + +.modal .app-file-name{ + padding-top: 20px; +} \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/vendor/css/bootstrap-responsive.css b/plugin/mindmap/edit-mindmap/vendor/css/bootstrap-responsive.css new file mode 100644 index 000000000..a3352d774 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/css/bootstrap-responsive.css @@ -0,0 +1,1092 @@ +/*! + * Bootstrap Responsive v2.2.2 + * + * Copyright 2012 Twitter, Inc + * Licensed under the Apache License v2.0 + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Designed and built with all the love in the world @twitter by @mdo and @fat. + */ + +@-ms-viewport { + width: device-width; +} + +.clearfix { + *zoom: 1; +} + +.clearfix:before, +.clearfix:after { + display: table; + line-height: 0; + content: ""; +} + +.clearfix:after { + clear: both; +} + +.hide-text { + font: 0/0 a; + color: transparent; + text-shadow: none; + background-color: transparent; + border: 0; +} + +.input-block-level { + display: block; + width: 100%; + min-height: 30px; + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; +} + +.hidden { + display: none; + visibility: hidden; +} + +.visible-phone { + display: none !important; +} + +.visible-tablet { + display: none !important; +} + +.hidden-desktop { + display: none !important; +} + +.visible-desktop { + display: inherit !important; +} + +@media (min-width: 768px) and (max-width: 979px) { + .hidden-desktop { + display: inherit !important; + } + .visible-desktop { + display: none !important ; + } + .visible-tablet { + display: inherit !important; + } + .hidden-tablet { + display: none !important; + } +} + +@media (max-width: 767px) { + .hidden-desktop { + display: inherit !important; + } + .visible-desktop { + display: none !important; + } + .visible-phone { + display: inherit !important; + } + .hidden-phone { + display: none !important; + } +} + +@media (min-width: 1200px) { + .row { + margin-left: -30px; + *zoom: 1; + } + .row:before, + .row:after { + display: table; + line-height: 0; + content: ""; + } + .row:after { + clear: both; + } + [class*="span"] { + float: left; + min-height: 1px; + margin-left: 30px; + } + .container, + .navbar-static-top .container, + .navbar-fixed-top .container, + .navbar-fixed-bottom .container { + width: 1170px; + } + .span12 { + width: 1170px; + } + .span11 { + width: 1070px; + } + .span10 { + width: 970px; + } + .span9 { + width: 870px; + } + .span8 { + width: 770px; + } + .span7 { + width: 670px; + } + .span6 { + width: 570px; + } + .span5 { + width: 470px; + } + .span4 { + width: 370px; + } + .span3 { + width: 270px; + } + .span2 { + width: 170px; + } + .span1 { + width: 70px; + } + .offset12 { + margin-left: 1230px; + } + .offset11 { + margin-left: 1130px; + } + .offset10 { + margin-left: 1030px; + } + .offset9 { + margin-left: 930px; + } + .offset8 { + margin-left: 830px; + } + .offset7 { + margin-left: 730px; + } + .offset6 { + margin-left: 630px; + } + .offset5 { + margin-left: 530px; + } + .offset4 { + margin-left: 430px; + } + .offset3 { + margin-left: 330px; + } + .offset2 { + margin-left: 230px; + } + .offset1 { + margin-left: 130px; + } + .row-fluid { + width: 100%; + *zoom: 1; + } + .row-fluid:before, + .row-fluid:after { + display: table; + line-height: 0; + content: ""; + } + .row-fluid:after { + clear: both; + } + .row-fluid [class*="span"] { + display: block; + float: left; + width: 100%; + min-height: 30px; + margin-left: 2.564102564102564%; + *margin-left: 2.5109110747408616%; + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; + } + .row-fluid [class*="span"]:first-child { + margin-left: 0; + } + .row-fluid .controls-row [class*="span"] + [class*="span"] { + margin-left: 2.564102564102564%; + } + .row-fluid .span12 { + width: 100%; + *width: 99.94680851063829%; + } + .row-fluid .span11 { + width: 91.45299145299145%; + *width: 91.39979996362975%; + } + .row-fluid .span10 { + width: 82.90598290598291%; + *width: 82.8527914166212%; + } + .row-fluid .span9 { + width: 74.35897435897436%; + *width: 74.30578286961266%; + } + .row-fluid .span8 { + width: 65.81196581196582%; + *width: 65.75877432260411%; + } + .row-fluid .span7 { + width: 57.26495726495726%; + *width: 57.21176577559556%; + } + .row-fluid .span6 { + width: 48.717948717948715%; + *width: 48.664757228587014%; + } + .row-fluid .span5 { + width: 40.17094017094017%; + *width: 40.11774868157847%; + } + .row-fluid .span4 { + width: 31.623931623931625%; + *width: 31.570740134569924%; + } + .row-fluid .span3 { + width: 23.076923076923077%; + *width: 23.023731587561375%; + } + .row-fluid .span2 { + width: 14.52991452991453%; + *width: 14.476723040552828%; + } + .row-fluid .span1 { + width: 5.982905982905983%; + *width: 5.929714493544281%; + } + .row-fluid .offset12 { + margin-left: 105.12820512820512%; + *margin-left: 105.02182214948171%; + } + .row-fluid .offset12:first-child { + margin-left: 102.56410256410257%; + *margin-left: 102.45771958537915%; + } + .row-fluid .offset11 { + margin-left: 96.58119658119658%; + *margin-left: 96.47481360247316%; + } + .row-fluid .offset11:first-child { + margin-left: 94.01709401709402%; + *margin-left: 93.91071103837061%; + } + .row-fluid .offset10 { + margin-left: 88.03418803418803%; + *margin-left: 87.92780505546462%; + } + .row-fluid .offset10:first-child { + margin-left: 85.47008547008548%; + *margin-left: 85.36370249136206%; + } + .row-fluid .offset9 { + margin-left: 79.48717948717949%; + *margin-left: 79.38079650845607%; + } + .row-fluid .offset9:first-child { + margin-left: 76.92307692307693%; + *margin-left: 76.81669394435352%; + } + .row-fluid .offset8 { + margin-left: 70.94017094017094%; + *margin-left: 70.83378796144753%; + } + .row-fluid .offset8:first-child { + margin-left: 68.37606837606839%; + *margin-left: 68.26968539734497%; + } + .row-fluid .offset7 { + margin-left: 62.393162393162385%; + *margin-left: 62.28677941443899%; + } + .row-fluid .offset7:first-child { + margin-left: 59.82905982905982%; + *margin-left: 59.72267685033642%; + } + .row-fluid .offset6 { + margin-left: 53.84615384615384%; + *margin-left: 53.739770867430444%; + } + .row-fluid .offset6:first-child { + margin-left: 51.28205128205128%; + *margin-left: 51.175668303327875%; + } + .row-fluid .offset5 { + margin-left: 45.299145299145295%; + *margin-left: 45.1927623204219%; + } + .row-fluid .offset5:first-child { + margin-left: 42.73504273504273%; + *margin-left: 42.62865975631933%; + } + .row-fluid .offset4 { + margin-left: 36.75213675213675%; + *margin-left: 36.645753773413354%; + } + .row-fluid .offset4:first-child { + margin-left: 34.18803418803419%; + *margin-left: 34.081651209310785%; + } + .row-fluid .offset3 { + margin-left: 28.205128205128204%; + *margin-left: 28.0987452264048%; + } + .row-fluid .offset3:first-child { + margin-left: 25.641025641025642%; + *margin-left: 25.53464266230224%; + } + .row-fluid .offset2 { + margin-left: 19.65811965811966%; + *margin-left: 19.551736679396257%; + } + .row-fluid .offset2:first-child { + margin-left: 17.094017094017094%; + *margin-left: 16.98763411529369%; + } + .row-fluid .offset1 { + margin-left: 11.11111111111111%; + *margin-left: 11.004728132387708%; + } + .row-fluid .offset1:first-child { + margin-left: 8.547008547008547%; + *margin-left: 8.440625568285142%; + } + input, + textarea, + .uneditable-input { + margin-left: 0; + } + .controls-row [class*="span"] + [class*="span"] { + margin-left: 30px; + } + input.span12, + textarea.span12, + .uneditable-input.span12 { + width: 1156px; + } + input.span11, + textarea.span11, + .uneditable-input.span11 { + width: 1056px; + } + input.span10, + textarea.span10, + .uneditable-input.span10 { + width: 956px; + } + input.span9, + textarea.span9, + .uneditable-input.span9 { + width: 856px; + } + input.span8, + textarea.span8, + .uneditable-input.span8 { + width: 756px; + } + input.span7, + textarea.span7, + .uneditable-input.span7 { + width: 656px; + } + input.span6, + textarea.span6, + .uneditable-input.span6 { + width: 556px; + } + input.span5, + textarea.span5, + .uneditable-input.span5 { + width: 456px; + } + input.span4, + textarea.span4, + .uneditable-input.span4 { + width: 356px; + } + input.span3, + textarea.span3, + .uneditable-input.span3 { + width: 256px; + } + input.span2, + textarea.span2, + .uneditable-input.span2 { + width: 156px; + } + input.span1, + textarea.span1, + .uneditable-input.span1 { + width: 56px; + } + .thumbnails { + margin-left: -30px; + } + .thumbnails > li { + margin-left: 30px; + } + .row-fluid .thumbnails { + margin-left: 0; + } +} + +@media (min-width: 768px) and (max-width: 979px) { + .row { + margin-left: -20px; + *zoom: 1; + } + .row:before, + .row:after { + display: table; + line-height: 0; + content: ""; + } + .row:after { + clear: both; + } + [class*="span"] { + float: left; + min-height: 1px; + margin-left: 20px; + } + .container, + .navbar-static-top .container, + .navbar-fixed-top .container, + .navbar-fixed-bottom .container { + width: 724px; + } + .span12 { + width: 724px; + } + .span11 { + width: 662px; + } + .span10 { + width: 600px; + } + .span9 { + width: 538px; + } + .span8 { + width: 476px; + } + .span7 { + width: 414px; + } + .span6 { + width: 352px; + } + .span5 { + width: 290px; + } + .span4 { + width: 228px; + } + .span3 { + width: 166px; + } + .span2 { + width: 104px; + } + .span1 { + width: 42px; + } + .offset12 { + margin-left: 764px; + } + .offset11 { + margin-left: 702px; + } + .offset10 { + margin-left: 640px; + } + .offset9 { + margin-left: 578px; + } + .offset8 { + margin-left: 516px; + } + .offset7 { + margin-left: 454px; + } + .offset6 { + margin-left: 392px; + } + .offset5 { + margin-left: 330px; + } + .offset4 { + margin-left: 268px; + } + .offset3 { + margin-left: 206px; + } + .offset2 { + margin-left: 144px; + } + .offset1 { + margin-left: 82px; + } + .row-fluid { + width: 100%; + *zoom: 1; + } + .row-fluid:before, + .row-fluid:after { + display: table; + line-height: 0; + content: ""; + } + .row-fluid:after { + clear: both; + } + .row-fluid [class*="span"] { + display: block; + float: left; + width: 100%; + min-height: 30px; + margin-left: 2.7624309392265194%; + *margin-left: 2.709239449864817%; + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; + } + .row-fluid [class*="span"]:first-child { + margin-left: 0; + } + .row-fluid .controls-row [class*="span"] + [class*="span"] { + margin-left: 2.7624309392265194%; + } + .row-fluid .span12 { + width: 100%; + *width: 99.94680851063829%; + } + .row-fluid .span11 { + width: 91.43646408839778%; + *width: 91.38327259903608%; + } + .row-fluid .span10 { + width: 82.87292817679558%; + *width: 82.81973668743387%; + } + .row-fluid .span9 { + width: 74.30939226519337%; + *width: 74.25620077583166%; + } + .row-fluid .span8 { + width: 65.74585635359117%; + *width: 65.69266486422946%; + } + .row-fluid .span7 { + width: 57.18232044198895%; + *width: 57.12912895262725%; + } + .row-fluid .span6 { + width: 48.61878453038674%; + *width: 48.56559304102504%; + } + .row-fluid .span5 { + width: 40.05524861878453%; + *width: 40.00205712942283%; + } + .row-fluid .span4 { + width: 31.491712707182323%; + *width: 31.43852121782062%; + } + .row-fluid .span3 { + width: 22.92817679558011%; + *width: 22.87498530621841%; + } + .row-fluid .span2 { + width: 14.3646408839779%; + *width: 14.311449394616199%; + } + .row-fluid .span1 { + width: 5.801104972375691%; + *width: 5.747913483013988%; + } + .row-fluid .offset12 { + margin-left: 105.52486187845304%; + *margin-left: 105.41847889972962%; + } + .row-fluid .offset12:first-child { + margin-left: 102.76243093922652%; + *margin-left: 102.6560479605031%; + } + .row-fluid .offset11 { + margin-left: 96.96132596685082%; + *margin-left: 96.8549429881274%; + } + .row-fluid .offset11:first-child { + margin-left: 94.1988950276243%; + *margin-left: 94.09251204890089%; + } + .row-fluid .offset10 { + margin-left: 88.39779005524862%; + *margin-left: 88.2914070765252%; + } + .row-fluid .offset10:first-child { + margin-left: 85.6353591160221%; + *margin-left: 85.52897613729868%; + } + .row-fluid .offset9 { + margin-left: 79.8342541436464%; + *margin-left: 79.72787116492299%; + } + .row-fluid .offset9:first-child { + margin-left: 77.07182320441989%; + *margin-left: 76.96544022569647%; + } + .row-fluid .offset8 { + margin-left: 71.2707182320442%; + *margin-left: 71.16433525332079%; + } + .row-fluid .offset8:first-child { + margin-left: 68.50828729281768%; + *margin-left: 68.40190431409427%; + } + .row-fluid .offset7 { + margin-left: 62.70718232044199%; + *margin-left: 62.600799341718584%; + } + .row-fluid .offset7:first-child { + margin-left: 59.94475138121547%; + *margin-left: 59.838368402492065%; + } + .row-fluid .offset6 { + margin-left: 54.14364640883978%; + *margin-left: 54.037263430116376%; + } + .row-fluid .offset6:first-child { + margin-left: 51.38121546961326%; + *margin-left: 51.27483249088986%; + } + .row-fluid .offset5 { + margin-left: 45.58011049723757%; + *margin-left: 45.47372751851417%; + } + .row-fluid .offset5:first-child { + margin-left: 42.81767955801105%; + *margin-left: 42.71129657928765%; + } + .row-fluid .offset4 { + margin-left: 37.01657458563536%; + *margin-left: 36.91019160691196%; + } + .row-fluid .offset4:first-child { + margin-left: 34.25414364640884%; + *margin-left: 34.14776066768544%; + } + .row-fluid .offset3 { + margin-left: 28.45303867403315%; + *margin-left: 28.346655695309746%; + } + .row-fluid .offset3:first-child { + margin-left: 25.69060773480663%; + *margin-left: 25.584224756083227%; + } + .row-fluid .offset2 { + margin-left: 19.88950276243094%; + *margin-left: 19.783119783707537%; + } + .row-fluid .offset2:first-child { + margin-left: 17.12707182320442%; + *margin-left: 17.02068884448102%; + } + .row-fluid .offset1 { + margin-left: 11.32596685082873%; + *margin-left: 11.219583872105325%; + } + .row-fluid .offset1:first-child { + margin-left: 8.56353591160221%; + *margin-left: 8.457152932878806%; + } + input, + textarea, + .uneditable-input { + margin-left: 0; + } + .controls-row [class*="span"] + [class*="span"] { + margin-left: 20px; + } + input.span12, + textarea.span12, + .uneditable-input.span12 { + width: 710px; + } + input.span11, + textarea.span11, + .uneditable-input.span11 { + width: 648px; + } + input.span10, + textarea.span10, + .uneditable-input.span10 { + width: 586px; + } + input.span9, + textarea.span9, + .uneditable-input.span9 { + width: 524px; + } + input.span8, + textarea.span8, + .uneditable-input.span8 { + width: 462px; + } + input.span7, + textarea.span7, + .uneditable-input.span7 { + width: 400px; + } + input.span6, + textarea.span6, + .uneditable-input.span6 { + width: 338px; + } + input.span5, + textarea.span5, + .uneditable-input.span5 { + width: 276px; + } + input.span4, + textarea.span4, + .uneditable-input.span4 { + width: 214px; + } + input.span3, + textarea.span3, + .uneditable-input.span3 { + width: 152px; + } + input.span2, + textarea.span2, + .uneditable-input.span2 { + width: 90px; + } + input.span1, + textarea.span1, + .uneditable-input.span1 { + width: 28px; + } +} + +@media (max-width: 767px) { + body { + padding-right: 20px; + padding-left: 20px; + } + .navbar-fixed-top, + .navbar-fixed-bottom, + .navbar-static-top { + margin-right: -20px; + margin-left: -20px; + } + .container-fluid { + padding: 0; + } + .dl-horizontal dt { + float: none; + width: auto; + clear: none; + text-align: left; + } + .dl-horizontal dd { + margin-left: 0; + } + .container { + width: auto; + } + .row-fluid { + width: 100%; + } + .row, + .thumbnails { + margin-left: 0; + } + .thumbnails > li { + float: none; + margin-left: 0; + } + [class*="span"], + .uneditable-input[class*="span"], + .row-fluid [class*="span"] { + display: block; + float: none; + width: 100%; + margin-left: 0; + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; + } + .span12, + .row-fluid .span12 { + width: 100%; + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; + } + .row-fluid [class*="offset"]:first-child { + margin-left: 0; + } + .input-large, + .input-xlarge, + .input-xxlarge, + input[class*="span"], + select[class*="span"], + textarea[class*="span"], + .uneditable-input { + display: block; + width: 100%; + min-height: 30px; + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; + } + .input-prepend input, + .input-append input, + .input-prepend input[class*="span"], + .input-append input[class*="span"] { + display: inline-block; + width: auto; + } + .controls-row [class*="span"] + [class*="span"] { + margin-left: 0; + } + .modal { + position: fixed; + top: 20px; + right: 20px; + left: 20px; + width: auto; + margin: 0; + } + .modal.fade { + top: -100px; + } + .modal.fade.in { + top: 20px; + } +} + +@media (max-width: 480px) { + .nav-collapse { + -webkit-transform: translate3d(0, 0, 0); + } + .page-header h1 small { + display: block; + line-height: 20px; + } + input[type="checkbox"], + input[type="radio"] { + border: 1px solid #ccc; + } + .form-horizontal .control-label { + float: none; + width: auto; + padding-top: 0; + text-align: left; + } + .form-horizontal .controls { + margin-left: 0; + } + .form-horizontal .control-list { + padding-top: 0; + } + .form-horizontal .form-actions { + padding-right: 10px; + padding-left: 10px; + } + .media .pull-left, + .media .pull-right { + display: block; + float: none; + margin-bottom: 10px; + } + .media-object { + margin-right: 0; + margin-left: 0; + } + .modal { + top: 10px; + right: 10px; + left: 10px; + } + .modal-header .close { + padding: 10px; + margin: -10px; + } + .carousel-caption { + position: static; + } +} + +@media (max-width: 979px) { + body { + padding-top: 0; + } + .navbar-fixed-top, + .navbar-fixed-bottom { + position: static; + } + .navbar-fixed-top { + margin-bottom: 20px; + } + .navbar-fixed-bottom { + margin-top: 20px; + } + .navbar-fixed-top .navbar-inner, + .navbar-fixed-bottom .navbar-inner { + padding: 5px; + } + .navbar .container { + width: auto; + padding: 0; + } + .navbar .brand { + padding-right: 10px; + padding-left: 10px; + margin: 0 0 0 -5px; + } + .nav-collapse { + clear: both; + } + .nav-collapse .nav { + float: none; + margin: 0 0 10px; + } + .nav-collapse .nav > li { + float: none; + } + .nav-collapse .nav > li > a { + margin-bottom: 2px; + } + .nav-collapse .nav > .divider-vertical { + display: none; + } + .nav-collapse .nav .nav-header { + color: #777777; + text-shadow: none; + } + .nav-collapse .nav > li > a, + .nav-collapse .dropdown-menu a { + padding: 9px 15px; + font-weight: bold; + color: #777777; + -webkit-border-radius: 3px; + -moz-border-radius: 3px; + border-radius: 3px; + } + .nav-collapse .btn { + padding: 4px 10px 4px; + font-weight: normal; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; + } + .nav-collapse .dropdown-menu li + li a { + margin-bottom: 2px; + } + .nav-collapse .nav > li > a:hover, + .nav-collapse .dropdown-menu a:hover { + background-color: #f2f2f2; + } + .navbar-inverse .nav-collapse .nav > li > a, + .navbar-inverse .nav-collapse .dropdown-menu a { + color: #999999; + } + .navbar-inverse .nav-collapse .nav > li > a:hover, + .navbar-inverse .nav-collapse .dropdown-menu a:hover { + background-color: #111111; + } + .nav-collapse.in .btn-group { + padding: 0; + margin-top: 5px; + } + .nav-collapse .dropdown-menu { + position: static; + top: auto; + left: auto; + display: none; + float: none; + max-width: none; + padding: 0; + margin: 0 15px; + background-color: transparent; + border: none; + -webkit-border-radius: 0; + -moz-border-radius: 0; + border-radius: 0; + -webkit-box-shadow: none; + -moz-box-shadow: none; + box-shadow: none; + } + .nav-collapse .open > .dropdown-menu { + display: block; + } + .nav-collapse .dropdown-menu:before, + .nav-collapse .dropdown-menu:after { + display: none; + } + .nav-collapse .dropdown-menu .divider { + display: none; + } + .nav-collapse .nav > li > .dropdown-menu:before, + .nav-collapse .nav > li > .dropdown-menu:after { + display: none; + } + .nav-collapse .navbar-form, + .nav-collapse .navbar-search { + float: none; + padding: 10px 15px; + margin: 10px 0; + border-top: 1px solid #f2f2f2; + border-bottom: 1px solid #f2f2f2; + -webkit-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.1); + -moz-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.1); + box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.1); + } + .navbar-inverse .nav-collapse .navbar-form, + .navbar-inverse .nav-collapse .navbar-search { + border-top-color: #111111; + border-bottom-color: #111111; + } + .navbar .nav-collapse .nav.pull-right { + float: none; + margin-left: 0; + } + .nav-collapse, + .nav-collapse.collapse { + height: 0; + overflow: hidden; + } + .navbar .btn-navbar { + display: block; + } + .navbar-static .navbar-inner { + padding-right: 10px; + padding-left: 10px; + } +} + +@media (min-width: 980px) { + .nav-collapse.collapse { + height: auto !important; + overflow: visible !important; + } +} diff --git a/plugin/mindmap/edit-mindmap/vendor/css/bootstrap-responsive.min.css b/plugin/mindmap/edit-mindmap/vendor/css/bootstrap-responsive.min.css new file mode 100644 index 000000000..5cb833ff0 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/css/bootstrap-responsive.min.css @@ -0,0 +1,9 @@ +/*! + * Bootstrap Responsive v2.2.2 + * + * Copyright 2012 Twitter, Inc + * Licensed under the Apache License v2.0 + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Designed and built with all the love in the world @twitter by @mdo and @fat. + */@-ms-viewport{width:device-width}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;line-height:0;content:""}.clearfix:after{clear:both}.hide-text{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.input-block-level{display:block;width:100%;min-height:30px;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.hidden{display:none;visibility:hidden}.visible-phone{display:none!important}.visible-tablet{display:none!important}.hidden-desktop{display:none!important}.visible-desktop{display:inherit!important}@media(min-width:768px) and (max-width:979px){.hidden-desktop{display:inherit!important}.visible-desktop{display:none!important}.visible-tablet{display:inherit!important}.hidden-tablet{display:none!important}}@media(max-width:767px){.hidden-desktop{display:inherit!important}.visible-desktop{display:none!important}.visible-phone{display:inherit!important}.hidden-phone{display:none!important}}@media(min-width:1200px){.row{margin-left:-30px;*zoom:1}.row:before,.row:after{display:table;line-height:0;content:""}.row:after{clear:both}[class*="span"]{float:left;min-height:1px;margin-left:30px}.container,.navbar-static-top .container,.navbar-fixed-top .container,.navbar-fixed-bottom .container{width:1170px}.span12{width:1170px}.span11{width:1070px}.span10{width:970px}.span9{width:870px}.span8{width:770px}.span7{width:670px}.span6{width:570px}.span5{width:470px}.span4{width:370px}.span3{width:270px}.span2{width:170px}.span1{width:70px}.offset12{margin-left:1230px}.offset11{margin-left:1130px}.offset10{margin-left:1030px}.offset9{margin-left:930px}.offset8{margin-left:830px}.offset7{margin-left:730px}.offset6{margin-left:630px}.offset5{margin-left:530px}.offset4{margin-left:430px}.offset3{margin-left:330px}.offset2{margin-left:230px}.offset1{margin-left:130px}.row-fluid{width:100%;*zoom:1}.row-fluid:before,.row-fluid:after{display:table;line-height:0;content:""}.row-fluid:after{clear:both}.row-fluid [class*="span"]{display:block;float:left;width:100%;min-height:30px;margin-left:2.564102564102564%;*margin-left:2.5109110747408616%;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.row-fluid [class*="span"]:first-child{margin-left:0}.row-fluid .controls-row [class*="span"]+[class*="span"]{margin-left:2.564102564102564%}.row-fluid .span12{width:100%;*width:99.94680851063829%}.row-fluid .span11{width:91.45299145299145%;*width:91.39979996362975%}.row-fluid .span10{width:82.90598290598291%;*width:82.8527914166212%}.row-fluid .span9{width:74.35897435897436%;*width:74.30578286961266%}.row-fluid .span8{width:65.81196581196582%;*width:65.75877432260411%}.row-fluid .span7{width:57.26495726495726%;*width:57.21176577559556%}.row-fluid .span6{width:48.717948717948715%;*width:48.664757228587014%}.row-fluid .span5{width:40.17094017094017%;*width:40.11774868157847%}.row-fluid .span4{width:31.623931623931625%;*width:31.570740134569924%}.row-fluid .span3{width:23.076923076923077%;*width:23.023731587561375%}.row-fluid .span2{width:14.52991452991453%;*width:14.476723040552828%}.row-fluid .span1{width:5.982905982905983%;*width:5.929714493544281%}.row-fluid .offset12{margin-left:105.12820512820512%;*margin-left:105.02182214948171%}.row-fluid .offset12:first-child{margin-left:102.56410256410257%;*margin-left:102.45771958537915%}.row-fluid .offset11{margin-left:96.58119658119658%;*margin-left:96.47481360247316%}.row-fluid .offset11:first-child{margin-left:94.01709401709402%;*margin-left:93.91071103837061%}.row-fluid .offset10{margin-left:88.03418803418803%;*margin-left:87.92780505546462%}.row-fluid .offset10:first-child{margin-left:85.47008547008548%;*margin-left:85.36370249136206%}.row-fluid .offset9{margin-left:79.48717948717949%;*margin-left:79.38079650845607%}.row-fluid .offset9:first-child{margin-left:76.92307692307693%;*margin-left:76.81669394435352%}.row-fluid .offset8{margin-left:70.94017094017094%;*margin-left:70.83378796144753%}.row-fluid .offset8:first-child{margin-left:68.37606837606839%;*margin-left:68.26968539734497%}.row-fluid .offset7{margin-left:62.393162393162385%;*margin-left:62.28677941443899%}.row-fluid .offset7:first-child{margin-left:59.82905982905982%;*margin-left:59.72267685033642%}.row-fluid .offset6{margin-left:53.84615384615384%;*margin-left:53.739770867430444%}.row-fluid .offset6:first-child{margin-left:51.28205128205128%;*margin-left:51.175668303327875%}.row-fluid .offset5{margin-left:45.299145299145295%;*margin-left:45.1927623204219%}.row-fluid .offset5:first-child{margin-left:42.73504273504273%;*margin-left:42.62865975631933%}.row-fluid .offset4{margin-left:36.75213675213675%;*margin-left:36.645753773413354%}.row-fluid .offset4:first-child{margin-left:34.18803418803419%;*margin-left:34.081651209310785%}.row-fluid .offset3{margin-left:28.205128205128204%;*margin-left:28.0987452264048%}.row-fluid .offset3:first-child{margin-left:25.641025641025642%;*margin-left:25.53464266230224%}.row-fluid .offset2{margin-left:19.65811965811966%;*margin-left:19.551736679396257%}.row-fluid .offset2:first-child{margin-left:17.094017094017094%;*margin-left:16.98763411529369%}.row-fluid .offset1{margin-left:11.11111111111111%;*margin-left:11.004728132387708%}.row-fluid .offset1:first-child{margin-left:8.547008547008547%;*margin-left:8.440625568285142%}input,textarea,.uneditable-input{margin-left:0}.controls-row [class*="span"]+[class*="span"]{margin-left:30px}input.span12,textarea.span12,.uneditable-input.span12{width:1156px}input.span11,textarea.span11,.uneditable-input.span11{width:1056px}input.span10,textarea.span10,.uneditable-input.span10{width:956px}input.span9,textarea.span9,.uneditable-input.span9{width:856px}input.span8,textarea.span8,.uneditable-input.span8{width:756px}input.span7,textarea.span7,.uneditable-input.span7{width:656px}input.span6,textarea.span6,.uneditable-input.span6{width:556px}input.span5,textarea.span5,.uneditable-input.span5{width:456px}input.span4,textarea.span4,.uneditable-input.span4{width:356px}input.span3,textarea.span3,.uneditable-input.span3{width:256px}input.span2,textarea.span2,.uneditable-input.span2{width:156px}input.span1,textarea.span1,.uneditable-input.span1{width:56px}.thumbnails{margin-left:-30px}.thumbnails>li{margin-left:30px}.row-fluid .thumbnails{margin-left:0}}@media(min-width:768px) and (max-width:979px){.row{margin-left:-20px;*zoom:1}.row:before,.row:after{display:table;line-height:0;content:""}.row:after{clear:both}[class*="span"]{float:left;min-height:1px;margin-left:20px}.container,.navbar-static-top .container,.navbar-fixed-top .container,.navbar-fixed-bottom .container{width:724px}.span12{width:724px}.span11{width:662px}.span10{width:600px}.span9{width:538px}.span8{width:476px}.span7{width:414px}.span6{width:352px}.span5{width:290px}.span4{width:228px}.span3{width:166px}.span2{width:104px}.span1{width:42px}.offset12{margin-left:764px}.offset11{margin-left:702px}.offset10{margin-left:640px}.offset9{margin-left:578px}.offset8{margin-left:516px}.offset7{margin-left:454px}.offset6{margin-left:392px}.offset5{margin-left:330px}.offset4{margin-left:268px}.offset3{margin-left:206px}.offset2{margin-left:144px}.offset1{margin-left:82px}.row-fluid{width:100%;*zoom:1}.row-fluid:before,.row-fluid:after{display:table;line-height:0;content:""}.row-fluid:after{clear:both}.row-fluid [class*="span"]{display:block;float:left;width:100%;min-height:30px;margin-left:2.7624309392265194%;*margin-left:2.709239449864817%;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.row-fluid [class*="span"]:first-child{margin-left:0}.row-fluid .controls-row [class*="span"]+[class*="span"]{margin-left:2.7624309392265194%}.row-fluid .span12{width:100%;*width:99.94680851063829%}.row-fluid .span11{width:91.43646408839778%;*width:91.38327259903608%}.row-fluid .span10{width:82.87292817679558%;*width:82.81973668743387%}.row-fluid .span9{width:74.30939226519337%;*width:74.25620077583166%}.row-fluid .span8{width:65.74585635359117%;*width:65.69266486422946%}.row-fluid .span7{width:57.18232044198895%;*width:57.12912895262725%}.row-fluid .span6{width:48.61878453038674%;*width:48.56559304102504%}.row-fluid .span5{width:40.05524861878453%;*width:40.00205712942283%}.row-fluid .span4{width:31.491712707182323%;*width:31.43852121782062%}.row-fluid .span3{width:22.92817679558011%;*width:22.87498530621841%}.row-fluid .span2{width:14.3646408839779%;*width:14.311449394616199%}.row-fluid .span1{width:5.801104972375691%;*width:5.747913483013988%}.row-fluid .offset12{margin-left:105.52486187845304%;*margin-left:105.41847889972962%}.row-fluid .offset12:first-child{margin-left:102.76243093922652%;*margin-left:102.6560479605031%}.row-fluid .offset11{margin-left:96.96132596685082%;*margin-left:96.8549429881274%}.row-fluid .offset11:first-child{margin-left:94.1988950276243%;*margin-left:94.09251204890089%}.row-fluid .offset10{margin-left:88.39779005524862%;*margin-left:88.2914070765252%}.row-fluid .offset10:first-child{margin-left:85.6353591160221%;*margin-left:85.52897613729868%}.row-fluid .offset9{margin-left:79.8342541436464%;*margin-left:79.72787116492299%}.row-fluid .offset9:first-child{margin-left:77.07182320441989%;*margin-left:76.96544022569647%}.row-fluid .offset8{margin-left:71.2707182320442%;*margin-left:71.16433525332079%}.row-fluid .offset8:first-child{margin-left:68.50828729281768%;*margin-left:68.40190431409427%}.row-fluid .offset7{margin-left:62.70718232044199%;*margin-left:62.600799341718584%}.row-fluid .offset7:first-child{margin-left:59.94475138121547%;*margin-left:59.838368402492065%}.row-fluid .offset6{margin-left:54.14364640883978%;*margin-left:54.037263430116376%}.row-fluid .offset6:first-child{margin-left:51.38121546961326%;*margin-left:51.27483249088986%}.row-fluid .offset5{margin-left:45.58011049723757%;*margin-left:45.47372751851417%}.row-fluid .offset5:first-child{margin-left:42.81767955801105%;*margin-left:42.71129657928765%}.row-fluid .offset4{margin-left:37.01657458563536%;*margin-left:36.91019160691196%}.row-fluid .offset4:first-child{margin-left:34.25414364640884%;*margin-left:34.14776066768544%}.row-fluid .offset3{margin-left:28.45303867403315%;*margin-left:28.346655695309746%}.row-fluid .offset3:first-child{margin-left:25.69060773480663%;*margin-left:25.584224756083227%}.row-fluid .offset2{margin-left:19.88950276243094%;*margin-left:19.783119783707537%}.row-fluid .offset2:first-child{margin-left:17.12707182320442%;*margin-left:17.02068884448102%}.row-fluid .offset1{margin-left:11.32596685082873%;*margin-left:11.219583872105325%}.row-fluid .offset1:first-child{margin-left:8.56353591160221%;*margin-left:8.457152932878806%}input,textarea,.uneditable-input{margin-left:0}.controls-row [class*="span"]+[class*="span"]{margin-left:20px}input.span12,textarea.span12,.uneditable-input.span12{width:710px}input.span11,textarea.span11,.uneditable-input.span11{width:648px}input.span10,textarea.span10,.uneditable-input.span10{width:586px}input.span9,textarea.span9,.uneditable-input.span9{width:524px}input.span8,textarea.span8,.uneditable-input.span8{width:462px}input.span7,textarea.span7,.uneditable-input.span7{width:400px}input.span6,textarea.span6,.uneditable-input.span6{width:338px}input.span5,textarea.span5,.uneditable-input.span5{width:276px}input.span4,textarea.span4,.uneditable-input.span4{width:214px}input.span3,textarea.span3,.uneditable-input.span3{width:152px}input.span2,textarea.span2,.uneditable-input.span2{width:90px}input.span1,textarea.span1,.uneditable-input.span1{width:28px}}@media(max-width:767px){body{padding-right:20px;padding-left:20px}.navbar-fixed-top,.navbar-fixed-bottom,.navbar-static-top{margin-right:-20px;margin-left:-20px}.container-fluid{padding:0}.dl-horizontal dt{float:none;width:auto;clear:none;text-align:left}.dl-horizontal dd{margin-left:0}.container{width:auto}.row-fluid{width:100%}.row,.thumbnails{margin-left:0}.thumbnails>li{float:none;margin-left:0}[class*="span"],.uneditable-input[class*="span"],.row-fluid [class*="span"]{display:block;float:none;width:100%;margin-left:0;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.span12,.row-fluid .span12{width:100%;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.row-fluid [class*="offset"]:first-child{margin-left:0}.input-large,.input-xlarge,.input-xxlarge,input[class*="span"],select[class*="span"],textarea[class*="span"],.uneditable-input{display:block;width:100%;min-height:30px;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.input-prepend input,.input-append input,.input-prepend input[class*="span"],.input-append input[class*="span"]{display:inline-block;width:auto}.controls-row [class*="span"]+[class*="span"]{margin-left:0}.modal{position:fixed;top:20px;right:20px;left:20px;width:auto;margin:0}.modal.fade{top:-100px}.modal.fade.in{top:20px}}@media(max-width:480px){.nav-collapse{-webkit-transform:translate3d(0,0,0)}.page-header h1 small{display:block;line-height:20px}input[type="checkbox"],input[type="radio"]{border:1px solid #ccc}.form-horizontal .control-label{float:none;width:auto;padding-top:0;text-align:left}.form-horizontal .controls{margin-left:0}.form-horizontal .control-list{padding-top:0}.form-horizontal .form-actions{padding-right:10px;padding-left:10px}.media .pull-left,.media .pull-right{display:block;float:none;margin-bottom:10px}.media-object{margin-right:0;margin-left:0}.modal{top:10px;right:10px;left:10px}.modal-header .close{padding:10px;margin:-10px}.carousel-caption{position:static}}@media(max-width:979px){body{padding-top:0}.navbar-fixed-top,.navbar-fixed-bottom{position:static}.navbar-fixed-top{margin-bottom:20px}.navbar-fixed-bottom{margin-top:20px}.navbar-fixed-top .navbar-inner,.navbar-fixed-bottom .navbar-inner{padding:5px}.navbar .container{width:auto;padding:0}.navbar .brand{padding-right:10px;padding-left:10px;margin:0 0 0 -5px}.nav-collapse{clear:both}.nav-collapse .nav{float:none;margin:0 0 10px}.nav-collapse .nav>li{float:none}.nav-collapse .nav>li>a{margin-bottom:2px}.nav-collapse .nav>.divider-vertical{display:none}.nav-collapse .nav .nav-header{color:#777;text-shadow:none}.nav-collapse .nav>li>a,.nav-collapse .dropdown-menu a{padding:9px 15px;font-weight:bold;color:#777;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px}.nav-collapse .btn{padding:4px 10px 4px;font-weight:normal;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px}.nav-collapse .dropdown-menu li+li a{margin-bottom:2px}.nav-collapse .nav>li>a:hover,.nav-collapse .dropdown-menu a:hover{background-color:#f2f2f2}.navbar-inverse .nav-collapse .nav>li>a,.navbar-inverse .nav-collapse .dropdown-menu a{color:#999}.navbar-inverse .nav-collapse .nav>li>a:hover,.navbar-inverse .nav-collapse .dropdown-menu a:hover{background-color:#111}.nav-collapse.in .btn-group{padding:0;margin-top:5px}.nav-collapse .dropdown-menu{position:static;top:auto;left:auto;display:none;float:none;max-width:none;padding:0;margin:0 15px;background-color:transparent;border:0;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0;-webkit-box-shadow:none;-moz-box-shadow:none;box-shadow:none}.nav-collapse .open>.dropdown-menu{display:block}.nav-collapse .dropdown-menu:before,.nav-collapse .dropdown-menu:after{display:none}.nav-collapse .dropdown-menu .divider{display:none}.nav-collapse .nav>li>.dropdown-menu:before,.nav-collapse .nav>li>.dropdown-menu:after{display:none}.nav-collapse .navbar-form,.nav-collapse .navbar-search{float:none;padding:10px 15px;margin:10px 0;border-top:1px solid #f2f2f2;border-bottom:1px solid #f2f2f2;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.1);-moz-box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.1);box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.1)}.navbar-inverse .nav-collapse .navbar-form,.navbar-inverse .nav-collapse .navbar-search{border-top-color:#111;border-bottom-color:#111}.navbar .nav-collapse .nav.pull-right{float:none;margin-left:0}.nav-collapse,.nav-collapse.collapse{height:0;overflow:hidden}.navbar .btn-navbar{display:block}.navbar-static .navbar-inner{padding-right:10px;padding-left:10px}}@media(min-width:980px){.nav-collapse.collapse{height:auto!important;overflow:visible!important}} diff --git a/plugin/mindmap/edit-mindmap/vendor/css/bootstrap.css b/plugin/mindmap/edit-mindmap/vendor/css/bootstrap.css new file mode 100644 index 000000000..8ab3cefcf --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/css/bootstrap.css @@ -0,0 +1,6039 @@ +/*! + * Bootstrap v2.2.2 + * + * Copyright 2012 Twitter, Inc + * Licensed under the Apache License v2.0 + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Designed and built with all the love in the world @twitter by @mdo and @fat. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +nav, +section { + display: block; +} + +audio, +canvas, +video { + display: inline-block; + *display: inline; + *zoom: 1; +} + +audio:not([controls]) { + display: none; +} + +html { + font-size: 100%; + -webkit-text-size-adjust: 100%; + -ms-text-size-adjust: 100%; +} + +a:focus { + outline: thin dotted #333; + outline: 5px auto -webkit-focus-ring-color; + outline-offset: -2px; +} + +a:hover, +a:active { + outline: 0; +} + +sub, +sup { + position: relative; + font-size: 75%; + line-height: 0; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +img { + width: auto\9; + height: auto; + max-width: 100%; + vertical-align: middle; + border: 0; + -ms-interpolation-mode: bicubic; +} + +#map_canvas img, +.google-maps img { + max-width: none; +} + +button, +input, +select, +textarea { + margin: 0; + font-size: 100%; + vertical-align: middle; +} + +button, +input { + *overflow: visible; + line-height: normal; +} + +button::-moz-focus-inner, +input::-moz-focus-inner { + padding: 0; + border: 0; +} + +button, +html input[type="button"], +input[type="reset"], +input[type="submit"] { + cursor: pointer; + -webkit-appearance: button; +} + +label, +select, +button, +input[type="button"], +input[type="reset"], +input[type="submit"], +input[type="radio"], +input[type="checkbox"] { + cursor: pointer; +} + +input[type="search"] { + -webkit-box-sizing: content-box; + -moz-box-sizing: content-box; + box-sizing: content-box; + -webkit-appearance: textfield; +} + +input[type="search"]::-webkit-search-decoration, +input[type="search"]::-webkit-search-cancel-button { + -webkit-appearance: none; +} + +textarea { + overflow: auto; + vertical-align: top; +} + +@media print { + * { + color: #000 !important; + text-shadow: none !important; + background: transparent !important; + box-shadow: none !important; + } + a, + a:visited { + text-decoration: underline; + } + a[href]:after { + content: " (" attr(href) ")"; + } + abbr[title]:after { + content: " (" attr(title) ")"; + } + .ir a:after, + a[href^="javascript:"]:after, + a[href^="#"]:after { + content: ""; + } + pre, + blockquote { + border: 1px solid #999; + page-break-inside: avoid; + } + thead { + display: table-header-group; + } + tr, + img { + page-break-inside: avoid; + } + img { + max-width: 100% !important; + } + @page { + margin: 0.5cm; + } + p, + h2, + h3 { + orphans: 3; + widows: 3; + } + h2, + h3 { + page-break-after: avoid; + } +} + +.clearfix { + *zoom: 1; +} + +.clearfix:before, +.clearfix:after { + display: table; + line-height: 0; + content: ""; +} + +.clearfix:after { + clear: both; +} + +.hide-text { + font: 0/0 a; + color: transparent; + text-shadow: none; + background-color: transparent; + border: 0; +} + +.input-block-level { + display: block; + width: 100%; + min-height: 30px; + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; +} + +body { + margin: 0; + font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 14px; + line-height: 20px; + color: #333333; + background-color: #ffffff; +} + +a { + color: #0088cc; + text-decoration: none; +} + +a:hover { + color: #005580; + text-decoration: underline; +} + +.img-rounded { + -webkit-border-radius: 6px; + -moz-border-radius: 6px; + border-radius: 6px; +} + +.img-polaroid { + padding: 4px; + background-color: #fff; + border: 1px solid #ccc; + border: 1px solid rgba(0, 0, 0, 0.2); + -webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1); + -moz-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1); + box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1); +} + +.img-circle { + -webkit-border-radius: 500px; + -moz-border-radius: 500px; + border-radius: 500px; +} + +.row { + margin-left: -20px; + *zoom: 1; +} + +.row:before, +.row:after { + display: table; + line-height: 0; + content: ""; +} + +.row:after { + clear: both; +} + +[class*="span"] { + float: left; + min-height: 1px; + margin-left: 20px; +} + +.container, +.navbar-static-top .container, +.navbar-fixed-top .container, +.navbar-fixed-bottom .container { + width: 940px; +} + +.span12 { + width: 940px; +} + +.span11 { + width: 860px; +} + +.span10 { + width: 780px; +} + +.span9 { + width: 700px; +} + +.span8 { + width: 620px; +} + +.span7 { + width: 540px; +} + +.span6 { + width: 460px; +} + +.span5 { + width: 380px; +} + +.span4 { + width: 300px; +} + +.span3 { + width: 220px; +} + +.span2 { + width: 140px; +} + +.span1 { + width: 60px; +} + +.offset12 { + margin-left: 980px; +} + +.offset11 { + margin-left: 900px; +} + +.offset10 { + margin-left: 820px; +} + +.offset9 { + margin-left: 740px; +} + +.offset8 { + margin-left: 660px; +} + +.offset7 { + margin-left: 580px; +} + +.offset6 { + margin-left: 500px; +} + +.offset5 { + margin-left: 420px; +} + +.offset4 { + margin-left: 340px; +} + +.offset3 { + margin-left: 260px; +} + +.offset2 { + margin-left: 180px; +} + +.offset1 { + margin-left: 100px; +} + +.row-fluid { + width: 100%; + *zoom: 1; +} + +.row-fluid:before, +.row-fluid:after { + display: table; + line-height: 0; + content: ""; +} + +.row-fluid:after { + clear: both; +} + +.row-fluid [class*="span"] { + display: block; + float: left; + width: 100%; + min-height: 30px; + margin-left: 2.127659574468085%; + *margin-left: 2.074468085106383%; + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; +} + +.row-fluid [class*="span"]:first-child { + margin-left: 0; +} + +.row-fluid .controls-row [class*="span"] + [class*="span"] { + margin-left: 2.127659574468085%; +} + +.row-fluid .span12 { + width: 100%; + *width: 99.94680851063829%; +} + +.row-fluid .span11 { + width: 91.48936170212765%; + *width: 91.43617021276594%; +} + +.row-fluid .span10 { + width: 82.97872340425532%; + *width: 82.92553191489361%; +} + +.row-fluid .span9 { + width: 74.46808510638297%; + *width: 74.41489361702126%; +} + +.row-fluid .span8 { + width: 65.95744680851064%; + *width: 65.90425531914893%; +} + +.row-fluid .span7 { + width: 57.44680851063829%; + *width: 57.39361702127659%; +} + +.row-fluid .span6 { + width: 48.93617021276595%; + *width: 48.88297872340425%; +} + +.row-fluid .span5 { + width: 40.42553191489362%; + *width: 40.37234042553192%; +} + +.row-fluid .span4 { + width: 31.914893617021278%; + *width: 31.861702127659576%; +} + +.row-fluid .span3 { + width: 23.404255319148934%; + *width: 23.351063829787233%; +} + +.row-fluid .span2 { + width: 14.893617021276595%; + *width: 14.840425531914894%; +} + +.row-fluid .span1 { + width: 6.382978723404255%; + *width: 6.329787234042553%; +} + +.row-fluid .offset12 { + margin-left: 104.25531914893617%; + *margin-left: 104.14893617021275%; +} + +.row-fluid .offset12:first-child { + margin-left: 102.12765957446808%; + *margin-left: 102.02127659574467%; +} + +.row-fluid .offset11 { + margin-left: 95.74468085106382%; + *margin-left: 95.6382978723404%; +} + +.row-fluid .offset11:first-child { + margin-left: 93.61702127659574%; + *margin-left: 93.51063829787232%; +} + +.row-fluid .offset10 { + margin-left: 87.23404255319149%; + *margin-left: 87.12765957446807%; +} + +.row-fluid .offset10:first-child { + margin-left: 85.1063829787234%; + *margin-left: 84.99999999999999%; +} + +.row-fluid .offset9 { + margin-left: 78.72340425531914%; + *margin-left: 78.61702127659572%; +} + +.row-fluid .offset9:first-child { + margin-left: 76.59574468085106%; + *margin-left: 76.48936170212764%; +} + +.row-fluid .offset8 { + margin-left: 70.2127659574468%; + *margin-left: 70.10638297872339%; +} + +.row-fluid .offset8:first-child { + margin-left: 68.08510638297872%; + *margin-left: 67.9787234042553%; +} + +.row-fluid .offset7 { + margin-left: 61.70212765957446%; + *margin-left: 61.59574468085106%; +} + +.row-fluid .offset7:first-child { + margin-left: 59.574468085106375%; + *margin-left: 59.46808510638297%; +} + +.row-fluid .offset6 { + margin-left: 53.191489361702125%; + *margin-left: 53.085106382978715%; +} + +.row-fluid .offset6:first-child { + margin-left: 51.063829787234035%; + *margin-left: 50.95744680851063%; +} + +.row-fluid .offset5 { + margin-left: 44.68085106382979%; + *margin-left: 44.57446808510638%; +} + +.row-fluid .offset5:first-child { + margin-left: 42.5531914893617%; + *margin-left: 42.4468085106383%; +} + +.row-fluid .offset4 { + margin-left: 36.170212765957444%; + *margin-left: 36.06382978723405%; +} + +.row-fluid .offset4:first-child { + margin-left: 34.04255319148936%; + *margin-left: 33.93617021276596%; +} + +.row-fluid .offset3 { + margin-left: 27.659574468085104%; + *margin-left: 27.5531914893617%; +} + +.row-fluid .offset3:first-child { + margin-left: 25.53191489361702%; + *margin-left: 25.425531914893618%; +} + +.row-fluid .offset2 { + margin-left: 19.148936170212764%; + *margin-left: 19.04255319148936%; +} + +.row-fluid .offset2:first-child { + margin-left: 17.02127659574468%; + *margin-left: 16.914893617021278%; +} + +.row-fluid .offset1 { + margin-left: 10.638297872340425%; + *margin-left: 10.53191489361702%; +} + +.row-fluid .offset1:first-child { + margin-left: 8.51063829787234%; + *margin-left: 8.404255319148938%; +} + +[class*="span"].hide, +.row-fluid [class*="span"].hide { + display: none; +} + +[class*="span"].pull-right, +.row-fluid [class*="span"].pull-right { + float: right; +} + +.container { + margin-right: auto; + margin-left: auto; + *zoom: 1; +} + +.container:before, +.container:after { + display: table; + line-height: 0; + content: ""; +} + +.container:after { + clear: both; +} + +.container-fluid { + padding-right: 20px; + padding-left: 20px; + *zoom: 1; +} + +.container-fluid:before, +.container-fluid:after { + display: table; + line-height: 0; + content: ""; +} + +.container-fluid:after { + clear: both; +} + +p { + margin: 0 0 10px; +} + +.lead { + margin-bottom: 20px; + font-size: 21px; + font-weight: 200; + line-height: 30px; +} + +small { + font-size: 85%; +} + +strong { + font-weight: bold; +} + +em { + font-style: italic; +} + +cite { + font-style: normal; +} + +.muted { + color: #999999; +} + +a.muted:hover { + color: #808080; +} + +.text-warning { + color: #c09853; +} + +a.text-warning:hover { + color: #a47e3c; +} + +.text-error { + color: #b94a48; +} + +a.text-error:hover { + color: #953b39; +} + +.text-info { + color: #3a87ad; +} + +a.text-info:hover { + color: #2d6987; +} + +.text-success { + color: #468847; +} + +a.text-success:hover { + color: #356635; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + margin: 10px 0; + font-family: inherit; + font-weight: bold; + line-height: 20px; + color: inherit; + text-rendering: optimizelegibility; +} + +h1 small, +h2 small, +h3 small, +h4 small, +h5 small, +h6 small { + font-weight: normal; + line-height: 1; + color: #999999; +} + +h1, +h2, +h3 { + line-height: 40px; +} + +h1 { + font-size: 38.5px; +} + +h2 { + font-size: 31.5px; +} + +h3 { + font-size: 24.5px; +} + +h4 { + font-size: 17.5px; +} + +h5 { + font-size: 14px; +} + +h6 { + font-size: 11.9px; +} + +h1 small { + font-size: 24.5px; +} + +h2 small { + font-size: 17.5px; +} + +h3 small { + font-size: 14px; +} + +h4 small { + font-size: 14px; +} + +.page-header { + padding-bottom: 9px; + margin: 20px 0 30px; + border-bottom: 1px solid #eeeeee; +} + +ul, +ol { + padding: 0; + margin: 0 0 10px 25px; +} + +ul ul, +ul ol, +ol ol, +ol ul { + margin-bottom: 0; +} + +li { + line-height: 20px; +} + +ul.unstyled, +ol.unstyled { + margin-left: 0; + list-style: none; +} + +ul.inline, +ol.inline { + margin-left: 0; + list-style: none; +} + +ul.inline > li, +ol.inline > li { + display: inline-block; + padding-right: 5px; + padding-left: 5px; +} + +dl { + margin-bottom: 20px; +} + +dt, +dd { + line-height: 20px; +} + +dt { + font-weight: bold; +} + +dd { + margin-left: 10px; +} + +.dl-horizontal { + *zoom: 1; +} + +.dl-horizontal:before, +.dl-horizontal:after { + display: table; + line-height: 0; + content: ""; +} + +.dl-horizontal:after { + clear: both; +} + +.dl-horizontal dt { + float: left; + width: 160px; + overflow: hidden; + clear: left; + text-align: right; + text-overflow: ellipsis; + white-space: nowrap; +} + +.dl-horizontal dd { + margin-left: 180px; +} + +hr { + margin: 20px 0; + border: 0; + border-top: 1px solid #eeeeee; + border-bottom: 1px solid #ffffff; +} + +abbr[title], +abbr[data-original-title] { + cursor: help; + border-bottom: 1px dotted #999999; +} + +abbr.initialism { + font-size: 90%; + text-transform: uppercase; +} + +blockquote { + padding: 0 0 0 15px; + margin: 0 0 20px; + border-left: 5px solid #eeeeee; +} + +blockquote p { + margin-bottom: 0; + font-size: 16px; + font-weight: 300; + line-height: 25px; +} + +blockquote small { + display: block; + line-height: 20px; + color: #999999; +} + +blockquote small:before { + content: '\2014 \00A0'; +} + +blockquote.pull-right { + float: right; + padding-right: 15px; + padding-left: 0; + border-right: 5px solid #eeeeee; + border-left: 0; +} + +blockquote.pull-right p, +blockquote.pull-right small { + text-align: right; +} + +blockquote.pull-right small:before { + content: ''; +} + +blockquote.pull-right small:after { + content: '\00A0 \2014'; +} + +q:before, +q:after, +blockquote:before, +blockquote:after { + content: ""; +} + +address { + display: block; + margin-bottom: 20px; + font-style: normal; + line-height: 20px; +} + +code, +pre { + padding: 0 3px 2px; + font-family: Monaco, Menlo, Consolas, "Courier New", monospace; + font-size: 12px; + color: #333333; + -webkit-border-radius: 3px; + -moz-border-radius: 3px; + border-radius: 3px; +} + +code { + padding: 2px 4px; + color: #d14; + white-space: nowrap; + background-color: #f7f7f9; + border: 1px solid #e1e1e8; +} + +pre { + display: block; + padding: 9.5px; + margin: 0 0 10px; + font-size: 13px; + line-height: 20px; + word-break: break-all; + word-wrap: break-word; + white-space: pre; + white-space: pre-wrap; + background-color: #f5f5f5; + border: 1px solid #ccc; + border: 1px solid rgba(0, 0, 0, 0.15); + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; +} + +pre.prettyprint { + margin-bottom: 20px; +} + +pre code { + padding: 0; + color: inherit; + white-space: pre; + white-space: pre-wrap; + background-color: transparent; + border: 0; +} + +.pre-scrollable { + max-height: 340px; + overflow-y: scroll; +} + +form { + margin: 0 0 20px; +} + +fieldset { + padding: 0; + margin: 0; + border: 0; +} + +legend { + display: block; + width: 100%; + padding: 0; + margin-bottom: 20px; + font-size: 21px; + line-height: 40px; + color: #333333; + border: 0; + border-bottom: 1px solid #e5e5e5; +} + +legend small { + font-size: 15px; + color: #999999; +} + +label, +input, +button, +select, +textarea { + font-size: 14px; + font-weight: normal; + line-height: 20px; +} + +input, +button, +select, +textarea { + font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; +} + +label { + display: block; + margin-bottom: 5px; +} + +select, +textarea, +input[type="text"], +input[type="password"], +input[type="datetime"], +input[type="datetime-local"], +input[type="date"], +input[type="month"], +input[type="time"], +input[type="week"], +input[type="number"], +input[type="email"], +input[type="url"], +input[type="search"], +input[type="tel"], +input[type="color"], +.uneditable-input { + display: inline-block; + height: 20px; + padding: 4px 6px; + margin-bottom: 10px; + font-size: 14px; + line-height: 20px; + color: #555555; + vertical-align: middle; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; +} + +input, +textarea, +.uneditable-input { + width: 206px; +} + +textarea { + height: auto; +} + +textarea, +input[type="text"], +input[type="password"], +input[type="datetime"], +input[type="datetime-local"], +input[type="date"], +input[type="month"], +input[type="time"], +input[type="week"], +input[type="number"], +input[type="email"], +input[type="url"], +input[type="search"], +input[type="tel"], +input[type="color"], +.uneditable-input { + background-color: #ffffff; + border: 1px solid #cccccc; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + -webkit-transition: border linear 0.2s, box-shadow linear 0.2s; + -moz-transition: border linear 0.2s, box-shadow linear 0.2s; + -o-transition: border linear 0.2s, box-shadow linear 0.2s; + transition: border linear 0.2s, box-shadow linear 0.2s; +} + +textarea:focus, +input[type="text"]:focus, +input[type="password"]:focus, +input[type="datetime"]:focus, +input[type="datetime-local"]:focus, +input[type="date"]:focus, +input[type="month"]:focus, +input[type="time"]:focus, +input[type="week"]:focus, +input[type="number"]:focus, +input[type="email"]:focus, +input[type="url"]:focus, +input[type="search"]:focus, +input[type="tel"]:focus, +input[type="color"]:focus, +.uneditable-input:focus { + border-color: rgba(82, 168, 236, 0.8); + outline: 0; + outline: thin dotted \9; + /* IE6-9 */ + + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(82, 168, 236, 0.6); + -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(82, 168, 236, 0.6); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px rgba(82, 168, 236, 0.6); +} + +input[type="radio"], +input[type="checkbox"] { + margin: 4px 0 0; + margin-top: 1px \9; + *margin-top: 0; + line-height: normal; +} + +input[type="file"], +input[type="image"], +input[type="submit"], +input[type="reset"], +input[type="button"], +input[type="radio"], +input[type="checkbox"] { + width: auto; +} + +select, +input[type="file"] { + height: 30px; + /* In IE7, the height of the select element cannot be changed by height, only font-size */ + + *margin-top: 4px; + /* For IE7, add top margin to align select with labels */ + + line-height: 30px; +} + +select { + width: 220px; + background-color: #ffffff; + border: 1px solid #cccccc; +} + +select[multiple], +select[size] { + height: auto; +} + +select:focus, +input[type="file"]:focus, +input[type="radio"]:focus, +input[type="checkbox"]:focus { + outline: thin dotted #333; + outline: 5px auto -webkit-focus-ring-color; + outline-offset: -2px; +} + +.uneditable-input, +.uneditable-textarea { + color: #999999; + cursor: not-allowed; + background-color: #fcfcfc; + border-color: #cccccc; + -webkit-box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.025); + -moz-box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.025); + box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.025); +} + +.uneditable-input { + overflow: hidden; + white-space: nowrap; +} + +.uneditable-textarea { + width: auto; + height: auto; +} + +input:-moz-placeholder, +textarea:-moz-placeholder { + color: #999999; +} + +input:-ms-input-placeholder, +textarea:-ms-input-placeholder { + color: #999999; +} + +input::-webkit-input-placeholder, +textarea::-webkit-input-placeholder { + color: #999999; +} + +.radio, +.checkbox { + min-height: 20px; + padding-left: 20px; +} + +.radio input[type="radio"], +.checkbox input[type="checkbox"] { + float: left; + margin-left: -20px; +} + +.controls > .radio:first-child, +.controls > .checkbox:first-child { + padding-top: 5px; +} + +.radio.inline, +.checkbox.inline { + display: inline-block; + padding-top: 5px; + margin-bottom: 0; + vertical-align: middle; +} + +.radio.inline + .radio.inline, +.checkbox.inline + .checkbox.inline { + margin-left: 10px; +} + +.input-mini { + width: 60px; +} + +.input-small { + width: 90px; +} + +.input-medium { + width: 150px; +} + +.input-large { + width: 210px; +} + +.input-xlarge { + width: 270px; +} + +.input-xxlarge { + width: 530px; +} + +input[class*="span"], +select[class*="span"], +textarea[class*="span"], +.uneditable-input[class*="span"], +.row-fluid input[class*="span"], +.row-fluid select[class*="span"], +.row-fluid textarea[class*="span"], +.row-fluid .uneditable-input[class*="span"] { + float: none; + margin-left: 0; +} + +.input-append input[class*="span"], +.input-append .uneditable-input[class*="span"], +.input-prepend input[class*="span"], +.input-prepend .uneditable-input[class*="span"], +.row-fluid input[class*="span"], +.row-fluid select[class*="span"], +.row-fluid textarea[class*="span"], +.row-fluid .uneditable-input[class*="span"], +.row-fluid .input-prepend [class*="span"], +.row-fluid .input-append [class*="span"] { + display: inline-block; +} + +input, +textarea, +.uneditable-input { + margin-left: 0; +} + +.controls-row [class*="span"] + [class*="span"] { + margin-left: 20px; +} + +input.span12, +textarea.span12, +.uneditable-input.span12 { + width: 926px; +} + +input.span11, +textarea.span11, +.uneditable-input.span11 { + width: 846px; +} + +input.span10, +textarea.span10, +.uneditable-input.span10 { + width: 766px; +} + +input.span9, +textarea.span9, +.uneditable-input.span9 { + width: 686px; +} + +input.span8, +textarea.span8, +.uneditable-input.span8 { + width: 606px; +} + +input.span7, +textarea.span7, +.uneditable-input.span7 { + width: 526px; +} + +input.span6, +textarea.span6, +.uneditable-input.span6 { + width: 446px; +} + +input.span5, +textarea.span5, +.uneditable-input.span5 { + width: 366px; +} + +input.span4, +textarea.span4, +.uneditable-input.span4 { + width: 286px; +} + +input.span3, +textarea.span3, +.uneditable-input.span3 { + width: 206px; +} + +input.span2, +textarea.span2, +.uneditable-input.span2 { + width: 126px; +} + +input.span1, +textarea.span1, +.uneditable-input.span1 { + width: 46px; +} + +.controls-row { + *zoom: 1; +} + +.controls-row:before, +.controls-row:after { + display: table; + line-height: 0; + content: ""; +} + +.controls-row:after { + clear: both; +} + +.controls-row [class*="span"], +.row-fluid .controls-row [class*="span"] { + float: left; +} + +.controls-row .checkbox[class*="span"], +.controls-row .radio[class*="span"] { + padding-top: 5px; +} + +input[disabled], +select[disabled], +textarea[disabled], +input[readonly], +select[readonly], +textarea[readonly] { + cursor: not-allowed; + background-color: #eeeeee; +} + +input[type="radio"][disabled], +input[type="checkbox"][disabled], +input[type="radio"][readonly], +input[type="checkbox"][readonly] { + background-color: transparent; +} + +.control-group.warning .control-label, +.control-group.warning .help-block, +.control-group.warning .help-inline { + color: #c09853; +} + +.control-group.warning .checkbox, +.control-group.warning .radio, +.control-group.warning input, +.control-group.warning select, +.control-group.warning textarea { + color: #c09853; +} + +.control-group.warning input, +.control-group.warning select, +.control-group.warning textarea { + border-color: #c09853; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); +} + +.control-group.warning input:focus, +.control-group.warning select:focus, +.control-group.warning textarea:focus { + border-color: #a47e3c; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #dbc59e; + -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #dbc59e; + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #dbc59e; +} + +.control-group.warning .input-prepend .add-on, +.control-group.warning .input-append .add-on { + color: #c09853; + background-color: #fcf8e3; + border-color: #c09853; +} + +.control-group.error .control-label, +.control-group.error .help-block, +.control-group.error .help-inline { + color: #b94a48; +} + +.control-group.error .checkbox, +.control-group.error .radio, +.control-group.error input, +.control-group.error select, +.control-group.error textarea { + color: #b94a48; +} + +.control-group.error input, +.control-group.error select, +.control-group.error textarea { + border-color: #b94a48; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); +} + +.control-group.error input:focus, +.control-group.error select:focus, +.control-group.error textarea:focus { + border-color: #953b39; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #d59392; + -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #d59392; + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #d59392; +} + +.control-group.error .input-prepend .add-on, +.control-group.error .input-append .add-on { + color: #b94a48; + background-color: #f2dede; + border-color: #b94a48; +} + +.control-group.success .control-label, +.control-group.success .help-block, +.control-group.success .help-inline { + color: #468847; +} + +.control-group.success .checkbox, +.control-group.success .radio, +.control-group.success input, +.control-group.success select, +.control-group.success textarea { + color: #468847; +} + +.control-group.success input, +.control-group.success select, +.control-group.success textarea { + border-color: #468847; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); +} + +.control-group.success input:focus, +.control-group.success select:focus, +.control-group.success textarea:focus { + border-color: #356635; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #7aba7b; + -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #7aba7b; + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #7aba7b; +} + +.control-group.success .input-prepend .add-on, +.control-group.success .input-append .add-on { + color: #468847; + background-color: #dff0d8; + border-color: #468847; +} + +.control-group.info .control-label, +.control-group.info .help-block, +.control-group.info .help-inline { + color: #3a87ad; +} + +.control-group.info .checkbox, +.control-group.info .radio, +.control-group.info input, +.control-group.info select, +.control-group.info textarea { + color: #3a87ad; +} + +.control-group.info input, +.control-group.info select, +.control-group.info textarea { + border-color: #3a87ad; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075); +} + +.control-group.info input:focus, +.control-group.info select:focus, +.control-group.info textarea:focus { + border-color: #2d6987; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #7ab5d3; + -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #7ab5d3; + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #7ab5d3; +} + +.control-group.info .input-prepend .add-on, +.control-group.info .input-append .add-on { + color: #3a87ad; + background-color: #d9edf7; + border-color: #3a87ad; +} + +input:focus:invalid, +textarea:focus:invalid, +select:focus:invalid { + color: #b94a48; + border-color: #ee5f5b; +} + +input:focus:invalid:focus, +textarea:focus:invalid:focus, +select:focus:invalid:focus { + border-color: #e9322d; + -webkit-box-shadow: 0 0 6px #f8b9b7; + -moz-box-shadow: 0 0 6px #f8b9b7; + box-shadow: 0 0 6px #f8b9b7; +} + +.form-actions { + padding: 19px 20px 20px; + margin-top: 20px; + margin-bottom: 20px; + background-color: #f5f5f5; + border-top: 1px solid #e5e5e5; + *zoom: 1; +} + +.form-actions:before, +.form-actions:after { + display: table; + line-height: 0; + content: ""; +} + +.form-actions:after { + clear: both; +} + +.help-block, +.help-inline { + color: #595959; +} + +.help-block { + display: block; + margin-bottom: 10px; +} + +.help-inline { + display: inline-block; + *display: inline; + padding-left: 5px; + vertical-align: middle; + *zoom: 1; +} + +.input-append, +.input-prepend { + margin-bottom: 5px; + font-size: 0; + white-space: nowrap; +} + +.input-append input, +.input-prepend input, +.input-append select, +.input-prepend select, +.input-append .uneditable-input, +.input-prepend .uneditable-input, +.input-append .dropdown-menu, +.input-prepend .dropdown-menu { + font-size: 14px; +} + +.input-append input, +.input-prepend input, +.input-append select, +.input-prepend select, +.input-append .uneditable-input, +.input-prepend .uneditable-input { + position: relative; + margin-bottom: 0; + *margin-left: 0; + vertical-align: top; + -webkit-border-radius: 0 4px 4px 0; + -moz-border-radius: 0 4px 4px 0; + border-radius: 0 4px 4px 0; +} + +.input-append input:focus, +.input-prepend input:focus, +.input-append select:focus, +.input-prepend select:focus, +.input-append .uneditable-input:focus, +.input-prepend .uneditable-input:focus { + z-index: 2; +} + +.input-append .add-on, +.input-prepend .add-on { + display: inline-block; + width: auto; + height: 20px; + min-width: 16px; + padding: 4px 5px; + font-size: 14px; + font-weight: normal; + line-height: 20px; + text-align: center; + text-shadow: 0 1px 0 #ffffff; + background-color: #eeeeee; + border: 1px solid #ccc; +} + +.input-append .add-on, +.input-prepend .add-on, +.input-append .btn, +.input-prepend .btn, +.input-append .btn-group > .dropdown-toggle, +.input-prepend .btn-group > .dropdown-toggle { + vertical-align: top; + -webkit-border-radius: 0; + -moz-border-radius: 0; + border-radius: 0; +} + +.input-append .active, +.input-prepend .active { + background-color: #a9dba9; + border-color: #46a546; +} + +.input-prepend .add-on, +.input-prepend .btn { + margin-right: -1px; +} + +.input-prepend .add-on:first-child, +.input-prepend .btn:first-child { + -webkit-border-radius: 4px 0 0 4px; + -moz-border-radius: 4px 0 0 4px; + border-radius: 4px 0 0 4px; +} + +.input-append input, +.input-append select, +.input-append .uneditable-input { + -webkit-border-radius: 4px 0 0 4px; + -moz-border-radius: 4px 0 0 4px; + border-radius: 4px 0 0 4px; +} + +.input-append input + .btn-group .btn:last-child, +.input-append select + .btn-group .btn:last-child, +.input-append .uneditable-input + .btn-group .btn:last-child { + -webkit-border-radius: 0 4px 4px 0; + -moz-border-radius: 0 4px 4px 0; + border-radius: 0 4px 4px 0; +} + +.input-append .add-on, +.input-append .btn, +.input-append .btn-group { + margin-left: -1px; +} + +.input-append .add-on:last-child, +.input-append .btn:last-child, +.input-append .btn-group:last-child > .dropdown-toggle { + -webkit-border-radius: 0 4px 4px 0; + -moz-border-radius: 0 4px 4px 0; + border-radius: 0 4px 4px 0; +} + +.input-prepend.input-append input, +.input-prepend.input-append select, +.input-prepend.input-append .uneditable-input { + -webkit-border-radius: 0; + -moz-border-radius: 0; + border-radius: 0; +} + +.input-prepend.input-append input + .btn-group .btn, +.input-prepend.input-append select + .btn-group .btn, +.input-prepend.input-append .uneditable-input + .btn-group .btn { + -webkit-border-radius: 0 4px 4px 0; + -moz-border-radius: 0 4px 4px 0; + border-radius: 0 4px 4px 0; +} + +.input-prepend.input-append .add-on:first-child, +.input-prepend.input-append .btn:first-child { + margin-right: -1px; + -webkit-border-radius: 4px 0 0 4px; + -moz-border-radius: 4px 0 0 4px; + border-radius: 4px 0 0 4px; +} + +.input-prepend.input-append .add-on:last-child, +.input-prepend.input-append .btn:last-child { + margin-left: -1px; + -webkit-border-radius: 0 4px 4px 0; + -moz-border-radius: 0 4px 4px 0; + border-radius: 0 4px 4px 0; +} + +.input-prepend.input-append .btn-group:first-child { + margin-left: 0; +} + +input.search-query { + padding-right: 14px; + padding-right: 4px \9; + padding-left: 14px; + padding-left: 4px \9; + /* IE7-8 doesn't have border-radius, so don't indent the padding */ + + margin-bottom: 0; + -webkit-border-radius: 15px; + -moz-border-radius: 15px; + border-radius: 15px; +} + +/* Allow for input prepend/append in search forms */ + +.form-search .input-append .search-query, +.form-search .input-prepend .search-query { + -webkit-border-radius: 0; + -moz-border-radius: 0; + border-radius: 0; +} + +.form-search .input-append .search-query { + -webkit-border-radius: 14px 0 0 14px; + -moz-border-radius: 14px 0 0 14px; + border-radius: 14px 0 0 14px; +} + +.form-search .input-append .btn { + -webkit-border-radius: 0 14px 14px 0; + -moz-border-radius: 0 14px 14px 0; + border-radius: 0 14px 14px 0; +} + +.form-search .input-prepend .search-query { + -webkit-border-radius: 0 14px 14px 0; + -moz-border-radius: 0 14px 14px 0; + border-radius: 0 14px 14px 0; +} + +.form-search .input-prepend .btn { + -webkit-border-radius: 14px 0 0 14px; + -moz-border-radius: 14px 0 0 14px; + border-radius: 14px 0 0 14px; +} + +.form-search input, +.form-inline input, +.form-horizontal input, +.form-search textarea, +.form-inline textarea, +.form-horizontal textarea, +.form-search select, +.form-inline select, +.form-horizontal select, +.form-search .help-inline, +.form-inline .help-inline, +.form-horizontal .help-inline, +.form-search .uneditable-input, +.form-inline .uneditable-input, +.form-horizontal .uneditable-input, +.form-search .input-prepend, +.form-inline .input-prepend, +.form-horizontal .input-prepend, +.form-search .input-append, +.form-inline .input-append, +.form-horizontal .input-append { + display: inline-block; + *display: inline; + margin-bottom: 0; + vertical-align: middle; + *zoom: 1; +} + +.form-search .hide, +.form-inline .hide, +.form-horizontal .hide { + display: none; +} + +.form-search label, +.form-inline label, +.form-search .btn-group, +.form-inline .btn-group { + display: inline-block; +} + +.form-search .input-append, +.form-inline .input-append, +.form-search .input-prepend, +.form-inline .input-prepend { + margin-bottom: 0; +} + +.form-search .radio, +.form-search .checkbox, +.form-inline .radio, +.form-inline .checkbox { + padding-left: 0; + margin-bottom: 0; + vertical-align: middle; +} + +.form-search .radio input[type="radio"], +.form-search .checkbox input[type="checkbox"], +.form-inline .radio input[type="radio"], +.form-inline .checkbox input[type="checkbox"] { + float: left; + margin-right: 3px; + margin-left: 0; +} + +.control-group { + margin-bottom: 10px; +} + +legend + .control-group { + margin-top: 20px; + -webkit-margin-top-collapse: separate; +} + +.form-horizontal .control-group { + margin-bottom: 20px; + *zoom: 1; +} + +.form-horizontal .control-group:before, +.form-horizontal .control-group:after { + display: table; + line-height: 0; + content: ""; +} + +.form-horizontal .control-group:after { + clear: both; +} + +.form-horizontal .control-label { + float: left; + width: 160px; + padding-top: 5px; + text-align: right; +} + +.form-horizontal .controls { + *display: inline-block; + *padding-left: 20px; + margin-left: 180px; + *margin-left: 0; +} + +.form-horizontal .controls:first-child { + *padding-left: 180px; +} + +.form-horizontal .help-block { + margin-bottom: 0; +} + +.form-horizontal input + .help-block, +.form-horizontal select + .help-block, +.form-horizontal textarea + .help-block, +.form-horizontal .uneditable-input + .help-block, +.form-horizontal .input-prepend + .help-block, +.form-horizontal .input-append + .help-block { + margin-top: 10px; +} + +.form-horizontal .form-actions { + padding-left: 180px; +} + +table { + max-width: 100%; + background-color: transparent; + border-collapse: collapse; + border-spacing: 0; +} + +.table { + width: 100%; + margin-bottom: 20px; +} + +.table th, +.table td { + padding: 8px; + line-height: 20px; + text-align: left; + vertical-align: top; + border-top: 1px solid #dddddd; +} + +.table th { + font-weight: bold; +} + +.table thead th { + vertical-align: bottom; +} + +.table caption + thead tr:first-child th, +.table caption + thead tr:first-child td, +.table colgroup + thead tr:first-child th, +.table colgroup + thead tr:first-child td, +.table thead:first-child tr:first-child th, +.table thead:first-child tr:first-child td { + border-top: 0; +} + +.table tbody + tbody { + border-top: 2px solid #dddddd; +} + +.table .table { + background-color: #ffffff; +} + +.table-condensed th, +.table-condensed td { + padding: 4px 5px; +} + +.table-bordered { + border: 1px solid #dddddd; + border-collapse: separate; + *border-collapse: collapse; + border-left: 0; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; +} + +.table-bordered th, +.table-bordered td { + border-left: 1px solid #dddddd; +} + +.table-bordered caption + thead tr:first-child th, +.table-bordered caption + tbody tr:first-child th, +.table-bordered caption + tbody tr:first-child td, +.table-bordered colgroup + thead tr:first-child th, +.table-bordered colgroup + tbody tr:first-child th, +.table-bordered colgroup + tbody tr:first-child td, +.table-bordered thead:first-child tr:first-child th, +.table-bordered tbody:first-child tr:first-child th, +.table-bordered tbody:first-child tr:first-child td { + border-top: 0; +} + +.table-bordered thead:first-child tr:first-child > th:first-child, +.table-bordered tbody:first-child tr:first-child > td:first-child { + -webkit-border-top-left-radius: 4px; + border-top-left-radius: 4px; + -moz-border-radius-topleft: 4px; +} + +.table-bordered thead:first-child tr:first-child > th:last-child, +.table-bordered tbody:first-child tr:first-child > td:last-child { + -webkit-border-top-right-radius: 4px; + border-top-right-radius: 4px; + -moz-border-radius-topright: 4px; +} + +.table-bordered thead:last-child tr:last-child > th:first-child, +.table-bordered tbody:last-child tr:last-child > td:first-child, +.table-bordered tfoot:last-child tr:last-child > td:first-child { + -webkit-border-bottom-left-radius: 4px; + border-bottom-left-radius: 4px; + -moz-border-radius-bottomleft: 4px; +} + +.table-bordered thead:last-child tr:last-child > th:last-child, +.table-bordered tbody:last-child tr:last-child > td:last-child, +.table-bordered tfoot:last-child tr:last-child > td:last-child { + -webkit-border-bottom-right-radius: 4px; + border-bottom-right-radius: 4px; + -moz-border-radius-bottomright: 4px; +} + +.table-bordered tfoot + tbody:last-child tr:last-child td:first-child { + -webkit-border-bottom-left-radius: 0; + border-bottom-left-radius: 0; + -moz-border-radius-bottomleft: 0; +} + +.table-bordered tfoot + tbody:last-child tr:last-child td:last-child { + -webkit-border-bottom-right-radius: 0; + border-bottom-right-radius: 0; + -moz-border-radius-bottomright: 0; +} + +.table-bordered caption + thead tr:first-child th:first-child, +.table-bordered caption + tbody tr:first-child td:first-child, +.table-bordered colgroup + thead tr:first-child th:first-child, +.table-bordered colgroup + tbody tr:first-child td:first-child { + -webkit-border-top-left-radius: 4px; + border-top-left-radius: 4px; + -moz-border-radius-topleft: 4px; +} + +.table-bordered caption + thead tr:first-child th:last-child, +.table-bordered caption + tbody tr:first-child td:last-child, +.table-bordered colgroup + thead tr:first-child th:last-child, +.table-bordered colgroup + tbody tr:first-child td:last-child { + -webkit-border-top-right-radius: 4px; + border-top-right-radius: 4px; + -moz-border-radius-topright: 4px; +} + +.table-striped tbody > tr:nth-child(odd) > td, +.table-striped tbody > tr:nth-child(odd) > th { + background-color: #f9f9f9; +} + +.table-hover tbody tr:hover td, +.table-hover tbody tr:hover th { + background-color: #f5f5f5; +} + +table td[class*="span"], +table th[class*="span"], +.row-fluid table td[class*="span"], +.row-fluid table th[class*="span"] { + display: table-cell; + float: none; + margin-left: 0; +} + +.table td.span1, +.table th.span1 { + float: none; + width: 44px; + margin-left: 0; +} + +.table td.span2, +.table th.span2 { + float: none; + width: 124px; + margin-left: 0; +} + +.table td.span3, +.table th.span3 { + float: none; + width: 204px; + margin-left: 0; +} + +.table td.span4, +.table th.span4 { + float: none; + width: 284px; + margin-left: 0; +} + +.table td.span5, +.table th.span5 { + float: none; + width: 364px; + margin-left: 0; +} + +.table td.span6, +.table th.span6 { + float: none; + width: 444px; + margin-left: 0; +} + +.table td.span7, +.table th.span7 { + float: none; + width: 524px; + margin-left: 0; +} + +.table td.span8, +.table th.span8 { + float: none; + width: 604px; + margin-left: 0; +} + +.table td.span9, +.table th.span9 { + float: none; + width: 684px; + margin-left: 0; +} + +.table td.span10, +.table th.span10 { + float: none; + width: 764px; + margin-left: 0; +} + +.table td.span11, +.table th.span11 { + float: none; + width: 844px; + margin-left: 0; +} + +.table td.span12, +.table th.span12 { + float: none; + width: 924px; + margin-left: 0; +} + +.table tbody tr.success td { + background-color: #dff0d8; +} + +.table tbody tr.error td { + background-color: #f2dede; +} + +.table tbody tr.warning td { + background-color: #fcf8e3; +} + +.table tbody tr.info td { + background-color: #d9edf7; +} + +.table-hover tbody tr.success:hover td { + background-color: #d0e9c6; +} + +.table-hover tbody tr.error:hover td { + background-color: #ebcccc; +} + +.table-hover tbody tr.warning:hover td { + background-color: #faf2cc; +} + +.table-hover tbody tr.info:hover td { + background-color: #c4e3f3; +} + +[class^="icon-"], +[class*=" icon-"] { + display: inline-block; + width: 14px; + height: 14px; + margin-top: 1px; + *margin-right: .3em; + line-height: 14px; + vertical-align: text-top; + background-image: url("../img/glyphicons-halflings.png"); + background-position: 14px 14px; + background-repeat: no-repeat; +} + +/* White icons with optional class, or on hover/active states of certain elements */ + +.icon-white, +.nav-pills > .active > a > [class^="icon-"], +.nav-pills > .active > a > [class*=" icon-"], +.nav-list > .active > a > [class^="icon-"], +.nav-list > .active > a > [class*=" icon-"], +.navbar-inverse .nav > .active > a > [class^="icon-"], +.navbar-inverse .nav > .active > a > [class*=" icon-"], +.dropdown-menu > li > a:hover > [class^="icon-"], +.dropdown-menu > li > a:hover > [class*=" icon-"], +.dropdown-menu > .active > a > [class^="icon-"], +.dropdown-menu > .active > a > [class*=" icon-"], +.dropdown-submenu:hover > a > [class^="icon-"], +.dropdown-submenu:hover > a > [class*=" icon-"] { + background-image: url("../img/glyphicons-halflings-white.png"); +} + +.icon-glass { + background-position: 0 0; +} + +.icon-music { + background-position: -24px 0; +} + +.icon-search { + background-position: -48px 0; +} + +.icon-envelope { + background-position: -72px 0; +} + +.icon-heart { + background-position: -96px 0; +} + +.icon-star { + background-position: -120px 0; +} + +.icon-star-empty { + background-position: -144px 0; +} + +.icon-user { + background-position: -168px 0; +} + +.icon-film { + background-position: -192px 0; +} + +.icon-th-large { + background-position: -216px 0; +} + +.icon-th { + background-position: -240px 0; +} + +.icon-th-list { + background-position: -264px 0; +} + +.icon-ok { + background-position: -288px 0; +} + +.icon-remove { + background-position: -312px 0; +} + +.icon-zoom-in { + background-position: -336px 0; +} + +.icon-zoom-out { + background-position: -360px 0; +} + +.icon-off { + background-position: -384px 0; +} + +.icon-signal { + background-position: -408px 0; +} + +.icon-cog { + background-position: -432px 0; +} + +.icon-trash { + background-position: -456px 0; +} + +.icon-home { + background-position: 0 -24px; +} + +.icon-file { + background-position: -24px -24px; +} + +.icon-time { + background-position: -48px -24px; +} + +.icon-road { + background-position: -72px -24px; +} + +.icon-download-alt { + background-position: -96px -24px; +} + +.icon-download { + background-position: -120px -24px; +} + +.icon-upload { + background-position: -144px -24px; +} + +.icon-inbox { + background-position: -168px -24px; +} + +.icon-play-circle { + background-position: -192px -24px; +} + +.icon-repeat { + background-position: -216px -24px; +} + +.icon-refresh { + background-position: -240px -24px; +} + +.icon-list-alt { + background-position: -264px -24px; +} + +.icon-lock { + background-position: -287px -24px; +} + +.icon-flag { + background-position: -312px -24px; +} + +.icon-headphones { + background-position: -336px -24px; +} + +.icon-volume-off { + background-position: -360px -24px; +} + +.icon-volume-down { + background-position: -384px -24px; +} + +.icon-volume-up { + background-position: -408px -24px; +} + +.icon-qrcode { + background-position: -432px -24px; +} + +.icon-barcode { + background-position: -456px -24px; +} + +.icon-tag { + background-position: 0 -48px; +} + +.icon-tags { + background-position: -25px -48px; +} + +.icon-book { + background-position: -48px -48px; +} + +.icon-bookmark { + background-position: -72px -48px; +} + +.icon-print { + background-position: -96px -48px; +} + +.icon-camera { + background-position: -120px -48px; +} + +.icon-font { + background-position: -144px -48px; +} + +.icon-bold { + background-position: -167px -48px; +} + +.icon-italic { + background-position: -192px -48px; +} + +.icon-text-height { + background-position: -216px -48px; +} + +.icon-text-width { + background-position: -240px -48px; +} + +.icon-align-left { + background-position: -264px -48px; +} + +.icon-align-center { + background-position: -288px -48px; +} + +.icon-align-right { + background-position: -312px -48px; +} + +.icon-align-justify { + background-position: -336px -48px; +} + +.icon-list { + background-position: -360px -48px; +} + +.icon-indent-left { + background-position: -384px -48px; +} + +.icon-indent-right { + background-position: -408px -48px; +} + +.icon-facetime-video { + background-position: -432px -48px; +} + +.icon-picture { + background-position: -456px -48px; +} + +.icon-pencil { + background-position: 0 -72px; +} + +.icon-map-marker { + background-position: -24px -72px; +} + +.icon-adjust { + background-position: -48px -72px; +} + +.icon-tint { + background-position: -72px -72px; +} + +.icon-edit { + background-position: -96px -72px; +} + +.icon-share { + background-position: -120px -72px; +} + +.icon-check { + background-position: -144px -72px; +} + +.icon-move { + background-position: -168px -72px; +} + +.icon-step-backward { + background-position: -192px -72px; +} + +.icon-fast-backward { + background-position: -216px -72px; +} + +.icon-backward { + background-position: -240px -72px; +} + +.icon-play { + background-position: -264px -72px; +} + +.icon-pause { + background-position: -288px -72px; +} + +.icon-stop { + background-position: -312px -72px; +} + +.icon-forward { + background-position: -336px -72px; +} + +.icon-fast-forward { + background-position: -360px -72px; +} + +.icon-step-forward { + background-position: -384px -72px; +} + +.icon-eject { + background-position: -408px -72px; +} + +.icon-chevron-left { + background-position: -432px -72px; +} + +.icon-chevron-right { + background-position: -456px -72px; +} + +.icon-plus-sign { + background-position: 0 -96px; +} + +.icon-minus-sign { + background-position: -24px -96px; +} + +.icon-remove-sign { + background-position: -48px -96px; +} + +.icon-ok-sign { + background-position: -72px -96px; +} + +.icon-question-sign { + background-position: -96px -96px; +} + +.icon-info-sign { + background-position: -120px -96px; +} + +.icon-screenshot { + background-position: -144px -96px; +} + +.icon-remove-circle { + background-position: -168px -96px; +} + +.icon-ok-circle { + background-position: -192px -96px; +} + +.icon-ban-circle { + background-position: -216px -96px; +} + +.icon-arrow-left { + background-position: -240px -96px; +} + +.icon-arrow-right { + background-position: -264px -96px; +} + +.icon-arrow-up { + background-position: -289px -96px; +} + +.icon-arrow-down { + background-position: -312px -96px; +} + +.icon-share-alt { + background-position: -336px -96px; +} + +.icon-resize-full { + background-position: -360px -96px; +} + +.icon-resize-small { + background-position: -384px -96px; +} + +.icon-plus { + background-position: -408px -96px; +} + +.icon-minus { + background-position: -433px -96px; +} + +.icon-asterisk { + background-position: -456px -96px; +} + +.icon-exclamation-sign { + background-position: 0 -120px; +} + +.icon-gift { + background-position: -24px -120px; +} + +.icon-leaf { + background-position: -48px -120px; +} + +.icon-fire { + background-position: -72px -120px; +} + +.icon-eye-open { + background-position: -96px -120px; +} + +.icon-eye-close { + background-position: -120px -120px; +} + +.icon-warning-sign { + background-position: -144px -120px; +} + +.icon-plane { + background-position: -168px -120px; +} + +.icon-calendar { + background-position: -192px -120px; +} + +.icon-random { + width: 16px; + background-position: -216px -120px; +} + +.icon-comment { + background-position: -240px -120px; +} + +.icon-magnet { + background-position: -264px -120px; +} + +.icon-chevron-up { + background-position: -288px -120px; +} + +.icon-chevron-down { + background-position: -313px -119px; +} + +.icon-retweet { + background-position: -336px -120px; +} + +.icon-shopping-cart { + background-position: -360px -120px; +} + +.icon-folder-close { + background-position: -384px -120px; +} + +.icon-folder-open { + width: 16px; + background-position: -408px -120px; +} + +.icon-resize-vertical { + background-position: -432px -119px; +} + +.icon-resize-horizontal { + background-position: -456px -118px; +} + +.icon-hdd { + background-position: 0 -144px; +} + +.icon-bullhorn { + background-position: -24px -144px; +} + +.icon-bell { + background-position: -48px -144px; +} + +.icon-certificate { + background-position: -72px -144px; +} + +.icon-thumbs-up { + background-position: -96px -144px; +} + +.icon-thumbs-down { + background-position: -120px -144px; +} + +.icon-hand-right { + background-position: -144px -144px; +} + +.icon-hand-left { + background-position: -168px -144px; +} + +.icon-hand-up { + background-position: -192px -144px; +} + +.icon-hand-down { + background-position: -216px -144px; +} + +.icon-circle-arrow-right { + background-position: -240px -144px; +} + +.icon-circle-arrow-left { + background-position: -264px -144px; +} + +.icon-circle-arrow-up { + background-position: -288px -144px; +} + +.icon-circle-arrow-down { + background-position: -312px -144px; +} + +.icon-globe { + background-position: -336px -144px; +} + +.icon-wrench { + background-position: -360px -144px; +} + +.icon-tasks { + background-position: -384px -144px; +} + +.icon-filter { + background-position: -408px -144px; +} + +.icon-briefcase { + background-position: -432px -144px; +} + +.icon-fullscreen { + background-position: -456px -144px; +} + +.dropup, +.dropdown { + position: relative; +} + +.dropdown-toggle { + *margin-bottom: -3px; +} + +.dropdown-toggle:active, +.open .dropdown-toggle { + outline: 0; +} + +.caret { + display: inline-block; + width: 0; + height: 0; + vertical-align: top; + border-top: 4px solid #000000; + border-right: 4px solid transparent; + border-left: 4px solid transparent; + content: ""; +} + +.dropdown .caret { + margin-top: 8px; + margin-left: 2px; +} + +.dropdown-menu { + position: absolute; + top: 100%; + left: 0; + z-index: 1000; + display: none; + float: left; + min-width: 160px; + padding: 5px 0; + margin: 2px 0 0; + list-style: none; + background-color: #ffffff; + border: 1px solid #ccc; + border: 1px solid rgba(0, 0, 0, 0.2); + *border-right-width: 2px; + *border-bottom-width: 2px; + -webkit-border-radius: 6px; + -moz-border-radius: 6px; + border-radius: 6px; + -webkit-box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); + -moz-box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); + box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); + -webkit-background-clip: padding-box; + -moz-background-clip: padding; + background-clip: padding-box; +} + +.dropdown-menu.pull-right { + right: 0; + left: auto; +} + +.dropdown-menu .divider { + *width: 100%; + height: 1px; + margin: 9px 1px; + *margin: -5px 0 5px; + overflow: hidden; + background-color: #e5e5e5; + border-bottom: 1px solid #ffffff; +} + +.dropdown-menu li > a { + display: block; + padding: 3px 20px; + clear: both; + font-weight: normal; + line-height: 20px; + color: #333333; + white-space: nowrap; +} + +.dropdown-menu li > a:hover, +.dropdown-menu li > a:focus, +.dropdown-submenu:hover > a { + color: #ffffff; + text-decoration: none; + background-color: #0081c2; + background-image: -moz-linear-gradient(top, #0088cc, #0077b3); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#0088cc), to(#0077b3)); + background-image: -webkit-linear-gradient(top, #0088cc, #0077b3); + background-image: -o-linear-gradient(top, #0088cc, #0077b3); + background-image: linear-gradient(to bottom, #0088cc, #0077b3); + background-repeat: repeat-x; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff0088cc', endColorstr='#ff0077b3', GradientType=0); +} + +.dropdown-menu .active > a, +.dropdown-menu .active > a:hover { + color: #ffffff; + text-decoration: none; + background-color: #0081c2; + background-image: -moz-linear-gradient(top, #0088cc, #0077b3); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#0088cc), to(#0077b3)); + background-image: -webkit-linear-gradient(top, #0088cc, #0077b3); + background-image: -o-linear-gradient(top, #0088cc, #0077b3); + background-image: linear-gradient(to bottom, #0088cc, #0077b3); + background-repeat: repeat-x; + outline: 0; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff0088cc', endColorstr='#ff0077b3', GradientType=0); +} + +.dropdown-menu .disabled > a, +.dropdown-menu .disabled > a:hover { + color: #999999; +} + +.dropdown-menu .disabled > a:hover { + text-decoration: none; + cursor: default; + background-color: transparent; + background-image: none; + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); +} + +.open { + *z-index: 1000; +} + +.open > .dropdown-menu { + display: block; +} + +.pull-right > .dropdown-menu { + right: 0; + left: auto; +} + +.dropup .caret, +.navbar-fixed-bottom .dropdown .caret { + border-top: 0; + border-bottom: 4px solid #000000; + content: ""; +} + +.dropup .dropdown-menu, +.navbar-fixed-bottom .dropdown .dropdown-menu { + top: auto; + bottom: 100%; + margin-bottom: 1px; +} + +.dropdown-submenu { + position: relative; +} + +.dropdown-submenu > .dropdown-menu { + top: 0; + left: 100%; + margin-top: -6px; + margin-left: -1px; + -webkit-border-radius: 0 6px 6px 6px; + -moz-border-radius: 0 6px 6px 6px; + border-radius: 0 6px 6px 6px; +} + +.dropdown-submenu:hover > .dropdown-menu { + display: block; +} + +.dropup .dropdown-submenu > .dropdown-menu { + top: auto; + bottom: 0; + margin-top: 0; + margin-bottom: -2px; + -webkit-border-radius: 5px 5px 5px 0; + -moz-border-radius: 5px 5px 5px 0; + border-radius: 5px 5px 5px 0; +} + +.dropdown-submenu > a:after { + display: block; + float: right; + width: 0; + height: 0; + margin-top: 5px; + margin-right: -10px; + border-color: transparent; + border-left-color: #cccccc; + border-style: solid; + border-width: 5px 0 5px 5px; + content: " "; +} + +.dropdown-submenu:hover > a:after { + border-left-color: #ffffff; +} + +.dropdown-submenu.pull-left { + float: none; +} + +.dropdown-submenu.pull-left > .dropdown-menu { + left: -100%; + margin-left: 10px; + -webkit-border-radius: 6px 0 6px 6px; + -moz-border-radius: 6px 0 6px 6px; + border-radius: 6px 0 6px 6px; +} + +.dropdown .dropdown-menu .nav-header { + padding-right: 20px; + padding-left: 20px; +} + +.typeahead { + z-index: 1051; + margin-top: 2px; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; +} + +.well { + min-height: 20px; + padding: 19px; + margin-bottom: 20px; + background-color: #f5f5f5; + border: 1px solid #e3e3e3; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; + -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05); + -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05); + box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05); +} + +.well blockquote { + border-color: #ddd; + border-color: rgba(0, 0, 0, 0.15); +} + +.well-large { + padding: 24px; + -webkit-border-radius: 6px; + -moz-border-radius: 6px; + border-radius: 6px; +} + +.well-small { + padding: 9px; + -webkit-border-radius: 3px; + -moz-border-radius: 3px; + border-radius: 3px; +} + +.fade { + opacity: 0; + -webkit-transition: opacity 0.15s linear; + -moz-transition: opacity 0.15s linear; + -o-transition: opacity 0.15s linear; + transition: opacity 0.15s linear; +} + +.fade.in { + opacity: 1; +} + +.collapse { + position: relative; + height: 0; + overflow: hidden; + -webkit-transition: height 0.35s ease; + -moz-transition: height 0.35s ease; + -o-transition: height 0.35s ease; + transition: height 0.35s ease; +} + +.collapse.in { + height: auto; +} + +.close { + float: right; + font-size: 20px; + font-weight: bold; + line-height: 20px; + color: #000000; + text-shadow: 0 1px 0 #ffffff; + opacity: 0.2; + filter: alpha(opacity=20); +} + +.close:hover { + color: #000000; + text-decoration: none; + cursor: pointer; + opacity: 0.4; + filter: alpha(opacity=40); +} + +button.close { + padding: 0; + cursor: pointer; + background: transparent; + border: 0; + -webkit-appearance: none; +} + +.btn { + display: inline-block; + *display: inline; + padding: 4px 12px; + margin-bottom: 0; + *margin-left: .3em; + font-size: 14px; + line-height: 20px; + color: #333333; + text-align: center; + text-shadow: 0 1px 1px rgba(255, 255, 255, 0.75); + vertical-align: middle; + cursor: pointer; + background-color: #f5f5f5; + *background-color: #e6e6e6; + background-image: -moz-linear-gradient(top, #ffffff, #e6e6e6); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#ffffff), to(#e6e6e6)); + background-image: -webkit-linear-gradient(top, #ffffff, #e6e6e6); + background-image: -o-linear-gradient(top, #ffffff, #e6e6e6); + background-image: linear-gradient(to bottom, #ffffff, #e6e6e6); + background-repeat: repeat-x; + border: 1px solid #bbbbbb; + *border: 0; + border-color: #e6e6e6 #e6e6e6 #bfbfbf; + border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25); + border-bottom-color: #a2a2a2; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffffffff', endColorstr='#ffe6e6e6', GradientType=0); + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); + *zoom: 1; + -webkit-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.2), 0 1px 2px rgba(0, 0, 0, 0.05); + -moz-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.2), 0 1px 2px rgba(0, 0, 0, 0.05); + box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.2), 0 1px 2px rgba(0, 0, 0, 0.05); +} + +.btn:hover, +.btn:active, +.btn.active, +.btn.disabled, +.btn[disabled] { + color: #333333; + background-color: #e6e6e6; + *background-color: #d9d9d9; +} + +.btn:active, +.btn.active { + background-color: #cccccc \9; +} + +.btn:first-child { + *margin-left: 0; +} + +.btn:hover { + color: #333333; + text-decoration: none; + background-position: 0 -15px; + -webkit-transition: background-position 0.1s linear; + -moz-transition: background-position 0.1s linear; + -o-transition: background-position 0.1s linear; + transition: background-position 0.1s linear; +} + +.btn:focus { + outline: thin dotted #333; + outline: 5px auto -webkit-focus-ring-color; + outline-offset: -2px; +} + +.btn.active, +.btn:active { + background-image: none; + outline: 0; + -webkit-box-shadow: inset 0 2px 4px rgba(0, 0, 0, 0.15), 0 1px 2px rgba(0, 0, 0, 0.05); + -moz-box-shadow: inset 0 2px 4px rgba(0, 0, 0, 0.15), 0 1px 2px rgba(0, 0, 0, 0.05); + box-shadow: inset 0 2px 4px rgba(0, 0, 0, 0.15), 0 1px 2px rgba(0, 0, 0, 0.05); +} + +.btn.disabled, +.btn[disabled] { + cursor: default; + background-image: none; + opacity: 0.65; + filter: alpha(opacity=65); + -webkit-box-shadow: none; + -moz-box-shadow: none; + box-shadow: none; +} + +.btn-large { + padding: 11px 19px; + font-size: 17.5px; + -webkit-border-radius: 6px; + -moz-border-radius: 6px; + border-radius: 6px; +} + +.btn-large [class^="icon-"], +.btn-large [class*=" icon-"] { + margin-top: 4px; +} + +.btn-small { + padding: 2px 10px; + font-size: 11.9px; + -webkit-border-radius: 3px; + -moz-border-radius: 3px; + border-radius: 3px; +} + +.btn-small [class^="icon-"], +.btn-small [class*=" icon-"] { + margin-top: 0; +} + +.btn-mini [class^="icon-"], +.btn-mini [class*=" icon-"] { + margin-top: -1px; +} + +.btn-mini { + padding: 0 6px; + font-size: 10.5px; + -webkit-border-radius: 3px; + -moz-border-radius: 3px; + border-radius: 3px; +} + +.btn-block { + display: block; + width: 100%; + padding-right: 0; + padding-left: 0; + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; +} + +.btn-block + .btn-block { + margin-top: 5px; +} + +input[type="submit"].btn-block, +input[type="reset"].btn-block, +input[type="button"].btn-block { + width: 100%; +} + +.btn-primary.active, +.btn-warning.active, +.btn-danger.active, +.btn-success.active, +.btn-info.active, +.btn-inverse.active { + color: rgba(255, 255, 255, 0.75); +} + +.btn { + border-color: #c5c5c5; + border-color: rgba(0, 0, 0, 0.15) rgba(0, 0, 0, 0.15) rgba(0, 0, 0, 0.25); +} + +.btn-primary { + color: #ffffff; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); + background-color: #006dcc; + *background-color: #0044cc; + background-image: -moz-linear-gradient(top, #0088cc, #0044cc); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#0088cc), to(#0044cc)); + background-image: -webkit-linear-gradient(top, #0088cc, #0044cc); + background-image: -o-linear-gradient(top, #0088cc, #0044cc); + background-image: linear-gradient(to bottom, #0088cc, #0044cc); + background-repeat: repeat-x; + border-color: #0044cc #0044cc #002a80; + border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25); + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff0088cc', endColorstr='#ff0044cc', GradientType=0); + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); +} + +.btn-primary:hover, +.btn-primary:active, +.btn-primary.active, +.btn-primary.disabled, +.btn-primary[disabled] { + color: #ffffff; + background-color: #0044cc; + *background-color: #003bb3; +} + +.btn-primary:active, +.btn-primary.active { + background-color: #003399 \9; +} + +.btn-warning { + color: #ffffff; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); + background-color: #faa732; + *background-color: #f89406; + background-image: -moz-linear-gradient(top, #fbb450, #f89406); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#fbb450), to(#f89406)); + background-image: -webkit-linear-gradient(top, #fbb450, #f89406); + background-image: -o-linear-gradient(top, #fbb450, #f89406); + background-image: linear-gradient(to bottom, #fbb450, #f89406); + background-repeat: repeat-x; + border-color: #f89406 #f89406 #ad6704; + border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25); + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#fffbb450', endColorstr='#fff89406', GradientType=0); + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); +} + +.btn-warning:hover, +.btn-warning:active, +.btn-warning.active, +.btn-warning.disabled, +.btn-warning[disabled] { + color: #ffffff; + background-color: #f89406; + *background-color: #df8505; +} + +.btn-warning:active, +.btn-warning.active { + background-color: #c67605 \9; +} + +.btn-danger { + color: #ffffff; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); + background-color: #da4f49; + *background-color: #bd362f; + background-image: -moz-linear-gradient(top, #ee5f5b, #bd362f); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#ee5f5b), to(#bd362f)); + background-image: -webkit-linear-gradient(top, #ee5f5b, #bd362f); + background-image: -o-linear-gradient(top, #ee5f5b, #bd362f); + background-image: linear-gradient(to bottom, #ee5f5b, #bd362f); + background-repeat: repeat-x; + border-color: #bd362f #bd362f #802420; + border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25); + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffee5f5b', endColorstr='#ffbd362f', GradientType=0); + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); +} + +.btn-danger:hover, +.btn-danger:active, +.btn-danger.active, +.btn-danger.disabled, +.btn-danger[disabled] { + color: #ffffff; + background-color: #bd362f; + *background-color: #a9302a; +} + +.btn-danger:active, +.btn-danger.active { + background-color: #942a25 \9; +} + +.btn-success { + color: #ffffff; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); + background-color: #5bb75b; + *background-color: #51a351; + background-image: -moz-linear-gradient(top, #62c462, #51a351); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#62c462), to(#51a351)); + background-image: -webkit-linear-gradient(top, #62c462, #51a351); + background-image: -o-linear-gradient(top, #62c462, #51a351); + background-image: linear-gradient(to bottom, #62c462, #51a351); + background-repeat: repeat-x; + border-color: #51a351 #51a351 #387038; + border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25); + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff62c462', endColorstr='#ff51a351', GradientType=0); + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); +} + +.btn-success:hover, +.btn-success:active, +.btn-success.active, +.btn-success.disabled, +.btn-success[disabled] { + color: #ffffff; + background-color: #51a351; + *background-color: #499249; +} + +.btn-success:active, +.btn-success.active { + background-color: #408140 \9; +} + +.btn-info { + color: #ffffff; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); + background-color: #49afcd; + *background-color: #2f96b4; + background-image: -moz-linear-gradient(top, #5bc0de, #2f96b4); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#5bc0de), to(#2f96b4)); + background-image: -webkit-linear-gradient(top, #5bc0de, #2f96b4); + background-image: -o-linear-gradient(top, #5bc0de, #2f96b4); + background-image: linear-gradient(to bottom, #5bc0de, #2f96b4); + background-repeat: repeat-x; + border-color: #2f96b4 #2f96b4 #1f6377; + border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25); + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff5bc0de', endColorstr='#ff2f96b4', GradientType=0); + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); +} + +.btn-info:hover, +.btn-info:active, +.btn-info.active, +.btn-info.disabled, +.btn-info[disabled] { + color: #ffffff; + background-color: #2f96b4; + *background-color: #2a85a0; +} + +.btn-info:active, +.btn-info.active { + background-color: #24748c \9; +} + +.btn-inverse { + color: #ffffff; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); + background-color: #363636; + *background-color: #222222; + background-image: -moz-linear-gradient(top, #444444, #222222); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#444444), to(#222222)); + background-image: -webkit-linear-gradient(top, #444444, #222222); + background-image: -o-linear-gradient(top, #444444, #222222); + background-image: linear-gradient(to bottom, #444444, #222222); + background-repeat: repeat-x; + border-color: #222222 #222222 #000000; + border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25); + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff444444', endColorstr='#ff222222', GradientType=0); + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); +} + +.btn-inverse:hover, +.btn-inverse:active, +.btn-inverse.active, +.btn-inverse.disabled, +.btn-inverse[disabled] { + color: #ffffff; + background-color: #222222; + *background-color: #151515; +} + +.btn-inverse:active, +.btn-inverse.active { + background-color: #080808 \9; +} + +button.btn, +input[type="submit"].btn { + *padding-top: 3px; + *padding-bottom: 3px; +} + +button.btn::-moz-focus-inner, +input[type="submit"].btn::-moz-focus-inner { + padding: 0; + border: 0; +} + +button.btn.btn-large, +input[type="submit"].btn.btn-large { + *padding-top: 7px; + *padding-bottom: 7px; +} + +button.btn.btn-small, +input[type="submit"].btn.btn-small { + *padding-top: 3px; + *padding-bottom: 3px; +} + +button.btn.btn-mini, +input[type="submit"].btn.btn-mini { + *padding-top: 1px; + *padding-bottom: 1px; +} + +.btn-link, +.btn-link:active, +.btn-link[disabled] { + background-color: transparent; + background-image: none; + -webkit-box-shadow: none; + -moz-box-shadow: none; + box-shadow: none; +} + +.btn-link { + color: #0088cc; + cursor: pointer; + border-color: transparent; + -webkit-border-radius: 0; + -moz-border-radius: 0; + border-radius: 0; +} + +.btn-link:hover { + color: #005580; + text-decoration: underline; + background-color: transparent; +} + +.btn-link[disabled]:hover { + color: #333333; + text-decoration: none; +} + +.btn-group { + position: relative; + display: inline-block; + *display: inline; + *margin-left: .3em; + font-size: 0; + white-space: nowrap; + vertical-align: middle; + *zoom: 1; +} + +.btn-group:first-child { + *margin-left: 0; +} + +.btn-group + .btn-group { + margin-left: 5px; +} + +.btn-toolbar { + margin-top: 10px; + margin-bottom: 10px; + font-size: 0; +} + +.btn-toolbar > .btn + .btn, +.btn-toolbar > .btn-group + .btn, +.btn-toolbar > .btn + .btn-group { + margin-left: 5px; +} + +.btn-group > .btn { + position: relative; + -webkit-border-radius: 0; + -moz-border-radius: 0; + border-radius: 0; +} + +.btn-group > .btn + .btn { + margin-left: -1px; +} + +.btn-group > .btn, +.btn-group > .dropdown-menu, +.btn-group > .popover { + font-size: 14px; +} + +.btn-group > .btn-mini { + font-size: 10.5px; +} + +.btn-group > .btn-small { + font-size: 11.9px; +} + +.btn-group > .btn-large { + font-size: 17.5px; +} + +.btn-group > .btn:first-child { + margin-left: 0; + -webkit-border-bottom-left-radius: 4px; + border-bottom-left-radius: 4px; + -webkit-border-top-left-radius: 4px; + border-top-left-radius: 4px; + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-topleft: 4px; +} + +.btn-group > .btn:last-child, +.btn-group > .dropdown-toggle { + -webkit-border-top-right-radius: 4px; + border-top-right-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + border-bottom-right-radius: 4px; + -moz-border-radius-topright: 4px; + -moz-border-radius-bottomright: 4px; +} + +.btn-group > .btn.large:first-child { + margin-left: 0; + -webkit-border-bottom-left-radius: 6px; + border-bottom-left-radius: 6px; + -webkit-border-top-left-radius: 6px; + border-top-left-radius: 6px; + -moz-border-radius-bottomleft: 6px; + -moz-border-radius-topleft: 6px; +} + +.btn-group > .btn.large:last-child, +.btn-group > .large.dropdown-toggle { + -webkit-border-top-right-radius: 6px; + border-top-right-radius: 6px; + -webkit-border-bottom-right-radius: 6px; + border-bottom-right-radius: 6px; + -moz-border-radius-topright: 6px; + -moz-border-radius-bottomright: 6px; +} + +.btn-group > .btn:hover, +.btn-group > .btn:focus, +.btn-group > .btn:active, +.btn-group > .btn.active { + z-index: 2; +} + +.btn-group .dropdown-toggle:active, +.btn-group.open .dropdown-toggle { + outline: 0; +} + +.btn-group > .btn + .dropdown-toggle { + *padding-top: 5px; + padding-right: 8px; + *padding-bottom: 5px; + padding-left: 8px; + -webkit-box-shadow: inset 1px 0 0 rgba(255, 255, 255, 0.125), inset 0 1px 0 rgba(255, 255, 255, 0.2), 0 1px 2px rgba(0, 0, 0, 0.05); + -moz-box-shadow: inset 1px 0 0 rgba(255, 255, 255, 0.125), inset 0 1px 0 rgba(255, 255, 255, 0.2), 0 1px 2px rgba(0, 0, 0, 0.05); + box-shadow: inset 1px 0 0 rgba(255, 255, 255, 0.125), inset 0 1px 0 rgba(255, 255, 255, 0.2), 0 1px 2px rgba(0, 0, 0, 0.05); +} + +.btn-group > .btn-mini + .dropdown-toggle { + *padding-top: 2px; + padding-right: 5px; + *padding-bottom: 2px; + padding-left: 5px; +} + +.btn-group > .btn-small + .dropdown-toggle { + *padding-top: 5px; + *padding-bottom: 4px; +} + +.btn-group > .btn-large + .dropdown-toggle { + *padding-top: 7px; + padding-right: 12px; + *padding-bottom: 7px; + padding-left: 12px; +} + +.btn-group.open .dropdown-toggle { + background-image: none; + -webkit-box-shadow: inset 0 2px 4px rgba(0, 0, 0, 0.15), 0 1px 2px rgba(0, 0, 0, 0.05); + -moz-box-shadow: inset 0 2px 4px rgba(0, 0, 0, 0.15), 0 1px 2px rgba(0, 0, 0, 0.05); + box-shadow: inset 0 2px 4px rgba(0, 0, 0, 0.15), 0 1px 2px rgba(0, 0, 0, 0.05); +} + +.btn-group.open .btn.dropdown-toggle { + background-color: #e6e6e6; +} + +.btn-group.open .btn-primary.dropdown-toggle { + background-color: #0044cc; +} + +.btn-group.open .btn-warning.dropdown-toggle { + background-color: #f89406; +} + +.btn-group.open .btn-danger.dropdown-toggle { + background-color: #bd362f; +} + +.btn-group.open .btn-success.dropdown-toggle { + background-color: #51a351; +} + +.btn-group.open .btn-info.dropdown-toggle { + background-color: #2f96b4; +} + +.btn-group.open .btn-inverse.dropdown-toggle { + background-color: #222222; +} + +.btn .caret { + margin-top: 8px; + margin-left: 0; +} + +.btn-mini .caret, +.btn-small .caret, +.btn-large .caret { + margin-top: 6px; +} + +.btn-large .caret { + border-top-width: 5px; + border-right-width: 5px; + border-left-width: 5px; +} + +.dropup .btn-large .caret { + border-bottom-width: 5px; +} + +.btn-primary .caret, +.btn-warning .caret, +.btn-danger .caret, +.btn-info .caret, +.btn-success .caret, +.btn-inverse .caret { + border-top-color: #ffffff; + border-bottom-color: #ffffff; +} + +.btn-group-vertical { + display: inline-block; + *display: inline; + /* IE7 inline-block hack */ + + *zoom: 1; +} + +.btn-group-vertical > .btn { + display: block; + float: none; + max-width: 100%; + -webkit-border-radius: 0; + -moz-border-radius: 0; + border-radius: 0; +} + +.btn-group-vertical > .btn + .btn { + margin-top: -1px; + margin-left: 0; +} + +.btn-group-vertical > .btn:first-child { + -webkit-border-radius: 4px 4px 0 0; + -moz-border-radius: 4px 4px 0 0; + border-radius: 4px 4px 0 0; +} + +.btn-group-vertical > .btn:last-child { + -webkit-border-radius: 0 0 4px 4px; + -moz-border-radius: 0 0 4px 4px; + border-radius: 0 0 4px 4px; +} + +.btn-group-vertical > .btn-large:first-child { + -webkit-border-radius: 6px 6px 0 0; + -moz-border-radius: 6px 6px 0 0; + border-radius: 6px 6px 0 0; +} + +.btn-group-vertical > .btn-large:last-child { + -webkit-border-radius: 0 0 6px 6px; + -moz-border-radius: 0 0 6px 6px; + border-radius: 0 0 6px 6px; +} + +.alert { + padding: 8px 35px 8px 14px; + margin-bottom: 20px; + text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5); + background-color: #fcf8e3; + border: 1px solid #fbeed5; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; +} + +.alert, +.alert h4 { + color: #c09853; +} + +.alert h4 { + margin: 0; +} + +.alert .close { + position: relative; + top: -2px; + right: -21px; + line-height: 20px; +} + +.alert-success { + color: #468847; + background-color: #dff0d8; + border-color: #d6e9c6; +} + +.alert-success h4 { + color: #468847; +} + +.alert-danger, +.alert-error { + color: #b94a48; + background-color: #f2dede; + border-color: #eed3d7; +} + +.alert-danger h4, +.alert-error h4 { + color: #b94a48; +} + +.alert-info { + color: #3a87ad; + background-color: #d9edf7; + border-color: #bce8f1; +} + +.alert-info h4 { + color: #3a87ad; +} + +.alert-block { + padding-top: 14px; + padding-bottom: 14px; +} + +.alert-block > p, +.alert-block > ul { + margin-bottom: 0; +} + +.alert-block p + p { + margin-top: 5px; +} + +.nav { + margin-bottom: 20px; + margin-left: 0; + list-style: none; +} + +.nav > li > a { + display: block; +} + +.nav > li > a:hover { + text-decoration: none; + background-color: #eeeeee; +} + +.nav > li > a > img { + max-width: none; +} + +.nav > .pull-right { + float: right; +} + +.nav-header { + display: block; + padding: 3px 15px; + font-size: 11px; + font-weight: bold; + line-height: 20px; + color: #999999; + text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5); + text-transform: uppercase; +} + +.nav li + .nav-header { + margin-top: 9px; +} + +.nav-list { + padding-right: 15px; + padding-left: 15px; + margin-bottom: 0; +} + +.nav-list > li > a, +.nav-list .nav-header { + margin-right: -15px; + margin-left: -15px; + text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5); +} + +.nav-list > li > a { + padding: 3px 15px; +} + +.nav-list > .active > a, +.nav-list > .active > a:hover { + color: #ffffff; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.2); + background-color: #0088cc; +} + +.nav-list [class^="icon-"], +.nav-list [class*=" icon-"] { + margin-right: 2px; +} + +.nav-list .divider { + *width: 100%; + height: 1px; + margin: 9px 1px; + *margin: -5px 0 5px; + overflow: hidden; + background-color: #e5e5e5; + border-bottom: 1px solid #ffffff; +} + +.nav-tabs, +.nav-pills { + *zoom: 1; +} + +.nav-tabs:before, +.nav-pills:before, +.nav-tabs:after, +.nav-pills:after { + display: table; + line-height: 0; + content: ""; +} + +.nav-tabs:after, +.nav-pills:after { + clear: both; +} + +.nav-tabs > li, +.nav-pills > li { + float: left; +} + +.nav-tabs > li > a, +.nav-pills > li > a { + padding-right: 12px; + padding-left: 12px; + margin-right: 2px; + line-height: 14px; +} + +.nav-tabs { + border-bottom: 1px solid #ddd; +} + +.nav-tabs > li { + margin-bottom: -1px; +} + +.nav-tabs > li > a { + padding-top: 8px; + padding-bottom: 8px; + line-height: 20px; + border: 1px solid transparent; + -webkit-border-radius: 4px 4px 0 0; + -moz-border-radius: 4px 4px 0 0; + border-radius: 4px 4px 0 0; +} + +.nav-tabs > li > a:hover { + border-color: #eeeeee #eeeeee #dddddd; +} + +.nav-tabs > .active > a, +.nav-tabs > .active > a:hover { + color: #555555; + cursor: default; + background-color: #ffffff; + border: 1px solid #ddd; + border-bottom-color: transparent; +} + +.nav-pills > li > a { + padding-top: 8px; + padding-bottom: 8px; + margin-top: 2px; + margin-bottom: 2px; + -webkit-border-radius: 5px; + -moz-border-radius: 5px; + border-radius: 5px; +} + +.nav-pills > .active > a, +.nav-pills > .active > a:hover { + color: #ffffff; + background-color: #0088cc; +} + +.nav-stacked > li { + float: none; +} + +.nav-stacked > li > a { + margin-right: 0; +} + +.nav-tabs.nav-stacked { + border-bottom: 0; +} + +.nav-tabs.nav-stacked > li > a { + border: 1px solid #ddd; + -webkit-border-radius: 0; + -moz-border-radius: 0; + border-radius: 0; +} + +.nav-tabs.nav-stacked > li:first-child > a { + -webkit-border-top-right-radius: 4px; + border-top-right-radius: 4px; + -webkit-border-top-left-radius: 4px; + border-top-left-radius: 4px; + -moz-border-radius-topright: 4px; + -moz-border-radius-topleft: 4px; +} + +.nav-tabs.nav-stacked > li:last-child > a { + -webkit-border-bottom-right-radius: 4px; + border-bottom-right-radius: 4px; + -webkit-border-bottom-left-radius: 4px; + border-bottom-left-radius: 4px; + -moz-border-radius-bottomright: 4px; + -moz-border-radius-bottomleft: 4px; +} + +.nav-tabs.nav-stacked > li > a:hover { + z-index: 2; + border-color: #ddd; +} + +.nav-pills.nav-stacked > li > a { + margin-bottom: 3px; +} + +.nav-pills.nav-stacked > li:last-child > a { + margin-bottom: 1px; +} + +.nav-tabs .dropdown-menu { + -webkit-border-radius: 0 0 6px 6px; + -moz-border-radius: 0 0 6px 6px; + border-radius: 0 0 6px 6px; +} + +.nav-pills .dropdown-menu { + -webkit-border-radius: 6px; + -moz-border-radius: 6px; + border-radius: 6px; +} + +.nav .dropdown-toggle .caret { + margin-top: 6px; + border-top-color: #0088cc; + border-bottom-color: #0088cc; +} + +.nav .dropdown-toggle:hover .caret { + border-top-color: #005580; + border-bottom-color: #005580; +} + +/* move down carets for tabs */ + +.nav-tabs .dropdown-toggle .caret { + margin-top: 8px; +} + +.nav .active .dropdown-toggle .caret { + border-top-color: #fff; + border-bottom-color: #fff; +} + +.nav-tabs .active .dropdown-toggle .caret { + border-top-color: #555555; + border-bottom-color: #555555; +} + +.nav > .dropdown.active > a:hover { + cursor: pointer; +} + +.nav-tabs .open .dropdown-toggle, +.nav-pills .open .dropdown-toggle, +.nav > li.dropdown.open.active > a:hover { + color: #ffffff; + background-color: #999999; + border-color: #999999; +} + +.nav li.dropdown.open .caret, +.nav li.dropdown.open.active .caret, +.nav li.dropdown.open a:hover .caret { + border-top-color: #ffffff; + border-bottom-color: #ffffff; + opacity: 1; + filter: alpha(opacity=100); +} + +.tabs-stacked .open > a:hover { + border-color: #999999; +} + +.tabbable { + *zoom: 1; +} + +.tabbable:before, +.tabbable:after { + display: table; + line-height: 0; + content: ""; +} + +.tabbable:after { + clear: both; +} + +.tab-content { + overflow: auto; +} + +.tabs-below > .nav-tabs, +.tabs-right > .nav-tabs, +.tabs-left > .nav-tabs { + border-bottom: 0; +} + +.tab-content > .tab-pane, +.pill-content > .pill-pane { + display: none; +} + +.tab-content > .active, +.pill-content > .active { + display: block; +} + +.tabs-below > .nav-tabs { + border-top: 1px solid #ddd; +} + +.tabs-below > .nav-tabs > li { + margin-top: -1px; + margin-bottom: 0; +} + +.tabs-below > .nav-tabs > li > a { + -webkit-border-radius: 0 0 4px 4px; + -moz-border-radius: 0 0 4px 4px; + border-radius: 0 0 4px 4px; +} + +.tabs-below > .nav-tabs > li > a:hover { + border-top-color: #ddd; + border-bottom-color: transparent; +} + +.tabs-below > .nav-tabs > .active > a, +.tabs-below > .nav-tabs > .active > a:hover { + border-color: transparent #ddd #ddd #ddd; +} + +.tabs-left > .nav-tabs > li, +.tabs-right > .nav-tabs > li { + float: none; +} + +.tabs-left > .nav-tabs > li > a, +.tabs-right > .nav-tabs > li > a { + min-width: 74px; + margin-right: 0; + margin-bottom: 3px; +} + +.tabs-left > .nav-tabs { + float: left; + margin-right: 19px; + border-right: 1px solid #ddd; +} + +.tabs-left > .nav-tabs > li > a { + margin-right: -1px; + -webkit-border-radius: 4px 0 0 4px; + -moz-border-radius: 4px 0 0 4px; + border-radius: 4px 0 0 4px; +} + +.tabs-left > .nav-tabs > li > a:hover { + border-color: #eeeeee #dddddd #eeeeee #eeeeee; +} + +.tabs-left > .nav-tabs .active > a, +.tabs-left > .nav-tabs .active > a:hover { + border-color: #ddd transparent #ddd #ddd; + *border-right-color: #ffffff; +} + +.tabs-right > .nav-tabs { + float: right; + margin-left: 19px; + border-left: 1px solid #ddd; +} + +.tabs-right > .nav-tabs > li > a { + margin-left: -1px; + -webkit-border-radius: 0 4px 4px 0; + -moz-border-radius: 0 4px 4px 0; + border-radius: 0 4px 4px 0; +} + +.tabs-right > .nav-tabs > li > a:hover { + border-color: #eeeeee #eeeeee #eeeeee #dddddd; +} + +.tabs-right > .nav-tabs .active > a, +.tabs-right > .nav-tabs .active > a:hover { + border-color: #ddd #ddd #ddd transparent; + *border-left-color: #ffffff; +} + +.nav > .disabled > a { + color: #999999; +} + +.nav > .disabled > a:hover { + text-decoration: none; + cursor: default; + background-color: transparent; +} + +.navbar { + *position: relative; + *z-index: 2; + margin-bottom: 20px; + overflow: visible; +} + +.navbar-inner { + min-height: 40px; + padding-right: 20px; + padding-left: 20px; + background-color: #fafafa; + background-image: -moz-linear-gradient(top, #ffffff, #f2f2f2); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#ffffff), to(#f2f2f2)); + background-image: -webkit-linear-gradient(top, #ffffff, #f2f2f2); + background-image: -o-linear-gradient(top, #ffffff, #f2f2f2); + background-image: linear-gradient(to bottom, #ffffff, #f2f2f2); + background-repeat: repeat-x; + border: 1px solid #d4d4d4; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffffffff', endColorstr='#fff2f2f2', GradientType=0); + *zoom: 1; + -webkit-box-shadow: 0 1px 4px rgba(0, 0, 0, 0.065); + -moz-box-shadow: 0 1px 4px rgba(0, 0, 0, 0.065); + box-shadow: 0 1px 4px rgba(0, 0, 0, 0.065); +} + +.navbar-inner:before, +.navbar-inner:after { + display: table; + line-height: 0; + content: ""; +} + +.navbar-inner:after { + clear: both; +} + +.navbar .container { + width: auto; +} + +.nav-collapse.collapse { + height: auto; + overflow: visible; +} + +.navbar .brand { + display: block; + float: left; + padding: 10px 20px 10px; + margin-left: -20px; + font-size: 20px; + font-weight: 200; + color: #777777; + text-shadow: 0 1px 0 #ffffff; +} + +.navbar .brand:hover { + text-decoration: none; +} + +.navbar-text { + margin-bottom: 0; + line-height: 40px; + color: #777777; +} + +.navbar-link { + color: #777777; +} + +.navbar-link:hover { + color: #333333; +} + +.navbar .divider-vertical { + height: 40px; + margin: 0 9px; + border-right: 1px solid #ffffff; + border-left: 1px solid #f2f2f2; +} + +.navbar .btn, +.navbar .btn-group { + margin-top: 5px; +} + +.navbar .btn-group .btn, +.navbar .input-prepend .btn, +.navbar .input-append .btn { + margin-top: 0; +} + +.navbar-form { + margin-bottom: 0; + *zoom: 1; +} + +.navbar-form:before, +.navbar-form:after { + display: table; + line-height: 0; + content: ""; +} + +.navbar-form:after { + clear: both; +} + +.navbar-form input, +.navbar-form select, +.navbar-form .radio, +.navbar-form .checkbox { + margin-top: 5px; +} + +.navbar-form input, +.navbar-form select, +.navbar-form .btn { + display: inline-block; + margin-bottom: 0; +} + +.navbar-form input[type="image"], +.navbar-form input[type="checkbox"], +.navbar-form input[type="radio"] { + margin-top: 3px; +} + +.navbar-form .input-append, +.navbar-form .input-prepend { + margin-top: 5px; + white-space: nowrap; +} + +.navbar-form .input-append input, +.navbar-form .input-prepend input { + margin-top: 0; +} + +.navbar-search { + position: relative; + float: left; + margin-top: 5px; + margin-bottom: 0; +} + +.navbar-search .search-query { + padding: 4px 14px; + margin-bottom: 0; + font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 13px; + font-weight: normal; + line-height: 1; + -webkit-border-radius: 15px; + -moz-border-radius: 15px; + border-radius: 15px; +} + +.navbar-static-top { + position: static; + margin-bottom: 0; +} + +.navbar-static-top .navbar-inner { + -webkit-border-radius: 0; + -moz-border-radius: 0; + border-radius: 0; +} + +.navbar-fixed-top, +.navbar-fixed-bottom { + position: fixed; + right: 0; + left: 0; + z-index: 1030; + margin-bottom: 0; +} + +.navbar-fixed-top .navbar-inner, +.navbar-static-top .navbar-inner { + border-width: 0 0 1px; +} + +.navbar-fixed-bottom .navbar-inner { + border-width: 1px 0 0; +} + +.navbar-fixed-top .navbar-inner, +.navbar-fixed-bottom .navbar-inner { + padding-right: 0; + padding-left: 0; + -webkit-border-radius: 0; + -moz-border-radius: 0; + border-radius: 0; +} + +.navbar-static-top .container, +.navbar-fixed-top .container, +.navbar-fixed-bottom .container { + width: 940px; +} + +.navbar-fixed-top { + top: 0; +} + +.navbar-fixed-top .navbar-inner, +.navbar-static-top .navbar-inner { + -webkit-box-shadow: 0 1px 10px rgba(0, 0, 0, 0.1); + -moz-box-shadow: 0 1px 10px rgba(0, 0, 0, 0.1); + box-shadow: 0 1px 10px rgba(0, 0, 0, 0.1); +} + +.navbar-fixed-bottom { + bottom: 0; +} + +.navbar-fixed-bottom .navbar-inner { + -webkit-box-shadow: 0 -1px 10px rgba(0, 0, 0, 0.1); + -moz-box-shadow: 0 -1px 10px rgba(0, 0, 0, 0.1); + box-shadow: 0 -1px 10px rgba(0, 0, 0, 0.1); +} + +.navbar .nav { + position: relative; + left: 0; + display: block; + float: left; + margin: 0 10px 0 0; +} + +.navbar .nav.pull-right { + float: right; + margin-right: 0; +} + +.navbar .nav > li { + float: left; +} + +.navbar .nav > li > a { + float: none; + padding: 10px 15px 10px; + color: #777777; + text-decoration: none; + text-shadow: 0 1px 0 #ffffff; +} + +.navbar .nav .dropdown-toggle .caret { + margin-top: 8px; +} + +.navbar .nav > li > a:focus, +.navbar .nav > li > a:hover { + color: #333333; + text-decoration: none; + background-color: transparent; +} + +.navbar .nav > .active > a, +.navbar .nav > .active > a:hover, +.navbar .nav > .active > a:focus { + color: #555555; + text-decoration: none; + background-color: #e5e5e5; + -webkit-box-shadow: inset 0 3px 8px rgba(0, 0, 0, 0.125); + -moz-box-shadow: inset 0 3px 8px rgba(0, 0, 0, 0.125); + box-shadow: inset 0 3px 8px rgba(0, 0, 0, 0.125); +} + +.navbar .btn-navbar { + display: none; + float: right; + padding: 7px 10px; + margin-right: 5px; + margin-left: 5px; + color: #ffffff; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); + background-color: #ededed; + *background-color: #e5e5e5; + background-image: -moz-linear-gradient(top, #f2f2f2, #e5e5e5); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#f2f2f2), to(#e5e5e5)); + background-image: -webkit-linear-gradient(top, #f2f2f2, #e5e5e5); + background-image: -o-linear-gradient(top, #f2f2f2, #e5e5e5); + background-image: linear-gradient(to bottom, #f2f2f2, #e5e5e5); + background-repeat: repeat-x; + border-color: #e5e5e5 #e5e5e5 #bfbfbf; + border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25); + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff2f2f2', endColorstr='#ffe5e5e5', GradientType=0); + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); + -webkit-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.075); + -moz-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.075); + box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.075); +} + +.navbar .btn-navbar:hover, +.navbar .btn-navbar:active, +.navbar .btn-navbar.active, +.navbar .btn-navbar.disabled, +.navbar .btn-navbar[disabled] { + color: #ffffff; + background-color: #e5e5e5; + *background-color: #d9d9d9; +} + +.navbar .btn-navbar:active, +.navbar .btn-navbar.active { + background-color: #cccccc \9; +} + +.navbar .btn-navbar .icon-bar { + display: block; + width: 18px; + height: 2px; + background-color: #f5f5f5; + -webkit-border-radius: 1px; + -moz-border-radius: 1px; + border-radius: 1px; + -webkit-box-shadow: 0 1px 0 rgba(0, 0, 0, 0.25); + -moz-box-shadow: 0 1px 0 rgba(0, 0, 0, 0.25); + box-shadow: 0 1px 0 rgba(0, 0, 0, 0.25); +} + +.btn-navbar .icon-bar + .icon-bar { + margin-top: 3px; +} + +.navbar .nav > li > .dropdown-menu:before { + position: absolute; + top: -7px; + left: 9px; + display: inline-block; + border-right: 7px solid transparent; + border-bottom: 7px solid #ccc; + border-left: 7px solid transparent; + border-bottom-color: rgba(0, 0, 0, 0.2); + content: ''; +} + +.navbar .nav > li > .dropdown-menu:after { + position: absolute; + top: -6px; + left: 10px; + display: inline-block; + border-right: 6px solid transparent; + border-bottom: 6px solid #ffffff; + border-left: 6px solid transparent; + content: ''; +} + +.navbar-fixed-bottom .nav > li > .dropdown-menu:before { + top: auto; + bottom: -7px; + border-top: 7px solid #ccc; + border-bottom: 0; + border-top-color: rgba(0, 0, 0, 0.2); +} + +.navbar-fixed-bottom .nav > li > .dropdown-menu:after { + top: auto; + bottom: -6px; + border-top: 6px solid #ffffff; + border-bottom: 0; +} + +.navbar .nav li.dropdown > a:hover .caret { + border-top-color: #555555; + border-bottom-color: #555555; +} + +.navbar .nav li.dropdown.open > .dropdown-toggle, +.navbar .nav li.dropdown.active > .dropdown-toggle, +.navbar .nav li.dropdown.open.active > .dropdown-toggle { + color: #555555; + background-color: #e5e5e5; +} + +.navbar .nav li.dropdown > .dropdown-toggle .caret { + border-top-color: #777777; + border-bottom-color: #777777; +} + +.navbar .nav li.dropdown.open > .dropdown-toggle .caret, +.navbar .nav li.dropdown.active > .dropdown-toggle .caret, +.navbar .nav li.dropdown.open.active > .dropdown-toggle .caret { + border-top-color: #555555; + border-bottom-color: #555555; +} + +.navbar .pull-right > li > .dropdown-menu, +.navbar .nav > li > .dropdown-menu.pull-right { + right: 0; + left: auto; +} + +.navbar .pull-right > li > .dropdown-menu:before, +.navbar .nav > li > .dropdown-menu.pull-right:before { + right: 12px; + left: auto; +} + +.navbar .pull-right > li > .dropdown-menu:after, +.navbar .nav > li > .dropdown-menu.pull-right:after { + right: 13px; + left: auto; +} + +.navbar .pull-right > li > .dropdown-menu .dropdown-menu, +.navbar .nav > li > .dropdown-menu.pull-right .dropdown-menu { + right: 100%; + left: auto; + margin-right: -1px; + margin-left: 0; + -webkit-border-radius: 6px 0 6px 6px; + -moz-border-radius: 6px 0 6px 6px; + border-radius: 6px 0 6px 6px; +} + +.navbar-inverse .navbar-inner { + background-color: #1b1b1b; + background-image: -moz-linear-gradient(top, #222222, #111111); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#222222), to(#111111)); + background-image: -webkit-linear-gradient(top, #222222, #111111); + background-image: -o-linear-gradient(top, #222222, #111111); + background-image: linear-gradient(to bottom, #222222, #111111); + background-repeat: repeat-x; + border-color: #252525; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff222222', endColorstr='#ff111111', GradientType=0); +} + +.navbar-inverse .brand, +.navbar-inverse .nav > li > a { + color: #999999; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); +} + +.navbar-inverse .brand:hover, +.navbar-inverse .nav > li > a:hover { + color: #ffffff; +} + +.navbar-inverse .brand { + color: #999999; +} + +.navbar-inverse .navbar-text { + color: #999999; +} + +.navbar-inverse .nav > li > a:focus, +.navbar-inverse .nav > li > a:hover { + color: #ffffff; + background-color: transparent; +} + +.navbar-inverse .nav .active > a, +.navbar-inverse .nav .active > a:hover, +.navbar-inverse .nav .active > a:focus { + color: #ffffff; + background-color: #111111; +} + +.navbar-inverse .navbar-link { + color: #999999; +} + +.navbar-inverse .navbar-link:hover { + color: #ffffff; +} + +.navbar-inverse .divider-vertical { + border-right-color: #222222; + border-left-color: #111111; +} + +.navbar-inverse .nav li.dropdown.open > .dropdown-toggle, +.navbar-inverse .nav li.dropdown.active > .dropdown-toggle, +.navbar-inverse .nav li.dropdown.open.active > .dropdown-toggle { + color: #ffffff; + background-color: #111111; +} + +.navbar-inverse .nav li.dropdown > a:hover .caret { + border-top-color: #ffffff; + border-bottom-color: #ffffff; +} + +.navbar-inverse .nav li.dropdown > .dropdown-toggle .caret { + border-top-color: #999999; + border-bottom-color: #999999; +} + +.navbar-inverse .nav li.dropdown.open > .dropdown-toggle .caret, +.navbar-inverse .nav li.dropdown.active > .dropdown-toggle .caret, +.navbar-inverse .nav li.dropdown.open.active > .dropdown-toggle .caret { + border-top-color: #ffffff; + border-bottom-color: #ffffff; +} + +.navbar-inverse .navbar-search .search-query { + color: #ffffff; + background-color: #515151; + border-color: #111111; + -webkit-box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.1), 0 1px 0 rgba(255, 255, 255, 0.15); + -moz-box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.1), 0 1px 0 rgba(255, 255, 255, 0.15); + box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.1), 0 1px 0 rgba(255, 255, 255, 0.15); + -webkit-transition: none; + -moz-transition: none; + -o-transition: none; + transition: none; +} + +.navbar-inverse .navbar-search .search-query:-moz-placeholder { + color: #cccccc; +} + +.navbar-inverse .navbar-search .search-query:-ms-input-placeholder { + color: #cccccc; +} + +.navbar-inverse .navbar-search .search-query::-webkit-input-placeholder { + color: #cccccc; +} + +.navbar-inverse .navbar-search .search-query:focus, +.navbar-inverse .navbar-search .search-query.focused { + padding: 5px 15px; + color: #333333; + text-shadow: 0 1px 0 #ffffff; + background-color: #ffffff; + border: 0; + outline: 0; + -webkit-box-shadow: 0 0 3px rgba(0, 0, 0, 0.15); + -moz-box-shadow: 0 0 3px rgba(0, 0, 0, 0.15); + box-shadow: 0 0 3px rgba(0, 0, 0, 0.15); +} + +.navbar-inverse .btn-navbar { + color: #ffffff; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); + background-color: #0e0e0e; + *background-color: #040404; + background-image: -moz-linear-gradient(top, #151515, #040404); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#151515), to(#040404)); + background-image: -webkit-linear-gradient(top, #151515, #040404); + background-image: -o-linear-gradient(top, #151515, #040404); + background-image: linear-gradient(to bottom, #151515, #040404); + background-repeat: repeat-x; + border-color: #040404 #040404 #000000; + border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25); + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff151515', endColorstr='#ff040404', GradientType=0); + filter: progid:DXImageTransform.Microsoft.gradient(enabled=false); +} + +.navbar-inverse .btn-navbar:hover, +.navbar-inverse .btn-navbar:active, +.navbar-inverse .btn-navbar.active, +.navbar-inverse .btn-navbar.disabled, +.navbar-inverse .btn-navbar[disabled] { + color: #ffffff; + background-color: #040404; + *background-color: #000000; +} + +.navbar-inverse .btn-navbar:active, +.navbar-inverse .btn-navbar.active { + background-color: #000000 \9; +} + +.breadcrumb { + padding: 8px 15px; + margin: 0 0 20px; + list-style: none; + background-color: #f5f5f5; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; +} + +.breadcrumb > li { + display: inline-block; + *display: inline; + text-shadow: 0 1px 0 #ffffff; + *zoom: 1; +} + +.breadcrumb > li > .divider { + padding: 0 5px; + color: #ccc; +} + +.breadcrumb > .active { + color: #999999; +} + +.pagination { + margin: 20px 0; +} + +.pagination ul { + display: inline-block; + *display: inline; + margin-bottom: 0; + margin-left: 0; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; + *zoom: 1; + -webkit-box-shadow: 0 1px 2px rgba(0, 0, 0, 0.05); + -moz-box-shadow: 0 1px 2px rgba(0, 0, 0, 0.05); + box-shadow: 0 1px 2px rgba(0, 0, 0, 0.05); +} + +.pagination ul > li { + display: inline; +} + +.pagination ul > li > a, +.pagination ul > li > span { + float: left; + padding: 4px 12px; + line-height: 20px; + text-decoration: none; + background-color: #ffffff; + border: 1px solid #dddddd; + border-left-width: 0; +} + +.pagination ul > li > a:hover, +.pagination ul > .active > a, +.pagination ul > .active > span { + background-color: #f5f5f5; +} + +.pagination ul > .active > a, +.pagination ul > .active > span { + color: #999999; + cursor: default; +} + +.pagination ul > .disabled > span, +.pagination ul > .disabled > a, +.pagination ul > .disabled > a:hover { + color: #999999; + cursor: default; + background-color: transparent; +} + +.pagination ul > li:first-child > a, +.pagination ul > li:first-child > span { + border-left-width: 1px; + -webkit-border-bottom-left-radius: 4px; + border-bottom-left-radius: 4px; + -webkit-border-top-left-radius: 4px; + border-top-left-radius: 4px; + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-topleft: 4px; +} + +.pagination ul > li:last-child > a, +.pagination ul > li:last-child > span { + -webkit-border-top-right-radius: 4px; + border-top-right-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + border-bottom-right-radius: 4px; + -moz-border-radius-topright: 4px; + -moz-border-radius-bottomright: 4px; +} + +.pagination-centered { + text-align: center; +} + +.pagination-right { + text-align: right; +} + +.pagination-large ul > li > a, +.pagination-large ul > li > span { + padding: 11px 19px; + font-size: 17.5px; +} + +.pagination-large ul > li:first-child > a, +.pagination-large ul > li:first-child > span { + -webkit-border-bottom-left-radius: 6px; + border-bottom-left-radius: 6px; + -webkit-border-top-left-radius: 6px; + border-top-left-radius: 6px; + -moz-border-radius-bottomleft: 6px; + -moz-border-radius-topleft: 6px; +} + +.pagination-large ul > li:last-child > a, +.pagination-large ul > li:last-child > span { + -webkit-border-top-right-radius: 6px; + border-top-right-radius: 6px; + -webkit-border-bottom-right-radius: 6px; + border-bottom-right-radius: 6px; + -moz-border-radius-topright: 6px; + -moz-border-radius-bottomright: 6px; +} + +.pagination-mini ul > li:first-child > a, +.pagination-small ul > li:first-child > a, +.pagination-mini ul > li:first-child > span, +.pagination-small ul > li:first-child > span { + -webkit-border-bottom-left-radius: 3px; + border-bottom-left-radius: 3px; + -webkit-border-top-left-radius: 3px; + border-top-left-radius: 3px; + -moz-border-radius-bottomleft: 3px; + -moz-border-radius-topleft: 3px; +} + +.pagination-mini ul > li:last-child > a, +.pagination-small ul > li:last-child > a, +.pagination-mini ul > li:last-child > span, +.pagination-small ul > li:last-child > span { + -webkit-border-top-right-radius: 3px; + border-top-right-radius: 3px; + -webkit-border-bottom-right-radius: 3px; + border-bottom-right-radius: 3px; + -moz-border-radius-topright: 3px; + -moz-border-radius-bottomright: 3px; +} + +.pagination-small ul > li > a, +.pagination-small ul > li > span { + padding: 2px 10px; + font-size: 11.9px; +} + +.pagination-mini ul > li > a, +.pagination-mini ul > li > span { + padding: 0 6px; + font-size: 10.5px; +} + +.pager { + margin: 20px 0; + text-align: center; + list-style: none; + *zoom: 1; +} + +.pager:before, +.pager:after { + display: table; + line-height: 0; + content: ""; +} + +.pager:after { + clear: both; +} + +.pager li { + display: inline; +} + +.pager li > a, +.pager li > span { + display: inline-block; + padding: 5px 14px; + background-color: #fff; + border: 1px solid #ddd; + -webkit-border-radius: 15px; + -moz-border-radius: 15px; + border-radius: 15px; +} + +.pager li > a:hover { + text-decoration: none; + background-color: #f5f5f5; +} + +.pager .next > a, +.pager .next > span { + float: right; +} + +.pager .previous > a, +.pager .previous > span { + float: left; +} + +.pager .disabled > a, +.pager .disabled > a:hover, +.pager .disabled > span { + color: #999999; + cursor: default; + background-color: #fff; +} + +.modal-backdrop { + position: fixed; + top: 0; + right: 0; + bottom: 0; + left: 0; + z-index: 1040; + background-color: #000000; +} + +.modal-backdrop.fade { + opacity: 0; +} + +.modal-backdrop, +.modal-backdrop.fade.in { + opacity: 0.8; + filter: alpha(opacity=80); +} + +.modal { + position: fixed; + top: 10%; + left: 50%; + z-index: 1050; + width: 560px; + margin-left: -280px; + background-color: #ffffff; + border: 1px solid #999; + border: 1px solid rgba(0, 0, 0, 0.3); + *border: 1px solid #999; + -webkit-border-radius: 6px; + -moz-border-radius: 6px; + border-radius: 6px; + outline: none; + -webkit-box-shadow: 0 3px 7px rgba(0, 0, 0, 0.3); + -moz-box-shadow: 0 3px 7px rgba(0, 0, 0, 0.3); + box-shadow: 0 3px 7px rgba(0, 0, 0, 0.3); + -webkit-background-clip: padding-box; + -moz-background-clip: padding-box; + background-clip: padding-box; +} + +.modal.fade { + top: -25%; + -webkit-transition: opacity 0.3s linear, top 0.3s ease-out; + -moz-transition: opacity 0.3s linear, top 0.3s ease-out; + -o-transition: opacity 0.3s linear, top 0.3s ease-out; + transition: opacity 0.3s linear, top 0.3s ease-out; +} + +.modal.fade.in { + top: 10%; +} + +.modal-header { + padding: 9px 15px; + border-bottom: 1px solid #eee; +} + +.modal-header .close { + margin-top: 2px; +} + +.modal-header h3 { + margin: 0; + line-height: 30px; +} + +.modal-body { + position: relative; + max-height: 400px; + padding: 15px; + overflow-y: auto; +} + +.modal-form { + margin-bottom: 0; +} + +.modal-footer { + padding: 14px 15px 15px; + margin-bottom: 0; + text-align: right; + background-color: #f5f5f5; + border-top: 1px solid #ddd; + -webkit-border-radius: 0 0 6px 6px; + -moz-border-radius: 0 0 6px 6px; + border-radius: 0 0 6px 6px; + *zoom: 1; + -webkit-box-shadow: inset 0 1px 0 #ffffff; + -moz-box-shadow: inset 0 1px 0 #ffffff; + box-shadow: inset 0 1px 0 #ffffff; +} + +.modal-footer:before, +.modal-footer:after { + display: table; + line-height: 0; + content: ""; +} + +.modal-footer:after { + clear: both; +} + +.modal-footer .btn + .btn { + margin-bottom: 0; + margin-left: 5px; +} + +.modal-footer .btn-group .btn + .btn { + margin-left: -1px; +} + +.modal-footer .btn-block + .btn-block { + margin-left: 0; +} + +.tooltip { + position: absolute; + z-index: 1030; + display: block; + padding: 5px; + font-size: 11px; + opacity: 0; + filter: alpha(opacity=0); + visibility: visible; +} + +.tooltip.in { + opacity: 0.8; + filter: alpha(opacity=80); +} + +.tooltip.top { + margin-top: -3px; +} + +.tooltip.right { + margin-left: 3px; +} + +.tooltip.bottom { + margin-top: 3px; +} + +.tooltip.left { + margin-left: -3px; +} + +.tooltip-inner { + max-width: 200px; + padding: 3px 8px; + color: #ffffff; + text-align: center; + text-decoration: none; + background-color: #000000; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; +} + +.tooltip-arrow { + position: absolute; + width: 0; + height: 0; + border-color: transparent; + border-style: solid; +} + +.tooltip.top .tooltip-arrow { + bottom: 0; + left: 50%; + margin-left: -5px; + border-top-color: #000000; + border-width: 5px 5px 0; +} + +.tooltip.right .tooltip-arrow { + top: 50%; + left: 0; + margin-top: -5px; + border-right-color: #000000; + border-width: 5px 5px 5px 0; +} + +.tooltip.left .tooltip-arrow { + top: 50%; + right: 0; + margin-top: -5px; + border-left-color: #000000; + border-width: 5px 0 5px 5px; +} + +.tooltip.bottom .tooltip-arrow { + top: 0; + left: 50%; + margin-left: -5px; + border-bottom-color: #000000; + border-width: 0 5px 5px; +} + +.popover { + position: absolute; + top: 0; + left: 0; + z-index: 1010; + display: none; + width: 236px; + padding: 1px; + text-align: left; + white-space: normal; + background-color: #ffffff; + border: 1px solid #ccc; + border: 1px solid rgba(0, 0, 0, 0.2); + -webkit-border-radius: 6px; + -moz-border-radius: 6px; + border-radius: 6px; + -webkit-box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); + -moz-box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); + box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2); + -webkit-background-clip: padding-box; + -moz-background-clip: padding; + background-clip: padding-box; +} + +.popover.top { + margin-top: -10px; +} + +.popover.right { + margin-left: 10px; +} + +.popover.bottom { + margin-top: 10px; +} + +.popover.left { + margin-left: -10px; +} + +.popover-title { + padding: 8px 14px; + margin: 0; + font-size: 14px; + font-weight: normal; + line-height: 18px; + background-color: #f7f7f7; + border-bottom: 1px solid #ebebeb; + -webkit-border-radius: 5px 5px 0 0; + -moz-border-radius: 5px 5px 0 0; + border-radius: 5px 5px 0 0; +} + +.popover-content { + padding: 9px 14px; +} + +.popover .arrow, +.popover .arrow:after { + position: absolute; + display: block; + width: 0; + height: 0; + border-color: transparent; + border-style: solid; +} + +.popover .arrow { + border-width: 11px; +} + +.popover .arrow:after { + border-width: 10px; + content: ""; +} + +.popover.top .arrow { + bottom: -11px; + left: 50%; + margin-left: -11px; + border-top-color: #999; + border-top-color: rgba(0, 0, 0, 0.25); + border-bottom-width: 0; +} + +.popover.top .arrow:after { + bottom: 1px; + margin-left: -10px; + border-top-color: #ffffff; + border-bottom-width: 0; +} + +.popover.right .arrow { + top: 50%; + left: -11px; + margin-top: -11px; + border-right-color: #999; + border-right-color: rgba(0, 0, 0, 0.25); + border-left-width: 0; +} + +.popover.right .arrow:after { + bottom: -10px; + left: 1px; + border-right-color: #ffffff; + border-left-width: 0; +} + +.popover.bottom .arrow { + top: -11px; + left: 50%; + margin-left: -11px; + border-bottom-color: #999; + border-bottom-color: rgba(0, 0, 0, 0.25); + border-top-width: 0; +} + +.popover.bottom .arrow:after { + top: 1px; + margin-left: -10px; + border-bottom-color: #ffffff; + border-top-width: 0; +} + +.popover.left .arrow { + top: 50%; + right: -11px; + margin-top: -11px; + border-left-color: #999; + border-left-color: rgba(0, 0, 0, 0.25); + border-right-width: 0; +} + +.popover.left .arrow:after { + right: 1px; + bottom: -10px; + border-left-color: #ffffff; + border-right-width: 0; +} + +.thumbnails { + margin-left: -20px; + list-style: none; + *zoom: 1; +} + +.thumbnails:before, +.thumbnails:after { + display: table; + line-height: 0; + content: ""; +} + +.thumbnails:after { + clear: both; +} + +.row-fluid .thumbnails { + margin-left: 0; +} + +.thumbnails > li { + float: left; + margin-bottom: 20px; + margin-left: 20px; +} + +.thumbnail { + display: block; + padding: 4px; + line-height: 20px; + border: 1px solid #ddd; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; + -webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.055); + -moz-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.055); + box-shadow: 0 1px 3px rgba(0, 0, 0, 0.055); + -webkit-transition: all 0.2s ease-in-out; + -moz-transition: all 0.2s ease-in-out; + -o-transition: all 0.2s ease-in-out; + transition: all 0.2s ease-in-out; +} + +a.thumbnail:hover { + border-color: #0088cc; + -webkit-box-shadow: 0 1px 4px rgba(0, 105, 214, 0.25); + -moz-box-shadow: 0 1px 4px rgba(0, 105, 214, 0.25); + box-shadow: 0 1px 4px rgba(0, 105, 214, 0.25); +} + +.thumbnail > img { + display: block; + max-width: 100%; + margin-right: auto; + margin-left: auto; +} + +.thumbnail .caption { + padding: 9px; + color: #555555; +} + +.media, +.media-body { + overflow: hidden; + *overflow: visible; + zoom: 1; +} + +.media, +.media .media { + margin-top: 15px; +} + +.media:first-child { + margin-top: 0; +} + +.media-object { + display: block; +} + +.media-heading { + margin: 0 0 5px; +} + +.media .pull-left { + margin-right: 10px; +} + +.media .pull-right { + margin-left: 10px; +} + +.media-list { + margin-left: 0; + list-style: none; +} + +.label, +.badge { + display: inline-block; + padding: 2px 4px; + font-size: 11.844px; + font-weight: bold; + line-height: 14px; + color: #ffffff; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); + white-space: nowrap; + vertical-align: baseline; + background-color: #999999; +} + +.label { + -webkit-border-radius: 3px; + -moz-border-radius: 3px; + border-radius: 3px; +} + +.badge { + padding-right: 9px; + padding-left: 9px; + -webkit-border-radius: 9px; + -moz-border-radius: 9px; + border-radius: 9px; +} + +.label:empty, +.badge:empty { + display: none; +} + +a.label:hover, +a.badge:hover { + color: #ffffff; + text-decoration: none; + cursor: pointer; +} + +.label-important, +.badge-important { + background-color: #b94a48; +} + +.label-important[href], +.badge-important[href] { + background-color: #953b39; +} + +.label-warning, +.badge-warning { + background-color: #f89406; +} + +.label-warning[href], +.badge-warning[href] { + background-color: #c67605; +} + +.label-success, +.badge-success { + background-color: #468847; +} + +.label-success[href], +.badge-success[href] { + background-color: #356635; +} + +.label-info, +.badge-info { + background-color: #3a87ad; +} + +.label-info[href], +.badge-info[href] { + background-color: #2d6987; +} + +.label-inverse, +.badge-inverse { + background-color: #333333; +} + +.label-inverse[href], +.badge-inverse[href] { + background-color: #1a1a1a; +} + +.btn .label, +.btn .badge { + position: relative; + top: -1px; +} + +.btn-mini .label, +.btn-mini .badge { + top: 0; +} + +@-webkit-keyframes progress-bar-stripes { + from { + background-position: 40px 0; + } + to { + background-position: 0 0; + } +} + +@-moz-keyframes progress-bar-stripes { + from { + background-position: 40px 0; + } + to { + background-position: 0 0; + } +} + +@-ms-keyframes progress-bar-stripes { + from { + background-position: 40px 0; + } + to { + background-position: 0 0; + } +} + +@-o-keyframes progress-bar-stripes { + from { + background-position: 0 0; + } + to { + background-position: 40px 0; + } +} + +@keyframes progress-bar-stripes { + from { + background-position: 40px 0; + } + to { + background-position: 0 0; + } +} + +.progress { + height: 20px; + margin-bottom: 20px; + overflow: hidden; + background-color: #f7f7f7; + background-image: -moz-linear-gradient(top, #f5f5f5, #f9f9f9); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#f5f5f5), to(#f9f9f9)); + background-image: -webkit-linear-gradient(top, #f5f5f5, #f9f9f9); + background-image: -o-linear-gradient(top, #f5f5f5, #f9f9f9); + background-image: linear-gradient(to bottom, #f5f5f5, #f9f9f9); + background-repeat: repeat-x; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff5f5f5', endColorstr='#fff9f9f9', GradientType=0); + -webkit-box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.1); + -moz-box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.1); + box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.1); +} + +.progress .bar { + float: left; + width: 0; + height: 100%; + font-size: 12px; + color: #ffffff; + text-align: center; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25); + background-color: #0e90d2; + background-image: -moz-linear-gradient(top, #149bdf, #0480be); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#149bdf), to(#0480be)); + background-image: -webkit-linear-gradient(top, #149bdf, #0480be); + background-image: -o-linear-gradient(top, #149bdf, #0480be); + background-image: linear-gradient(to bottom, #149bdf, #0480be); + background-repeat: repeat-x; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff149bdf', endColorstr='#ff0480be', GradientType=0); + -webkit-box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.15); + -moz-box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.15); + box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.15); + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + box-sizing: border-box; + -webkit-transition: width 0.6s ease; + -moz-transition: width 0.6s ease; + -o-transition: width 0.6s ease; + transition: width 0.6s ease; +} + +.progress .bar + .bar { + -webkit-box-shadow: inset 1px 0 0 rgba(0, 0, 0, 0.15), inset 0 -1px 0 rgba(0, 0, 0, 0.15); + -moz-box-shadow: inset 1px 0 0 rgba(0, 0, 0, 0.15), inset 0 -1px 0 rgba(0, 0, 0, 0.15); + box-shadow: inset 1px 0 0 rgba(0, 0, 0, 0.15), inset 0 -1px 0 rgba(0, 0, 0, 0.15); +} + +.progress-striped .bar { + background-color: #149bdf; + background-image: -webkit-gradient(linear, 0 100%, 100% 0, color-stop(0.25, rgba(255, 255, 255, 0.15)), color-stop(0.25, transparent), color-stop(0.5, transparent), color-stop(0.5, rgba(255, 255, 255, 0.15)), color-stop(0.75, rgba(255, 255, 255, 0.15)), color-stop(0.75, transparent), to(transparent)); + background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -moz-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -o-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + -webkit-background-size: 40px 40px; + -moz-background-size: 40px 40px; + -o-background-size: 40px 40px; + background-size: 40px 40px; +} + +.progress.active .bar { + -webkit-animation: progress-bar-stripes 2s linear infinite; + -moz-animation: progress-bar-stripes 2s linear infinite; + -ms-animation: progress-bar-stripes 2s linear infinite; + -o-animation: progress-bar-stripes 2s linear infinite; + animation: progress-bar-stripes 2s linear infinite; +} + +.progress-danger .bar, +.progress .bar-danger { + background-color: #dd514c; + background-image: -moz-linear-gradient(top, #ee5f5b, #c43c35); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#ee5f5b), to(#c43c35)); + background-image: -webkit-linear-gradient(top, #ee5f5b, #c43c35); + background-image: -o-linear-gradient(top, #ee5f5b, #c43c35); + background-image: linear-gradient(to bottom, #ee5f5b, #c43c35); + background-repeat: repeat-x; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffee5f5b', endColorstr='#ffc43c35', GradientType=0); +} + +.progress-danger.progress-striped .bar, +.progress-striped .bar-danger { + background-color: #ee5f5b; + background-image: -webkit-gradient(linear, 0 100%, 100% 0, color-stop(0.25, rgba(255, 255, 255, 0.15)), color-stop(0.25, transparent), color-stop(0.5, transparent), color-stop(0.5, rgba(255, 255, 255, 0.15)), color-stop(0.75, rgba(255, 255, 255, 0.15)), color-stop(0.75, transparent), to(transparent)); + background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -moz-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -o-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); +} + +.progress-success .bar, +.progress .bar-success { + background-color: #5eb95e; + background-image: -moz-linear-gradient(top, #62c462, #57a957); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#62c462), to(#57a957)); + background-image: -webkit-linear-gradient(top, #62c462, #57a957); + background-image: -o-linear-gradient(top, #62c462, #57a957); + background-image: linear-gradient(to bottom, #62c462, #57a957); + background-repeat: repeat-x; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff62c462', endColorstr='#ff57a957', GradientType=0); +} + +.progress-success.progress-striped .bar, +.progress-striped .bar-success { + background-color: #62c462; + background-image: -webkit-gradient(linear, 0 100%, 100% 0, color-stop(0.25, rgba(255, 255, 255, 0.15)), color-stop(0.25, transparent), color-stop(0.5, transparent), color-stop(0.5, rgba(255, 255, 255, 0.15)), color-stop(0.75, rgba(255, 255, 255, 0.15)), color-stop(0.75, transparent), to(transparent)); + background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -moz-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -o-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); +} + +.progress-info .bar, +.progress .bar-info { + background-color: #4bb1cf; + background-image: -moz-linear-gradient(top, #5bc0de, #339bb9); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#5bc0de), to(#339bb9)); + background-image: -webkit-linear-gradient(top, #5bc0de, #339bb9); + background-image: -o-linear-gradient(top, #5bc0de, #339bb9); + background-image: linear-gradient(to bottom, #5bc0de, #339bb9); + background-repeat: repeat-x; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff5bc0de', endColorstr='#ff339bb9', GradientType=0); +} + +.progress-info.progress-striped .bar, +.progress-striped .bar-info { + background-color: #5bc0de; + background-image: -webkit-gradient(linear, 0 100%, 100% 0, color-stop(0.25, rgba(255, 255, 255, 0.15)), color-stop(0.25, transparent), color-stop(0.5, transparent), color-stop(0.5, rgba(255, 255, 255, 0.15)), color-stop(0.75, rgba(255, 255, 255, 0.15)), color-stop(0.75, transparent), to(transparent)); + background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -moz-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -o-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); +} + +.progress-warning .bar, +.progress .bar-warning { + background-color: #faa732; + background-image: -moz-linear-gradient(top, #fbb450, #f89406); + background-image: -webkit-gradient(linear, 0 0, 0 100%, from(#fbb450), to(#f89406)); + background-image: -webkit-linear-gradient(top, #fbb450, #f89406); + background-image: -o-linear-gradient(top, #fbb450, #f89406); + background-image: linear-gradient(to bottom, #fbb450, #f89406); + background-repeat: repeat-x; + filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#fffbb450', endColorstr='#fff89406', GradientType=0); +} + +.progress-warning.progress-striped .bar, +.progress-striped .bar-warning { + background-color: #fbb450; + background-image: -webkit-gradient(linear, 0 100%, 100% 0, color-stop(0.25, rgba(255, 255, 255, 0.15)), color-stop(0.25, transparent), color-stop(0.5, transparent), color-stop(0.5, rgba(255, 255, 255, 0.15)), color-stop(0.75, rgba(255, 255, 255, 0.15)), color-stop(0.75, transparent), to(transparent)); + background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -moz-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: -o-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); + background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent); +} + +.accordion { + margin-bottom: 20px; +} + +.accordion-group { + margin-bottom: 2px; + border: 1px solid #e5e5e5; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; +} + +.accordion-heading { + border-bottom: 0; +} + +.accordion-heading .accordion-toggle { + display: block; + padding: 8px 15px; +} + +.accordion-toggle { + cursor: pointer; +} + +.accordion-inner { + padding: 9px 15px; + border-top: 1px solid #e5e5e5; +} + +.carousel { + position: relative; + margin-bottom: 20px; + line-height: 1; +} + +.carousel-inner { + position: relative; + width: 100%; + overflow: hidden; +} + +.carousel-inner > .item { + position: relative; + display: none; + -webkit-transition: 0.6s ease-in-out left; + -moz-transition: 0.6s ease-in-out left; + -o-transition: 0.6s ease-in-out left; + transition: 0.6s ease-in-out left; +} + +.carousel-inner > .item > img { + display: block; + line-height: 1; +} + +.carousel-inner > .active, +.carousel-inner > .next, +.carousel-inner > .prev { + display: block; +} + +.carousel-inner > .active { + left: 0; +} + +.carousel-inner > .next, +.carousel-inner > .prev { + position: absolute; + top: 0; + width: 100%; +} + +.carousel-inner > .next { + left: 100%; +} + +.carousel-inner > .prev { + left: -100%; +} + +.carousel-inner > .next.left, +.carousel-inner > .prev.right { + left: 0; +} + +.carousel-inner > .active.left { + left: -100%; +} + +.carousel-inner > .active.right { + left: 100%; +} + +.carousel-control { + position: absolute; + top: 40%; + left: 15px; + width: 40px; + height: 40px; + margin-top: -20px; + font-size: 60px; + font-weight: 100; + line-height: 30px; + color: #ffffff; + text-align: center; + background: #222222; + border: 3px solid #ffffff; + -webkit-border-radius: 23px; + -moz-border-radius: 23px; + border-radius: 23px; + opacity: 0.5; + filter: alpha(opacity=50); +} + +.carousel-control.right { + right: 15px; + left: auto; +} + +.carousel-control:hover { + color: #ffffff; + text-decoration: none; + opacity: 0.9; + filter: alpha(opacity=90); +} + +.carousel-caption { + position: absolute; + right: 0; + bottom: 0; + left: 0; + padding: 15px; + background: #333333; + background: rgba(0, 0, 0, 0.75); +} + +.carousel-caption h4, +.carousel-caption p { + line-height: 20px; + color: #ffffff; +} + +.carousel-caption h4 { + margin: 0 0 5px; +} + +.carousel-caption p { + margin-bottom: 0; +} + +.hero-unit { + padding: 60px; + margin-bottom: 30px; + font-size: 18px; + font-weight: 200; + line-height: 30px; + color: inherit; + background-color: #eeeeee; + -webkit-border-radius: 6px; + -moz-border-radius: 6px; + border-radius: 6px; +} + +.hero-unit h1 { + margin-bottom: 0; + font-size: 60px; + line-height: 1; + letter-spacing: -1px; + color: inherit; +} + +.hero-unit li { + line-height: 30px; +} + +.pull-right { + float: right; +} + +.pull-left { + float: left; +} + +.hide { + display: none; +} + +.show { + display: block; +} + +.invisible { + visibility: hidden; +} + +.affix { + position: fixed; +} diff --git a/plugin/mindmap/edit-mindmap/vendor/css/bootstrap.min.css b/plugin/mindmap/edit-mindmap/vendor/css/bootstrap.min.css new file mode 100644 index 000000000..140f731df --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/css/bootstrap.min.css @@ -0,0 +1,9 @@ +/*! + * Bootstrap v2.2.2 + * + * Copyright 2012 Twitter, Inc + * Licensed under the Apache License v2.0 + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Designed and built with all the love in the world @twitter by @mdo and @fat. + */article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}audio:not([controls]){display:none}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}a:focus{outline:thin dotted #333;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}a:hover,a:active{outline:0}sub,sup{position:relative;font-size:75%;line-height:0;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{width:auto\9;height:auto;max-width:100%;vertical-align:middle;border:0;-ms-interpolation-mode:bicubic}#map_canvas img,.google-maps img{max-width:none}button,input,select,textarea{margin:0;font-size:100%;vertical-align:middle}button,input{*overflow:visible;line-height:normal}button::-moz-focus-inner,input::-moz-focus-inner{padding:0;border:0}button,html input[type="button"],input[type="reset"],input[type="submit"]{cursor:pointer;-webkit-appearance:button}label,select,button,input[type="button"],input[type="reset"],input[type="submit"],input[type="radio"],input[type="checkbox"]{cursor:pointer}input[type="search"]{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;-webkit-appearance:textfield}input[type="search"]::-webkit-search-decoration,input[type="search"]::-webkit-search-cancel-button{-webkit-appearance:none}textarea{overflow:auto;vertical-align:top}@media print{*{color:#000!important;text-shadow:none!important;background:transparent!important;box-shadow:none!important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}p,h2,h3{orphans:3;widows:3}h2,h3{page-break-after:avoid}}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;line-height:0;content:""}.clearfix:after{clear:both}.hide-text{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.input-block-level{display:block;width:100%;min-height:30px;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}body{margin:0;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;line-height:20px;color:#333;background-color:#fff}a{color:#08c;text-decoration:none}a:hover{color:#005580;text-decoration:underline}.img-rounded{-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px}.img-polaroid{padding:4px;background-color:#fff;border:1px solid #ccc;border:1px solid rgba(0,0,0,0.2);-webkit-box-shadow:0 1px 3px rgba(0,0,0,0.1);-moz-box-shadow:0 1px 3px rgba(0,0,0,0.1);box-shadow:0 1px 3px rgba(0,0,0,0.1)}.img-circle{-webkit-border-radius:500px;-moz-border-radius:500px;border-radius:500px}.row{margin-left:-20px;*zoom:1}.row:before,.row:after{display:table;line-height:0;content:""}.row:after{clear:both}[class*="span"]{float:left;min-height:1px;margin-left:20px}.container,.navbar-static-top .container,.navbar-fixed-top .container,.navbar-fixed-bottom .container{width:940px}.span12{width:940px}.span11{width:860px}.span10{width:780px}.span9{width:700px}.span8{width:620px}.span7{width:540px}.span6{width:460px}.span5{width:380px}.span4{width:300px}.span3{width:220px}.span2{width:140px}.span1{width:60px}.offset12{margin-left:980px}.offset11{margin-left:900px}.offset10{margin-left:820px}.offset9{margin-left:740px}.offset8{margin-left:660px}.offset7{margin-left:580px}.offset6{margin-left:500px}.offset5{margin-left:420px}.offset4{margin-left:340px}.offset3{margin-left:260px}.offset2{margin-left:180px}.offset1{margin-left:100px}.row-fluid{width:100%;*zoom:1}.row-fluid:before,.row-fluid:after{display:table;line-height:0;content:""}.row-fluid:after{clear:both}.row-fluid [class*="span"]{display:block;float:left;width:100%;min-height:30px;margin-left:2.127659574468085%;*margin-left:2.074468085106383%;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.row-fluid [class*="span"]:first-child{margin-left:0}.row-fluid .controls-row [class*="span"]+[class*="span"]{margin-left:2.127659574468085%}.row-fluid .span12{width:100%;*width:99.94680851063829%}.row-fluid .span11{width:91.48936170212765%;*width:91.43617021276594%}.row-fluid .span10{width:82.97872340425532%;*width:82.92553191489361%}.row-fluid .span9{width:74.46808510638297%;*width:74.41489361702126%}.row-fluid .span8{width:65.95744680851064%;*width:65.90425531914893%}.row-fluid .span7{width:57.44680851063829%;*width:57.39361702127659%}.row-fluid .span6{width:48.93617021276595%;*width:48.88297872340425%}.row-fluid .span5{width:40.42553191489362%;*width:40.37234042553192%}.row-fluid .span4{width:31.914893617021278%;*width:31.861702127659576%}.row-fluid .span3{width:23.404255319148934%;*width:23.351063829787233%}.row-fluid .span2{width:14.893617021276595%;*width:14.840425531914894%}.row-fluid .span1{width:6.382978723404255%;*width:6.329787234042553%}.row-fluid .offset12{margin-left:104.25531914893617%;*margin-left:104.14893617021275%}.row-fluid .offset12:first-child{margin-left:102.12765957446808%;*margin-left:102.02127659574467%}.row-fluid .offset11{margin-left:95.74468085106382%;*margin-left:95.6382978723404%}.row-fluid .offset11:first-child{margin-left:93.61702127659574%;*margin-left:93.51063829787232%}.row-fluid .offset10{margin-left:87.23404255319149%;*margin-left:87.12765957446807%}.row-fluid .offset10:first-child{margin-left:85.1063829787234%;*margin-left:84.99999999999999%}.row-fluid .offset9{margin-left:78.72340425531914%;*margin-left:78.61702127659572%}.row-fluid .offset9:first-child{margin-left:76.59574468085106%;*margin-left:76.48936170212764%}.row-fluid .offset8{margin-left:70.2127659574468%;*margin-left:70.10638297872339%}.row-fluid .offset8:first-child{margin-left:68.08510638297872%;*margin-left:67.9787234042553%}.row-fluid .offset7{margin-left:61.70212765957446%;*margin-left:61.59574468085106%}.row-fluid .offset7:first-child{margin-left:59.574468085106375%;*margin-left:59.46808510638297%}.row-fluid .offset6{margin-left:53.191489361702125%;*margin-left:53.085106382978715%}.row-fluid .offset6:first-child{margin-left:51.063829787234035%;*margin-left:50.95744680851063%}.row-fluid .offset5{margin-left:44.68085106382979%;*margin-left:44.57446808510638%}.row-fluid .offset5:first-child{margin-left:42.5531914893617%;*margin-left:42.4468085106383%}.row-fluid .offset4{margin-left:36.170212765957444%;*margin-left:36.06382978723405%}.row-fluid .offset4:first-child{margin-left:34.04255319148936%;*margin-left:33.93617021276596%}.row-fluid .offset3{margin-left:27.659574468085104%;*margin-left:27.5531914893617%}.row-fluid .offset3:first-child{margin-left:25.53191489361702%;*margin-left:25.425531914893618%}.row-fluid .offset2{margin-left:19.148936170212764%;*margin-left:19.04255319148936%}.row-fluid .offset2:first-child{margin-left:17.02127659574468%;*margin-left:16.914893617021278%}.row-fluid .offset1{margin-left:10.638297872340425%;*margin-left:10.53191489361702%}.row-fluid .offset1:first-child{margin-left:8.51063829787234%;*margin-left:8.404255319148938%}[class*="span"].hide,.row-fluid [class*="span"].hide{display:none}[class*="span"].pull-right,.row-fluid [class*="span"].pull-right{float:right}.container{margin-right:auto;margin-left:auto;*zoom:1}.container:before,.container:after{display:table;line-height:0;content:""}.container:after{clear:both}.container-fluid{padding-right:20px;padding-left:20px;*zoom:1}.container-fluid:before,.container-fluid:after{display:table;line-height:0;content:""}.container-fluid:after{clear:both}p{margin:0 0 10px}.lead{margin-bottom:20px;font-size:21px;font-weight:200;line-height:30px}small{font-size:85%}strong{font-weight:bold}em{font-style:italic}cite{font-style:normal}.muted{color:#999}a.muted:hover{color:#808080}.text-warning{color:#c09853}a.text-warning:hover{color:#a47e3c}.text-error{color:#b94a48}a.text-error:hover{color:#953b39}.text-info{color:#3a87ad}a.text-info:hover{color:#2d6987}.text-success{color:#468847}a.text-success:hover{color:#356635}h1,h2,h3,h4,h5,h6{margin:10px 0;font-family:inherit;font-weight:bold;line-height:20px;color:inherit;text-rendering:optimizelegibility}h1 small,h2 small,h3 small,h4 small,h5 small,h6 small{font-weight:normal;line-height:1;color:#999}h1,h2,h3{line-height:40px}h1{font-size:38.5px}h2{font-size:31.5px}h3{font-size:24.5px}h4{font-size:17.5px}h5{font-size:14px}h6{font-size:11.9px}h1 small{font-size:24.5px}h2 small{font-size:17.5px}h3 small{font-size:14px}h4 small{font-size:14px}.page-header{padding-bottom:9px;margin:20px 0 30px;border-bottom:1px solid #eee}ul,ol{padding:0;margin:0 0 10px 25px}ul ul,ul ol,ol ol,ol ul{margin-bottom:0}li{line-height:20px}ul.unstyled,ol.unstyled{margin-left:0;list-style:none}ul.inline,ol.inline{margin-left:0;list-style:none}ul.inline>li,ol.inline>li{display:inline-block;padding-right:5px;padding-left:5px}dl{margin-bottom:20px}dt,dd{line-height:20px}dt{font-weight:bold}dd{margin-left:10px}.dl-horizontal{*zoom:1}.dl-horizontal:before,.dl-horizontal:after{display:table;line-height:0;content:""}.dl-horizontal:after{clear:both}.dl-horizontal dt{float:left;width:160px;overflow:hidden;clear:left;text-align:right;text-overflow:ellipsis;white-space:nowrap}.dl-horizontal dd{margin-left:180px}hr{margin:20px 0;border:0;border-top:1px solid #eee;border-bottom:1px solid #fff}abbr[title],abbr[data-original-title]{cursor:help;border-bottom:1px dotted #999}abbr.initialism{font-size:90%;text-transform:uppercase}blockquote{padding:0 0 0 15px;margin:0 0 20px;border-left:5px solid #eee}blockquote p{margin-bottom:0;font-size:16px;font-weight:300;line-height:25px}blockquote small{display:block;line-height:20px;color:#999}blockquote small:before{content:'\2014 \00A0'}blockquote.pull-right{float:right;padding-right:15px;padding-left:0;border-right:5px solid #eee;border-left:0}blockquote.pull-right p,blockquote.pull-right small{text-align:right}blockquote.pull-right small:before{content:''}blockquote.pull-right small:after{content:'\00A0 \2014'}q:before,q:after,blockquote:before,blockquote:after{content:""}address{display:block;margin-bottom:20px;font-style:normal;line-height:20px}code,pre{padding:0 3px 2px;font-family:Monaco,Menlo,Consolas,"Courier New",monospace;font-size:12px;color:#333;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px}code{padding:2px 4px;color:#d14;white-space:nowrap;background-color:#f7f7f9;border:1px solid #e1e1e8}pre{display:block;padding:9.5px;margin:0 0 10px;font-size:13px;line-height:20px;word-break:break-all;word-wrap:break-word;white-space:pre;white-space:pre-wrap;background-color:#f5f5f5;border:1px solid #ccc;border:1px solid rgba(0,0,0,0.15);-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px}pre.prettyprint{margin-bottom:20px}pre code{padding:0;color:inherit;white-space:pre;white-space:pre-wrap;background-color:transparent;border:0}.pre-scrollable{max-height:340px;overflow-y:scroll}form{margin:0 0 20px}fieldset{padding:0;margin:0;border:0}legend{display:block;width:100%;padding:0;margin-bottom:20px;font-size:21px;line-height:40px;color:#333;border:0;border-bottom:1px solid #e5e5e5}legend small{font-size:15px;color:#999}label,input,button,select,textarea{font-size:14px;font-weight:normal;line-height:20px}input,button,select,textarea{font-family:"Helvetica Neue",Helvetica,Arial,sans-serif}label{display:block;margin-bottom:5px}select,textarea,input[type="text"],input[type="password"],input[type="datetime"],input[type="datetime-local"],input[type="date"],input[type="month"],input[type="time"],input[type="week"],input[type="number"],input[type="email"],input[type="url"],input[type="search"],input[type="tel"],input[type="color"],.uneditable-input{display:inline-block;height:20px;padding:4px 6px;margin-bottom:10px;font-size:14px;line-height:20px;color:#555;vertical-align:middle;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px}input,textarea,.uneditable-input{width:206px}textarea{height:auto}textarea,input[type="text"],input[type="password"],input[type="datetime"],input[type="datetime-local"],input[type="date"],input[type="month"],input[type="time"],input[type="week"],input[type="number"],input[type="email"],input[type="url"],input[type="search"],input[type="tel"],input[type="color"],.uneditable-input{background-color:#fff;border:1px solid #ccc;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-webkit-transition:border linear .2s,box-shadow linear .2s;-moz-transition:border linear .2s,box-shadow linear .2s;-o-transition:border linear .2s,box-shadow linear .2s;transition:border linear .2s,box-shadow linear .2s}textarea:focus,input[type="text"]:focus,input[type="password"]:focus,input[type="datetime"]:focus,input[type="datetime-local"]:focus,input[type="date"]:focus,input[type="month"]:focus,input[type="time"]:focus,input[type="week"]:focus,input[type="number"]:focus,input[type="email"]:focus,input[type="url"]:focus,input[type="search"]:focus,input[type="tel"]:focus,input[type="color"]:focus,.uneditable-input:focus{border-color:rgba(82,168,236,0.8);outline:0;outline:thin dotted \9;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(82,168,236,0.6);-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(82,168,236,0.6);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 8px rgba(82,168,236,0.6)}input[type="radio"],input[type="checkbox"]{margin:4px 0 0;margin-top:1px \9;*margin-top:0;line-height:normal}input[type="file"],input[type="image"],input[type="submit"],input[type="reset"],input[type="button"],input[type="radio"],input[type="checkbox"]{width:auto}select,input[type="file"]{height:30px;*margin-top:4px;line-height:30px}select{width:220px;background-color:#fff;border:1px solid #ccc}select[multiple],select[size]{height:auto}select:focus,input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted #333;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.uneditable-input,.uneditable-textarea{color:#999;cursor:not-allowed;background-color:#fcfcfc;border-color:#ccc;-webkit-box-shadow:inset 0 1px 2px rgba(0,0,0,0.025);-moz-box-shadow:inset 0 1px 2px rgba(0,0,0,0.025);box-shadow:inset 0 1px 2px rgba(0,0,0,0.025)}.uneditable-input{overflow:hidden;white-space:nowrap}.uneditable-textarea{width:auto;height:auto}input:-moz-placeholder,textarea:-moz-placeholder{color:#999}input:-ms-input-placeholder,textarea:-ms-input-placeholder{color:#999}input::-webkit-input-placeholder,textarea::-webkit-input-placeholder{color:#999}.radio,.checkbox{min-height:20px;padding-left:20px}.radio input[type="radio"],.checkbox input[type="checkbox"]{float:left;margin-left:-20px}.controls>.radio:first-child,.controls>.checkbox:first-child{padding-top:5px}.radio.inline,.checkbox.inline{display:inline-block;padding-top:5px;margin-bottom:0;vertical-align:middle}.radio.inline+.radio.inline,.checkbox.inline+.checkbox.inline{margin-left:10px}.input-mini{width:60px}.input-small{width:90px}.input-medium{width:150px}.input-large{width:210px}.input-xlarge{width:270px}.input-xxlarge{width:530px}input[class*="span"],select[class*="span"],textarea[class*="span"],.uneditable-input[class*="span"],.row-fluid input[class*="span"],.row-fluid select[class*="span"],.row-fluid textarea[class*="span"],.row-fluid .uneditable-input[class*="span"]{float:none;margin-left:0}.input-append input[class*="span"],.input-append .uneditable-input[class*="span"],.input-prepend input[class*="span"],.input-prepend .uneditable-input[class*="span"],.row-fluid input[class*="span"],.row-fluid select[class*="span"],.row-fluid textarea[class*="span"],.row-fluid .uneditable-input[class*="span"],.row-fluid .input-prepend [class*="span"],.row-fluid .input-append [class*="span"]{display:inline-block}input,textarea,.uneditable-input{margin-left:0}.controls-row [class*="span"]+[class*="span"]{margin-left:20px}input.span12,textarea.span12,.uneditable-input.span12{width:926px}input.span11,textarea.span11,.uneditable-input.span11{width:846px}input.span10,textarea.span10,.uneditable-input.span10{width:766px}input.span9,textarea.span9,.uneditable-input.span9{width:686px}input.span8,textarea.span8,.uneditable-input.span8{width:606px}input.span7,textarea.span7,.uneditable-input.span7{width:526px}input.span6,textarea.span6,.uneditable-input.span6{width:446px}input.span5,textarea.span5,.uneditable-input.span5{width:366px}input.span4,textarea.span4,.uneditable-input.span4{width:286px}input.span3,textarea.span3,.uneditable-input.span3{width:206px}input.span2,textarea.span2,.uneditable-input.span2{width:126px}input.span1,textarea.span1,.uneditable-input.span1{width:46px}.controls-row{*zoom:1}.controls-row:before,.controls-row:after{display:table;line-height:0;content:""}.controls-row:after{clear:both}.controls-row [class*="span"],.row-fluid .controls-row [class*="span"]{float:left}.controls-row .checkbox[class*="span"],.controls-row .radio[class*="span"]{padding-top:5px}input[disabled],select[disabled],textarea[disabled],input[readonly],select[readonly],textarea[readonly]{cursor:not-allowed;background-color:#eee}input[type="radio"][disabled],input[type="checkbox"][disabled],input[type="radio"][readonly],input[type="checkbox"][readonly]{background-color:transparent}.control-group.warning .control-label,.control-group.warning .help-block,.control-group.warning .help-inline{color:#c09853}.control-group.warning .checkbox,.control-group.warning .radio,.control-group.warning input,.control-group.warning select,.control-group.warning textarea{color:#c09853}.control-group.warning input,.control-group.warning select,.control-group.warning textarea{border-color:#c09853;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.control-group.warning input:focus,.control-group.warning select:focus,.control-group.warning textarea:focus{border-color:#a47e3c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #dbc59e;-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #dbc59e;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #dbc59e}.control-group.warning .input-prepend .add-on,.control-group.warning .input-append .add-on{color:#c09853;background-color:#fcf8e3;border-color:#c09853}.control-group.error .control-label,.control-group.error .help-block,.control-group.error .help-inline{color:#b94a48}.control-group.error .checkbox,.control-group.error .radio,.control-group.error input,.control-group.error select,.control-group.error textarea{color:#b94a48}.control-group.error input,.control-group.error select,.control-group.error textarea{border-color:#b94a48;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.control-group.error input:focus,.control-group.error select:focus,.control-group.error textarea:focus{border-color:#953b39;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #d59392;-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #d59392;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #d59392}.control-group.error .input-prepend .add-on,.control-group.error .input-append .add-on{color:#b94a48;background-color:#f2dede;border-color:#b94a48}.control-group.success .control-label,.control-group.success .help-block,.control-group.success .help-inline{color:#468847}.control-group.success .checkbox,.control-group.success .radio,.control-group.success input,.control-group.success select,.control-group.success textarea{color:#468847}.control-group.success input,.control-group.success select,.control-group.success textarea{border-color:#468847;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.control-group.success input:focus,.control-group.success select:focus,.control-group.success textarea:focus{border-color:#356635;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #7aba7b;-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #7aba7b;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #7aba7b}.control-group.success .input-prepend .add-on,.control-group.success .input-append .add-on{color:#468847;background-color:#dff0d8;border-color:#468847}.control-group.info .control-label,.control-group.info .help-block,.control-group.info .help-inline{color:#3a87ad}.control-group.info .checkbox,.control-group.info .radio,.control-group.info input,.control-group.info select,.control-group.info textarea{color:#3a87ad}.control-group.info input,.control-group.info select,.control-group.info textarea{border-color:#3a87ad;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.control-group.info input:focus,.control-group.info select:focus,.control-group.info textarea:focus{border-color:#2d6987;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #7ab5d3;-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #7ab5d3;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #7ab5d3}.control-group.info .input-prepend .add-on,.control-group.info .input-append .add-on{color:#3a87ad;background-color:#d9edf7;border-color:#3a87ad}input:focus:invalid,textarea:focus:invalid,select:focus:invalid{color:#b94a48;border-color:#ee5f5b}input:focus:invalid:focus,textarea:focus:invalid:focus,select:focus:invalid:focus{border-color:#e9322d;-webkit-box-shadow:0 0 6px #f8b9b7;-moz-box-shadow:0 0 6px #f8b9b7;box-shadow:0 0 6px #f8b9b7}.form-actions{padding:19px 20px 20px;margin-top:20px;margin-bottom:20px;background-color:#f5f5f5;border-top:1px solid #e5e5e5;*zoom:1}.form-actions:before,.form-actions:after{display:table;line-height:0;content:""}.form-actions:after{clear:both}.help-block,.help-inline{color:#595959}.help-block{display:block;margin-bottom:10px}.help-inline{display:inline-block;*display:inline;padding-left:5px;vertical-align:middle;*zoom:1}.input-append,.input-prepend{margin-bottom:5px;font-size:0;white-space:nowrap}.input-append input,.input-prepend input,.input-append select,.input-prepend select,.input-append .uneditable-input,.input-prepend .uneditable-input,.input-append .dropdown-menu,.input-prepend .dropdown-menu{font-size:14px}.input-append input,.input-prepend input,.input-append select,.input-prepend select,.input-append .uneditable-input,.input-prepend .uneditable-input{position:relative;margin-bottom:0;*margin-left:0;vertical-align:top;-webkit-border-radius:0 4px 4px 0;-moz-border-radius:0 4px 4px 0;border-radius:0 4px 4px 0}.input-append input:focus,.input-prepend input:focus,.input-append select:focus,.input-prepend select:focus,.input-append .uneditable-input:focus,.input-prepend .uneditable-input:focus{z-index:2}.input-append .add-on,.input-prepend .add-on{display:inline-block;width:auto;height:20px;min-width:16px;padding:4px 5px;font-size:14px;font-weight:normal;line-height:20px;text-align:center;text-shadow:0 1px 0 #fff;background-color:#eee;border:1px solid #ccc}.input-append .add-on,.input-prepend .add-on,.input-append .btn,.input-prepend .btn,.input-append .btn-group>.dropdown-toggle,.input-prepend .btn-group>.dropdown-toggle{vertical-align:top;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.input-append .active,.input-prepend .active{background-color:#a9dba9;border-color:#46a546}.input-prepend .add-on,.input-prepend .btn{margin-right:-1px}.input-prepend .add-on:first-child,.input-prepend .btn:first-child{-webkit-border-radius:4px 0 0 4px;-moz-border-radius:4px 0 0 4px;border-radius:4px 0 0 4px}.input-append input,.input-append select,.input-append .uneditable-input{-webkit-border-radius:4px 0 0 4px;-moz-border-radius:4px 0 0 4px;border-radius:4px 0 0 4px}.input-append input+.btn-group .btn:last-child,.input-append select+.btn-group .btn:last-child,.input-append .uneditable-input+.btn-group .btn:last-child{-webkit-border-radius:0 4px 4px 0;-moz-border-radius:0 4px 4px 0;border-radius:0 4px 4px 0}.input-append .add-on,.input-append .btn,.input-append .btn-group{margin-left:-1px}.input-append .add-on:last-child,.input-append .btn:last-child,.input-append .btn-group:last-child>.dropdown-toggle{-webkit-border-radius:0 4px 4px 0;-moz-border-radius:0 4px 4px 0;border-radius:0 4px 4px 0}.input-prepend.input-append input,.input-prepend.input-append select,.input-prepend.input-append .uneditable-input{-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.input-prepend.input-append input+.btn-group .btn,.input-prepend.input-append select+.btn-group .btn,.input-prepend.input-append .uneditable-input+.btn-group .btn{-webkit-border-radius:0 4px 4px 0;-moz-border-radius:0 4px 4px 0;border-radius:0 4px 4px 0}.input-prepend.input-append .add-on:first-child,.input-prepend.input-append .btn:first-child{margin-right:-1px;-webkit-border-radius:4px 0 0 4px;-moz-border-radius:4px 0 0 4px;border-radius:4px 0 0 4px}.input-prepend.input-append .add-on:last-child,.input-prepend.input-append .btn:last-child{margin-left:-1px;-webkit-border-radius:0 4px 4px 0;-moz-border-radius:0 4px 4px 0;border-radius:0 4px 4px 0}.input-prepend.input-append .btn-group:first-child{margin-left:0}input.search-query{padding-right:14px;padding-right:4px \9;padding-left:14px;padding-left:4px \9;margin-bottom:0;-webkit-border-radius:15px;-moz-border-radius:15px;border-radius:15px}.form-search .input-append .search-query,.form-search .input-prepend .search-query{-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.form-search .input-append .search-query{-webkit-border-radius:14px 0 0 14px;-moz-border-radius:14px 0 0 14px;border-radius:14px 0 0 14px}.form-search .input-append .btn{-webkit-border-radius:0 14px 14px 0;-moz-border-radius:0 14px 14px 0;border-radius:0 14px 14px 0}.form-search .input-prepend .search-query{-webkit-border-radius:0 14px 14px 0;-moz-border-radius:0 14px 14px 0;border-radius:0 14px 14px 0}.form-search .input-prepend .btn{-webkit-border-radius:14px 0 0 14px;-moz-border-radius:14px 0 0 14px;border-radius:14px 0 0 14px}.form-search input,.form-inline input,.form-horizontal input,.form-search textarea,.form-inline textarea,.form-horizontal textarea,.form-search select,.form-inline select,.form-horizontal select,.form-search .help-inline,.form-inline .help-inline,.form-horizontal .help-inline,.form-search .uneditable-input,.form-inline .uneditable-input,.form-horizontal .uneditable-input,.form-search .input-prepend,.form-inline .input-prepend,.form-horizontal .input-prepend,.form-search .input-append,.form-inline .input-append,.form-horizontal .input-append{display:inline-block;*display:inline;margin-bottom:0;vertical-align:middle;*zoom:1}.form-search .hide,.form-inline .hide,.form-horizontal .hide{display:none}.form-search label,.form-inline label,.form-search .btn-group,.form-inline .btn-group{display:inline-block}.form-search .input-append,.form-inline .input-append,.form-search .input-prepend,.form-inline .input-prepend{margin-bottom:0}.form-search .radio,.form-search .checkbox,.form-inline .radio,.form-inline .checkbox{padding-left:0;margin-bottom:0;vertical-align:middle}.form-search .radio input[type="radio"],.form-search .checkbox input[type="checkbox"],.form-inline .radio input[type="radio"],.form-inline .checkbox input[type="checkbox"]{float:left;margin-right:3px;margin-left:0}.control-group{margin-bottom:10px}legend+.control-group{margin-top:20px;-webkit-margin-top-collapse:separate}.form-horizontal .control-group{margin-bottom:20px;*zoom:1}.form-horizontal .control-group:before,.form-horizontal .control-group:after{display:table;line-height:0;content:""}.form-horizontal .control-group:after{clear:both}.form-horizontal .control-label{float:left;width:160px;padding-top:5px;text-align:right}.form-horizontal .controls{*display:inline-block;*padding-left:20px;margin-left:180px;*margin-left:0}.form-horizontal .controls:first-child{*padding-left:180px}.form-horizontal .help-block{margin-bottom:0}.form-horizontal input+.help-block,.form-horizontal select+.help-block,.form-horizontal textarea+.help-block,.form-horizontal .uneditable-input+.help-block,.form-horizontal .input-prepend+.help-block,.form-horizontal .input-append+.help-block{margin-top:10px}.form-horizontal .form-actions{padding-left:180px}table{max-width:100%;background-color:transparent;border-collapse:collapse;border-spacing:0}.table{width:100%;margin-bottom:20px}.table th,.table td{padding:8px;line-height:20px;text-align:left;vertical-align:top;border-top:1px solid #ddd}.table th{font-weight:bold}.table thead th{vertical-align:bottom}.table caption+thead tr:first-child th,.table caption+thead tr:first-child td,.table colgroup+thead tr:first-child th,.table colgroup+thead tr:first-child td,.table thead:first-child tr:first-child th,.table thead:first-child tr:first-child td{border-top:0}.table tbody+tbody{border-top:2px solid #ddd}.table .table{background-color:#fff}.table-condensed th,.table-condensed td{padding:4px 5px}.table-bordered{border:1px solid #ddd;border-collapse:separate;*border-collapse:collapse;border-left:0;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px}.table-bordered th,.table-bordered td{border-left:1px solid #ddd}.table-bordered caption+thead tr:first-child th,.table-bordered caption+tbody tr:first-child th,.table-bordered caption+tbody tr:first-child td,.table-bordered colgroup+thead tr:first-child th,.table-bordered colgroup+tbody tr:first-child th,.table-bordered colgroup+tbody tr:first-child td,.table-bordered thead:first-child tr:first-child th,.table-bordered tbody:first-child tr:first-child th,.table-bordered tbody:first-child tr:first-child td{border-top:0}.table-bordered thead:first-child tr:first-child>th:first-child,.table-bordered tbody:first-child tr:first-child>td:first-child{-webkit-border-top-left-radius:4px;border-top-left-radius:4px;-moz-border-radius-topleft:4px}.table-bordered thead:first-child tr:first-child>th:last-child,.table-bordered tbody:first-child tr:first-child>td:last-child{-webkit-border-top-right-radius:4px;border-top-right-radius:4px;-moz-border-radius-topright:4px}.table-bordered thead:last-child tr:last-child>th:first-child,.table-bordered tbody:last-child tr:last-child>td:first-child,.table-bordered tfoot:last-child tr:last-child>td:first-child{-webkit-border-bottom-left-radius:4px;border-bottom-left-radius:4px;-moz-border-radius-bottomleft:4px}.table-bordered thead:last-child tr:last-child>th:last-child,.table-bordered tbody:last-child tr:last-child>td:last-child,.table-bordered tfoot:last-child tr:last-child>td:last-child{-webkit-border-bottom-right-radius:4px;border-bottom-right-radius:4px;-moz-border-radius-bottomright:4px}.table-bordered tfoot+tbody:last-child tr:last-child td:first-child{-webkit-border-bottom-left-radius:0;border-bottom-left-radius:0;-moz-border-radius-bottomleft:0}.table-bordered tfoot+tbody:last-child tr:last-child td:last-child{-webkit-border-bottom-right-radius:0;border-bottom-right-radius:0;-moz-border-radius-bottomright:0}.table-bordered caption+thead tr:first-child th:first-child,.table-bordered caption+tbody tr:first-child td:first-child,.table-bordered colgroup+thead tr:first-child th:first-child,.table-bordered colgroup+tbody tr:first-child td:first-child{-webkit-border-top-left-radius:4px;border-top-left-radius:4px;-moz-border-radius-topleft:4px}.table-bordered caption+thead tr:first-child th:last-child,.table-bordered caption+tbody tr:first-child td:last-child,.table-bordered colgroup+thead tr:first-child th:last-child,.table-bordered colgroup+tbody tr:first-child td:last-child{-webkit-border-top-right-radius:4px;border-top-right-radius:4px;-moz-border-radius-topright:4px}.table-striped tbody>tr:nth-child(odd)>td,.table-striped tbody>tr:nth-child(odd)>th{background-color:#f9f9f9}.table-hover tbody tr:hover td,.table-hover tbody tr:hover th{background-color:#f5f5f5}table td[class*="span"],table th[class*="span"],.row-fluid table td[class*="span"],.row-fluid table th[class*="span"]{display:table-cell;float:none;margin-left:0}.table td.span1,.table th.span1{float:none;width:44px;margin-left:0}.table td.span2,.table th.span2{float:none;width:124px;margin-left:0}.table td.span3,.table th.span3{float:none;width:204px;margin-left:0}.table td.span4,.table th.span4{float:none;width:284px;margin-left:0}.table td.span5,.table th.span5{float:none;width:364px;margin-left:0}.table td.span6,.table th.span6{float:none;width:444px;margin-left:0}.table td.span7,.table th.span7{float:none;width:524px;margin-left:0}.table td.span8,.table th.span8{float:none;width:604px;margin-left:0}.table td.span9,.table th.span9{float:none;width:684px;margin-left:0}.table td.span10,.table th.span10{float:none;width:764px;margin-left:0}.table td.span11,.table th.span11{float:none;width:844px;margin-left:0}.table td.span12,.table th.span12{float:none;width:924px;margin-left:0}.table tbody tr.success td{background-color:#dff0d8}.table tbody tr.error td{background-color:#f2dede}.table tbody tr.warning td{background-color:#fcf8e3}.table tbody tr.info td{background-color:#d9edf7}.table-hover tbody tr.success:hover td{background-color:#d0e9c6}.table-hover tbody tr.error:hover td{background-color:#ebcccc}.table-hover tbody tr.warning:hover td{background-color:#faf2cc}.table-hover tbody tr.info:hover td{background-color:#c4e3f3}[class^="icon-"],[class*=" icon-"]{display:inline-block;width:14px;height:14px;margin-top:1px;*margin-right:.3em;line-height:14px;vertical-align:text-top;background-image:url("../img/glyphicons-halflings.png");background-position:14px 14px;background-repeat:no-repeat}.icon-white,.nav-pills>.active>a>[class^="icon-"],.nav-pills>.active>a>[class*=" icon-"],.nav-list>.active>a>[class^="icon-"],.nav-list>.active>a>[class*=" icon-"],.navbar-inverse .nav>.active>a>[class^="icon-"],.navbar-inverse .nav>.active>a>[class*=" icon-"],.dropdown-menu>li>a:hover>[class^="icon-"],.dropdown-menu>li>a:hover>[class*=" icon-"],.dropdown-menu>.active>a>[class^="icon-"],.dropdown-menu>.active>a>[class*=" icon-"],.dropdown-submenu:hover>a>[class^="icon-"],.dropdown-submenu:hover>a>[class*=" icon-"]{background-image:url("../img/glyphicons-halflings-white.png")}.icon-glass{background-position:0 0}.icon-music{background-position:-24px 0}.icon-search{background-position:-48px 0}.icon-envelope{background-position:-72px 0}.icon-heart{background-position:-96px 0}.icon-star{background-position:-120px 0}.icon-star-empty{background-position:-144px 0}.icon-user{background-position:-168px 0}.icon-film{background-position:-192px 0}.icon-th-large{background-position:-216px 0}.icon-th{background-position:-240px 0}.icon-th-list{background-position:-264px 0}.icon-ok{background-position:-288px 0}.icon-remove{background-position:-312px 0}.icon-zoom-in{background-position:-336px 0}.icon-zoom-out{background-position:-360px 0}.icon-off{background-position:-384px 0}.icon-signal{background-position:-408px 0}.icon-cog{background-position:-432px 0}.icon-trash{background-position:-456px 0}.icon-home{background-position:0 -24px}.icon-file{background-position:-24px -24px}.icon-time{background-position:-48px -24px}.icon-road{background-position:-72px -24px}.icon-download-alt{background-position:-96px -24px}.icon-download{background-position:-120px -24px}.icon-upload{background-position:-144px -24px}.icon-inbox{background-position:-168px -24px}.icon-play-circle{background-position:-192px -24px}.icon-repeat{background-position:-216px -24px}.icon-refresh{background-position:-240px -24px}.icon-list-alt{background-position:-264px -24px}.icon-lock{background-position:-287px -24px}.icon-flag{background-position:-312px -24px}.icon-headphones{background-position:-336px -24px}.icon-volume-off{background-position:-360px -24px}.icon-volume-down{background-position:-384px -24px}.icon-volume-up{background-position:-408px -24px}.icon-qrcode{background-position:-432px -24px}.icon-barcode{background-position:-456px -24px}.icon-tag{background-position:0 -48px}.icon-tags{background-position:-25px -48px}.icon-book{background-position:-48px -48px}.icon-bookmark{background-position:-72px -48px}.icon-print{background-position:-96px -48px}.icon-camera{background-position:-120px -48px}.icon-font{background-position:-144px -48px}.icon-bold{background-position:-167px -48px}.icon-italic{background-position:-192px -48px}.icon-text-height{background-position:-216px -48px}.icon-text-width{background-position:-240px -48px}.icon-align-left{background-position:-264px -48px}.icon-align-center{background-position:-288px -48px}.icon-align-right{background-position:-312px -48px}.icon-align-justify{background-position:-336px -48px}.icon-list{background-position:-360px -48px}.icon-indent-left{background-position:-384px -48px}.icon-indent-right{background-position:-408px -48px}.icon-facetime-video{background-position:-432px -48px}.icon-picture{background-position:-456px -48px}.icon-pencil{background-position:0 -72px}.icon-map-marker{background-position:-24px -72px}.icon-adjust{background-position:-48px -72px}.icon-tint{background-position:-72px -72px}.icon-edit{background-position:-96px -72px}.icon-share{background-position:-120px -72px}.icon-check{background-position:-144px -72px}.icon-move{background-position:-168px -72px}.icon-step-backward{background-position:-192px -72px}.icon-fast-backward{background-position:-216px -72px}.icon-backward{background-position:-240px -72px}.icon-play{background-position:-264px -72px}.icon-pause{background-position:-288px -72px}.icon-stop{background-position:-312px -72px}.icon-forward{background-position:-336px -72px}.icon-fast-forward{background-position:-360px -72px}.icon-step-forward{background-position:-384px -72px}.icon-eject{background-position:-408px -72px}.icon-chevron-left{background-position:-432px -72px}.icon-chevron-right{background-position:-456px -72px}.icon-plus-sign{background-position:0 -96px}.icon-minus-sign{background-position:-24px -96px}.icon-remove-sign{background-position:-48px -96px}.icon-ok-sign{background-position:-72px -96px}.icon-question-sign{background-position:-96px -96px}.icon-info-sign{background-position:-120px -96px}.icon-screenshot{background-position:-144px -96px}.icon-remove-circle{background-position:-168px -96px}.icon-ok-circle{background-position:-192px -96px}.icon-ban-circle{background-position:-216px -96px}.icon-arrow-left{background-position:-240px -96px}.icon-arrow-right{background-position:-264px -96px}.icon-arrow-up{background-position:-289px -96px}.icon-arrow-down{background-position:-312px -96px}.icon-share-alt{background-position:-336px -96px}.icon-resize-full{background-position:-360px -96px}.icon-resize-small{background-position:-384px -96px}.icon-plus{background-position:-408px -96px}.icon-minus{background-position:-433px -96px}.icon-asterisk{background-position:-456px -96px}.icon-exclamation-sign{background-position:0 -120px}.icon-gift{background-position:-24px -120px}.icon-leaf{background-position:-48px -120px}.icon-fire{background-position:-72px -120px}.icon-eye-open{background-position:-96px -120px}.icon-eye-close{background-position:-120px -120px}.icon-warning-sign{background-position:-144px -120px}.icon-plane{background-position:-168px -120px}.icon-calendar{background-position:-192px -120px}.icon-random{width:16px;background-position:-216px -120px}.icon-comment{background-position:-240px -120px}.icon-magnet{background-position:-264px -120px}.icon-chevron-up{background-position:-288px -120px}.icon-chevron-down{background-position:-313px -119px}.icon-retweet{background-position:-336px -120px}.icon-shopping-cart{background-position:-360px -120px}.icon-folder-close{background-position:-384px -120px}.icon-folder-open{width:16px;background-position:-408px -120px}.icon-resize-vertical{background-position:-432px -119px}.icon-resize-horizontal{background-position:-456px -118px}.icon-hdd{background-position:0 -144px}.icon-bullhorn{background-position:-24px -144px}.icon-bell{background-position:-48px -144px}.icon-certificate{background-position:-72px -144px}.icon-thumbs-up{background-position:-96px -144px}.icon-thumbs-down{background-position:-120px -144px}.icon-hand-right{background-position:-144px -144px}.icon-hand-left{background-position:-168px -144px}.icon-hand-up{background-position:-192px -144px}.icon-hand-down{background-position:-216px -144px}.icon-circle-arrow-right{background-position:-240px -144px}.icon-circle-arrow-left{background-position:-264px -144px}.icon-circle-arrow-up{background-position:-288px -144px}.icon-circle-arrow-down{background-position:-312px -144px}.icon-globe{background-position:-336px -144px}.icon-wrench{background-position:-360px -144px}.icon-tasks{background-position:-384px -144px}.icon-filter{background-position:-408px -144px}.icon-briefcase{background-position:-432px -144px}.icon-fullscreen{background-position:-456px -144px}.dropup,.dropdown{position:relative}.dropdown-toggle{*margin-bottom:-3px}.dropdown-toggle:active,.open .dropdown-toggle{outline:0}.caret{display:inline-block;width:0;height:0;vertical-align:top;border-top:4px solid #000;border-right:4px solid transparent;border-left:4px solid transparent;content:""}.dropdown .caret{margin-top:8px;margin-left:2px}.dropdown-menu{position:absolute;top:100%;left:0;z-index:1000;display:none;float:left;min-width:160px;padding:5px 0;margin:2px 0 0;list-style:none;background-color:#fff;border:1px solid #ccc;border:1px solid rgba(0,0,0,0.2);*border-right-width:2px;*border-bottom-width:2px;-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px;-webkit-box-shadow:0 5px 10px rgba(0,0,0,0.2);-moz-box-shadow:0 5px 10px rgba(0,0,0,0.2);box-shadow:0 5px 10px rgba(0,0,0,0.2);-webkit-background-clip:padding-box;-moz-background-clip:padding;background-clip:padding-box}.dropdown-menu.pull-right{right:0;left:auto}.dropdown-menu .divider{*width:100%;height:1px;margin:9px 1px;*margin:-5px 0 5px;overflow:hidden;background-color:#e5e5e5;border-bottom:1px solid #fff}.dropdown-menu li>a{display:block;padding:3px 20px;clear:both;font-weight:normal;line-height:20px;color:#333;white-space:nowrap}.dropdown-menu li>a:hover,.dropdown-menu li>a:focus,.dropdown-submenu:hover>a{color:#fff;text-decoration:none;background-color:#0081c2;background-image:-moz-linear-gradient(top,#08c,#0077b3);background-image:-webkit-gradient(linear,0 0,0 100%,from(#08c),to(#0077b3));background-image:-webkit-linear-gradient(top,#08c,#0077b3);background-image:-o-linear-gradient(top,#08c,#0077b3);background-image:linear-gradient(to bottom,#08c,#0077b3);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff0088cc',endColorstr='#ff0077b3',GradientType=0)}.dropdown-menu .active>a,.dropdown-menu .active>a:hover{color:#fff;text-decoration:none;background-color:#0081c2;background-image:-moz-linear-gradient(top,#08c,#0077b3);background-image:-webkit-gradient(linear,0 0,0 100%,from(#08c),to(#0077b3));background-image:-webkit-linear-gradient(top,#08c,#0077b3);background-image:-o-linear-gradient(top,#08c,#0077b3);background-image:linear-gradient(to bottom,#08c,#0077b3);background-repeat:repeat-x;outline:0;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff0088cc',endColorstr='#ff0077b3',GradientType=0)}.dropdown-menu .disabled>a,.dropdown-menu .disabled>a:hover{color:#999}.dropdown-menu .disabled>a:hover{text-decoration:none;cursor:default;background-color:transparent;background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.open{*z-index:1000}.open>.dropdown-menu{display:block}.pull-right>.dropdown-menu{right:0;left:auto}.dropup .caret,.navbar-fixed-bottom .dropdown .caret{border-top:0;border-bottom:4px solid #000;content:""}.dropup .dropdown-menu,.navbar-fixed-bottom .dropdown .dropdown-menu{top:auto;bottom:100%;margin-bottom:1px}.dropdown-submenu{position:relative}.dropdown-submenu>.dropdown-menu{top:0;left:100%;margin-top:-6px;margin-left:-1px;-webkit-border-radius:0 6px 6px 6px;-moz-border-radius:0 6px 6px 6px;border-radius:0 6px 6px 6px}.dropdown-submenu:hover>.dropdown-menu{display:block}.dropup .dropdown-submenu>.dropdown-menu{top:auto;bottom:0;margin-top:0;margin-bottom:-2px;-webkit-border-radius:5px 5px 5px 0;-moz-border-radius:5px 5px 5px 0;border-radius:5px 5px 5px 0}.dropdown-submenu>a:after{display:block;float:right;width:0;height:0;margin-top:5px;margin-right:-10px;border-color:transparent;border-left-color:#ccc;border-style:solid;border-width:5px 0 5px 5px;content:" "}.dropdown-submenu:hover>a:after{border-left-color:#fff}.dropdown-submenu.pull-left{float:none}.dropdown-submenu.pull-left>.dropdown-menu{left:-100%;margin-left:10px;-webkit-border-radius:6px 0 6px 6px;-moz-border-radius:6px 0 6px 6px;border-radius:6px 0 6px 6px}.dropdown .dropdown-menu .nav-header{padding-right:20px;padding-left:20px}.typeahead{z-index:1051;margin-top:2px;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px}.well{min-height:20px;padding:19px;margin-bottom:20px;background-color:#f5f5f5;border:1px solid #e3e3e3;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.05);-moz-box-shadow:inset 0 1px 1px rgba(0,0,0,0.05);box-shadow:inset 0 1px 1px rgba(0,0,0,0.05)}.well blockquote{border-color:#ddd;border-color:rgba(0,0,0,0.15)}.well-large{padding:24px;-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px}.well-small{padding:9px;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px}.fade{opacity:0;-webkit-transition:opacity .15s linear;-moz-transition:opacity .15s linear;-o-transition:opacity .15s linear;transition:opacity .15s linear}.fade.in{opacity:1}.collapse{position:relative;height:0;overflow:hidden;-webkit-transition:height .35s ease;-moz-transition:height .35s ease;-o-transition:height .35s ease;transition:height .35s ease}.collapse.in{height:auto}.close{float:right;font-size:20px;font-weight:bold;line-height:20px;color:#000;text-shadow:0 1px 0 #fff;opacity:.2;filter:alpha(opacity=20)}.close:hover{color:#000;text-decoration:none;cursor:pointer;opacity:.4;filter:alpha(opacity=40)}button.close{padding:0;cursor:pointer;background:transparent;border:0;-webkit-appearance:none}.btn{display:inline-block;*display:inline;padding:4px 12px;margin-bottom:0;*margin-left:.3em;font-size:14px;line-height:20px;color:#333;text-align:center;text-shadow:0 1px 1px rgba(255,255,255,0.75);vertical-align:middle;cursor:pointer;background-color:#f5f5f5;*background-color:#e6e6e6;background-image:-moz-linear-gradient(top,#fff,#e6e6e6);background-image:-webkit-gradient(linear,0 0,0 100%,from(#fff),to(#e6e6e6));background-image:-webkit-linear-gradient(top,#fff,#e6e6e6);background-image:-o-linear-gradient(top,#fff,#e6e6e6);background-image:linear-gradient(to bottom,#fff,#e6e6e6);background-repeat:repeat-x;border:1px solid #bbb;*border:0;border-color:#e6e6e6 #e6e6e6 #bfbfbf;border-color:rgba(0,0,0,0.1) rgba(0,0,0,0.1) rgba(0,0,0,0.25);border-bottom-color:#a2a2a2;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffffffff',endColorstr='#ffe6e6e6',GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled=false);*zoom:1;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,0.2),0 1px 2px rgba(0,0,0,0.05);-moz-box-shadow:inset 0 1px 0 rgba(255,255,255,0.2),0 1px 2px rgba(0,0,0,0.05);box-shadow:inset 0 1px 0 rgba(255,255,255,0.2),0 1px 2px rgba(0,0,0,0.05)}.btn:hover,.btn:active,.btn.active,.btn.disabled,.btn[disabled]{color:#333;background-color:#e6e6e6;*background-color:#d9d9d9}.btn:active,.btn.active{background-color:#ccc \9}.btn:first-child{*margin-left:0}.btn:hover{color:#333;text-decoration:none;background-position:0 -15px;-webkit-transition:background-position .1s linear;-moz-transition:background-position .1s linear;-o-transition:background-position .1s linear;transition:background-position .1s linear}.btn:focus{outline:thin dotted #333;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.btn.active,.btn:active{background-image:none;outline:0;-webkit-box-shadow:inset 0 2px 4px rgba(0,0,0,0.15),0 1px 2px rgba(0,0,0,0.05);-moz-box-shadow:inset 0 2px 4px rgba(0,0,0,0.15),0 1px 2px rgba(0,0,0,0.05);box-shadow:inset 0 2px 4px rgba(0,0,0,0.15),0 1px 2px rgba(0,0,0,0.05)}.btn.disabled,.btn[disabled]{cursor:default;background-image:none;opacity:.65;filter:alpha(opacity=65);-webkit-box-shadow:none;-moz-box-shadow:none;box-shadow:none}.btn-large{padding:11px 19px;font-size:17.5px;-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px}.btn-large [class^="icon-"],.btn-large [class*=" icon-"]{margin-top:4px}.btn-small{padding:2px 10px;font-size:11.9px;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px}.btn-small [class^="icon-"],.btn-small [class*=" icon-"]{margin-top:0}.btn-mini [class^="icon-"],.btn-mini [class*=" icon-"]{margin-top:-1px}.btn-mini{padding:0 6px;font-size:10.5px;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px}.btn-block{display:block;width:100%;padding-right:0;padding-left:0;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.btn-block+.btn-block{margin-top:5px}input[type="submit"].btn-block,input[type="reset"].btn-block,input[type="button"].btn-block{width:100%}.btn-primary.active,.btn-warning.active,.btn-danger.active,.btn-success.active,.btn-info.active,.btn-inverse.active{color:rgba(255,255,255,0.75)}.btn{border-color:#c5c5c5;border-color:rgba(0,0,0,0.15) rgba(0,0,0,0.15) rgba(0,0,0,0.25)}.btn-primary{color:#fff;text-shadow:0 -1px 0 rgba(0,0,0,0.25);background-color:#006dcc;*background-color:#04c;background-image:-moz-linear-gradient(top,#08c,#04c);background-image:-webkit-gradient(linear,0 0,0 100%,from(#08c),to(#04c));background-image:-webkit-linear-gradient(top,#08c,#04c);background-image:-o-linear-gradient(top,#08c,#04c);background-image:linear-gradient(to bottom,#08c,#04c);background-repeat:repeat-x;border-color:#04c #04c #002a80;border-color:rgba(0,0,0,0.1) rgba(0,0,0,0.1) rgba(0,0,0,0.25);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff0088cc',endColorstr='#ff0044cc',GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.btn-primary:hover,.btn-primary:active,.btn-primary.active,.btn-primary.disabled,.btn-primary[disabled]{color:#fff;background-color:#04c;*background-color:#003bb3}.btn-primary:active,.btn-primary.active{background-color:#039 \9}.btn-warning{color:#fff;text-shadow:0 -1px 0 rgba(0,0,0,0.25);background-color:#faa732;*background-color:#f89406;background-image:-moz-linear-gradient(top,#fbb450,#f89406);background-image:-webkit-gradient(linear,0 0,0 100%,from(#fbb450),to(#f89406));background-image:-webkit-linear-gradient(top,#fbb450,#f89406);background-image:-o-linear-gradient(top,#fbb450,#f89406);background-image:linear-gradient(to bottom,#fbb450,#f89406);background-repeat:repeat-x;border-color:#f89406 #f89406 #ad6704;border-color:rgba(0,0,0,0.1) rgba(0,0,0,0.1) rgba(0,0,0,0.25);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fffbb450',endColorstr='#fff89406',GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.btn-warning:hover,.btn-warning:active,.btn-warning.active,.btn-warning.disabled,.btn-warning[disabled]{color:#fff;background-color:#f89406;*background-color:#df8505}.btn-warning:active,.btn-warning.active{background-color:#c67605 \9}.btn-danger{color:#fff;text-shadow:0 -1px 0 rgba(0,0,0,0.25);background-color:#da4f49;*background-color:#bd362f;background-image:-moz-linear-gradient(top,#ee5f5b,#bd362f);background-image:-webkit-gradient(linear,0 0,0 100%,from(#ee5f5b),to(#bd362f));background-image:-webkit-linear-gradient(top,#ee5f5b,#bd362f);background-image:-o-linear-gradient(top,#ee5f5b,#bd362f);background-image:linear-gradient(to bottom,#ee5f5b,#bd362f);background-repeat:repeat-x;border-color:#bd362f #bd362f #802420;border-color:rgba(0,0,0,0.1) rgba(0,0,0,0.1) rgba(0,0,0,0.25);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffee5f5b',endColorstr='#ffbd362f',GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.btn-danger:hover,.btn-danger:active,.btn-danger.active,.btn-danger.disabled,.btn-danger[disabled]{color:#fff;background-color:#bd362f;*background-color:#a9302a}.btn-danger:active,.btn-danger.active{background-color:#942a25 \9}.btn-success{color:#fff;text-shadow:0 -1px 0 rgba(0,0,0,0.25);background-color:#5bb75b;*background-color:#51a351;background-image:-moz-linear-gradient(top,#62c462,#51a351);background-image:-webkit-gradient(linear,0 0,0 100%,from(#62c462),to(#51a351));background-image:-webkit-linear-gradient(top,#62c462,#51a351);background-image:-o-linear-gradient(top,#62c462,#51a351);background-image:linear-gradient(to bottom,#62c462,#51a351);background-repeat:repeat-x;border-color:#51a351 #51a351 #387038;border-color:rgba(0,0,0,0.1) rgba(0,0,0,0.1) rgba(0,0,0,0.25);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff62c462',endColorstr='#ff51a351',GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.btn-success:hover,.btn-success:active,.btn-success.active,.btn-success.disabled,.btn-success[disabled]{color:#fff;background-color:#51a351;*background-color:#499249}.btn-success:active,.btn-success.active{background-color:#408140 \9}.btn-info{color:#fff;text-shadow:0 -1px 0 rgba(0,0,0,0.25);background-color:#49afcd;*background-color:#2f96b4;background-image:-moz-linear-gradient(top,#5bc0de,#2f96b4);background-image:-webkit-gradient(linear,0 0,0 100%,from(#5bc0de),to(#2f96b4));background-image:-webkit-linear-gradient(top,#5bc0de,#2f96b4);background-image:-o-linear-gradient(top,#5bc0de,#2f96b4);background-image:linear-gradient(to bottom,#5bc0de,#2f96b4);background-repeat:repeat-x;border-color:#2f96b4 #2f96b4 #1f6377;border-color:rgba(0,0,0,0.1) rgba(0,0,0,0.1) rgba(0,0,0,0.25);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff5bc0de',endColorstr='#ff2f96b4',GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.btn-info:hover,.btn-info:active,.btn-info.active,.btn-info.disabled,.btn-info[disabled]{color:#fff;background-color:#2f96b4;*background-color:#2a85a0}.btn-info:active,.btn-info.active{background-color:#24748c \9}.btn-inverse{color:#fff;text-shadow:0 -1px 0 rgba(0,0,0,0.25);background-color:#363636;*background-color:#222;background-image:-moz-linear-gradient(top,#444,#222);background-image:-webkit-gradient(linear,0 0,0 100%,from(#444),to(#222));background-image:-webkit-linear-gradient(top,#444,#222);background-image:-o-linear-gradient(top,#444,#222);background-image:linear-gradient(to bottom,#444,#222);background-repeat:repeat-x;border-color:#222 #222 #000;border-color:rgba(0,0,0,0.1) rgba(0,0,0,0.1) rgba(0,0,0,0.25);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff444444',endColorstr='#ff222222',GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.btn-inverse:hover,.btn-inverse:active,.btn-inverse.active,.btn-inverse.disabled,.btn-inverse[disabled]{color:#fff;background-color:#222;*background-color:#151515}.btn-inverse:active,.btn-inverse.active{background-color:#080808 \9}button.btn,input[type="submit"].btn{*padding-top:3px;*padding-bottom:3px}button.btn::-moz-focus-inner,input[type="submit"].btn::-moz-focus-inner{padding:0;border:0}button.btn.btn-large,input[type="submit"].btn.btn-large{*padding-top:7px;*padding-bottom:7px}button.btn.btn-small,input[type="submit"].btn.btn-small{*padding-top:3px;*padding-bottom:3px}button.btn.btn-mini,input[type="submit"].btn.btn-mini{*padding-top:1px;*padding-bottom:1px}.btn-link,.btn-link:active,.btn-link[disabled]{background-color:transparent;background-image:none;-webkit-box-shadow:none;-moz-box-shadow:none;box-shadow:none}.btn-link{color:#08c;cursor:pointer;border-color:transparent;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.btn-link:hover{color:#005580;text-decoration:underline;background-color:transparent}.btn-link[disabled]:hover{color:#333;text-decoration:none}.btn-group{position:relative;display:inline-block;*display:inline;*margin-left:.3em;font-size:0;white-space:nowrap;vertical-align:middle;*zoom:1}.btn-group:first-child{*margin-left:0}.btn-group+.btn-group{margin-left:5px}.btn-toolbar{margin-top:10px;margin-bottom:10px;font-size:0}.btn-toolbar>.btn+.btn,.btn-toolbar>.btn-group+.btn,.btn-toolbar>.btn+.btn-group{margin-left:5px}.btn-group>.btn{position:relative;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.btn-group>.btn+.btn{margin-left:-1px}.btn-group>.btn,.btn-group>.dropdown-menu,.btn-group>.popover{font-size:14px}.btn-group>.btn-mini{font-size:10.5px}.btn-group>.btn-small{font-size:11.9px}.btn-group>.btn-large{font-size:17.5px}.btn-group>.btn:first-child{margin-left:0;-webkit-border-bottom-left-radius:4px;border-bottom-left-radius:4px;-webkit-border-top-left-radius:4px;border-top-left-radius:4px;-moz-border-radius-bottomleft:4px;-moz-border-radius-topleft:4px}.btn-group>.btn:last-child,.btn-group>.dropdown-toggle{-webkit-border-top-right-radius:4px;border-top-right-radius:4px;-webkit-border-bottom-right-radius:4px;border-bottom-right-radius:4px;-moz-border-radius-topright:4px;-moz-border-radius-bottomright:4px}.btn-group>.btn.large:first-child{margin-left:0;-webkit-border-bottom-left-radius:6px;border-bottom-left-radius:6px;-webkit-border-top-left-radius:6px;border-top-left-radius:6px;-moz-border-radius-bottomleft:6px;-moz-border-radius-topleft:6px}.btn-group>.btn.large:last-child,.btn-group>.large.dropdown-toggle{-webkit-border-top-right-radius:6px;border-top-right-radius:6px;-webkit-border-bottom-right-radius:6px;border-bottom-right-radius:6px;-moz-border-radius-topright:6px;-moz-border-radius-bottomright:6px}.btn-group>.btn:hover,.btn-group>.btn:focus,.btn-group>.btn:active,.btn-group>.btn.active{z-index:2}.btn-group .dropdown-toggle:active,.btn-group.open .dropdown-toggle{outline:0}.btn-group>.btn+.dropdown-toggle{*padding-top:5px;padding-right:8px;*padding-bottom:5px;padding-left:8px;-webkit-box-shadow:inset 1px 0 0 rgba(255,255,255,0.125),inset 0 1px 0 rgba(255,255,255,0.2),0 1px 2px rgba(0,0,0,0.05);-moz-box-shadow:inset 1px 0 0 rgba(255,255,255,0.125),inset 0 1px 0 rgba(255,255,255,0.2),0 1px 2px rgba(0,0,0,0.05);box-shadow:inset 1px 0 0 rgba(255,255,255,0.125),inset 0 1px 0 rgba(255,255,255,0.2),0 1px 2px rgba(0,0,0,0.05)}.btn-group>.btn-mini+.dropdown-toggle{*padding-top:2px;padding-right:5px;*padding-bottom:2px;padding-left:5px}.btn-group>.btn-small+.dropdown-toggle{*padding-top:5px;*padding-bottom:4px}.btn-group>.btn-large+.dropdown-toggle{*padding-top:7px;padding-right:12px;*padding-bottom:7px;padding-left:12px}.btn-group.open .dropdown-toggle{background-image:none;-webkit-box-shadow:inset 0 2px 4px rgba(0,0,0,0.15),0 1px 2px rgba(0,0,0,0.05);-moz-box-shadow:inset 0 2px 4px rgba(0,0,0,0.15),0 1px 2px rgba(0,0,0,0.05);box-shadow:inset 0 2px 4px rgba(0,0,0,0.15),0 1px 2px rgba(0,0,0,0.05)}.btn-group.open .btn.dropdown-toggle{background-color:#e6e6e6}.btn-group.open .btn-primary.dropdown-toggle{background-color:#04c}.btn-group.open .btn-warning.dropdown-toggle{background-color:#f89406}.btn-group.open .btn-danger.dropdown-toggle{background-color:#bd362f}.btn-group.open .btn-success.dropdown-toggle{background-color:#51a351}.btn-group.open .btn-info.dropdown-toggle{background-color:#2f96b4}.btn-group.open .btn-inverse.dropdown-toggle{background-color:#222}.btn .caret{margin-top:8px;margin-left:0}.btn-mini .caret,.btn-small .caret,.btn-large .caret{margin-top:6px}.btn-large .caret{border-top-width:5px;border-right-width:5px;border-left-width:5px}.dropup .btn-large .caret{border-bottom-width:5px}.btn-primary .caret,.btn-warning .caret,.btn-danger .caret,.btn-info .caret,.btn-success .caret,.btn-inverse .caret{border-top-color:#fff;border-bottom-color:#fff}.btn-group-vertical{display:inline-block;*display:inline;*zoom:1}.btn-group-vertical>.btn{display:block;float:none;max-width:100%;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.btn-group-vertical>.btn+.btn{margin-top:-1px;margin-left:0}.btn-group-vertical>.btn:first-child{-webkit-border-radius:4px 4px 0 0;-moz-border-radius:4px 4px 0 0;border-radius:4px 4px 0 0}.btn-group-vertical>.btn:last-child{-webkit-border-radius:0 0 4px 4px;-moz-border-radius:0 0 4px 4px;border-radius:0 0 4px 4px}.btn-group-vertical>.btn-large:first-child{-webkit-border-radius:6px 6px 0 0;-moz-border-radius:6px 6px 0 0;border-radius:6px 6px 0 0}.btn-group-vertical>.btn-large:last-child{-webkit-border-radius:0 0 6px 6px;-moz-border-radius:0 0 6px 6px;border-radius:0 0 6px 6px}.alert{padding:8px 35px 8px 14px;margin-bottom:20px;text-shadow:0 1px 0 rgba(255,255,255,0.5);background-color:#fcf8e3;border:1px solid #fbeed5;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px}.alert,.alert h4{color:#c09853}.alert h4{margin:0}.alert .close{position:relative;top:-2px;right:-21px;line-height:20px}.alert-success{color:#468847;background-color:#dff0d8;border-color:#d6e9c6}.alert-success h4{color:#468847}.alert-danger,.alert-error{color:#b94a48;background-color:#f2dede;border-color:#eed3d7}.alert-danger h4,.alert-error h4{color:#b94a48}.alert-info{color:#3a87ad;background-color:#d9edf7;border-color:#bce8f1}.alert-info h4{color:#3a87ad}.alert-block{padding-top:14px;padding-bottom:14px}.alert-block>p,.alert-block>ul{margin-bottom:0}.alert-block p+p{margin-top:5px}.nav{margin-bottom:20px;margin-left:0;list-style:none}.nav>li>a{display:block}.nav>li>a:hover{text-decoration:none;background-color:#eee}.nav>li>a>img{max-width:none}.nav>.pull-right{float:right}.nav-header{display:block;padding:3px 15px;font-size:11px;font-weight:bold;line-height:20px;color:#999;text-shadow:0 1px 0 rgba(255,255,255,0.5);text-transform:uppercase}.nav li+.nav-header{margin-top:9px}.nav-list{padding-right:15px;padding-left:15px;margin-bottom:0}.nav-list>li>a,.nav-list .nav-header{margin-right:-15px;margin-left:-15px;text-shadow:0 1px 0 rgba(255,255,255,0.5)}.nav-list>li>a{padding:3px 15px}.nav-list>.active>a,.nav-list>.active>a:hover{color:#fff;text-shadow:0 -1px 0 rgba(0,0,0,0.2);background-color:#08c}.nav-list [class^="icon-"],.nav-list [class*=" icon-"]{margin-right:2px}.nav-list .divider{*width:100%;height:1px;margin:9px 1px;*margin:-5px 0 5px;overflow:hidden;background-color:#e5e5e5;border-bottom:1px solid #fff}.nav-tabs,.nav-pills{*zoom:1}.nav-tabs:before,.nav-pills:before,.nav-tabs:after,.nav-pills:after{display:table;line-height:0;content:""}.nav-tabs:after,.nav-pills:after{clear:both}.nav-tabs>li,.nav-pills>li{float:left}.nav-tabs>li>a,.nav-pills>li>a{padding-right:12px;padding-left:12px;margin-right:2px;line-height:14px}.nav-tabs{border-bottom:1px solid #ddd}.nav-tabs>li{margin-bottom:-1px}.nav-tabs>li>a{padding-top:8px;padding-bottom:8px;line-height:20px;border:1px solid transparent;-webkit-border-radius:4px 4px 0 0;-moz-border-radius:4px 4px 0 0;border-radius:4px 4px 0 0}.nav-tabs>li>a:hover{border-color:#eee #eee #ddd}.nav-tabs>.active>a,.nav-tabs>.active>a:hover{color:#555;cursor:default;background-color:#fff;border:1px solid #ddd;border-bottom-color:transparent}.nav-pills>li>a{padding-top:8px;padding-bottom:8px;margin-top:2px;margin-bottom:2px;-webkit-border-radius:5px;-moz-border-radius:5px;border-radius:5px}.nav-pills>.active>a,.nav-pills>.active>a:hover{color:#fff;background-color:#08c}.nav-stacked>li{float:none}.nav-stacked>li>a{margin-right:0}.nav-tabs.nav-stacked{border-bottom:0}.nav-tabs.nav-stacked>li>a{border:1px solid #ddd;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.nav-tabs.nav-stacked>li:first-child>a{-webkit-border-top-right-radius:4px;border-top-right-radius:4px;-webkit-border-top-left-radius:4px;border-top-left-radius:4px;-moz-border-radius-topright:4px;-moz-border-radius-topleft:4px}.nav-tabs.nav-stacked>li:last-child>a{-webkit-border-bottom-right-radius:4px;border-bottom-right-radius:4px;-webkit-border-bottom-left-radius:4px;border-bottom-left-radius:4px;-moz-border-radius-bottomright:4px;-moz-border-radius-bottomleft:4px}.nav-tabs.nav-stacked>li>a:hover{z-index:2;border-color:#ddd}.nav-pills.nav-stacked>li>a{margin-bottom:3px}.nav-pills.nav-stacked>li:last-child>a{margin-bottom:1px}.nav-tabs .dropdown-menu{-webkit-border-radius:0 0 6px 6px;-moz-border-radius:0 0 6px 6px;border-radius:0 0 6px 6px}.nav-pills .dropdown-menu{-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px}.nav .dropdown-toggle .caret{margin-top:6px;border-top-color:#08c;border-bottom-color:#08c}.nav .dropdown-toggle:hover .caret{border-top-color:#005580;border-bottom-color:#005580}.nav-tabs .dropdown-toggle .caret{margin-top:8px}.nav .active .dropdown-toggle .caret{border-top-color:#fff;border-bottom-color:#fff}.nav-tabs .active .dropdown-toggle .caret{border-top-color:#555;border-bottom-color:#555}.nav>.dropdown.active>a:hover{cursor:pointer}.nav-tabs .open .dropdown-toggle,.nav-pills .open .dropdown-toggle,.nav>li.dropdown.open.active>a:hover{color:#fff;background-color:#999;border-color:#999}.nav li.dropdown.open .caret,.nav li.dropdown.open.active .caret,.nav li.dropdown.open a:hover .caret{border-top-color:#fff;border-bottom-color:#fff;opacity:1;filter:alpha(opacity=100)}.tabs-stacked .open>a:hover{border-color:#999}.tabbable{*zoom:1}.tabbable:before,.tabbable:after{display:table;line-height:0;content:""}.tabbable:after{clear:both}.tab-content{overflow:auto}.tabs-below>.nav-tabs,.tabs-right>.nav-tabs,.tabs-left>.nav-tabs{border-bottom:0}.tab-content>.tab-pane,.pill-content>.pill-pane{display:none}.tab-content>.active,.pill-content>.active{display:block}.tabs-below>.nav-tabs{border-top:1px solid #ddd}.tabs-below>.nav-tabs>li{margin-top:-1px;margin-bottom:0}.tabs-below>.nav-tabs>li>a{-webkit-border-radius:0 0 4px 4px;-moz-border-radius:0 0 4px 4px;border-radius:0 0 4px 4px}.tabs-below>.nav-tabs>li>a:hover{border-top-color:#ddd;border-bottom-color:transparent}.tabs-below>.nav-tabs>.active>a,.tabs-below>.nav-tabs>.active>a:hover{border-color:transparent #ddd #ddd #ddd}.tabs-left>.nav-tabs>li,.tabs-right>.nav-tabs>li{float:none}.tabs-left>.nav-tabs>li>a,.tabs-right>.nav-tabs>li>a{min-width:74px;margin-right:0;margin-bottom:3px}.tabs-left>.nav-tabs{float:left;margin-right:19px;border-right:1px solid #ddd}.tabs-left>.nav-tabs>li>a{margin-right:-1px;-webkit-border-radius:4px 0 0 4px;-moz-border-radius:4px 0 0 4px;border-radius:4px 0 0 4px}.tabs-left>.nav-tabs>li>a:hover{border-color:#eee #ddd #eee #eee}.tabs-left>.nav-tabs .active>a,.tabs-left>.nav-tabs .active>a:hover{border-color:#ddd transparent #ddd #ddd;*border-right-color:#fff}.tabs-right>.nav-tabs{float:right;margin-left:19px;border-left:1px solid #ddd}.tabs-right>.nav-tabs>li>a{margin-left:-1px;-webkit-border-radius:0 4px 4px 0;-moz-border-radius:0 4px 4px 0;border-radius:0 4px 4px 0}.tabs-right>.nav-tabs>li>a:hover{border-color:#eee #eee #eee #ddd}.tabs-right>.nav-tabs .active>a,.tabs-right>.nav-tabs .active>a:hover{border-color:#ddd #ddd #ddd transparent;*border-left-color:#fff}.nav>.disabled>a{color:#999}.nav>.disabled>a:hover{text-decoration:none;cursor:default;background-color:transparent}.navbar{*position:relative;*z-index:2;margin-bottom:20px;overflow:visible}.navbar-inner{min-height:40px;padding-right:20px;padding-left:20px;background-color:#fafafa;background-image:-moz-linear-gradient(top,#fff,#f2f2f2);background-image:-webkit-gradient(linear,0 0,0 100%,from(#fff),to(#f2f2f2));background-image:-webkit-linear-gradient(top,#fff,#f2f2f2);background-image:-o-linear-gradient(top,#fff,#f2f2f2);background-image:linear-gradient(to bottom,#fff,#f2f2f2);background-repeat:repeat-x;border:1px solid #d4d4d4;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffffffff',endColorstr='#fff2f2f2',GradientType=0);*zoom:1;-webkit-box-shadow:0 1px 4px rgba(0,0,0,0.065);-moz-box-shadow:0 1px 4px rgba(0,0,0,0.065);box-shadow:0 1px 4px rgba(0,0,0,0.065)}.navbar-inner:before,.navbar-inner:after{display:table;line-height:0;content:""}.navbar-inner:after{clear:both}.navbar .container{width:auto}.nav-collapse.collapse{height:auto;overflow:visible}.navbar .brand{display:block;float:left;padding:10px 20px 10px;margin-left:-20px;font-size:20px;font-weight:200;color:#777;text-shadow:0 1px 0 #fff}.navbar .brand:hover{text-decoration:none}.navbar-text{margin-bottom:0;line-height:40px;color:#777}.navbar-link{color:#777}.navbar-link:hover{color:#333}.navbar .divider-vertical{height:40px;margin:0 9px;border-right:1px solid #fff;border-left:1px solid #f2f2f2}.navbar .btn,.navbar .btn-group{margin-top:5px}.navbar .btn-group .btn,.navbar .input-prepend .btn,.navbar .input-append .btn{margin-top:0}.navbar-form{margin-bottom:0;*zoom:1}.navbar-form:before,.navbar-form:after{display:table;line-height:0;content:""}.navbar-form:after{clear:both}.navbar-form input,.navbar-form select,.navbar-form .radio,.navbar-form .checkbox{margin-top:5px}.navbar-form input,.navbar-form select,.navbar-form .btn{display:inline-block;margin-bottom:0}.navbar-form input[type="image"],.navbar-form input[type="checkbox"],.navbar-form input[type="radio"]{margin-top:3px}.navbar-form .input-append,.navbar-form .input-prepend{margin-top:5px;white-space:nowrap}.navbar-form .input-append input,.navbar-form .input-prepend input{margin-top:0}.navbar-search{position:relative;float:left;margin-top:5px;margin-bottom:0}.navbar-search .search-query{padding:4px 14px;margin-bottom:0;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:13px;font-weight:normal;line-height:1;-webkit-border-radius:15px;-moz-border-radius:15px;border-radius:15px}.navbar-static-top{position:static;margin-bottom:0}.navbar-static-top .navbar-inner{-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.navbar-fixed-top,.navbar-fixed-bottom{position:fixed;right:0;left:0;z-index:1030;margin-bottom:0}.navbar-fixed-top .navbar-inner,.navbar-static-top .navbar-inner{border-width:0 0 1px}.navbar-fixed-bottom .navbar-inner{border-width:1px 0 0}.navbar-fixed-top .navbar-inner,.navbar-fixed-bottom .navbar-inner{padding-right:0;padding-left:0;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0}.navbar-static-top .container,.navbar-fixed-top .container,.navbar-fixed-bottom .container{width:940px}.navbar-fixed-top{top:0}.navbar-fixed-top .navbar-inner,.navbar-static-top .navbar-inner{-webkit-box-shadow:0 1px 10px rgba(0,0,0,0.1);-moz-box-shadow:0 1px 10px rgba(0,0,0,0.1);box-shadow:0 1px 10px rgba(0,0,0,0.1)}.navbar-fixed-bottom{bottom:0}.navbar-fixed-bottom .navbar-inner{-webkit-box-shadow:0 -1px 10px rgba(0,0,0,0.1);-moz-box-shadow:0 -1px 10px rgba(0,0,0,0.1);box-shadow:0 -1px 10px rgba(0,0,0,0.1)}.navbar .nav{position:relative;left:0;display:block;float:left;margin:0 10px 0 0}.navbar .nav.pull-right{float:right;margin-right:0}.navbar .nav>li{float:left}.navbar .nav>li>a{float:none;padding:10px 15px 10px;color:#777;text-decoration:none;text-shadow:0 1px 0 #fff}.navbar .nav .dropdown-toggle .caret{margin-top:8px}.navbar .nav>li>a:focus,.navbar .nav>li>a:hover{color:#333;text-decoration:none;background-color:transparent}.navbar .nav>.active>a,.navbar .nav>.active>a:hover,.navbar .nav>.active>a:focus{color:#555;text-decoration:none;background-color:#e5e5e5;-webkit-box-shadow:inset 0 3px 8px rgba(0,0,0,0.125);-moz-box-shadow:inset 0 3px 8px rgba(0,0,0,0.125);box-shadow:inset 0 3px 8px rgba(0,0,0,0.125)}.navbar .btn-navbar{display:none;float:right;padding:7px 10px;margin-right:5px;margin-left:5px;color:#fff;text-shadow:0 -1px 0 rgba(0,0,0,0.25);background-color:#ededed;*background-color:#e5e5e5;background-image:-moz-linear-gradient(top,#f2f2f2,#e5e5e5);background-image:-webkit-gradient(linear,0 0,0 100%,from(#f2f2f2),to(#e5e5e5));background-image:-webkit-linear-gradient(top,#f2f2f2,#e5e5e5);background-image:-o-linear-gradient(top,#f2f2f2,#e5e5e5);background-image:linear-gradient(to bottom,#f2f2f2,#e5e5e5);background-repeat:repeat-x;border-color:#e5e5e5 #e5e5e5 #bfbfbf;border-color:rgba(0,0,0,0.1) rgba(0,0,0,0.1) rgba(0,0,0,0.25);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff2f2f2',endColorstr='#ffe5e5e5',GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled=false);-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.075);-moz-box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.075);box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.075)}.navbar .btn-navbar:hover,.navbar .btn-navbar:active,.navbar .btn-navbar.active,.navbar .btn-navbar.disabled,.navbar .btn-navbar[disabled]{color:#fff;background-color:#e5e5e5;*background-color:#d9d9d9}.navbar .btn-navbar:active,.navbar .btn-navbar.active{background-color:#ccc \9}.navbar .btn-navbar .icon-bar{display:block;width:18px;height:2px;background-color:#f5f5f5;-webkit-border-radius:1px;-moz-border-radius:1px;border-radius:1px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,0.25);-moz-box-shadow:0 1px 0 rgba(0,0,0,0.25);box-shadow:0 1px 0 rgba(0,0,0,0.25)}.btn-navbar .icon-bar+.icon-bar{margin-top:3px}.navbar .nav>li>.dropdown-menu:before{position:absolute;top:-7px;left:9px;display:inline-block;border-right:7px solid transparent;border-bottom:7px solid #ccc;border-left:7px solid transparent;border-bottom-color:rgba(0,0,0,0.2);content:''}.navbar .nav>li>.dropdown-menu:after{position:absolute;top:-6px;left:10px;display:inline-block;border-right:6px solid transparent;border-bottom:6px solid #fff;border-left:6px solid transparent;content:''}.navbar-fixed-bottom .nav>li>.dropdown-menu:before{top:auto;bottom:-7px;border-top:7px solid #ccc;border-bottom:0;border-top-color:rgba(0,0,0,0.2)}.navbar-fixed-bottom .nav>li>.dropdown-menu:after{top:auto;bottom:-6px;border-top:6px solid #fff;border-bottom:0}.navbar .nav li.dropdown>a:hover .caret{border-top-color:#555;border-bottom-color:#555}.navbar .nav li.dropdown.open>.dropdown-toggle,.navbar .nav li.dropdown.active>.dropdown-toggle,.navbar .nav li.dropdown.open.active>.dropdown-toggle{color:#555;background-color:#e5e5e5}.navbar .nav li.dropdown>.dropdown-toggle .caret{border-top-color:#777;border-bottom-color:#777}.navbar .nav li.dropdown.open>.dropdown-toggle .caret,.navbar .nav li.dropdown.active>.dropdown-toggle .caret,.navbar .nav li.dropdown.open.active>.dropdown-toggle .caret{border-top-color:#555;border-bottom-color:#555}.navbar .pull-right>li>.dropdown-menu,.navbar .nav>li>.dropdown-menu.pull-right{right:0;left:auto}.navbar .pull-right>li>.dropdown-menu:before,.navbar .nav>li>.dropdown-menu.pull-right:before{right:12px;left:auto}.navbar .pull-right>li>.dropdown-menu:after,.navbar .nav>li>.dropdown-menu.pull-right:after{right:13px;left:auto}.navbar .pull-right>li>.dropdown-menu .dropdown-menu,.navbar .nav>li>.dropdown-menu.pull-right .dropdown-menu{right:100%;left:auto;margin-right:-1px;margin-left:0;-webkit-border-radius:6px 0 6px 6px;-moz-border-radius:6px 0 6px 6px;border-radius:6px 0 6px 6px}.navbar-inverse .navbar-inner{background-color:#1b1b1b;background-image:-moz-linear-gradient(top,#222,#111);background-image:-webkit-gradient(linear,0 0,0 100%,from(#222),to(#111));background-image:-webkit-linear-gradient(top,#222,#111);background-image:-o-linear-gradient(top,#222,#111);background-image:linear-gradient(to bottom,#222,#111);background-repeat:repeat-x;border-color:#252525;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff222222',endColorstr='#ff111111',GradientType=0)}.navbar-inverse .brand,.navbar-inverse .nav>li>a{color:#999;text-shadow:0 -1px 0 rgba(0,0,0,0.25)}.navbar-inverse .brand:hover,.navbar-inverse .nav>li>a:hover{color:#fff}.navbar-inverse .brand{color:#999}.navbar-inverse .navbar-text{color:#999}.navbar-inverse .nav>li>a:focus,.navbar-inverse .nav>li>a:hover{color:#fff;background-color:transparent}.navbar-inverse .nav .active>a,.navbar-inverse .nav .active>a:hover,.navbar-inverse .nav .active>a:focus{color:#fff;background-color:#111}.navbar-inverse .navbar-link{color:#999}.navbar-inverse .navbar-link:hover{color:#fff}.navbar-inverse .divider-vertical{border-right-color:#222;border-left-color:#111}.navbar-inverse .nav li.dropdown.open>.dropdown-toggle,.navbar-inverse .nav li.dropdown.active>.dropdown-toggle,.navbar-inverse .nav li.dropdown.open.active>.dropdown-toggle{color:#fff;background-color:#111}.navbar-inverse .nav li.dropdown>a:hover .caret{border-top-color:#fff;border-bottom-color:#fff}.navbar-inverse .nav li.dropdown>.dropdown-toggle .caret{border-top-color:#999;border-bottom-color:#999}.navbar-inverse .nav li.dropdown.open>.dropdown-toggle .caret,.navbar-inverse .nav li.dropdown.active>.dropdown-toggle .caret,.navbar-inverse .nav li.dropdown.open.active>.dropdown-toggle .caret{border-top-color:#fff;border-bottom-color:#fff}.navbar-inverse .navbar-search .search-query{color:#fff;background-color:#515151;border-color:#111;-webkit-box-shadow:inset 0 1px 2px rgba(0,0,0,0.1),0 1px 0 rgba(255,255,255,0.15);-moz-box-shadow:inset 0 1px 2px rgba(0,0,0,0.1),0 1px 0 rgba(255,255,255,0.15);box-shadow:inset 0 1px 2px rgba(0,0,0,0.1),0 1px 0 rgba(255,255,255,0.15);-webkit-transition:none;-moz-transition:none;-o-transition:none;transition:none}.navbar-inverse .navbar-search .search-query:-moz-placeholder{color:#ccc}.navbar-inverse .navbar-search .search-query:-ms-input-placeholder{color:#ccc}.navbar-inverse .navbar-search .search-query::-webkit-input-placeholder{color:#ccc}.navbar-inverse .navbar-search .search-query:focus,.navbar-inverse .navbar-search .search-query.focused{padding:5px 15px;color:#333;text-shadow:0 1px 0 #fff;background-color:#fff;border:0;outline:0;-webkit-box-shadow:0 0 3px rgba(0,0,0,0.15);-moz-box-shadow:0 0 3px rgba(0,0,0,0.15);box-shadow:0 0 3px rgba(0,0,0,0.15)}.navbar-inverse .btn-navbar{color:#fff;text-shadow:0 -1px 0 rgba(0,0,0,0.25);background-color:#0e0e0e;*background-color:#040404;background-image:-moz-linear-gradient(top,#151515,#040404);background-image:-webkit-gradient(linear,0 0,0 100%,from(#151515),to(#040404));background-image:-webkit-linear-gradient(top,#151515,#040404);background-image:-o-linear-gradient(top,#151515,#040404);background-image:linear-gradient(to bottom,#151515,#040404);background-repeat:repeat-x;border-color:#040404 #040404 #000;border-color:rgba(0,0,0,0.1) rgba(0,0,0,0.1) rgba(0,0,0,0.25);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff151515',endColorstr='#ff040404',GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled=false)}.navbar-inverse .btn-navbar:hover,.navbar-inverse .btn-navbar:active,.navbar-inverse .btn-navbar.active,.navbar-inverse .btn-navbar.disabled,.navbar-inverse .btn-navbar[disabled]{color:#fff;background-color:#040404;*background-color:#000}.navbar-inverse .btn-navbar:active,.navbar-inverse .btn-navbar.active{background-color:#000 \9}.breadcrumb{padding:8px 15px;margin:0 0 20px;list-style:none;background-color:#f5f5f5;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px}.breadcrumb>li{display:inline-block;*display:inline;text-shadow:0 1px 0 #fff;*zoom:1}.breadcrumb>li>.divider{padding:0 5px;color:#ccc}.breadcrumb>.active{color:#999}.pagination{margin:20px 0}.pagination ul{display:inline-block;*display:inline;margin-bottom:0;margin-left:0;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px;*zoom:1;-webkit-box-shadow:0 1px 2px rgba(0,0,0,0.05);-moz-box-shadow:0 1px 2px rgba(0,0,0,0.05);box-shadow:0 1px 2px rgba(0,0,0,0.05)}.pagination ul>li{display:inline}.pagination ul>li>a,.pagination ul>li>span{float:left;padding:4px 12px;line-height:20px;text-decoration:none;background-color:#fff;border:1px solid #ddd;border-left-width:0}.pagination ul>li>a:hover,.pagination ul>.active>a,.pagination ul>.active>span{background-color:#f5f5f5}.pagination ul>.active>a,.pagination ul>.active>span{color:#999;cursor:default}.pagination ul>.disabled>span,.pagination ul>.disabled>a,.pagination ul>.disabled>a:hover{color:#999;cursor:default;background-color:transparent}.pagination ul>li:first-child>a,.pagination ul>li:first-child>span{border-left-width:1px;-webkit-border-bottom-left-radius:4px;border-bottom-left-radius:4px;-webkit-border-top-left-radius:4px;border-top-left-radius:4px;-moz-border-radius-bottomleft:4px;-moz-border-radius-topleft:4px}.pagination ul>li:last-child>a,.pagination ul>li:last-child>span{-webkit-border-top-right-radius:4px;border-top-right-radius:4px;-webkit-border-bottom-right-radius:4px;border-bottom-right-radius:4px;-moz-border-radius-topright:4px;-moz-border-radius-bottomright:4px}.pagination-centered{text-align:center}.pagination-right{text-align:right}.pagination-large ul>li>a,.pagination-large ul>li>span{padding:11px 19px;font-size:17.5px}.pagination-large ul>li:first-child>a,.pagination-large ul>li:first-child>span{-webkit-border-bottom-left-radius:6px;border-bottom-left-radius:6px;-webkit-border-top-left-radius:6px;border-top-left-radius:6px;-moz-border-radius-bottomleft:6px;-moz-border-radius-topleft:6px}.pagination-large ul>li:last-child>a,.pagination-large ul>li:last-child>span{-webkit-border-top-right-radius:6px;border-top-right-radius:6px;-webkit-border-bottom-right-radius:6px;border-bottom-right-radius:6px;-moz-border-radius-topright:6px;-moz-border-radius-bottomright:6px}.pagination-mini ul>li:first-child>a,.pagination-small ul>li:first-child>a,.pagination-mini ul>li:first-child>span,.pagination-small ul>li:first-child>span{-webkit-border-bottom-left-radius:3px;border-bottom-left-radius:3px;-webkit-border-top-left-radius:3px;border-top-left-radius:3px;-moz-border-radius-bottomleft:3px;-moz-border-radius-topleft:3px}.pagination-mini ul>li:last-child>a,.pagination-small ul>li:last-child>a,.pagination-mini ul>li:last-child>span,.pagination-small ul>li:last-child>span{-webkit-border-top-right-radius:3px;border-top-right-radius:3px;-webkit-border-bottom-right-radius:3px;border-bottom-right-radius:3px;-moz-border-radius-topright:3px;-moz-border-radius-bottomright:3px}.pagination-small ul>li>a,.pagination-small ul>li>span{padding:2px 10px;font-size:11.9px}.pagination-mini ul>li>a,.pagination-mini ul>li>span{padding:0 6px;font-size:10.5px}.pager{margin:20px 0;text-align:center;list-style:none;*zoom:1}.pager:before,.pager:after{display:table;line-height:0;content:""}.pager:after{clear:both}.pager li{display:inline}.pager li>a,.pager li>span{display:inline-block;padding:5px 14px;background-color:#fff;border:1px solid #ddd;-webkit-border-radius:15px;-moz-border-radius:15px;border-radius:15px}.pager li>a:hover{text-decoration:none;background-color:#f5f5f5}.pager .next>a,.pager .next>span{float:right}.pager .previous>a,.pager .previous>span{float:left}.pager .disabled>a,.pager .disabled>a:hover,.pager .disabled>span{color:#999;cursor:default;background-color:#fff}.modal-backdrop{position:fixed;top:0;right:0;bottom:0;left:0;z-index:1040;background-color:#000}.modal-backdrop.fade{opacity:0}.modal-backdrop,.modal-backdrop.fade.in{opacity:.8;filter:alpha(opacity=80)}.modal{position:fixed;top:10%;left:50%;z-index:1050;width:560px;margin-left:-280px;background-color:#fff;border:1px solid #999;border:1px solid rgba(0,0,0,0.3);*border:1px solid #999;-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px;outline:0;-webkit-box-shadow:0 3px 7px rgba(0,0,0,0.3);-moz-box-shadow:0 3px 7px rgba(0,0,0,0.3);box-shadow:0 3px 7px rgba(0,0,0,0.3);-webkit-background-clip:padding-box;-moz-background-clip:padding-box;background-clip:padding-box}.modal.fade{top:-25%;-webkit-transition:opacity .3s linear,top .3s ease-out;-moz-transition:opacity .3s linear,top .3s ease-out;-o-transition:opacity .3s linear,top .3s ease-out;transition:opacity .3s linear,top .3s ease-out}.modal.fade.in{top:10%}.modal-header{padding:9px 15px;border-bottom:1px solid #eee}.modal-header .close{margin-top:2px}.modal-header h3{margin:0;line-height:30px}.modal-body{position:relative;max-height:400px;padding:15px;overflow-y:auto}.modal-form{margin-bottom:0}.modal-footer{padding:14px 15px 15px;margin-bottom:0;text-align:right;background-color:#f5f5f5;border-top:1px solid #ddd;-webkit-border-radius:0 0 6px 6px;-moz-border-radius:0 0 6px 6px;border-radius:0 0 6px 6px;*zoom:1;-webkit-box-shadow:inset 0 1px 0 #fff;-moz-box-shadow:inset 0 1px 0 #fff;box-shadow:inset 0 1px 0 #fff}.modal-footer:before,.modal-footer:after{display:table;line-height:0;content:""}.modal-footer:after{clear:both}.modal-footer .btn+.btn{margin-bottom:0;margin-left:5px}.modal-footer .btn-group .btn+.btn{margin-left:-1px}.modal-footer .btn-block+.btn-block{margin-left:0}.tooltip{position:absolute;z-index:1030;display:block;padding:5px;font-size:11px;opacity:0;filter:alpha(opacity=0);visibility:visible}.tooltip.in{opacity:.8;filter:alpha(opacity=80)}.tooltip.top{margin-top:-3px}.tooltip.right{margin-left:3px}.tooltip.bottom{margin-top:3px}.tooltip.left{margin-left:-3px}.tooltip-inner{max-width:200px;padding:3px 8px;color:#fff;text-align:center;text-decoration:none;background-color:#000;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px}.tooltip-arrow{position:absolute;width:0;height:0;border-color:transparent;border-style:solid}.tooltip.top .tooltip-arrow{bottom:0;left:50%;margin-left:-5px;border-top-color:#000;border-width:5px 5px 0}.tooltip.right .tooltip-arrow{top:50%;left:0;margin-top:-5px;border-right-color:#000;border-width:5px 5px 5px 0}.tooltip.left .tooltip-arrow{top:50%;right:0;margin-top:-5px;border-left-color:#000;border-width:5px 0 5px 5px}.tooltip.bottom .tooltip-arrow{top:0;left:50%;margin-left:-5px;border-bottom-color:#000;border-width:0 5px 5px}.popover{position:absolute;top:0;left:0;z-index:1010;display:none;width:236px;padding:1px;text-align:left;white-space:normal;background-color:#fff;border:1px solid #ccc;border:1px solid rgba(0,0,0,0.2);-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px;-webkit-box-shadow:0 5px 10px rgba(0,0,0,0.2);-moz-box-shadow:0 5px 10px rgba(0,0,0,0.2);box-shadow:0 5px 10px rgba(0,0,0,0.2);-webkit-background-clip:padding-box;-moz-background-clip:padding;background-clip:padding-box}.popover.top{margin-top:-10px}.popover.right{margin-left:10px}.popover.bottom{margin-top:10px}.popover.left{margin-left:-10px}.popover-title{padding:8px 14px;margin:0;font-size:14px;font-weight:normal;line-height:18px;background-color:#f7f7f7;border-bottom:1px solid #ebebeb;-webkit-border-radius:5px 5px 0 0;-moz-border-radius:5px 5px 0 0;border-radius:5px 5px 0 0}.popover-content{padding:9px 14px}.popover .arrow,.popover .arrow:after{position:absolute;display:block;width:0;height:0;border-color:transparent;border-style:solid}.popover .arrow{border-width:11px}.popover .arrow:after{border-width:10px;content:""}.popover.top .arrow{bottom:-11px;left:50%;margin-left:-11px;border-top-color:#999;border-top-color:rgba(0,0,0,0.25);border-bottom-width:0}.popover.top .arrow:after{bottom:1px;margin-left:-10px;border-top-color:#fff;border-bottom-width:0}.popover.right .arrow{top:50%;left:-11px;margin-top:-11px;border-right-color:#999;border-right-color:rgba(0,0,0,0.25);border-left-width:0}.popover.right .arrow:after{bottom:-10px;left:1px;border-right-color:#fff;border-left-width:0}.popover.bottom .arrow{top:-11px;left:50%;margin-left:-11px;border-bottom-color:#999;border-bottom-color:rgba(0,0,0,0.25);border-top-width:0}.popover.bottom .arrow:after{top:1px;margin-left:-10px;border-bottom-color:#fff;border-top-width:0}.popover.left .arrow{top:50%;right:-11px;margin-top:-11px;border-left-color:#999;border-left-color:rgba(0,0,0,0.25);border-right-width:0}.popover.left .arrow:after{right:1px;bottom:-10px;border-left-color:#fff;border-right-width:0}.thumbnails{margin-left:-20px;list-style:none;*zoom:1}.thumbnails:before,.thumbnails:after{display:table;line-height:0;content:""}.thumbnails:after{clear:both}.row-fluid .thumbnails{margin-left:0}.thumbnails>li{float:left;margin-bottom:20px;margin-left:20px}.thumbnail{display:block;padding:4px;line-height:20px;border:1px solid #ddd;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px;-webkit-box-shadow:0 1px 3px rgba(0,0,0,0.055);-moz-box-shadow:0 1px 3px rgba(0,0,0,0.055);box-shadow:0 1px 3px rgba(0,0,0,0.055);-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;-o-transition:all .2s ease-in-out;transition:all .2s ease-in-out}a.thumbnail:hover{border-color:#08c;-webkit-box-shadow:0 1px 4px rgba(0,105,214,0.25);-moz-box-shadow:0 1px 4px rgba(0,105,214,0.25);box-shadow:0 1px 4px rgba(0,105,214,0.25)}.thumbnail>img{display:block;max-width:100%;margin-right:auto;margin-left:auto}.thumbnail .caption{padding:9px;color:#555}.media,.media-body{overflow:hidden;*overflow:visible;zoom:1}.media,.media .media{margin-top:15px}.media:first-child{margin-top:0}.media-object{display:block}.media-heading{margin:0 0 5px}.media .pull-left{margin-right:10px}.media .pull-right{margin-left:10px}.media-list{margin-left:0;list-style:none}.label,.badge{display:inline-block;padding:2px 4px;font-size:11.844px;font-weight:bold;line-height:14px;color:#fff;text-shadow:0 -1px 0 rgba(0,0,0,0.25);white-space:nowrap;vertical-align:baseline;background-color:#999}.label{-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px}.badge{padding-right:9px;padding-left:9px;-webkit-border-radius:9px;-moz-border-radius:9px;border-radius:9px}.label:empty,.badge:empty{display:none}a.label:hover,a.badge:hover{color:#fff;text-decoration:none;cursor:pointer}.label-important,.badge-important{background-color:#b94a48}.label-important[href],.badge-important[href]{background-color:#953b39}.label-warning,.badge-warning{background-color:#f89406}.label-warning[href],.badge-warning[href]{background-color:#c67605}.label-success,.badge-success{background-color:#468847}.label-success[href],.badge-success[href]{background-color:#356635}.label-info,.badge-info{background-color:#3a87ad}.label-info[href],.badge-info[href]{background-color:#2d6987}.label-inverse,.badge-inverse{background-color:#333}.label-inverse[href],.badge-inverse[href]{background-color:#1a1a1a}.btn .label,.btn .badge{position:relative;top:-1px}.btn-mini .label,.btn-mini .badge{top:0}@-webkit-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@-moz-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@-ms-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@-o-keyframes progress-bar-stripes{from{background-position:0 0}to{background-position:40px 0}}@keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}.progress{height:20px;margin-bottom:20px;overflow:hidden;background-color:#f7f7f7;background-image:-moz-linear-gradient(top,#f5f5f5,#f9f9f9);background-image:-webkit-gradient(linear,0 0,0 100%,from(#f5f5f5),to(#f9f9f9));background-image:-webkit-linear-gradient(top,#f5f5f5,#f9f9f9);background-image:-o-linear-gradient(top,#f5f5f5,#f9f9f9);background-image:linear-gradient(to bottom,#f5f5f5,#f9f9f9);background-repeat:repeat-x;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff5f5f5',endColorstr='#fff9f9f9',GradientType=0);-webkit-box-shadow:inset 0 1px 2px rgba(0,0,0,0.1);-moz-box-shadow:inset 0 1px 2px rgba(0,0,0,0.1);box-shadow:inset 0 1px 2px rgba(0,0,0,0.1)}.progress .bar{float:left;width:0;height:100%;font-size:12px;color:#fff;text-align:center;text-shadow:0 -1px 0 rgba(0,0,0,0.25);background-color:#0e90d2;background-image:-moz-linear-gradient(top,#149bdf,#0480be);background-image:-webkit-gradient(linear,0 0,0 100%,from(#149bdf),to(#0480be));background-image:-webkit-linear-gradient(top,#149bdf,#0480be);background-image:-o-linear-gradient(top,#149bdf,#0480be);background-image:linear-gradient(to bottom,#149bdf,#0480be);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff149bdf',endColorstr='#ff0480be',GradientType=0);-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,0.15);-moz-box-shadow:inset 0 -1px 0 rgba(0,0,0,0.15);box-shadow:inset 0 -1px 0 rgba(0,0,0,0.15);-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;-webkit-transition:width .6s ease;-moz-transition:width .6s ease;-o-transition:width .6s ease;transition:width .6s ease}.progress .bar+.bar{-webkit-box-shadow:inset 1px 0 0 rgba(0,0,0,0.15),inset 0 -1px 0 rgba(0,0,0,0.15);-moz-box-shadow:inset 1px 0 0 rgba(0,0,0,0.15),inset 0 -1px 0 rgba(0,0,0,0.15);box-shadow:inset 1px 0 0 rgba(0,0,0,0.15),inset 0 -1px 0 rgba(0,0,0,0.15)}.progress-striped .bar{background-color:#149bdf;background-image:-webkit-gradient(linear,0 100%,100% 0,color-stop(0.25,rgba(255,255,255,0.15)),color-stop(0.25,transparent),color-stop(0.5,transparent),color-stop(0.5,rgba(255,255,255,0.15)),color-stop(0.75,rgba(255,255,255,0.15)),color-stop(0.75,transparent),to(transparent));background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-moz-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);-webkit-background-size:40px 40px;-moz-background-size:40px 40px;-o-background-size:40px 40px;background-size:40px 40px}.progress.active .bar{-webkit-animation:progress-bar-stripes 2s linear infinite;-moz-animation:progress-bar-stripes 2s linear infinite;-ms-animation:progress-bar-stripes 2s linear infinite;-o-animation:progress-bar-stripes 2s linear infinite;animation:progress-bar-stripes 2s linear infinite}.progress-danger .bar,.progress .bar-danger{background-color:#dd514c;background-image:-moz-linear-gradient(top,#ee5f5b,#c43c35);background-image:-webkit-gradient(linear,0 0,0 100%,from(#ee5f5b),to(#c43c35));background-image:-webkit-linear-gradient(top,#ee5f5b,#c43c35);background-image:-o-linear-gradient(top,#ee5f5b,#c43c35);background-image:linear-gradient(to bottom,#ee5f5b,#c43c35);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffee5f5b',endColorstr='#ffc43c35',GradientType=0)}.progress-danger.progress-striped .bar,.progress-striped .bar-danger{background-color:#ee5f5b;background-image:-webkit-gradient(linear,0 100%,100% 0,color-stop(0.25,rgba(255,255,255,0.15)),color-stop(0.25,transparent),color-stop(0.5,transparent),color-stop(0.5,rgba(255,255,255,0.15)),color-stop(0.75,rgba(255,255,255,0.15)),color-stop(0.75,transparent),to(transparent));background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-moz-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent)}.progress-success .bar,.progress .bar-success{background-color:#5eb95e;background-image:-moz-linear-gradient(top,#62c462,#57a957);background-image:-webkit-gradient(linear,0 0,0 100%,from(#62c462),to(#57a957));background-image:-webkit-linear-gradient(top,#62c462,#57a957);background-image:-o-linear-gradient(top,#62c462,#57a957);background-image:linear-gradient(to bottom,#62c462,#57a957);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff62c462',endColorstr='#ff57a957',GradientType=0)}.progress-success.progress-striped .bar,.progress-striped .bar-success{background-color:#62c462;background-image:-webkit-gradient(linear,0 100%,100% 0,color-stop(0.25,rgba(255,255,255,0.15)),color-stop(0.25,transparent),color-stop(0.5,transparent),color-stop(0.5,rgba(255,255,255,0.15)),color-stop(0.75,rgba(255,255,255,0.15)),color-stop(0.75,transparent),to(transparent));background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-moz-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent)}.progress-info .bar,.progress .bar-info{background-color:#4bb1cf;background-image:-moz-linear-gradient(top,#5bc0de,#339bb9);background-image:-webkit-gradient(linear,0 0,0 100%,from(#5bc0de),to(#339bb9));background-image:-webkit-linear-gradient(top,#5bc0de,#339bb9);background-image:-o-linear-gradient(top,#5bc0de,#339bb9);background-image:linear-gradient(to bottom,#5bc0de,#339bb9);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff5bc0de',endColorstr='#ff339bb9',GradientType=0)}.progress-info.progress-striped .bar,.progress-striped .bar-info{background-color:#5bc0de;background-image:-webkit-gradient(linear,0 100%,100% 0,color-stop(0.25,rgba(255,255,255,0.15)),color-stop(0.25,transparent),color-stop(0.5,transparent),color-stop(0.5,rgba(255,255,255,0.15)),color-stop(0.75,rgba(255,255,255,0.15)),color-stop(0.75,transparent),to(transparent));background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-moz-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent)}.progress-warning .bar,.progress .bar-warning{background-color:#faa732;background-image:-moz-linear-gradient(top,#fbb450,#f89406);background-image:-webkit-gradient(linear,0 0,0 100%,from(#fbb450),to(#f89406));background-image:-webkit-linear-gradient(top,#fbb450,#f89406);background-image:-o-linear-gradient(top,#fbb450,#f89406);background-image:linear-gradient(to bottom,#fbb450,#f89406);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fffbb450',endColorstr='#fff89406',GradientType=0)}.progress-warning.progress-striped .bar,.progress-striped .bar-warning{background-color:#fbb450;background-image:-webkit-gradient(linear,0 100%,100% 0,color-stop(0.25,rgba(255,255,255,0.15)),color-stop(0.25,transparent),color-stop(0.5,transparent),color-stop(0.5,rgba(255,255,255,0.15)),color-stop(0.75,rgba(255,255,255,0.15)),color-stop(0.75,transparent),to(transparent));background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-moz-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,0.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,0.15) 50%,rgba(255,255,255,0.15) 75%,transparent 75%,transparent)}.accordion{margin-bottom:20px}.accordion-group{margin-bottom:2px;border:1px solid #e5e5e5;-webkit-border-radius:4px;-moz-border-radius:4px;border-radius:4px}.accordion-heading{border-bottom:0}.accordion-heading .accordion-toggle{display:block;padding:8px 15px}.accordion-toggle{cursor:pointer}.accordion-inner{padding:9px 15px;border-top:1px solid #e5e5e5}.carousel{position:relative;margin-bottom:20px;line-height:1}.carousel-inner{position:relative;width:100%;overflow:hidden}.carousel-inner>.item{position:relative;display:none;-webkit-transition:.6s ease-in-out left;-moz-transition:.6s ease-in-out left;-o-transition:.6s ease-in-out left;transition:.6s ease-in-out left}.carousel-inner>.item>img{display:block;line-height:1}.carousel-inner>.active,.carousel-inner>.next,.carousel-inner>.prev{display:block}.carousel-inner>.active{left:0}.carousel-inner>.next,.carousel-inner>.prev{position:absolute;top:0;width:100%}.carousel-inner>.next{left:100%}.carousel-inner>.prev{left:-100%}.carousel-inner>.next.left,.carousel-inner>.prev.right{left:0}.carousel-inner>.active.left{left:-100%}.carousel-inner>.active.right{left:100%}.carousel-control{position:absolute;top:40%;left:15px;width:40px;height:40px;margin-top:-20px;font-size:60px;font-weight:100;line-height:30px;color:#fff;text-align:center;background:#222;border:3px solid #fff;-webkit-border-radius:23px;-moz-border-radius:23px;border-radius:23px;opacity:.5;filter:alpha(opacity=50)}.carousel-control.right{right:15px;left:auto}.carousel-control:hover{color:#fff;text-decoration:none;opacity:.9;filter:alpha(opacity=90)}.carousel-caption{position:absolute;right:0;bottom:0;left:0;padding:15px;background:#333;background:rgba(0,0,0,0.75)}.carousel-caption h4,.carousel-caption p{line-height:20px;color:#fff}.carousel-caption h4{margin:0 0 5px}.carousel-caption p{margin-bottom:0}.hero-unit{padding:60px;margin-bottom:30px;font-size:18px;font-weight:200;line-height:30px;color:inherit;background-color:#eee;-webkit-border-radius:6px;-moz-border-radius:6px;border-radius:6px}.hero-unit h1{margin-bottom:0;font-size:60px;line-height:1;letter-spacing:-1px;color:inherit}.hero-unit li{line-height:30px}.pull-right{float:right}.pull-left{float:left}.hide{display:none}.show{display:block}.invisible{visibility:hidden}.affix{position:fixed} diff --git a/plugin/mindmap/edit-mindmap/vendor/css/help.css b/plugin/mindmap/edit-mindmap/vendor/css/help.css new file mode 100644 index 000000000..3523085e8 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/css/help.css @@ -0,0 +1,6 @@ +html,body{margin:0;padding:0;} +html{background-color: rgb(0,135,255);height:100%;} +body{background-color: white;min-height:100%;} +.contentWrapper{width:940px;margin:0 auto;overflow: hidden;} +.nav{padding:30px 0;} +.next-page{float:right;} \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/vendor/css/qunit.css b/plugin/mindmap/edit-mindmap/vendor/css/qunit.css new file mode 100644 index 000000000..a1dd6a809 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/css/qunit.css @@ -0,0 +1,236 @@ +/** + * QUnit v1.7.0pre - A JavaScript Unit Testing Framework + * + * http://docs.jquery.com/QUnit + * + * Copyright (c) 2012 John Resig, Jörn Zaefferer + * Dual licensed under the MIT (MIT-LICENSE.txt) + * or GPL (GPL-LICENSE.txt) licenses. + */ + +/** Font Family and Sizes */ + +#qunit-tests, #qunit-header, #qunit-banner, #qunit-testrunner-toolbar, #qunit-userAgent, #qunit-testresult { + font-family: "Helvetica Neue Light", "HelveticaNeue-Light", "Helvetica Neue", Calibri, Helvetica, Arial, sans-serif; +} + +#qunit-testrunner-toolbar, #qunit-userAgent, #qunit-testresult, #qunit-tests li { font-size: small; } +#qunit-tests { font-size: smaller; } + + +/** Resets */ + +#qunit-tests, #qunit-tests ol, #qunit-header, #qunit-banner, #qunit-userAgent, #qunit-testresult { + margin: 0; + padding: 0; +} + + +/** Header */ + +#qunit-header { + padding: 0.5em 0 0.5em 1em; + + color: #8699a4; + background-color: #0d3349; + + font-size: 1.5em; + line-height: 1em; + font-weight: normal; + + border-radius: 15px 15px 0 0; + -moz-border-radius: 15px 15px 0 0; + -webkit-border-top-right-radius: 15px; + -webkit-border-top-left-radius: 15px; +} + +#qunit-header a { + text-decoration: none; + color: #c2ccd1; +} + +#qunit-header a:hover, +#qunit-header a:focus { + color: #fff; +} + +#qunit-header label { + display: inline-block; + padding-left: 0.5em; +} + +#qunit-banner { + height: 5px; +} + +#qunit-testrunner-toolbar { + padding: 0.5em 0 0.5em 2em; + color: #5E740B; + background-color: #eee; +} + +#qunit-userAgent { + padding: 0.5em 0 0.5em 2.5em; + background-color: #2b81af; + color: #fff; + text-shadow: rgba(0, 0, 0, 0.5) 2px 2px 1px; +} + + +/** Tests: Pass/Fail */ + +#qunit-tests { + list-style-position: inside; +} + +#qunit-tests li { + padding: 0.4em 0.5em 0.4em 2.5em; + border-bottom: 1px solid #fff; + list-style-position: inside; +} + +#qunit-tests.hidepass li.pass, #qunit-tests.hidepass li.running { + display: none; +} + +#qunit-tests li strong { + cursor: pointer; +} + +#qunit-tests li a { + padding: 0.5em; + color: #c2ccd1; + text-decoration: none; +} +#qunit-tests li a:hover, +#qunit-tests li a:focus { + color: #000; +} + +#qunit-tests ol { + margin-top: 0.5em; + padding: 0.5em; + + background-color: #fff; + + border-radius: 15px; + -moz-border-radius: 15px; + -webkit-border-radius: 15px; + + box-shadow: inset 0px 2px 13px #999; + -moz-box-shadow: inset 0px 2px 13px #999; + -webkit-box-shadow: inset 0px 2px 13px #999; +} + +#qunit-tests table { + border-collapse: collapse; + margin-top: .2em; +} + +#qunit-tests th { + text-align: right; + vertical-align: top; + padding: 0 .5em 0 0; +} + +#qunit-tests td { + vertical-align: top; +} + +#qunit-tests pre { + margin: 0; + white-space: pre-wrap; + word-wrap: break-word; +} + +#qunit-tests del { + background-color: #e0f2be; + color: #374e0c; + text-decoration: none; +} + +#qunit-tests ins { + background-color: #ffcaca; + color: #500; + text-decoration: none; +} + +/*** Test Counts */ + +#qunit-tests b.counts { color: black; } +#qunit-tests b.passed { color: #5E740B; } +#qunit-tests b.failed { color: #710909; } + +#qunit-tests li li { + margin: 0.5em; + padding: 0.4em 0.5em 0.4em 0.5em; + background-color: #fff; + border-bottom: none; + list-style-position: inside; +} + +/*** Passing Styles */ + +#qunit-tests li li.pass { + color: #5E740B; + background-color: #fff; + border-left: 26px solid #C6E746; +} + +#qunit-tests .pass { color: #528CE0; background-color: #D2E0E6; } +#qunit-tests .pass .test-name { color: #366097; } + +#qunit-tests .pass .test-actual, +#qunit-tests .pass .test-expected { color: #999999; } + +#qunit-banner.qunit-pass { background-color: #C6E746; } + +/*** Failing Styles */ + +#qunit-tests li li.fail { + color: #710909; + background-color: #fff; + border-left: 26px solid #EE5757; + white-space: pre; +} + +#qunit-tests > li:last-child { + border-radius: 0 0 15px 15px; + -moz-border-radius: 0 0 15px 15px; + -webkit-border-bottom-right-radius: 15px; + -webkit-border-bottom-left-radius: 15px; +} + +#qunit-tests .fail { color: #000000; background-color: #EE5757; } +#qunit-tests .fail .test-name, +#qunit-tests .fail .module-name { color: #000000; } + +#qunit-tests .fail .test-actual { color: #EE5757; } +#qunit-tests .fail .test-expected { color: green; } + +#qunit-banner.qunit-fail { background-color: #EE5757; } + + +/** Result */ + +#qunit-testresult { + padding: 0.5em 0.5em 0.5em 2.5em; + + color: #2b81af; + background-color: #D2E0E6; + + border-bottom: 1px solid white; +} +#qunit-testresult .module-name { + font-weight: bold; +} + +/** Fixture */ + +#qunit-fixture { + position: absolute; + top: -10000px; + left: -10000px; + width: 1000px; + height: 1000px; +} diff --git a/plugin/mindmap/edit-mindmap/vendor/help/introduce.html b/plugin/mindmap/edit-mindmap/vendor/help/introduce.html new file mode 100644 index 000000000..1423f8e40 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/help/introduce.html @@ -0,0 +1,68 @@ + + + + + MindMap帮助文档 + + + + + +
    +

    MindMap帮助文档

    + +

    简介

    + +

    + MindMap是一款web版的思维导图应用，整个项目使用html+css+javascript开发。MindMap利用了许多html5特性:Storage、 File Access、 Graphics、 Presentation。 +

    + +

    技术实现

    + +

    + MindMap以bootstrap为基础开发css+html。 +

    +

    + MindMap采用OOP的开发方式，使用类似backbone的extend方法实现继承。许多设计模式被应用到MindMap中：使用Command模式实现操作的Undo和Redo功能，使用Compositon模式组织map和node对象等等。 +

    +

    + MindMap的js组织方式，变量命名方式受到google closure的影响。 MindMap实现了一个类似closure的js加载器，配合一个nodejs脚本（用于生成js文件依赖记录）来管理组件之间的依赖关系。 +

    + +

    兼容性

    + +

    + 目前mindMap支持：Firefox19、Chrome25。我没有条件测试Safari；而Opera最近宣布将加入webkit的大家庭，所以我也没有再花时间测试；MindMap不支持IE。 +

    + +

    功能特性

    + +
      +
    1. + 可以将map保存为本地的文本文件，也能打开本地文本格式的map +
      2. +
    2. + 可以将map保存在浏览器的storage中，也能打开在storage中的map +
      3. +
    3. + 创建新的map，为map添加节点，为节点添加子节点，删除节点。 +
      4. +
    4. + 改变节点的内容、位置 +
      5. +
    5. + 保存操作，实现了简单的redo和undo功能 +
      6. +
    6. + 节点的copy、cut、paste功能 +
      7. +
    +
    + 下一节：map操作 +
    +
    + + \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/vendor/help/license.html b/plugin/mindmap/edit-mindmap/vendor/help/license.html new file mode 100644 index 000000000..ef1b1c0ce --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/help/license.html @@ -0,0 +1,46 @@ + + + + + templates + + + + + + +
    +

    mindMap帮助文档

    +
    + +

    简介

    + +

    MindMap是一款web版的思维导图应用，整个项目使用html+css+javascript开发。MindMap利用了许多html5特性:Storage、File Access、Graphics、Presentation。目前mindMap支持的浏览器有：Firefox19、Chrome25，我没有条件测试Safari，而Opera最近宣布将加入webkit的大家庭，所以我也没有再花时间测试，mindMap不支持IE。

    + +

    建立MindMap的目的是将自己在学习工作中积累的新知识和技巧应用到实践中。

    + +

    MindMap以bootstrap为基础开发css+html。 +js结构，命名方式类似于google closure，mindMap实现了一个类似closure的js加载器，并且使用一个nodejs脚本管理js文件的依赖关系。

    + +

    功能特性

    + +
      +
    1. 可以将map保存为本地的文本文件，也能本地文本格式的map
      2. +
    2. 可以将map保存在浏览器的storage中，也能打开在storage中的map
      3. +
    3. 创建新的map，为map添加节点，为节点添加子节点，删除节点。
      4. +
    4. 改变节点的内容、位置
      5. +
    5. 保存操作，实现了简单的redo和undo功能
      6. +
    6. 节点的copy、cut、paste功能
      7. +
    +
    +
    +
    + + \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/vendor/help/map.html b/plugin/mindmap/edit-mindmap/vendor/help/map.html new file mode 100644 index 000000000..30f90d679 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/help/map.html @@ -0,0 +1,103 @@ + + + + + + + MindMap帮助文档 + + + + + + +
    +

    MindMap帮助文档

    +

    map操作

    +
      +
    1. +

      + 创建新map：file-〉Create New Map 或者使用快捷键[ctrl+m] +

      + +

      create new map +

      +
      2. +
    2. +

      + 打开硬盘中的map：file-〉Open Map In Disk +

      + +

      open map in disk +

      +
      3. +
    3. +

      + 打开storage中的map：file-〉Open Map In Storage +

      + +

      open map in storage +

      +
      4. +
    4. +

      + 将map保存到硬盘中：file-〉Save Map In Disk 或者使用快捷键[ctrl+shift+s] +

      + +

      open map in storage +

      +
      5. +
    5. +

      + 将map保存到storage中：file-〉Save Map In Storage 或者使用快捷键[ctrl+s] +

      + +

      open map in storage +

      +
      6. +
    6. +

      + contextMenu: 右键点击map空白处 +

      +
      7. +
    7. +

      + 取消上一步操作：file-〉Undo 或者 contextMenu-〉Undo 或者使用快捷键[ctrl+z] +

      + +

      undo +

      + +

      undo +

      +
      8. +
    8. +

      + 还原上一步操作：file-〉Redo 或者 contextMenu-〉Redo 或者使用快捷键[ctrl+y] +

      + +

      redo +

      + +

      redo +

      +
      9. +
    9. +

      + 查看help文档 +

      + +

      redo +

      +
      10. +
    +
    + 上一节：MindMap简介 + 下一节：node操作 +
    +
    + + diff --git a/plugin/mindmap/edit-mindmap/vendor/help/node.html b/plugin/mindmap/edit-mindmap/vendor/help/node.html new file mode 100644 index 000000000..8c0e1f4ef --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/help/node.html @@ -0,0 +1,99 @@ + + + + + + + MindMap帮助文档 + + + + + + +
    +

    MindMap帮助文档

    +

    node操作

    +
      +
    1. +

      + 选中节点：左键单击节点 +

      +
      2. +
    2. +

      + nodeContextMenu：右键单击节点 +

      +
      3. +
    3. +

      + 修改节点位置：左键点击节点不松，拖动鼠标 +

      +
      4. +
    4. +

      + 修改节点内容：nodeContextMenu-〉edit +

      + +

      edit node +

      +
      5. +
    5. +

      + 创建根节点：contextMenu-〉Creat New Root Node +

      + +

      cteate root node +

      +
      6. +
    6. +

      + 添加子节点：nodeContextmenu-> Append Child Node +

      + +

      append child node +

      +
      7. +
    7. +

      + 删除节点：nodeContextMenu-〉Delete +

      + +

      delete node +

      +
      8. +
    8. +

      + 复制节点：选中节点-〉（点击右键-〉Copy）或者（file-〉Copy） 或者使用快捷键[ctrl+c] +

      + +

      copy node +

      +
      9. +
    9. +

      + 剪切节点：选中节点-〉（点击右键-〉cut）或者（file-〉cut） 或者使用快捷键[ctrl+x] +

      + +

      cut node +

      +
      10. +
    10. +

      + 粘贴节点：选中节点-〉（点击右键-〉Paste）或者（file-〉Paste） 或者使用快捷键[ctrl+v] +

      + +

      paste +

      +
      11. +
    +
    + 上一节：map操作 + Go to MindMap +
    +
    + + diff --git a/plugin/mindmap/edit-mindmap/vendor/html/index.html b/plugin/mindmap/edit-mindmap/vendor/html/index.html new file mode 100644 index 000000000..1a14f26ce --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/html/index.html @@ -0,0 +1,105 @@ + + + + + kampfer's mindMap + + + + + + + + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    + + + + + + + + diff --git a/plugin/mindmap/edit-mindmap/vendor/html/index2.html b/plugin/mindmap/edit-mindmap/vendor/html/index2.html new file mode 100644 index 000000000..7f04b0935 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/html/index2.html @@ -0,0 +1,225 @@ + + + + + kampfer's mindMap + + + + + + +
    + +
    + + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    +
    As a thank you, we ask you to include an optional link back to Glyphicons whenever practical.
    + +
    +
    + + +
    +
    + +

    © 2011-2012 kampfer

    + Kampfer's MindMap +
    +
    + + +
    +
    + +

    Save As :

    +
    +
    +

    There are 13 maps in your localstorage.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    #map namelastModified
    1 kampfer's mindmap12012-12-12
    2 kampfer's mindmap22012-12-12
    3 kampfer's mindmap32012-12-12
    4 kampfer's mindmap22012-12-12
    5 kampfer's mindmap22012-12-12
    6 kampfer's mindmap22012-12-12
    7 kampfer's mindmap22012-12-12
    8 kampfer's mindmap22012-12-12
    9 kampfer's mindmap22012-12-12
    10 kampfer's mindmap22012-12-12
    11 kampfer's mindmap22012-12-12
    12 kampfer's mindmap22012-12-12
    13 kampfer's mindmap22012-12-12
    14 kampfer's mindmap22012-12-12
    15 kampfer's mindmap22012-12-12
    16 kampfer's mindmap22012-12-12
    +
    +
    +
    + File name : + +
    +
    +
    +
    + Close + Save changes +
    +
    + + +
    + +
    + + +
    + + Holy guacamole! Best check yo self, you're not looking too good. +
    + + \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/vendor/html/template.html b/plugin/mindmap/edit-mindmap/vendor/html/template.html new file mode 100644 index 000000000..4751a914d --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/html/template.html @@ -0,0 +1,9 @@ + + + + + templates + + + diff --git a/plugin/mindmap/edit-mindmap/vendor/img/bg.gif b/plugin/mindmap/edit-mindmap/vendor/img/bg.gif new file mode 100644 index 000000000..c92e802e8 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/bg.gif differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/glyphicons-halflings-white.png b/plugin/mindmap/edit-mindmap/vendor/img/glyphicons-halflings-white.png new file mode 100644 index 000000000..3bf6484a2 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/glyphicons-halflings-white.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/glyphicons-halflings.png b/plugin/mindmap/edit-mindmap/vendor/img/glyphicons-halflings.png new file mode 100644 index 000000000..a99699932 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/glyphicons-halflings.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/append_child_node.png b/plugin/mindmap/edit-mindmap/vendor/img/help/append_child_node.png new file mode 100644 index 000000000..7d243359c Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/append_child_node.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/copy_node.png b/plugin/mindmap/edit-mindmap/vendor/img/help/copy_node.png new file mode 100644 index 000000000..f7370c041 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/copy_node.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/create_new_map.png b/plugin/mindmap/edit-mindmap/vendor/img/help/create_new_map.png new file mode 100644 index 000000000..c81cce27e Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/create_new_map.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/create_root_node.png b/plugin/mindmap/edit-mindmap/vendor/img/help/create_root_node.png new file mode 100644 index 000000000..671003a38 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/create_root_node.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/cut_node.png b/plugin/mindmap/edit-mindmap/vendor/img/help/cut_node.png new file mode 100644 index 000000000..0b08dfa8c Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/cut_node.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/delete.png b/plugin/mindmap/edit-mindmap/vendor/img/help/delete.png new file mode 100644 index 000000000..16ae1fde3 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/delete.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/edit_node.png b/plugin/mindmap/edit-mindmap/vendor/img/help/edit_node.png new file mode 100644 index 000000000..0ac5485b5 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/edit_node.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/help.png b/plugin/mindmap/edit-mindmap/vendor/img/help/help.png new file mode 100644 index 000000000..104b7e913 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/help.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/open_map_in_disk.png b/plugin/mindmap/edit-mindmap/vendor/img/help/open_map_in_disk.png new file mode 100644 index 000000000..927f3b2a0 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/open_map_in_disk.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/open_map_in_storage.png b/plugin/mindmap/edit-mindmap/vendor/img/help/open_map_in_storage.png new file mode 100644 index 000000000..b40433de4 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/open_map_in_storage.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/paste_node.png b/plugin/mindmap/edit-mindmap/vendor/img/help/paste_node.png new file mode 100644 index 000000000..5a61c0671 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/paste_node.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/redo1.png b/plugin/mindmap/edit-mindmap/vendor/img/help/redo1.png new file mode 100644 index 000000000..e535ea1f8 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/redo1.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/redo2.png b/plugin/mindmap/edit-mindmap/vendor/img/help/redo2.png new file mode 100644 index 000000000..0c26a1f99 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/redo2.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/save_map_in_disk.png b/plugin/mindmap/edit-mindmap/vendor/img/help/save_map_in_disk.png new file mode 100644 index 000000000..2f3f6f839 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/save_map_in_disk.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/save_map_in_storage.png b/plugin/mindmap/edit-mindmap/vendor/img/help/save_map_in_storage.png new file mode 100644 index 000000000..b72c0af41 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/save_map_in_storage.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/undo1.png b/plugin/mindmap/edit-mindmap/vendor/img/help/undo1.png new file mode 100644 index 000000000..8800f8345 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/undo1.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/img/help/undo2.png b/plugin/mindmap/edit-mindmap/vendor/img/help/undo2.png new file mode 100644 index 000000000..349c53f44 Binary files /dev/null and b/plugin/mindmap/edit-mindmap/vendor/img/help/undo2.png differ diff --git a/plugin/mindmap/edit-mindmap/vendor/index.html b/plugin/mindmap/edit-mindmap/vendor/index.html new file mode 100644 index 000000000..6973fe199 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/index.html @@ -0,0 +1,112 @@ + + + + + Kampfer's MindMap + + + + + + + + + + + + + +
    +
    +

    © 2012-2013 kampfer

    + Kampfer's MindMap +
    +
    + + +
    + +
    + + + + + + + diff --git a/plugin/mindmap/edit-mindmap/vendor/js/MapManager.js b/plugin/mindmap/edit-mindmap/vendor/js/MapManager.js new file mode 100644 index 000000000..9c0974430 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/js/MapManager.js @@ -0,0 +1,255 @@ +/*global kampfer*/ +kampfer.require('Class'); + +kampfer.provide('mindMap.MapManager'); + +/* + * MapManager类为mindmap提供数据支持。 + * 注意:1.MapManager依赖的第三方组件store.js依赖JSON，当浏览器不原生支持JSON时， + * 需要额外引入JSON.js实现兼容。 + * 2.MapManager提供的查询方法返回的都是对数据的引用，因此它们都是只读的，绝对不要直接 + * 对它们进行写操作。 + */ + +kampfer.mindMap.MapManager = kampfer.Class.extend({ + + /** + * 实例化一个MapManager对象。 + * 当传递给构建函数的参数是一个对象，那么这个对象被用作mindmap数据来源 + * @param name{string|object|null} + */ + initializer : function(data) { + this._oriData = data; + + data = data || {}; + this._nodeTree = data.document || []; + this._mapName = data.name; + this._lastModified = data.lastModified || +new Date(); + //map用于快速查找 + this._nodeMap = this.parseTree(this._nodeTree); + this._isModified = false; + }, + + _isModified : null, + + //重命名map的时候先改变_mapName.保存时会检查_mapName和_mapData.name的一致性, + //两者如果不一致那么会删除localstore中名字叫_mapData.name的数据.并将_mapName + //和_mapData.name同步. 这个过程需要同时保存新名字和旧名字,_mapName保存新名字 + //_mapData.name是旧名字。 + _mapName : null, + + //解析原始数据, 通过tree生成map + parseTree : function(data) { + var map = {}; + + for(var i = 0, root; (root = data[i]); i++) { + this.traverseNode(root, function(node) { + map[node.id] = node; + }); + } + + return map; + }, + + isModified : function() { + return this._isModified; + }, + + getMapName : function() { + return this._mapName; + }, + + getNode : function(id) { + return this._nodeMap[id]; + }, + + getChildren : function(id) { + if(id) { + var node = this.getNode(id); + return node.children; + } + }, + + getNodeTree : function() { + return this._nodeTree; + }, + + //如果有同id的node那么新的node不会被添加 + addNode : function(node) { + if( kampfer.type(node) === 'object' && !this.getNode(node.id) ) { + var parent = this.getNode(node.parent); + + //add node to nodeTree + if(parent) { + if(!parent.children) { + parent.children = []; + } + parent.children.push(node); + } else { + this._nodeTree.push(node); + } + + //保存node和它的子节点的引用 + this.traverseNode(node, function(node) { + if( !(node.id in this._nodeMap) ) { + this._nodeMap[node.id] = node; + } + }); + + this._isModified = true; + } + }, + + createNode : function(data) { + var node = { + id : this.generateUniqueId(), + parent : null, + children : null, + content : 'node', + offset : { + x : 100, + y : 100 + } + }, + type = kampfer.type(data); + + if( type === 'object' ) { + for(var attr in node) { + if(attr in data) { + if(attr === 'offset') { + node[attr].x = data[attr].x; + node[attr].y = data[attr].y; + } else { + node[attr] = data[attr]; + } + } + } + } else if( type === 'string' ) { + node.parent = data; + } + + return node; + }, + + //此方法会立即改变children数组的长度 + deleteNode : function(id) { + var node = this.getNode(id), parent, nodeList; + + if(!node) { + return; + } + + parent = this.getNode(node.parent); + if(!parent) { + nodeList = this._nodeTree; + } else if(parent.children) { + nodeList = parent.children; + } + if(nodeList) { + //delete node from tree + for(var i = 0, c; (c = nodeList[i]); i++) { + if(c.id === id) { + nodeList.splice(i, 1); + break; + } + } + } + //delete node from map + this.traverseNode(node, function(node) { + delete this._nodeMap[node.id]; + }); + + this._isModified = true; + + return node; + }, + + setNodeContent : function(id, text) { + var node = this.getNode(id); + node.content = text; + this._isModified = true; + }, + + getNodeContent : function(id) { + var node = this.getNode(id); + return node.content; + }, + + setNodePosition : function(id, x, y) { + if(kampfer.type(id) === 'object') { + id = id.id; + } + var node = this.getNode(id); + node.offset.x = x; + node.offset.y = y; + this._isModified = true; + }, + + //传值 + getNodePosition : function(id) { + var node = this.getNode(id); + return { + left : node.offset.x, + top : node.offset.y + }; + }, + + setMapName : function(name) { + this._mapName = name; + this._isModified = true; + }, + + getMapData : function() { + return { + document : this._nodeTree, + name : this._mapName, + lastModified : this._lastModified + }; + }, + + traverseNode : function(node, callback, forward) { + if(forward) { + callback.call(this, node); + } + if(node.children) { + for(var i = 0, child; (child = node.children[i]); i++) { + this.traverseNode(child, callback, forward); + } + } + if(!forward) { + callback.call(this, node); + } + }, + + traverse : function(callback) { + for(var i = 0, node; (node = this._nodeTree[i]); i++) { + this.traverseNode(node, callback, true); + } + }, + + /* + * 生成唯一id + * 直接使用时间戳不可行 + * 以下方法摘自http://www.cnblogs.com/NoRoad/archive/2010/03/12/1684759.html + */ + generateUniqueId : function() { + var guid = ""; + for(var i = 1; i <= 32; i++) { + var n = Math.floor(Math.random() * 16.0).toString(16); + guid += n; + if((i == 8) || (i == 12) || (i == 16) || (i == 20)) { + guid += "-"; + } + } + return guid; + }, + + dispose : function() { + delete this._oriData; + delete this._nodeTree; + delete this._mapName; + delete this._lastModified; + delete this._nodeMap; + delete this._isModified; + } +}); \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/vendor/js/MapsManager.js b/plugin/mindmap/edit-mindmap/vendor/js/MapsManager.js new file mode 100644 index 000000000..515085765 --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/js/MapsManager.js @@ -0,0 +1,125 @@ +/*global kampfer*/ +kampfer.require('Class'); +kampfer.require('store'); + +kampfer.provide('mindMap.MapsManager'); + +/* + * 负责维护localStorage + * MapsManager提供的查询方法返回的都是对数据的引用，因此它们都是只读的。 + * 绝对不要直接对它们进行写操作。 + * localStorage目前维护两部分内容: + * 1. map的信息 + * 2. clipboard的信息 + */ + +kampfer.mindMap.MapsManager = kampfer.Class.extend({ + + initializer : function(appName) { + if(appName) { + this._appName = appName; + } + }, + + _appName : 'mindMap', + + getAppName : function() { + return this._appName; + }, + + //从localStorage中读取mindMap保存的数据。 + //如果没有任何数据，那么就创建一个新的空的数据对象，并将它写入 localStorage。 + getMapStorage : function() { + var mapStore = kampfer.store.get(this._appName); + if(!mapStore) { + mapStore = {}; + + mapStore.maps = {}; + mapStore.maps._count = 0; + + kampfer.store.set(this._appName, mapStore); + } + return mapStore; + }, + + getMapData : function(name) { + var mapStore = this.getMapStorage(); + if(name) { + return mapStore.maps[name]; + } + }, + + //只接受object作为参数 + saveMapToLocalStorage : function(data) { + if( kampfer.type(data) === 'object' ) { + var mapStorage = this.getMapStorage(), + name = data.name; + if( !(name in mapStorage.maps) ) { + mapStorage.maps._count++; + } + mapStorage.maps[name] = data; + kampfer.store.set(this._appName, mapStorage); + } + }, + + getMapCount : function() { + var mapStorage = this.getMapStorage(); + return mapStorage.maps._count; + }, + + //返回包含所有map名字的数组 + getMapList : function() { + var mapStorage = this.getMapStorage(); + if(mapStorage.maps._count > 0) { + var ret = []; + for(var map in mapStorage.maps) { + if( map !== '_count') { + ret.push(mapStorage.maps[map]); + } + } + return ret; + } + }, + + hasMap : function(mapName) { + var mapStore = kampfer.store.get(this._appName); + if(mapStore) { + if(mapName in mapStore.maps) { + return true; + } + } + return false; + }, + + removeMap : function(mapName) { + if( this.hasMap(mapName) ) { + var mapStore = kampfer.store.get(this._appName); + delete mapStore.maps[mapName]; + kampfer.store.set(this._appName, mapStore); + } + }, + + setClipboard : function(data) { + var mapStore = kampfer.store.get(this._appName); + if(mapStore) { + mapStore.clipboard = data; + kampfer.store.set(this._appName, mapStore); + } + }, + + getClipboard : function() { + var mapStore = kampfer.store.get(this._appName); + if(mapStore && mapStore.clipboard) { + return mapStore.clipboard; + } + }, + + removeClipboard : function() { + var mapStore = kampfer.store.get(this._appName); + if(mapStore && mapStore.clipboard) { + delete mapStore.clipboard; + kampfer.store.set(this._appName, mapStore); + } + } + +}); \ No newline at end of file diff --git a/plugin/mindmap/edit-mindmap/vendor/js/base.js b/plugin/mindmap/edit-mindmap/vendor/js/base.js new file mode 100644 index 000000000..48aa6bf8a --- /dev/null +++ b/plugin/mindmap/edit-mindmap/vendor/js/base.js @@ -0,0 +1,369 @@ +/* + * @Author : l.w.kampfer@gmail.com + */ + +(function(global) { + + var COMPILED = false; + + var kampfer = {}; + + kampfer.global = global; + + kampfer.basePath = ''; + + kampfer.implicitNamespaces = {}; + + kampfer.isProvided = function(name) { + return !kampfer.implicitNamespaces[name] && !!kampfer.getPropertyByName(name); + }; + + kampfer.getPropertyByName = function( name, obj ) { + var namespace = name.split('.'), + cur = obj || kampfer; + for( var part; (part = namespace.shift()); ) { + if( kampfer.isDefAndNotNull( cur[part] ) ) { + cur = cur[part]; + } else { + return null; + } + } + return cur; + }; + + kampfer.exportPath = function(name, value, objectToExportTo) { + + var cur = objectToExportTo || kampfer.global, + namespace = name.split('.'); + + for( var part; (part = namespace.shift()); ) { + if( !namespace.length && kampfer.isDefAndNotNull(value) ) { + cur[part] = value; + } else if( cur[part] ) { + cur = cur[part]; + } else { + cur = cur[part] = {}; + } + } + + }; + + kampfer.provide = function(name) { + + //if(!COMPILED) { + + if( kampfer.isProvided(name) ) { + throw Error('Namespace "' + name + '" already declared.'); + } + + delete kampfer.implicitNamespaces[name]; + + var namespace = name; + while( (namespace = namespace.substring( 0, namespace.lastIndexOf('.') )) ) { + if( kampfer.getPropertyByName(namespace) ) { + break; + } else { + kampfer.implicitNamespaces[namespace] = true; + } + } + //} + + kampfer.exportPath(name, null, kampfer); + + }; + + kampfer.require = function(name) { + + if( !COMPILED ) { + if ( !name || kampfer.isProvided(name) ) { + return; + } + + var path = kampfer._getPathFromDeps(name); + if (path) { + kampfer._included[path] = true; + kampfer._writeScripts(); + } + } + + }; + + kampfer.addDependency = function( path, provides, requires ) { + + if( !COMPILED ) { + + var provide, require, deps; + path = path.replace(/\\/g, '/'); + deps = kampfer._dependencies; + + for( var i = 0; (provide = provides[i]); i++) { + deps.nameToPath[provide] = path; + if (!(path in deps.pathToNames)) { + deps.pathToNames[path] = {}; + } + deps.pathToNames[path][provide] = true; + } + + for( var j = 0; (require = requires[j]); j++) { + if (!(path in deps.requires)) { + deps.requires[path] = {}; + } + deps.requires[path][require] = true; + } + + } + + }; + + + if(!COMPILED) { + + kampfer._inHtmlDocument = function() { + var doc = kampfer.global.document; + return typeof doc != 'undefined' && 'write' in doc; + // XULDocument misses write. + }; + + kampfer._getPathFromDeps = function(name) { + if( name in kampfer._dependencies.nameToPath ) { + return kampfer._dependencies.nameToPath[name]; + } else { + return null; + } + }; + + kampfer._importScript = function(src) { + var _importScript = kampfer._writeScriptTag; + if(!kampfer._dependencies.written[src] && _importScript(src)) { + kampfer._dependencies.written[src] = true; + } + }; + + kampfer._writeScripts = function() { + + var scripts = [], + seenScript = {}, + deps = kampfer._dependencies; + + function visitNode(path) { + if( path in deps.written ) { + return; + } + + if( path in deps.visited ) { + if( !(path in seenScript) ) { + seenScript[path] = true; + scripts.push(path); + } + return; + } + + deps.visited[path] = true; + + if (path in deps.requires) { + for (var requireName in deps.requires[path]) { + + if (!kampfer.isProvided(requireName)) { + if (requireName in deps.nameToPath) { + visitNode(deps.nameToPath[requireName]); + } else { + throw Error('Undefined nameToPath for ' + requireName + ' in ' + path); + } + } + } + } + + if (!(path in seenScript)) { + seenScript[path] = true; + scripts.push(path); + } + } + + for( var path in kampfer._included ) { + if( !deps.written[path] ) { + visitNode(path); + } + } + + for( var i = 0; i < scripts.length; i++ ) { + if ( scripts[i] ) { + kampfer._importScript( kampfer.basePath + scripts[i] ); + } else { + throw Error('Undefined script input'); + } + } + }; + + + kampfer._writeScriptTag = function(src) { + if( kampfer._inHtmlDocument() ) { + var doc = kampfer.global.document; + doc.write(' +', + $this->getService( + $this->getActiveServiceId() + )->getCustomUserURL($userInfo['username'], $userInfo['id'], $this->salt()) + ); + } + + /** + * Generates the redirect user specific URL for redirection. + * + * @throws Exception on hash generation failure + * + * @return string the specific user redirect URL + */ + public function getActiveServiceSpecificUserUrl() + { + $userInfo = api_get_user_info(); + + return $this->getService( + $this->getActiveServiceId() + )->getCustomUserRedirectURL($userInfo['id'], $this->salt()); + } +} diff --git a/plugin/userremoteservice/uninstall.php b/plugin/userremoteservice/uninstall.php new file mode 100644 index 000000000..c6ec7c868 --- /dev/null +++ b/plugin/userremoteservice/uninstall.php @@ -0,0 +1,6 @@ +uninstall(); diff --git a/plugin/vchamilo/README.md b/plugin/vchamilo/README.md new file mode 100644 index 000000000..ca5f05dd8 --- /dev/null +++ b/plugin/vchamilo/README.md @@ -0,0 +1,142 @@ +Virtual Chamilo +=================== + +Authors : Valery Fremaux (valery.fremaux@gmail.com), Julio Montoya, Angel Quiroz, Yannick Warnier + +Virtual Chamilo (or vChamilo) is a feature that allows you to easily run several chamilo instances +sharing the same code base, with separate documents and databases, acting mostly like containers +sharing the same libraries. + +With vChamilo, your first Chamilo portal acts as a container (or "controller"), and a seed + (or image) for the Chamilo instances you will install afterwards. This first image should be + created automatically when configuring the plugin, but if it isn't, the plugin will tell you + so and ask to generate one through the interface. + +Once the plugin is fully setup, you will be able to create new Chamilo instances in a + matter of minutes (or seconds on powerful servers). + +Changelog +========= + +*Version 1.7* + +Added support for (optional) custom CSS folder +Database upgrade needed: + + ALTER TABLE vchamilo ADD COLUMN css_theme_folder varchar(255); + + +*Version 1.6* + +Database upgrade needed: + + ALTER TABLE vchamilo ADD COLUMN archive_url varchar(255); + ALTER TABLE vchamilo ADD COLUMN home_url varchar(255); + ALTER TABLE vchamilo ADD COLUMN upload_url varchar(255); + ALTER TABLE vchamilo ADD COLUMN course_url varchar(255); + +*Version 1.5* + +Improved usability and added validations. No DB update required. + +*Version 1.4* + +Database upgrade needed: + + ALTER TABLE vchamilo ADD COLUMN password_encryption VARCHAR(255); + +*Version 1.3* + +Added vchamilo import + + +Version features +=================== +This is still a beta version and it is not fully featured with back-office tools. +As such, you will be able to create, edit, copy, delete and even upgrade instances, but a certain +amount of manual work will still be required at the web server level to get your instances running. + +How to setup +=================== + +To set this plugin up, you will need to: + +1. Insert the virtualization hook into the Chamilo master configuration file and enable multi-urls: + +``` +/app/config/configuration.php +``` + +Insert the hook at the end of the file. + +``` +include_once $_configuration['root_sys'].'plugin/vchamilo/lib/Virtual.php'; +Virtual::hookConfiguration($_configuration); +``` +And add (or uncomment) the line to enable multi-url: + +``` +$_configuration['multiple_access_urls'] = true; +``` +At this point, make sure there is no caching mechanism maintaining the previous configuration + version before you continue. Enabling the multi-url option should have the immediate effect + of adding a multi-url management link at the bottom of the "Platform" block in the + administration main page. + +Take a moment to update the configuration of the default host in the multi-url configuration page +to the real hostname of your main (controller) portal. + +2. Change the permissions on the /plugin/vchamilo/templates/ directory as it will + be necessary for the plugin to create files and directories there +3. Create a common directory to be used for all Chamilo-related files. + We recommend using /var/ for that. Inside that directory, create the following 4 + directories: cache/, courses/, home/ and upload/ and give permissions to the web user to write + into them (exactly the same way you did it for the app/ directory when installing Chamilo) +4. Enable and configure the plugin in the Chamilo administration's plugins list + (if in doubt, use the suggested values). Please note that the proxy configuration part is + totally optional and is not maintained by the Chamilo team at this point. +5. Enable additional virtual hosts in your Apache config (unless you use subdirectories). All virtual hosts should point to the same DocumentRoot as the initial Chamilo installation. +6. For each virtual host or subdirectory, you will need to configure specific redirection rules (remember, this is still at beta-level): + +``` +RewriteEngine On +RewriteRule /app/upload/(.*)$ http://[vchamilo-instance-domain]/[selected-common-dir]/upload/[vchamilo-instance-dir]/$1 [QSA,L] +``` +In the example above, you would need to replace everything that is currently within brackets, with +the specific details of each instance. For example: +``` +RewriteRule /app/upload/(.*)$ http://beeznest.chamilo.net/var/upload/beeznest-chamilo-net/$1 [QSA,L] +``` +Although your vChamilo instances *will* work basically without this rewrite rule, you will end +up observing issues of files not appearing while uploading files on the instance. + +Note that the domain of the instance, in the last part of the path, will be transformed +from dot-separated domain (beeznest.chamilo.net) to dash-separated-domain (beeznest-chamilo-net). + +7. Finally, go to the "Instances manager" and create new instances. Once an instance has been +created, make sure you edit it and set the "Cache URL" (previously "Archive URL"), "Home URL" and "Upload URL". These should +have the form of the "Web root" of the instance + the common directory + {cache|home|upload} + the +instance domain with dots changed to hyphens. + +For example, if you have used "var/" as a common directory and your instance URL (Web Root) is +https://chamilo1.beeznest.com/, then your "Cache URL" would look like this: + + https://chamilo1.beeznest.com/var/cache/chamilo1-beeznest-com/ + +These settings might be complex to setup at first, but once you've created your first instance, +creating a hundred more should be easy. + +Important note about file system permissions +------------- + +vChamilo instances *need* a central directory where to store all their files. You should create +that directory (as mentioned in point 3 above) and make sure it has the right permissions. +The plugin/vchamilo/templates/ directory also needs to be writeable by the web server. + +Additional notes +------------- + +The vChamilo plugin can work in combination with the "Chamilo Shell":https://github.com/chamilo/chamilo-lms +(or "chash") to ensure a good level of automatization of heavy processes, like upgrading to a higher version. +Although upgrading still has a manual process (in part), it will certainly save you dozens of hours if +upgrading dozens of portals. diff --git a/plugin/vchamilo/ajax/service.php b/plugin/vchamilo/ajax/service.php new file mode 100644 index 000000000..1776ee045 --- /dev/null +++ b/plugin/vchamilo/ajax/service.php @@ -0,0 +1,25 @@ +Success    '; + } else { + echo 'Failure
    '.$errors.'    '; + } + break; +} + +exit; diff --git a/plugin/vchamilo/cli/bulkcreatenodes.php b/plugin/vchamilo/cli/bulkcreatenodes.php new file mode 100644 index 000000000..4d0677663 --- /dev/null +++ b/plugin/vchamilo/cli/bulkcreatenodes.php @@ -0,0 +1,218 @@ + false, + 'help' => false, + 'config' => false, + 'nodes' => '', + 'lint' => false, + 'verbose' => false + ), + array( + 'h' => 'help', + 'i' => 'interactive', + 'c' => 'config', + 'n' => 'nodes', + 'l' => 'lint', + 'v' => 'verbose' + ) +); + +$interactive = !empty($options['interactive']); + +if ($unrecognized) { + $unrecognized = implode("\n ", $unrecognized); + cli_error("Cli unkown options\n".$unrecognized); +} + +if ($options['help']) { + $help = "Command line VChamilo Generator. +Please note you must execute this script with the same uid as apache! + +Options: +--interactive Blocks on each step and waits for input to continue +-h, --help Print out this help +-c, --config Define an external config file +-n, --nodes A node descriptor CSV file +-l, --lint Decodes node file and give a report on nodes to be created. + +Example: +\$sudo -u www-data /usr/bin/php /var/www/chamilo/plugin/vchamilo/cli/bulkcreatenodes.php --nodes= +"; //TODO: localize - to be translated later when everything is finished + + echo $help; + die; +} + +// Get all options from config file. + +if (!empty($options['config'])) { + echo "Loading config : ".$options['config']; + if (!file_exists($options['config'])) { + cli_error('Config file mentioned but not found'); + } + + $content = file($options['config']); + foreach ($content as $l) { + if (preg_match('/^\s+$/', $l)) continue; // Empty lines. + if (preg_match('/^[#\/!;]/', $l)) continue; // Comments (any form). + if (preg_match('/^(.*?)=(.*)$/', $l, $matches)) { + if (in_array($matches[1], $expectedoptions)) { + $options[trim($matches[1])] = trim($matches[2]); + } + } + } +} + +require_once($_configuration['root_sys'].'local/classes/database.class.php'); // cli only functions +require_once($_configuration['root_sys'].'local/classes/textlib.class.php'); // cli only functions +require_once($_configuration['root_sys'].'local/classes/mootochamlib.php'); // moodle like API +require_once($_configuration['root_sys'].'/plugin/vchamilo/lib/vchamilo_plugin.class.php'); + +global $DB; +if ($options['verbose']) echo "building database manager\n"; +$DB = new DatabaseManager(); +if ($options['verbose']) echo "building plugin vchamilo\n"; +$plugin = VChamiloPlugin::create(); + +if (empty($options['nodes'])) { + cli_error('Missing node definition. Halt.'); +} + +if ($options['verbose']) echo "parsing nodelist\n"; +$nodes = vchamilo_parse_csv_nodelist($options['nodes'], $plugin); + +if ($options['lint']) { + ctrace("Lint mode:\n"); + print_object($nodes); + die; +} + +if (empty($nodes)) { + cli_error('Node list empty'); +} + +ctrace('Starting generation'); + +// Get main admin for further replacement. +$admin = $DB->get_record('user', array('username' => 'admin')); + +foreach ($nodes as $data) { + + ctrace('Making node '.$data->root_web); + + if (!empty($data->template)) { + ctrace('Using template '.$data->template); + + if (!vchamilo_template_exists($data->template)) { + ctrace('Template not found. Skipping node.'); + continue; + } + } + + if ($DB->get_record('vchamilo', array('root_web' => $data->root_web))) { + ctrace('Node exists. skipping'); + continue; + } + + $data->what = 'addinstance'; + $data->registeronly = false; + + $NDB = null; + + $automation = true; + $return = include($_configuration['root_sys'].'plugin/vchamilo/views/editinstance.controller.php'); + if ($return == -1) { + cli_error('Node create process error'); + } + + // This is specific code for presetting any plugin data per instance from the CSV + ctrace('Setting up ent_installer'); + if ($NDB) { + // Copy admin account info from master + $NDB->set_field('user', 'password', $admin->password, array('username' => 'admin'), 'user_id'); + + // Setting ENT_installer values + if (!empty($data->ent_installer)) { + foreach ($data->ent_installer as $setting => $value) { + $settingrec = new StdClass(); + $settingrec->variable = 'ent_installer_'.$setting; + $settingrec->subkey = 'ent_installer'; + $settingrec->type = 'setting'; + $settingrec->category = 'Plugins'; + $settingrec->access_url = 1; + $settingrec->selected_value = $value; + ctrace("Setting up {$settingrec->variable}|{$settingrec->subkey} to $value\n"); + if ($oldrec = $NDB->get_record('settings_current', array('variable' => $settingrec->variable, 'subkey' => $settingrec->subkey, 'type' => $settingrec->type))) { + $settingrec->id = $oldrec->id; + $NDB->update_record('settings_current', $settingrec, 'id'); + } else { + $NDB->insert_record('settings_current', $settingrec); + } + } + } + + // updating other config values + if (!empty($data->config)) { + ctrace("VChamilo has config overrides\n"); + foreach ($data->config as $configkey => $configsetting) { + ctrace("Setting up {$configkey}"); + // Note you can just alter existing settings here as we cannot pull enough data from csv headers to get a complete setting descriptor. + $settingrec = new StdClass(); + $settingrec->variable = $configkey; + if (!empty($settingrec->subkey)) { + $settingrec->subkey = $configsetting->subkey; + } + // $settingrec->type = 'setting'; + // $settingrec->category = 'Plugins'; + // $settingrec->access_url = 1; + $settingrec->selected_value = $configsetting->value; + + if (!empty($settingrec->subkey)) { + $params = array('variable' => $settingrec->variable, 'subkey' => $settingrec->subkey); + } else { + $params = array('variable' => $settingrec->variable); + } + + if ($oldrec = $NDB->get_record('settings_current', $params)) { + ctrace("Updating {$settingrec->variable}|{$settingrec->subkey} to $configsetting->value\n"); + $settingrec->id = $oldrec->id; + $NDB->update_record('settings_current', $settingrec, 'id'); + } + } + } + $NDB->dismount(); + } else { + ctrace('No Side CNX for setup'); + } + + if ($interactive) { + $input = readline("Continue (y/n|r) ?\n"); + if ($input == 'r' || $input == 'R') { + // do nothing, just continue + } elseif ($input == 'n' || $input == 'N') { + echo "finishing\n"; + exit; + } + } +} diff --git a/plugin/vchamilo/cli/bulkdestroynodes.php b/plugin/vchamilo/cli/bulkdestroynodes.php new file mode 100644 index 000000000..01af0ac6f --- /dev/null +++ b/plugin/vchamilo/cli/bulkdestroynodes.php @@ -0,0 +1,170 @@ + false, + 'help' => false, + 'config' => false, + 'nodes' => '', + 'lint' => false + ), + array( + 'h' => 'help', + 'c' => 'config', + 'n' => 'nodes', + 'i' => 'interactive', + 'l' => 'lint' + ) +); + +$interactive = !empty($options['interactive']); + +if ($unrecognized) { + $unrecognized = implode("\n ", $unrecognized); + cli_error(get_string('cliunknowoption', 'admin', $unrecognized)); +} + +if ($options['help']) { + $help = +"Command line VMoodle Generator. +Please note you must execute this script with the same uid as apache! + +Options: +--interactive No interactive questions or confirmations +-h, --help Print out this help +-c, --config Define an external config file +-n, --nodes A node descriptor CSV file +-l, --lint Decodes node file and give a report on nodes to be created. + +Example: +\$sudo -u www-data /usr/bin/php /var/www/chamilo19/plugin/vchamilo/cli/bulkdestroynodes.php --nodes= +"; //TODO: localize - to be translated later when everything is finished + + echo $help; + die; +} + +// Get all options from config file. +if (!empty($options['config'])) { + echo "Loading config : ".$options['config']; + if (!file_exists($options['config'])) { + cli_error(get_string('confignotfound', 'block_vmoodle')); + } + $content = file($options['config']); + foreach ($content as $l) { + if (preg_match('/^\s+$/', $l)) { + continue; // Empty lines. + } + if (preg_match('/^[#\/!;]/', $l)) { + continue; // Comments (any form). + } + if (preg_match('/^(.*?)=(.*)$/', $l, $matches)) { + if (in_array($matches[1], $expectedoptions)) { + $options[trim($matches[1])] = trim($matches[2]); + } + } + } +} + +require_once($_configuration['root_sys'].'local/classes/database.class.php'); // cli only functions +if ($options['verbose']) { + echo "loaded dbclass\n"; +} +require_once($_configuration['root_sys'].'local/classes/textlib.class.php'); // cli only functions +if ($options['verbose']) { + echo "loaded textlib\n"; +} +require_once($_configuration['root_sys'].'local/classes/mootochamlib.php'); // moodle like API +if ($options['verbose']) { + echo "loaded moodle wrapping\n"; +} +require_once($_configuration['root_sys'].'/plugin/vchamilo/lib/vchamilo_plugin.class.php'); +if ($options['verbose']) { + echo "loaded vchamilo plugin\n"; +} + +global $DB; +if ($options['verbose']) { + echo "building database manager\n"; +} +$DB = new DatabaseManager(); +if ($options['verbose']) { + echo "building plugin vchamilo\n"; +} +$plugin = VChamiloPlugin::create(); + +if (empty($options['nodes'])) { + cli_error(get_string('climissingnodes', 'block_vmoodle')); +} + +if ($options['verbose']) { + echo "parsing nodelist\n"; +} +$nodes = vchamilo_parse_csv_nodelist($options['nodes'], $plugin); + +if ($options['lint']) { + ctrace("Lint mode:\n"); + print_object($nodes); + die; +} + +if (empty($nodes)) { + cli_error(get_string('cliemptynodelist', 'block_vmoodle')); +} + +ctrace('Starting CLI processing'); + +foreach ($nodes as $n) { + + ctrace('Destroying node :'.$n->vhostname); + + if (!$DB->get_record('vchamilo', array('root_web' => $n->root_web))) { + ctrace('Node does not exist. Skipping'); + continue; + } + + /* + * This launches automatically all steps of the controller.management.php script several times + * with the "doadd" action and progressing in steps. + */ + $action = "fulldeleteinstances"; + + $automation = true; + + $return = include($_configuration['root_sys'].'/plugin/vchamilo/views/manage.controller.php'); + if ($interactive) { + $input = readline("Continue (y/n|r) ?\n"); + if ($input == 'r' || $input == 'R') { + $vmoodlestep--; + } elseif ($input == 'n' || $input == 'N') { + echo "finishing\n"; + exit(0); + } + } +} +exit (0); diff --git a/plugin/vchamilo/cli/clilib.php b/plugin/vchamilo/cli/clilib.php new file mode 100644 index 000000000..63cc22dfb --- /dev/null +++ b/plugin/vchamilo/cli/clilib.php @@ -0,0 +1,343 @@ + 1, + 'sitename' => 1, + 'institution' => 1, + 'main_database' => 1, + 'statistics_database' => 1, + 'user_personal_database' => 1, + 'db_user' => 1, + 'db_password' => 1, + 'course_folder' => 1, + ); + + $optional = array( + 'db_host' => 1, + 'template' => 1, + 'table_prefix' => 1, + 'single_database' => 1, + 'tracking_enabled' => 1, + 'visible' => 1, + ); + + $optionalDefaults = array( + 'db_host' => $_configuration['db_host'], + 'db_prefix' => 'chm_', + 'table_prefix' => '', + 'tracking_enabled' => 0, + 'single_database' => 1, + 'template' => '', + 'visible' => 1 + ); + + $patterns = array(); + + // Metas are accepted patterns (optional) + $metas = array( + 'plugin_.*', + 'config_.*' + ); + + // Get header (field names) + + $textlib = new textlib(); + + if (!$fp = fopen($nodelistlocation, 'rb')) { + cli_error($plugin->get_lang('badnodefile', 'vchamilo', $nodelistlocation)); + } + + // Jump any empty or comment line + $text = fgets($fp, 1024); + $i = 0; + while (vchamilo_is_empty_line_or_format($text, $i == 0)) { + $text = fgets($fp, 1024); + $i++; + } + + $headers = explode($csv_delimiter2, $text); + + // Check for valid field names + foreach ($headers as $h) { + $header[] = trim($h); + $patternized = implode('|', $patterns)."\\d+"; + $metapattern = implode('|', $metas); + if (!(isset($required[$h]) || + isset($optionalDefaults[$h]) || + isset($optional[$h]) || + preg_match("/$patternized/", $h) || + preg_match("/$metapattern/", $h))) { + cli_error("Node parse : invalidfieldname $h "); + return; + } + + if (isset($required[trim($h)])) { + $required[trim($h)] = 0; + } + } + + $expectedcols = count($headers); + $i++; + + // Check for required fields. + foreach ($required as $key => $value) { + if ($value) { // Required field missing. + cli_error("fieldrequired $key"); + return; + } + } + $linenum = 2; // Since header is line 1. + + // Take some from admin profile, other fixed by hardcoded defaults. + while (!feof($fp)) { + + // Make a new base record. + $vnode = new StdClass(); + foreach ($optionalDefaults as $key => $value) { + $vnode->$key = $value; + } + + //Note: commas within a field should be encoded as , (for comma separated csv files) + //Note: semicolon within a field should be encoded as ; (for semicolon separated csv files) + $text = fgets($fp, 1024); + if (vchamilo_is_empty_line_or_format($text, false)) { + $i++; + continue; + } + + $valueset = explode($csv_delimiter2, $text); + if (count($valueset) != $expectedcols) { + cli_error('wrong line count at line '.$i); + } + $f = 0; + foreach ($valueset as $value) { + // Decode encoded commas. + $key = $headers[$f]; + if (preg_match('/\|/', $key)) { + list($plugin, $variable) = explode('|', str_replace('plugin_', '', $key)); + if (empty($variable)) die("Key error in CSV : $key "); + if (!isset($vnode->$plugin)) { + $vnode->$plugin = new StdClass(); + } + $vnode->$plugin->$variable = trim($value); + } else { + if (preg_match('/^config_/', $key)) { + $smartkey = str_replace('config_', '', $key); + $keyparts = implode('|', $smartkey); + $keyvar = $keyparts[0]; + $subkey = @$keyparts[1]; + $vnode->config->$smartkey = new StdClass; + $vnode->config->$smartkey->subkey = $subkey; + $vnode->config->$smartkey->value = trim($value); + } else { + $vnode->$key = trim($value); + } + } + $f++; + } + $vnodes[] = $vnode; + } + + return $vnodes; +} + +/** + * Check a CSV input line format for empty or commented lines + * Ensures compatbility to UTF-8 BOM or unBOM formats + * @param resource $text + * @param bool $resetfirst + * @return bool + */ +function vchamilo_is_empty_line_or_format(&$text, $resetfirst = false) { + global $CFG; + + static $textlib; + static $first = true; + + // We may have a risk the BOM is present on first line + if ($resetfirst) $first = true; + if (!isset($textlib)) $textlib = new textlib(); // Singleton + $text = $textlib->trim_utf8_bom($text); + $first = false; + + $text = preg_replace("/\n?\r?/", '', $text); + + // last chance + if ('ASCII' == mb_detect_encoding($text)) { + $text = utf8_encode($text); + } + + // Check the text is empty or comment line and answer true if it is. + return preg_match('/^$/', $text) || preg_match('/^(\(|\[|-|#|\/| )/', $text); +} + +/** + * Get input from user + * @param string $prompt text prompt, should include possible options + * @param string $default default value when enter pressed + * @param array $options list of allowed options, empty means any text + * @param bool $casesensitiveoptions true if options are case sensitive + * @return string entered text + */ +function cli_input($prompt, $default = '', array $options = null, $casesensitiveoptions = false) { + echo $prompt; + echo "\n: "; + $input = fread(STDIN, 2048); + $input = trim($input); + if ($input === '') { + $input = $default; + } + if ($options) { + if (!$casesensitiveoptions) { + $input = strtolower($input); + } + if (!in_array($input, $options)) { + echo "Incorrect value, please retry.\n"; // TODO: localize, mark as needed in install + return cli_input($prompt, $default, $options, $casesensitiveoptions); + } + } + return $input; +} + +/** + * Returns cli script parameters. + * @param array $longoptions array of --style options ex:('verbose'=>false) + * @param array $shortmapping array describing mapping of short to long style options ex:('h'=>'help', 'v'=>'verbose') + * @return array array of arrays, options, unrecognised as optionlongname=>value + */ +function cli_get_params(array $longoptions, array $shortmapping = null) { + $shortmapping = (array) $shortmapping; + $options = array(); + $unrecognized = array(); + + if (empty($_SERVER['argv'])) { + // Bad luck, we can continue in interactive mode ;-) + return array($options, $unrecognized); + } + $rawoptions = $_SERVER['argv']; + + // Remove anything after '--', options can not be there. + if (($key = array_search('--', $rawoptions)) !== false) { + $rawoptions = array_slice($rawoptions, 0, $key); + } + + // Remove script. + unset($rawoptions[0]); + foreach ($rawoptions as $raw) { + if (substr($raw, 0, 2) === '--') { + $value = substr($raw, 2); + $parts = explode('=', $value); + if (count($parts) == 1) { + $key = reset($parts); + $value = true; + } else { + $key = array_shift($parts); + $value = implode('=', $parts); + } + if (array_key_exists($key, $longoptions)) { + $options[$key] = $value; + } else { + $unrecognized[] = $raw; + } + + } else if (substr($raw, 0, 1) === '-') { + $value = substr($raw, 1); + $parts = explode('=', $value); + if (count($parts) == 1) { + $key = reset($parts); + $value = true; + } else { + $key = array_shift($parts); + $value = implode('=', $parts); + } + if (array_key_exists($key, $shortmapping)) { + $options[$shortmapping[$key]] = $value; + } else { + $unrecognized[] = $raw; + } + } else { + $unrecognized[] = $raw; + continue; + } + } + // Apply defaults. + foreach ($longoptions as $key=>$default) { + if (!array_key_exists($key, $options)) { + $options[$key] = $default; + } + } + // Finished. + return array($options, $unrecognized); +} + +/** + * Print or return section separator string + * @param bool $return false means print, true return as string + * @return mixed void or string + */ +function cli_separator($return = false) { + $separator = str_repeat('-', 79)."\n"; + if ($return) { + return $separator; + } else { + echo $separator; + } +} + +/** + * Print or return section heading string + * @param string $string text + * @param bool $return false means print, true return as string + * @return mixed void or string + */ +function cli_heading($string, $return = false) { + $string = "== $string ==\n"; + if ($return) { + return $string; + } else { + echo $string; + } +} + +/** + * Write error notification + * @param $text + * @return void + */ +function cli_problem($text) { + fwrite(STDERR, $text."\n"); +} + +/** + * Write to standard out and error with exit in error. + * + * @param string $text + * @param int $errorCode + * @return void (does not return) + */ +function cli_error($text, $errorCode = 1) { + fwrite(STDERR, $text); + fwrite(STDERR, "\n"); + die($errorCode); +} diff --git a/plugin/vchamilo/cli/cron.php b/plugin/vchamilo/cli/cron.php new file mode 100644 index 000000000..612679739 --- /dev/null +++ b/plugin/vchamilo/cli/cron.php @@ -0,0 +1,77 @@ + false, + 'host' => false, + ), + array( + 'h' => 'help', + 'H' => 'host' + ) +); + +if ($unrecognized) { + $unrecognized = implode("\n ", $unrecognized); + cli_error(get_string('cliunknowoption', 'admin', $unrecognized)); +} + +if ($options['help']) { + $help = +"Command line chamilo CRON + +Options: +-h, --help Print out this help +-H, --host Set the host (physical or virtual) to operate on + +"; //TODO: localize - to be translated later when everything is finished + + echo $help; + die; +} + +if (!empty($options['host'])) { + // arms the vchamilo switching + echo('Arming for '.$options['host']."\n"); // mtrace not yet available. + define('CLI_VCHAMILO_OVERRIDE', $options['host']); +} +// replay full config whenever. If vchamilo switch is armed, will switch now config +require $_configuration['root_sys'].'app/config/configuration.php'; // do REALLY force configuration to play again, or the following call will not have config tweaked (require_once) +echo('Config check : playing for '.$_configuration['root_web']."\n"); + +error_log('[chamilo][cronjob] Starting cron jobs as process '.getmypid()); +echo '
    ';
+echo ('[chamilo][cronjob] Starting cron jobs as process '.getmypid()."\n");
+require_once $_configuration['root_sys'].'main/cron/notification.php';
+error_log('[chamilo][cronjob] Ending cron jobs of process '.getmypid());
+echo('[chamilo][cronjob] Ending cron jobs of process '.getmypid()."\n");
+echo '
    '; diff --git a/plugin/vchamilo/cli/maincron.php b/plugin/vchamilo/cli/maincron.php new file mode 100644 index 000000000..027e0942a --- /dev/null +++ b/plugin/vchamilo/cli/maincron.php @@ -0,0 +1,25 @@ +get_lang('hostlist'); + +$table = Database::get_main_table('vchamilo'); +$sql = "SELECT sitename, root_web FROM $table WHERE visible = 1"; + +if ($virtualChamilo == '%') { + $result = Database::query($sql); + $_template['hosts'] = []; + if ($result) { + while ($vchamilo = Database::fetch_assoc($result)) { + $_template['hosts'][] = $vchamilo; + } + } +} diff --git a/plugin/vchamilo/install.php b/plugin/vchamilo/install.php new file mode 100644 index 000000000..6093add95 --- /dev/null +++ b/plugin/vchamilo/install.php @@ -0,0 +1,79 @@ +'); + + $.get(url, function (data) { + $('#row_'+settingid).html(spare); + $('#res_'+settingid).html(data); + } ); +} \ No newline at end of file diff --git a/plugin/vchamilo/js/host_form.js b/plugin/vchamilo/js/host_form.js new file mode 100644 index 000000000..d7bad4795 --- /dev/null +++ b/plugin/vchamilo/js/host_form.js @@ -0,0 +1,62 @@ +/** + * Pop-up testing connection with database. + */ +function opencnxpopup(webroot) { + // Inputted data. + var dbhost = document.getElementById('id_vdbhost').value; + var dblogin = document.getElementById('id_vdbuser').value; + var dbpass = document.getElementById('id_vdbpassword').value; + + // PHP file linked the pop-up, and name. + var url = webroot+"/plugin/vchamilo/views/manage.testcnx.php" + "?" + "vdbhost=" + dbhost + "&" + "vdblogin=" + dblogin + + "&" + "vdbpass=" + dbpass; + // Pop-up's options. + var options = "width=500,height=300,toolbar=no,menubar=no,location=no,scrollbars=no,status=no"; + + // Opening the pop-up (title not working in Firefox). + var windowobj = window.open(url, '', options); +} + +/** + * Activates/desactivates services selection. + */ +function switcherServices(mnetnewsubnetwork) { + + // Retrieve 'select' elements from form. + var mnetenabled = document.getElementById('id_mnetenabled'); + var multimnet = document.getElementById('id_multimnet'); + var services = document.getElementById('id_services'); + + // Default values for services. + var mnetfreedefault = '0'; + var defaultservices = 'default'; + var subnetworkservices = 'subnetwork'; + + // Do the actions. + if (multimnet.value == mnetfreedefault + || multimnet.value == mnetnewsubnetwork) { + services.value = defaultservices; + services.disabled = true; + } else { + services.disabled = false; + services.value = subnetworkservices; + } +} + +function syncSchema(){ + + var originelement = document.getElementById("id_shortname"); + + var syncedelement2 = document.getElementById("id_vdbname"); + var syncedelement3 = document.getElementById("id_vdatapath"); + var syncedelement4 = document.getElementById("id_vhostname"); + + syncedelement2.value = syncedelement2.value.replace(/<%%INSTANCE%%>/g, originelement.value); + syncedelement3.value = syncedelement3.value.replace(/<%%INSTANCE%%>/g, originelement.value); + syncedelement4.value = syncedelement4.value.replace(/<%%INSTANCE%%>/g, originelement.value); +} + +function onLoadInit(){ + var originelement = document.getElementById("id_shortname"); + originelement.onchange = syncSchema; +} diff --git a/plugin/vchamilo/js/host_list.js b/plugin/vchamilo/js/host_list.js new file mode 100644 index 000000000..1708883e9 --- /dev/null +++ b/plugin/vchamilo/js/host_list.js @@ -0,0 +1,15 @@ +function selectallhosts() { + $('.vnodessel').attr('checked', true); +} + +function deselectallhosts() { + $('.vnodessel').attr('checked', false); +} + +function setpreset(form, select) { + presetvalue = select.options[select.selectedindex].value; + parts = presetvalue.split('/'); + + form.elements['variable'].value = parts[0]; + form.elements['subkey'].value = parts[1]; +} \ No newline at end of file diff --git a/plugin/vchamilo/lang/english.php b/plugin/vchamilo/lang/english.php new file mode 100644 index 000000000..bd79846da --- /dev/null +++ b/plugin/vchamilo/lang/english.php @@ -0,0 +1,123 @@ + + */ +$strings['archiverealroot'] = 'Cache container real root (system path, no symlinks here)'; +$strings['backtoindex'] = 'Back to instance index'; +$strings['badconnection'] = 'Connection FAILED'; +$strings['cancel'] = 'Cancel'; +$strings['choose'] = 'choose...'; +$strings['clearcache'] = 'Clear Twig cache'; +$strings['clearmastercache'] = 'Clear Twig cache for master'; +$strings['closewindow'] = 'Close this window'; +$strings['connectionok'] = 'Connection OK'; +$strings['continue'] = 'Continue'; +$strings['coursefolder'] = 'Physical dir'; +$strings['courserealroot'] = 'Course container real root (no symlinks here)'; +$strings['datalocation'] = 'Data location'; +$strings['datapathavailable'] = 'Data path is available and ready to be used as :
    '; +$strings['datapathnotavailable'] = 'Data path exists but has already files in it at
    '; +$strings['datapathcreated'] = 'Data path has been created as :
    '; +$strings['dbgroup'] = 'Database Settings'; +$strings['dbhost'] = 'Database Host'; +$strings['dbpassword'] = 'Password'; +$strings['dbprefix'] = 'Database prefix'; +$strings['dbuser'] = 'Username'; +$strings['deleteifempty'] = 'Delete if empty'; +$strings['deleteinstances'] = 'Remove instance'; +$strings['destroyinstances'] = 'Full delete instance'; +$strings['distributevalue'] = 'Distribute configuration value'; +$strings['edit'] = 'Edit instance info'; +$strings['emptysite'] = 'New empty site'; +$strings['enable_virtualisation'] = 'Enable'; +$strings['enabled'] = 'enabled'; +$strings['enableinstances'] = 'Enable'; +$strings['enabling'] = 'General enabling'; +$strings['errormuststartwithcourses'] = 'the course folder MUST start with \'courses_\' to avoid directory conflicts'; +$strings['homerealroot'] = 'Home container real root (no symlinks here)'; +$strings['hostdefinition'] = 'Host definition'; +$strings['hostlist'] = 'Other hosts'; +$strings['institution'] = 'Institution'; +$strings['lastcron'] = 'Last cron'; +$strings['maindatabase'] = 'Database name'; +$strings['manage_instances'] = 'Go to instance manager'; +$strings['newinstance'] = 'Add new instance'; +$strings['no'] = 'No'; +$strings['plugin_comment'] = 'Allows the virtualization of Chamilo. Use your main Chamilo installation as a hub, then create instances based on the same code but with different databases, and generate snapshots, and manage all instances like VM images.'; +$strings['plugin_title'] = 'Virtual Chamilo'; +$strings['proxysettings'] = 'Proxy settings'; +$strings['registerinstance'] = 'Register an instance'; +$strings['rootweb'] = 'Web root'; +$strings['savechanges'] = 'Save changes'; +$strings['selectall'] = 'Select all'; +$strings['selectnone'] = 'Deselect all'; +$strings['sendconfigvalue'] = 'Distribute a configuration value'; +$strings['setconfigvalue'] = 'Set a configuration value'; +$strings['singledatabase'] = 'Single database'; +$strings['sitename'] = 'Site Name'; +$strings['snapshotinstance'] = 'Snapshot'; +$strings['snapshotmaster'] = 'Snapshot master Chamilo'; +$strings['statisticsdatabase'] = 'Statistics database'; +$strings['successfinishedcapture'] = 'Snapshot of chamilo is finished'; +$strings['sync_settings'] = 'Synchronize settings'; +$strings['tableprefix'] = 'Table prefix'; +$strings['template'] = 'Template'; +$strings['templating'] = 'Templating'; +$strings['testconnection'] = 'Test database connexion'; +$strings['testdatapath'] = 'Test data location'; +$strings['userpersonaldatabase'] = 'User personal database'; +$strings['vchamilo'] = 'Virtual Chamilo'; +$strings['vchamilosnapshot1'] = 'STEP 1 OF 3 : Directories for snapshot have been created. Continue with database backup ...'; +$strings['vchamilosnapshot2'] = 'STEP 2 OF 3 : Databases have been backed up. Continue with saving files... beware this step can be long if a lot of content resides in the instance...'; +$strings['vchamilosnapshot3'] = 'STEP 3 OF 3 : Files saved.'; +$strings['withselection'] = 'With selection: '; +$strings['yes'] = 'Yes'; + +$strings['mysqlcmds'] = 'Mysql commands location'; +$strings['mysqlcmd'] = 'Full path to mysql client command'; +$strings['mysqldumpcms'] = 'Full path to mysqldump command'; + +$strings['sitenameinputerror'] = "Site Name is empty or invalid"; +$strings['institutioninputerror'] = "Institution is empty or invalid"; +$strings['rootwebinputerror'] = "Root web is empty or invalid"; +$strings['databaseinputerror'] = "Database empty"; +$strings['coursefolderinputerror'] = "Data location is empty"; + +$strings['httpproxyhost'] = "HTTP proxy host"; +$strings['httpproxyport'] = "HTTP proxy port"; +$strings['httpproxybypass'] = "HTTP proxy URL bypass"; +$strings['httpproxyuser'] = "HTTP proxy user"; +$strings['httpproxypassword'] = "HTTP proxy password"; + +$strings['variable'] = 'Variable'; +$strings['subkey'] = 'Subkey'; +$strings['category'] = 'Category'; +$strings['accessurl'] = 'Access URL'; +$strings['value'] = 'Value'; +$strings['syncall'] = 'Sync all the selection'; +$strings['syncthis'] = 'Sync this setting'; + +$strings['SiteNameExample'] = 'Example: Chamilo'; +$strings['InstitutionExample'] = 'Example: Chamilo Association'; +$strings['RootWebExample'] = 'Example: http://www.chamilo.org/ (with final slash)'; +$strings['DatabaseDescription'] = 'A new database will be created with that name.'; +$strings['RootWebExists'] = 'An instance with the same root web exists.'; +$strings['ImportInstance'] = 'Import instance'; +$strings['ConfigurationPath'] = 'Chamilo configuration path'; +$strings['UploadRealRoot'] = 'Upload files'; +$strings['DatabaseAccessShouldBeDifferentThanMasterChamilo'] = 'Database server should be different than the Chamilo master'; +$strings['UrlAppendExample'] = 'Example: /chamilo_v1 (with first slash)'; + +$strings['FromVersion'] = 'From version'; +$strings['CoursePath'] = 'Path to courses directory'; +$strings['HomePath'] = 'Path to home directory'; +$strings['UploadPath'] = 'Path to upload directory'; + +$strings['ArchiveUrl'] = 'Cache URL'; +$strings['HomeUrl'] = 'Home URL'; +$strings['UploadUrl'] = 'Upload URL'; +$strings['CourseUrl'] = 'Course URL'; +$strings['ThemeFolder'] = 'Theme folder'; +$strings['ThemeFolderExplanation'] = 'Theme folder should be located inside the web/css/themes/ folder'; diff --git a/plugin/vchamilo/lang/french.php b/plugin/vchamilo/lang/french.php new file mode 100644 index 000000000..9d9466a96 --- /dev/null +++ b/plugin/vchamilo/lang/french.php @@ -0,0 +1,108 @@ + + */ +$strings['archiverealroot'] = 'Container effectif de la cache (chemin réel sur disque)'; +$strings['backtoindex'] = 'Retour aux instances'; +$strings['cancel'] = 'Annuler'; +$strings['choose'] = 'Choisir une action...'; +$strings['closewindow'] = 'Fermer cette fenêtre'; +$strings['continue'] = 'Continuer'; +$strings['coursefolder'] = 'Répertoire des cours'; +$strings['courserealroot'] = 'Container effectif de cours (chemin réel)'; +$strings['clearcache'] = 'Vider le cache Twig'; +$strings['clearmastercache'] = 'Vider le cache Twig du maître'; +$strings['datalocation'] = 'Emplacement des données'; +$strings['datapathavailable'] = 'Le répertoire de données est disponible :
    '; +$strings['datapathnotavailable'] = 'Le répertoire de données existe mais a déjà des fichiers à l\'emplacement
    '; +$strings['datapathcreated'] = 'Le répertoire de données a été créé :
    '; +$strings['dbgroup'] = 'Réglages de base de données'; +$strings['dbhost'] = 'Hôte de BdD'; +$strings['dbpassword'] = 'Mot de passe'; +$strings['dbprefix'] = 'Préfix de base'; +$strings['dbuser'] = 'Utilisateur de BdD'; +$strings['deleteinstances'] = "Désactiver"; +$strings['destroyinstances'] = "Détruire"; +$strings['edit'] = 'Modifier les paramètres'; +$strings['emptysite'] = 'Nouveau site vide'; +$strings['enable_virtualisation'] = 'Activer'; +$strings['enabled'] = 'Etat'; +$strings['enableinstances'] = "Activer"; +$strings['enabling'] = 'Activation'; +$strings['errormuststartwithcourses'] = 'Le répertoire de cours doit commencer par \'courses_\' pour éviter les collisions de chemin'; +$strings['homerealroot'] = 'Container effectif de pages d\'accueil (chemin réel)'; +$strings['hostdefinition'] = 'Définition d\'hôte'; +$strings['hostlist'] = 'Les sites du réseau'; +$strings['institution'] = 'Institution'; +$strings['lastcron'] = 'Dernier cron'; +$strings['maindatabase'] = 'Nom de BdD'; +$strings['manage_instances'] = 'Aller au gestionnaire d\'instances'; +$strings['sync_settings'] = 'Synchroniser des réglages'; +$strings['deleteifempty'] = 'Supprimer la clef si vide'; +$strings['newinstance'] = "Ajouter une instance"; +$strings['no'] = 'Non'; +$strings['plugin_comment'] = 'Permettre les chamilos virtuels.'; +$strings['plugin_title'] = 'Virtualisation de Chamilo'; +$strings['proxysettings'] = 'Réglages du Proxy'; +$strings['registerinstance'] = "Enregistrer une instance"; +$strings['rootweb'] = 'Racine Web'; +$strings['savechanges'] = 'Enregistrer les modifications'; +$strings['selectall'] = 'Selectionner tout'; +$strings['selectnone'] = 'Déselectionner tout'; +$strings['setconfigvalue'] = 'Mettre à jour une variable de configuration'; +$strings['distributevalue'] = 'Distribuer la configuration'; +$strings['sendconfigvalue'] = 'Distribution d\'une valeur de configuration'; +$strings['singledatabase'] = 'Base de données unique'; +$strings['sitename'] = 'Nom du site'; +$strings['snapshotinstance'] = 'Snapshot'; +$strings['snapshotmaster'] = 'Snapshot du Chamilo maître'; +$strings['statisticsdatabase'] = 'base de données de statistiques'; +$strings['successfinishedcapture'] = 'La capture de Chamilo est terminée'; +$strings['tableprefix'] = 'Prefixe de table'; +$strings['template'] = 'Modèle'; +$strings['templating'] = 'Templating'; +$strings['testconnection'] = "Test de la connexion"; +$strings['testdatapath'] = "Test de l'emplacement de données"; +$strings['userpersonaldatabase'] = 'base de données des données personnelles'; +$strings['vchamilo'] = 'Chamilo Virtuel'; +$strings['vchamilosnapshot1'] = 'ETAPE 1 DE 3 : Les répertoires de snapshot ont été créés. Continuer avec la capture des bases...'; +$strings['vchamilosnapshot2'] = 'ETAPE 2 DE 3 : Les bases ont été capturées. Continuer avec la récupération des fichiers d\'usage... Attention, cette étape peut être longue si la plate-forme est fortement chargée en documents...'; +$strings['vchamilosnapshot3'] = 'ETAPE 3 DE 3 : Fichiers capturés.'; +$strings['withselection'] = "Avec la sélection : "; +$strings['yes'] = 'Oui'; + +$strings['mysqlcmds'] = 'Emplacement de la commande Mysql'; +$strings['mysqlcmd'] = 'Chemin vers le client mysql'; +$strings['mysqldumpcms'] = 'Chemin vers la commande mysqldump'; + +$strings['sitenameinputerror'] = "Le nom de site est vide"; +$strings['institutioninputerror'] = "L'institution est vide ou invalide"; +$strings['rootwebinputerror'] = "L'URL d'acces est vide ou invalide"; +$strings['databaseinputerror'] = "La base de données n'est pas définie"; +$strings['coursefolderinputerror'] = "Le répertoire du cours n'est pas défini"; + +$strings['httpproxyhost'] = "Hôte Proxy HTTP"; +$strings['httpproxyport'] = "Port Proxy HTTP"; +$strings['httpproxybypass'] = "Filtre d'URL de proxy (exclusions)"; +$strings['httpproxyuser'] = "Utilisateur Proxy"; +$strings['httpproxypassword'] = "Mot de passe Proxy"; + +$strings['variable'] = 'Variable'; +$strings['subkey'] = 'Clef'; +$strings['category'] = 'Catégorie'; +$strings['accessurl'] = 'Sous-site'; +$strings['value'] = 'Valeur'; +$strings['syncall'] = 'Synchroniser la sélection'; +$strings['syncthis'] = 'Synchroniser ce réglage'; + +$strings['SiteNameExample'] = 'Exemple: Chamilo'; +$strings['InstitutionExample'] = 'Exemple: Chamilo Association'; +$strings['RootWebExample'] = 'Exemple: http://www.chamilo.org/'; +$strings['DatabaseDescription'] = 'Une nouvelle base de données sera créée avec ce nom.'; +$strings['RootWebExists'] = 'Une instance avec le même nom existe déjà.'; +$strings['FromVersion'] = 'Version d\'origine'; +$strings['CoursePath'] = 'Chemin vers répertoire de cours'; +$strings['HomePath'] = 'Chemin vers répertoire home'; +$strings['UploadPath'] = 'Chemin vers répertoire upload'; diff --git a/plugin/vchamilo/lang/spanish.php b/plugin/vchamilo/lang/spanish.php new file mode 100644 index 000000000..e8a9b4110 --- /dev/null +++ b/plugin/vchamilo/lang/spanish.php @@ -0,0 +1,5 @@ + + * @author Julio Montoya + */ +class VChamiloPlugin extends Plugin +{ + /** + * VChamiloPlugin constructor. + */ + public function __construct() + { + parent::__construct('1.4', 'Valery Fremaux, Julio Montoya'); + } + + /** + * @return VChamiloPlugin + */ + public static function create() + { + static $result = null; + + return $result ? $result : $result = new self(); + } + + /** + * @return string + */ + public function get_name() + { + return 'vchamilo'; + } +} diff --git a/plugin/vchamilo/lib/Virtual.php b/plugin/vchamilo/lib/Virtual.php new file mode 100644 index 000000000..f343e6bbc --- /dev/null +++ b/plugin/vchamilo/lib/Virtual.php @@ -0,0 +1,1388 @@ +executeQuery($query); + + if ($result->rowCount()) { + $data = $result->fetch(); + $excludes = ['id', 'name']; + $query = "SELECT * FROM settings_current WHERE subkey = 'vchamilo'"; + $virtualSettings = $connection->executeQuery($query); + $virtualSettings = $virtualSettings->fetchAll(); + + $homePath = ''; + $coursePath = ''; + $archivePath = ''; + $uploadPath = ''; + $passwordEncryption = ''; + foreach ($virtualSettings as $setting) { + switch ($setting['variable']) { + case 'vchamilo_upload_real_root': + $uploadPath = $setting['selected_value']; + break; + case 'vchamilo_home_real_root': + $homePath = $setting['selected_value']; + break; + case 'vchamilo_course_real_root': + $coursePath = $setting['selected_value']; + break; + case 'vchamilo_archive_real_root': + $archivePath = $setting['selected_value']; + break; + case 'vchamilo_password_encryption': + $passwordEncryption = $setting['selected_value']; + break; + } + } + + if (empty($homePath) || empty($coursePath) || empty($archivePath) || empty($uploadPath)) { + echo 'Configure correctly the vchamilo plugin'; + exit; + } + + // Only load if is visible + if ($data && $data['visible'] === '1') { + foreach ($data as $key => $value) { + if (!in_array($key, $excludes)) { + // Avoid empty password_encryption + if ($key == 'password_encryption' && empty($value)) { + continue; + } + $_configuration[$key] = $value; + } + $_configuration['virtual'] = $data['root_web'].'/'; + } + + $data['SYS_ARCHIVE_PATH'] = self::addTrailingSlash($archivePath).$data['slug']; + $data['SYS_HOME_PATH'] = self::addTrailingSlash($homePath).$data['slug']; + $data['SYS_COURSE_PATH'] = self::addTrailingSlash($coursePath).$data['slug']; + $data['SYS_UPLOAD_PATH'] = self::addTrailingSlash($uploadPath).$data['slug']; + + $data['WEB_HOME_PATH'] = self::addTrailingSlash($data['home_url']); + $data['WEB_UPLOAD_PATH'] = self::addTrailingSlash($data['upload_url']); + $data['WEB_ARCHIVE_PATH'] = self::addTrailingSlash($data['archive_url']); + + if (!empty($passwordEncryption)) { + $_configuration['password_encryption'] = $passwordEncryption; + } + + // Instance cannot have multiple urls + $_configuration['multiple_access_urls'] = false; + $_configuration['virtual_css_theme_folder'] = ''; + if (isset($data['css_theme_folder']) && !empty($data['css_theme_folder'])) { + $_configuration['virtual_css_theme_folder'] = $data['css_theme_folder']; + } + $virtualChamilo = $data; + } else { + exit("This portal is disabled. Please contact your administrator"); + } + } // otherwise it means the plugin was not configured yet + } + + /** + * @param array $_configuration + */ + public static function getHostName(&$_configuration) + { + if (!empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && + $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https' || !empty($_configuration['force_https_forwarded_proto']) + ) { + $protocol = 'https'; + } else { + if (!empty($_SERVER['HTTPS'])) { + $protocol = 'https'; + } else { + $protocol = 'http'; + } + } + + if (defined('CLI_VCHAMILO_OVERRIDE')) { + $_configuration['vchamilo_web_root'] = CLI_VCHAMILO_OVERRIDE; + $_configuration['vchamilo_name'] = preg_replace('#https?://#', '', CLI_VCHAMILO_OVERRIDE); + // remove radical from override for name + + // fake the server signature + global $_SERVER; + + $_SERVER['SERVER_NAME'] = $_configuration['vchamilo_name']; + $_SERVER['HTTP_HOST'] = $_configuration['vchamilo_name']; + $_SERVER['QUERY_STRING'] = ''; + $_SERVER['REQUEST_URI'] = CLI_VCHAMILO_OVERRIDE; + + return; + } + + $contentPrefix = '/'; + if (isset($_SERVER['CONTEXT_PREFIX']) && !empty($_SERVER['CONTEXT_PREFIX'])) { + $contentPrefix = $_SERVER['CONTEXT_PREFIX']; + } else { + // Getting url_append from URL + if (isset($_SERVER['REQUEST_URI'])) { + $requestUri = $_SERVER['REQUEST_URI']; + if (strpos($requestUri, '/courses/') !== false) { + $result = substr($requestUri, 0, strpos($requestUri, '/courses/')); + if (!empty($result) && $result != '/') { + $contentPrefix = $result; + } + } + } + } + + $_configuration['vchamilo_web_root'] = "{$protocol}://".@$_SERVER['HTTP_HOST'].$contentPrefix; + + $_configuration['vchamilo_name'] = @$_SERVER['HTTP_HOST']; + if (empty($_configuration['vchamilo_name'])) { // try again with another source if has failed + $_configuration['vchamilo_name'] = "{$protocol}://".$_SERVER['SERVER_NAME']; + if ($_SERVER['SERVER_PORT'] != 80) { + $_configuration['vchamilo_name'] .= ':'.$_SERVER['SERVER_PORT']; + } + $_configuration['vchamilo_name'] = $_SERVER['SERVER_NAME']; + } + } + + /** + * @param string $path + * + * @return string + */ + public static function addTrailingSlash($path) + { + return substr($path, -1) == '/' ? $path : $path.'/'; + } + + /** + * provides a side connection to a vchamilo database. + * + * @param array $_configuration + * + * @return \Doctrine\DBAL\Driver\Connection + */ + public static function bootConnection(&$_configuration) + { + $dbParams = [ + 'driver' => 'pdo_mysql', + 'host' => $_configuration['db_host'], + 'user' => $_configuration['db_user'], + 'password' => $_configuration['db_password'], + 'dbname' => isset($_configuration['main_database']) ? $_configuration['main_database'] : '', + // Only relevant for pdo_sqlite, specifies the path to the SQLite database. + 'path' => isset($_configuration['db_path']) ? $_configuration['db_path'] : '', + // Only relevant for pdo_mysql, pdo_pgsql, and pdo_oci/oci8, + 'port' => isset($_configuration['db_port']) ? $_configuration['db_port'] : '', + ]; + + try { + $database = new \Database(); + $connection = $database->connect( + $dbParams, + $_configuration['root_sys'], + $_configuration['root_sys'], + true + ); + } catch (Exception $e) { + echo 'Side connection failure with '.$_configuration['db_host'].', '.$_configuration['db_user'].', ******** '; + exit(); + } + + return $connection; + } + + /** + * @param string $url + */ + public static function redirect($url) + { + if (preg_match('#https?://#', $url)) { + header('location: '.$url); + } else { + header('location: '.api_get_path(WEB_PATH).$url); + } + exit; + } + + /** + * @param string $course_folder + * + * @return string + */ + public static function getHtaccessFragment($course_folder) + { + $str = " + # Change this file to fit your configuration and save it as .htaccess in the courses folder # + # Chamilo mod rewrite + # Comment lines start with # and are not processed + + + RewriteEngine On + + # Rewrite base is the dir chamilo is installed in with trailing slash + RewriteBase /{$course_folder}/ + + # Do not rewrite on the main dir + # Change this path to the path of your main folder + RewriteCond %{REQUEST_URI} !^/main/ + + #replace nasty ampersands by 3 slashes, we change these back in download.php + RewriteRule ([^/]+)/document/(.*)&(.*)$ $1/document/$2///$3 [N] + + # Rewrite everything in the scorm folder of a course to the download script + RewriteRule ([^/]+)/scorm/(.*)$ /main/document/download_scorm.php?doc_url=/$2&cDir=$1 [QSA,L] + + # Rewrite everything in the document folder of a course to the download script + RewriteRule ([^/]+)/document/(.*)$ /main/document/download.php?doc_url=/$2&cDir=$1 [QSA,L] + + # Rewrite everything in the work folder + RewriteRule ([^/]+)/work/(.*)$ /main/work/download.php?file=work/$2&cDir=$1 [QSA,L] + + "; + + return $str; + } + + /** + * @return string + */ + public static function getDefaultCourseIndexFragment() + { + return ""; + } + + /** + * @param string $template + * + * @return bool + */ + public static function templateExists($template) + { + global $_configuration; + + // Find and checktemplate directory (files and SQL). + $separator = DIRECTORY_SEPARATOR; + $templatefoldername = 'plugin'.$separator.'vchamilo'.$separator.'templates'; + $relative_datadir = $templatefoldername.$separator.$template.'_sql'; + $absolute_datadir = $_configuration['root_sys'].$relative_datadir; + + return is_dir($absolute_datadir); + } + + /** + * drop a vchamilo instance databases using the physical connection. + * + * @param stdClass $params + * return an array of errors or false if ok + */ + public static function dropDatabase($params) + { + $params = clone $params; + + if (empty($params->main_database)) { + Display::addFlash(Display::return_message('No database found')); + + return; + } + + $databaseToDelete = $params->main_database; + unset($params->main_database); + $connection = self::getConnectionFromInstance($params); + if ($connection) { + $databases = $connection->getSchemaManager()->listDatabases(); + + if (in_array($databaseToDelete, $databases)) { + $connection->getSchemaManager()->dropDatabase( + $databaseToDelete + ); + Display::addFlash( + Display::return_message( + 'Database deleted: '.$databaseToDelete + ) + ); + } else { + Display::addFlash( + Display::return_message( + 'Database does not exist: '.$databaseToDelete + ) + ); + } + } else { + Display::addFlash( + Display::return_message( + "Cannot connect DB: $databaseToDelete" + ) + ); + } + + return false; + } + + /** + * @param stdClass $params + * + * @return bool + */ + public static function createDatabase($params) + { + $params = clone $params; + $databaseName = $params->main_database; + unset($params->main_database); + + $connection = self::getConnectionFromInstance($params); + if ($connection) { + $databaseList = $connection->getSchemaManager()->listDatabases(); + + if (!in_array($databaseName, $databaseList)) { + $connection->getSchemaManager()->createDatabase($databaseName); + Display::addFlash( + Display::return_message("Creating DB ".$databaseName) + ); + } else { + Display::addFlash( + Display::return_message("DB already exists: ".$databaseName) + ); + } + + return true; + } + + return false; + } + + /** + * get a proper SQLdump command. + * + * @param object $vchamilodata the complete new host information + * + * @return string the shell command + */ + public static function getDatabaseDumpCmd($vchamilodata) + { + $pgm = self::getConfig('vchamilo', 'mysql_cmd'); + + if (!$pgm) { + $pgm = '/usr/bin/mysql'; + } + + $phppgm = str_replace("\\", '/', $pgm); + $phppgm = str_replace("\"", '', $phppgm); + $pgm = str_replace("/", DIRECTORY_SEPARATOR, $pgm); + + if (!is_executable($phppgm)) { + throw new Exception('databasecommanddoesnotmatchanexecutablefile'); + } + + // Retrieves the host configuration (more secure). + $vchamilodata = empty($vchamilodata) ? self::makeThis() : $vchamilodata; + if (strstr($vchamilodata->db_host, ':') !== false) { + list($vchamilodata->db_host, $vchamilodata->db_port) = explode( + ':', + $vchamilodata->db_host + ); + } + + // Password. + $databasePassword = ''; + if (!empty($vchamilodata->db_password)) { + $databasePassword = '-p'.escapeshellarg($vchamilodata->db_password).' '; + } + + // Making the command line (see 'vconfig.php' file for defining the right paths). + $sqlcmd = $pgm.' -h'.$vchamilodata->db_host.(isset($vchamilodata->db_port) ? ' -P'.$vchamilodata->db_port.' ' : ' '); + $sqlcmd .= '-u'.$vchamilodata->db_user.' '.$databasePassword; + $sqlcmd .= '%DATABASE% < '; + + return $sqlcmd; + } + + /** + * @param stdClass $vchamilo + * @param string $template + * + * @return bool + */ + public static function loadDbTemplate($vchamilo, $template) + { + global $_configuration; + + // Make template directory (files and SQL). + $separator = DIRECTORY_SEPARATOR; + $templatefoldername = 'plugin'.$separator.'vchamilo'.$separator.'templates'; + $absolute_datadir = $_configuration['root_sys'].$templatefoldername.$separator.$template.$separator.'dump.sql'; + + if (!$sqlcmd = self::getDatabaseDumpCmd($vchamilo)) { + return false; + } + + $sqlcmd = str_replace('%DATABASE%', $vchamilo->main_database, $sqlcmd); + + // Make final commands to execute, depending on the database type. + $import = $sqlcmd.$absolute_datadir; + + // Execute the command. + Display::addFlash(Display::return_message("Load database from template dump: \n $import ")); + + if (!defined('CLI_SCRIPT')) { + putenv('LANG=en_US.utf-8'); + } + // ensure utf8 is correctly handled by php exec() + // @see http://stackoverflow.com/questions/10028925/call-a-program-via-shell-exec-with-utf-8-text-input + + exec($import, $output, $return); + if (!empty($output)) { + Display::addFlash(Display::return_message(implode("\n", $output)."\n")); + } + + return true; + } + + /** + * Backups a database for having a snapshot. + * + * @param $vchamilo object The Vchamilo object + * @param $outputfilerad string The output SQL file radical + * + * @return bool if TRUE, dumping database was a success, otherwise FALSE + */ + public static function backupDatabase($vchamilo, $outputfilerad) + { + // Separating host and port, if sticked. + if (strstr($vchamilo->db_host, ':') !== false) { + list($host, $port) = explode(':', $vchamilo->db_host); + } else { + $host = $vchamilo->db_host; + } + + // By default, empty password. + $pass = ''; + $pgm = null; + + if (empty($port)) { + $port = 3306; + } + + // Password. + if (!empty($vchamilo->db_password)) { + $pass = "-p".escapeshellarg($vchamilo->db_password); + } + + // Making the commands for each database. + $cmds = []; + // Windows environments are not supported for this plugin at this time + //if ($CFG->ostype == 'WINDOWS') { + // $cmd_main = "-h{$host} -P{$port} -u{$vchamilo->db_user} {$pass} {$vchamilo->main_database}"; + // $cmds[] = $cmd_main . ' > ' . $outputfilerad; + //} else { + $cmd_main = "-h{$host} -P{$port} -u{$vchamilo->db_user} {$pass} {$vchamilo->main_database}"; + $cmds[] = $cmd_main.' > '.escapeshellarg($outputfilerad); + //} + + $mysqldumpcmd = self::getConfig('vchamilo', 'cmd_mysqldump', true); + + $pgm = !empty($mysqldumpcmd) ? stripslashes($mysqldumpcmd) : false; + + if (!$pgm) { + $message = "Database dump command not available check here: "; + $url = api_get_path(WEB_CODE_PATH).'admin/configure_plugin.php?name=vchamilo'; + $message .= Display::url($url, $url); + Display::addFlash(Display::return_message($message)); + + return false; + } else { + $phppgm = str_replace("\\", '/', $pgm); + $phppgm = str_replace("\"", '', $phppgm); + $pgm = str_replace('/', DIRECTORY_SEPARATOR, $pgm); + + if (!is_executable($phppgm)) { + $message = "Database dump command $phppgm does not match any executable"; + Display::addFlash(Display::return_message($message)); + + return false; + } + + // executing all commands + foreach ($cmds as $cmd) { + // Final command. + $cmd = $pgm.' '.$cmd; + + // Executes the SQL command. + exec($cmd, $execoutput, $returnvalue); + } + } + + // End with success. + return 1; + } + + /** + * read manifest values in vchamilo template. + */ + public static function getVmanifest($version) + { + $templatewwwroot = ''; + // Define the $templatewwwroot content, found in manifest.php for this template + $file = api_get_path(SYS_PATH).'/plugin/vchamilo/templates/'.$version.'/manifest.php'; + if (file_exists($file)) { + include $file; + + $manifest = new stdClass(); + $manifest->templatewwwroot = $templatewwwroot; + // $manifest->templatevdbprefix = $templatevdbprefix; + // $manifest->coursefolder = $coursefolder; + + return $manifest; + } + + return false; + } + + /** + * make a fake vchamilo that represents the current host. + */ + public static function makeThis() + { + global $_configuration; + + $thisPortal = new stdClass(); + $thisPortal->root_web = $_configuration['root_web']; + $thisPortal->db_host = $_configuration['db_host']; + $thisPortal->db_user = $_configuration['db_user']; + $thisPortal->db_password = $_configuration['db_password']; + $thisPortal->main_database = $_configuration['main_database']; + + return $thisPortal; + } + + /** + * Get available templates for defining a new virtual host. + * + * @return array the available templates, or EMPTY array + */ + public static function getAvailableTemplates() + { + global $_configuration; + + $separator = DIRECTORY_SEPARATOR; + + $templatefoldername = 'plugin'.$separator.'vchamilo'.$separator.'templates'; + $tempDir = $_configuration['root_sys'].$templatefoldername; + + // Scans the templates. + if (!is_dir($tempDir)) { + $mode = api_get_permissions_for_new_directories(); + mkdir($tempDir, $mode, true); + } + + $finder = new \Symfony\Component\Finder\Finder(); + $dirs = $finder->in($tempDir)->depth('== 0'); + + // Retrieves template(s) name(s). Should be hostnames. + $templates = []; + /*if ($addEmptyTemplate) { + $templates = array('' => $plugin->get_lang('emptysite')); + }*/ + + $template = self::getConfig('vchamilo', 'default_template'); + + if ($dirs) { + /** @var Symfony\Component\Finder\SplFileInfo $dir */ + foreach ($dirs as $dir) { + if (is_dir($dir->getPathname())) { + // A template is considered when a dump.sql exists. + if (file_exists($dir->getPathname().'/dump.sql')) { + $templateName = $dir->getRelativePathname(); + if ($templateName == $template) { + $templateName .= ' (default)'; + } + $templates[$dir->getRelativePathname()] = $templateName; + } + } + } + } + + return $templates; + } + + /** + * this function set will map standard moodle API calls to chamilo + * internal primitives. This avoids too many changes to do in imported + * code. + */ + public static function getConfig($module, $key, $isplugin = true) + { + if ($isplugin) { + $key = $module.'_'.$key; + } + + $params = ['variable = ? AND subkey = ?' => [$key, $module]]; + $result = api_get_settings_params_simple($params); + if ($result) { + return $result['selected_value']; + } + + return false; + } + + /** + * @param stdClass $vchamilo + * @param string $template + */ + public static function loadFilesFromTemplate($vchamilo, $template) + { + global $_configuration; + + // Make template directory (files and SQL). + $separator = DIRECTORY_SEPARATOR; + $templateDir = $_configuration['root_sys'].'plugin'.$separator.'vchamilo'.$separator.'templates'.$separator.$template; + $vchamilo->virtual = true; + $coursePath = self::getConfig('vchamilo', 'course_real_root').$separator.$vchamilo->slug; + $homePath = self::getConfig('vchamilo', 'home_real_root').$separator.$vchamilo->slug; + $archivePath = self::getConfig('vchamilo', 'archive_real_root').$separator.$vchamilo->slug; + $uploadPath = self::getConfig('vchamilo', 'upload_real_root').$separator.$vchamilo->slug; + + // get the protocol free hostname + Display::addFlash( + Display::return_message("Copying {$templateDir}/data/courses => $coursePath") + ); + + copyDirTo( + self::chopLastSlash($templateDir.'/data/courses'), + self::chopLastSlash($coursePath), + false + ); + + Display::addFlash( + Display::return_message("Copying {$templateDir}/data/archive => $archivePath") + ); + + copyDirTo( + self::chopLastSlash($templateDir.'/data/archive'), + self::chopLastSlash($archivePath), + false + ); + + Display::addFlash( + Display::return_message("Copying {$templateDir}/data/home => $homePath") + ); + + copyDirTo( + self::chopLastSlash($templateDir.'/data/home'), + self::chopLastSlash($homePath), + false + ); + + // Upload + Display::addFlash( + Display::return_message("Copying {$templateDir}/data/upload => $uploadPath") + ); + + copyDirTo( + self::chopLastSlash($templateDir.'/data/upload/'), + self::chopLastSlash($uploadPath), + false + ); + } + + /** + * @param string $path + * + * @return mixed + */ + public static function chopLastSlash($path) + { + return preg_replace('/\/$/', '', $path); + } + + /** + * @param string $str + */ + public static function ctrace($str) + { + error_log($str); + Display::addFlash(Display::return_message($str, 'normal', false)); + } + + /** + * @param $file + * @param $component + * @param bool $return + * + * @return string + */ + public static function requireJs($file, $component, $return = false) + { + global $_configuration, $htmlHeadXtra; + + if (preg_match('/^local_/', $component)) { + $component = str_replace('local_', '', $component); + $path = 'local/'; + } else { + $path = 'plugin/'; + } + + // Secure the postslashing of the roots. + $root_web = $_configuration['root_web'].'/'; + $root_web = preg_replace('#//$#', '/', $root_web); + + $str = ''."\n"; + if ($return === 'head') { + $htmlHeadXtra[] = $str; + } + + if ($return) { + return $str; + } + echo $str; + } + + /** + * @param $file + * @param $component + * @param bool $return + * + * @return string + */ + public static function requireCss($file, $component, $return = false) + { + global $_configuration, $htmlHeadXtra; + + if (preg_match('/^local_/', $component)) { + $component = str_replace('local_', '', $component); + $path = 'local/'; + } else { + $path = 'plugin/'; + } + + // Secure the postslashing of the roots. + $root_web = $_configuration['root_web'].'/'; + $root_web = preg_replace('#//$#', '/', $root_web); + + $str = ''."\n"; + if ($return === 'head') { + $htmlHeadXtra[] = $str; + } + if ($return) { + return $str; + } + echo $str; + } + + /** + * @param string $url + * + * @return string + */ + public static function getSlugFromUrl($url) + { + $slugify = new Slugify(); + $urlInfo = parse_url($url); + if (isset($urlInfo['host'])) { + $path = $urlInfo['path'] != '/' ? '_'.$urlInfo['path'] : ''; + + return $slugify->slugify($urlInfo['host'].$path); + } + + return false; + } + + /** + * Check if all settings are complete. + */ + public static function checkSettings() + { + $enabled = self::getConfig('vchamilo', 'enable_virtualisation'); + + if (empty($enabled)) { + api_not_allowed(true, 'Plugin is not enabled'); + } + + global $virtualChamilo; + if (!isset($virtualChamilo)) { + api_not_allowed( + true, + 'You have to edit the configuration.php. Please check the readme file.' + ); + } + + $coursePath = self::getConfig('vchamilo', 'course_real_root'); + $homePath = self::getConfig('vchamilo', 'home_real_root'); + $archivePath = self::getConfig('vchamilo', 'archive_real_root'); + $uploadPath = self::getConfig('vchamilo', 'upload_real_root'); + $cmdSql = self::getConfig('vchamilo', 'cmd_mysql'); + $cmdMySql = self::getConfig('vchamilo', 'cmd_mysqldump'); + + if (empty($coursePath) || empty($homePath) || empty($uploadPath) || empty($archivePath) || empty($cmdSql) || empty($cmdMySql)) { + api_not_allowed(true, 'You have to complete all plugin settings.'); + } + + $separator = DIRECTORY_SEPARATOR; + $templatePath = api_get_path(SYS_PATH).'plugin'.$separator.'vchamilo'.$separator.'templates'; + + $paths = [ + $coursePath, + $homePath, + $archivePath, + $uploadPath, + $templatePath, + ]; + + foreach ($paths as $path) { + $path = trim($path); + if (is_dir($path)) { + if (!is_writable($path)) { + Display::addFlash( + Display::return_message("Directory must have writable permissions: '$path'", 'warning') + ); + } + } else { + Display::addFlash( + Display::return_message("Directory doesn't exist: '$path'", 'warning') + ); + } + } + } + + /** + * @param object $instance + * + * @return bool|\Doctrine\DBAL\Connection + */ + public static function getConnectionFromInstance($instance, $getManager = false) + { + $dbParams = [ + 'driver' => 'pdo_mysql', + 'host' => $instance->db_host, + 'user' => $instance->db_user, + 'password' => $instance->db_password, + //'dbname' => $instance->main_database, + // Only relevant for pdo_sqlite, specifies the path to the SQLite database. + //'path' => isset($_configuration['db_path']) ? $_configuration['db_path'] : '', + // Only relevant for pdo_mysql, pdo_pgsql, and pdo_oci/oci8, + //'port' => isset($_configuration['db_port']) ? $_configuration['db_port'] : '', + ]; + + if (!empty($instance->main_database)) { + $dbParams['dbname'] = $instance->main_database; + } + + try { + $database = new \Database(); + $manager = $database->connect( + $dbParams, + api_get_configuration_value('root_sys'), + api_get_configuration_value('root_sys'), + false, + true + ); + + if ($getManager) { + return $manager; + } + + return $manager->getConnection(); + } catch (Exception $e) { + error_log($e->getMessage()); + } + + return false; + } + + public static function addInstance(stdClass $data) + { + if (isset($data->what)) { + unset($data->what); + } + if (isset($data->submitbutton)) { + unset($data->submitbutton); + } + if (isset($data->id)) { + unset($data->id); + } + if (isset($data->vid)) { + unset($data->vid); + } + if (isset($data->testconnection)) { + unset($data->testconnection); + } + if (isset($data->testdatapath)) { + unset($data->testdatapath); + } + + $registeronly = $data->registeronly; + unset($data->registeronly); + $data->lastcron = 0; + $data->lastcrongap = 0; + $data->croncount = 0; + + if (isset($data->template) && !empty($data->template)) { + $template = $data->template; + } else { + $template = ''; + } + + $data->main_database = Database::clearDatabaseName($data->main_database); + + $mainDatabase = api_get_configuration_value('main_database'); + + if ($mainDatabase == $data->main_database) { + Display::addFlash( + Display::return_message('You cannot use the same database as the chamilo master', 'error') + ); + + return; + } + + $databaseName = $data->main_database; + $data->main_database = ''; + $connection = self::getConnectionFromInstance($data); + $data->main_database = $databaseName; + if (!$connection) { + Display::addFlash( + Display::return_message( + 'Cannot connect to database with params: '.print_r($data, 1), + 'error' + ) + ); + + return; + } + + $data->root_web = api_add_trailing_slash($data->root_web); + + $data->archive_url = api_add_trailing_slash($data->archive_url); + $data->home_url = api_add_trailing_slash($data->home_url); + $data->upload_url = api_add_trailing_slash($data->upload_url); + $data->course_url = api_add_trailing_slash($data->course_url); + + if (substr($data->root_web, 0, 4) != 'http') { + $data->root_web = api_get_protocol().'://'.$data->root_web; + } + + self::ctrace('Registering: '.$data->root_web); + $tablename = Database::get_main_table('vchamilo'); + $sql = "SELECT * FROM $tablename + WHERE root_web = '".Database::escape_string($data->root_web)."'"; + $result = Database::query($sql); + + if (Database::num_rows($result)) { + Database::update($tablename, $data, ['root_web = ?' => $data->root_web]); + $virtualInfo = Database::fetch_array($result); + $slug = $virtualInfo['slug']; + } else { + $slug = $data->slug = self::getSlugFromUrl($data->root_web); + if (empty($slug)) { + Display::addFlash( + Display::return_message('Cannot create slug from url: '.$data->root_web, 'error') + ); + + return; + } + Database::insert($tablename, (array) $data); + } + + if ($registeronly) { + // Stop it now. + self::ctrace('Registering only. out.'); + self::redirect(api_get_path(WEB_PLUGIN_PATH).'vchamilo/views/manage.php'); + } + + // or we continue with physical creation + self::createDirsFromSlug($slug); + + if (!$template) { + // Create empty database for install + self::ctrace("Creating database"); + self::createDatabase($data); + } else { + // Deploy template database + self::ctrace("Creating databases from template '$template'"); + self::createDatabase($data); + self::ctrace("Loading data template '$template'"); + self::loadDbTemplate($data, $template); + self::ctrace("Coying files from template '$template'"); + self::loadFilesFromTemplate($data, $template); + } + + // pluging in site name institution + $settingstable = $data->main_database.'.settings_current'; + $accessurltable = $data->main_database.'.access_url'; + + $sitename = Database::escape_string($data->sitename); + $institution = Database::escape_string($data->institution); + + $sqls[] = "UPDATE {$settingstable} SET selected_value = '{$sitename}' + WHERE variable = 'siteName' AND category = 'Platform' "; + + $sqls[] = "UPDATE {$settingstable} SET selected_value = '{$institution}' + WHERE variable = 'institution' AND category = 'Platform' "; + + $sqls[] = "UPDATE {$accessurltable} SET url = '{$data->root_web}' WHERE id = '1' "; + + foreach ($sqls as $sql) { + Database::query($sql); + } + + self::ctrace("Finished"); + } + + /** + * @throws \Doctrine\DBAL\Exception + * + * @return false|void + */ + public static function importInstance(stdClass $data, string $fromVersion) + { + if (isset($data->what)) { + unset($data->what); + } + if (isset($data->submitbutton)) { + unset($data->submitbutton); + } + if (isset($data->id)) { + unset($data->id); + } + if (isset($data->vid)) { + unset($data->vid); + } + if (isset($data->testconnection)) { + unset($data->testconnection); + } + if (isset($data->testdatapath)) { + unset($data->testdatapath); + } + + $fromCoursePath = $data->course_path; + $fromHomePath = $data->home_path; + $fromUploadPath = $data->upload_path; + + unset($data->course_path); + unset($data->home_path); + unset($data->upload_path); + + $newDatabase = clone $data; + $newDatabase->main_database = Database::clearDatabaseName($newDatabase->import_to_main_database); + $newDatabase->db_user = $newDatabase->import_to_db_user; + $newDatabase->db_password = $newDatabase->import_to_db_password; + $newDatabase->db_host = $newDatabase->import_to_db_host; + + unset($newDatabase->import_to_main_database); + unset($newDatabase->import_to_db_user); + unset($newDatabase->import_to_db_password); + unset($newDatabase->import_to_db_host); + + unset($data->import_to_main_database); + unset($data->import_to_db_user); + unset($data->import_to_db_password); + unset($data->import_to_db_host); + + $data->lastcron = 0; + $data->lastcrongap = 0; + $data->croncount = 0; + + $mainDatabase = api_get_configuration_value('main_database'); + + if ($mainDatabase == $data->main_database) { + Display::addFlash( + Display::return_message('You cannot use the same database as the chamilo master', 'error') + ); + + return false; + } + + self::ctrace('Registering: '.$data->root_web); + + $table = Database::get_main_table('vchamilo'); + $sql = "SELECT * FROM $table + WHERE root_web = '".Database::escape_string($data->root_web)."'"; + $result = Database::query($sql); + $id = null; + if (Database::num_rows($result)) { + Display::addFlash( + Display::return_message('Instance was already added: '.$data->root_web, 'error') + ); + + return false; + } else { + /** @var EntityManager $em */ + $em = self::getConnectionFromInstance($data, true); + if ($em) { + $connection = $em->getConnection(); + $statement = $connection->query('SELECT * FROM settings_current'); + $settings = $statement->fetchAll(); + $settings = array_column( + $settings, + 'selected_value', + 'variable' + ); + $institution = $settings['Institution']; + $siteName = $settings['siteName']; + $newDatabase->sitename = $siteName; + $newDatabase->institution = $institution; + $slug = $newDatabase->slug = $data->slug = self::getSlugFromUrl($data->root_web); + $id = Database::insert($table, (array) $newDatabase); + } + } + + if (!$id) { + // Show data detail to help debug + //var_dump($data); + throw new Exception('New/Imported instance was not registered - edit '.__FILE__.' on line '.__LINE__.'to var_dump'); + } + + if (empty($slug)) { + throw new Exception('Slug is empty'); + } + + self::createDirsFromSlug($slug); + $databaseCreated = self::createDatabase($newDatabase); + if (!$databaseCreated) { + Display::addFlash( + Display::return_message('Error while creating a DB', 'error') + ); + + return false; + } + + $coursePath = self::getConfig('vchamilo', 'course_real_root').'/'.$slug; + $homePath = self::getConfig('vchamilo', 'home_real_root').'/'.$slug; + $uploadPath = self::getConfig('vchamilo', 'upload_real_root').'/'.$slug; + + $dumpFile = api_get_path(SYS_ARCHIVE_PATH).uniqid($data->main_database.'_dump_', true).'.sql'; + self::ctrace('Create backup from "'.$data->main_database.'" here: '.$dumpFile.' '); + self::backupDatabase($data, $dumpFile); + + $sqlcmd = self::getDatabaseDumpCmd($newDatabase); + $sqlcmd = str_replace('%DATABASE%', $newDatabase->main_database, $sqlcmd); + $import = $sqlcmd.$dumpFile; + + // Execute the command. + if (!defined('CLI_SCRIPT')) { + putenv('LANG=en_US.utf-8'); + } + + // ensure utf8 is correctly handled by php exec() + // @see http://stackoverflow.com/questions/10028925/call-a-program-via-shell-exec-with-utf-8-text-input + $result = exec($import, $output, $return); + + self::ctrace('Restore backup here "'.$newDatabase->main_database.'" :
    '.$import.' '); + self::ctrace($result); + + $command = new \Chash\Command\Installation\UpgradeDatabaseCommand(); + // Creates the helper set + $helperSet = \Doctrine\ORM\Tools\Console\ConsoleRunner::createHelperSet($em); + + $helpers = [ + 'configuration' => new Chash\Helpers\ConfigurationHelper(), + 'dialog' => new \Symfony\Component\Console\Helper\QuestionHelper(), + ]; + + foreach ($helpers as $name => $helper) { + $helperSet->set($helper, $name); + } + + $command->setHelperSet($helperSet); + + $tmpFile = tmpfile(); + $outputStream = new \Symfony\Component\Console\Output\BufferedOutput($tmpFile); + + $arguments = [ + 'from-version' => $fromVersion, // @todo change value + 'to-version' => '1.11.x', + 'host' => $newDatabase->db_host, + 'username' => $newDatabase->db_user, + 'password' => $newDatabase->db_password, + 'db_name' => $newDatabase->main_database, + 'root_sys' => api_get_configuration_value('root_sys'), + ]; + + $input = new ArrayInput($arguments); + $command->run($input, $outputStream); + + error_log($outputStream->fetch()); + + if (file_exists($dumpFile)) { + unlink($dumpFile); + } + + // Course + self::ctrace("Copy from '$fromCoursePath' to backup '$coursePath' "); + copyDirTo( + self::chopLastSlash($fromCoursePath), + self::chopLastSlash($coursePath), + false + ); + + // Home + self::ctrace("Copy from '$fromHomePath' to backup '$homePath' "); + copyDirTo( + self::chopLastSlash($fromHomePath), + self::chopLastSlash($homePath), + false + ); + + // Upload + self::ctrace("Copy from '$fromUploadPath' to backup '$uploadPath' "); + copyDirTo( + self::chopLastSlash($fromUploadPath), + self::chopLastSlash($uploadPath), + false + ); + + self::ctrace("Finished"); + } + + /** + * @param string $slug + * + * @return string + */ + public static function createDirsFromSlug($slug) + { + // We continue with physical creation + + // Create course directory for operations. + // this is very important here (DO NOT USE api_get_path() !!) because storage may be remotely located + $absAlternateCourse = self::getConfig('vchamilo', 'course_real_root'); + $courseDir = $absAlternateCourse.'/'.$slug; + $mode = api_get_permissions_for_new_directories(); + if (!is_dir($courseDir)) { + self::ctrace("Creating physical course dir in $courseDir"); + mkdir($courseDir, $mode, true); + // initiate default index + $indexFile = $courseDir.'/index.html'; + if ($indexFile) { + file_put_contents($indexFile, self::getDefaultCourseIndexFragment()); + } + + $htaccessFile = $courseDir.'/.htaccess'; + if ($htaccessFile) { + file_put_contents($htaccessFile, self::getHtaccessFragment($slug)); + } + } + + $absAlternateHome = self::getConfig('vchamilo', 'home_real_root'); + $absAlternateArchive = self::getConfig('vchamilo', 'archive_real_root'); + $absAlternateUpload = self::getConfig('vchamilo', 'upload_real_root'); + + // absalternatehome is a vchamilo config setting that tells where the + // real physical storage for home pages are. + $homeDir = $absAlternateHome.'/'.$slug; + $archiveDir = $absAlternateArchive.'/'.$slug; + $uploadDir = $absAlternateUpload.'/'.$slug; + + $dirs = [ + $homeDir, + $archiveDir, + $uploadDir, + ]; + + foreach ($dirs as $dir) { + self::ctrace("Making dir as $dir"); + + if (!is_dir($dir)) { + if (!mkdir($dir, $mode, true)) { + self::ctrace("Error creating dir $dir \n"); + } + } + } + } + + /** + * @param $id + * + * @return array|mixed + */ + public static function getInstance($id) + { + $vhost = new stdClass(); + if ($id) { + $id = (int) $id; + $sql = "SELECT * FROM vchamilo WHERE id = $id"; + $result = Database::query($sql); + $vhost = (object) Database::fetch_array($result, 'ASSOC'); + } + + return $vhost; + } + + /** + * @param stdClass $instance + * + * @return bool|string returns the original version of the app + */ + public static function canBeUpgraded($instance) + { + $connection = self::getConnectionFromInstance($instance); + if ($connection) { + $sql = 'SELECT * FROM settings_current WHERE variable = "chamilo_database_version"'; + $statement = $connection->query($sql); + $settings = $statement->fetchAll(); + $settings = array_column($settings, 'selected_value', 'variable'); + $version = $settings['chamilo_database_version']; + $versionParts = explode('.', $version); + $version = implode('.', [$versionParts[0], $versionParts[1], '0']); + + $currentVersion = api_get_setting('chamilo_database_version'); + $versionParts = explode('.', $currentVersion); + $currentVersion = implode( + '.', + [$versionParts[0], $versionParts[1], '0'] + ); + + if (version_compare($version, $currentVersion, '<')) { + return $version; + } + } + + return false; + } + + /** + * @return array + */ + public static function getEncryptList() + { + $encryptList = [ + 'bcrypt', + 'sha1', + 'md5', + 'none', + ]; + + return array_combine($encryptList, $encryptList); + } +} diff --git a/plugin/vchamilo/pix/ajax_waiter.gif b/plugin/vchamilo/pix/ajax_waiter.gif new file mode 100644 index 000000000..3980ff00b Binary files /dev/null and b/plugin/vchamilo/pix/ajax_waiter.gif differ diff --git a/plugin/vchamilo/pix/icon.gif b/plugin/vchamilo/pix/icon.gif new file mode 100644 index 000000000..6259b870f Binary files /dev/null and b/plugin/vchamilo/pix/icon.gif differ diff --git a/plugin/vchamilo/pix/logo.png b/plugin/vchamilo/pix/logo.png new file mode 100644 index 000000000..c5439f665 Binary files /dev/null and b/plugin/vchamilo/pix/logo.png differ diff --git a/plugin/vchamilo/plugin.php b/plugin/vchamilo/plugin.php new file mode 100644 index 000000000..bebf00af3 --- /dev/null +++ b/plugin/vchamilo/plugin.php @@ -0,0 +1,106 @@ +Plugins). + * + * @package chamilo.plugin + * + * @author Julio Montoya + */ +global $_configuration; + +/** + * Plugin details (must be present). + */ + +/* Plugin config */ + +//the plugin title +$plugin_info['title'] = 'Chamilo Virtualization'; +//the comments that go with the plugin +$plugin_info['comment'] = "Allows the virtualization of Chamilo. Use your main Chamilo installation as a hub, then create instances based on the same code but with different databases, and generate snapshots, and manage all instances like VM images."; +//the plugin version +$plugin_info['version'] = '1.2'; +//the plugin author +$plugin_info['author'] = 'Valery Fremaux, Julio Montoya'; + +/* Plugin optional settings */ + +/* + * This form will be showed in the plugin settings once the plugin was installed + * in the plugin/hello_world/index.php you can have access to the value: $plugin_info['settings']['hello_world_show_type'] +*/ + +$form = new FormValidator('vchamilo_form'); + +$plugin = VChamiloPlugin::create(); + +$form_settings = [ + 'enable_virtualisation' => Virtual::getConfig('vchamilo', 'enable_virtualisation', true), + 'httpproxyhost' => Virtual::getConfig('vchamilo', 'httpproxyhost', true), + 'httpproxyport' => Virtual::getConfig('vchamilo', 'httpproxyport', true), + 'httpproxybypass' => Virtual::getConfig('vchamilo', 'httpproxybypass', true), + 'httpproxyuser' => Virtual::getConfig('vchamilo', 'httpproxyuser', true), + 'httpproxypassword' => Virtual::getConfig('vchamilo', 'httpproxypassword', true), + 'cmd_mysql' => Virtual::getConfig('vchamilo', 'cmd_mysql', true), + 'cmd_mysqldump' => Virtual::getConfig('vchamilo', 'cmd_mysqldump', true), + 'course_real_root' => Virtual::getConfig('vchamilo', 'course_real_root', true), + 'archive_real_root' => Virtual::getConfig('vchamilo', 'archive_real_root', true), + 'home_real_root' => Virtual::getConfig('vchamilo', 'home_real_root', true), + 'upload_real_root' => Virtual::getConfig('vchamilo', 'upload_real_root', true), +]; + +$form->setDefaults($form_settings); + +$wwwroot = $_configuration['root_web']; + +//A simple select +$options = [0 => $plugin->get_lang('no'), 1 => $plugin->get_lang('yes')]; +$form->addLabel( + '', + ''. + $plugin->get_lang('manage_instances').'' +); +$form->addElement('header', $plugin->get_lang('enabling')); +$form->addElement('select', 'enable_virtualisation', $plugin->get_lang('enable_virtualisation'), $options); +$form->addElement( + 'text', + 'course_real_root', + [$plugin->get_lang('courserealroot'), 'Example: '.api_get_path(SYS_PATH).'var/courses/'] +); +$form->addElement( + 'text', + 'archive_real_root', + [$plugin->get_lang('archiverealroot'), 'Example: '.api_get_path(SYS_PATH).'var/cache/'] +); +$form->addElement( + 'text', + 'home_real_root', + [$plugin->get_lang('homerealroot'), 'Example: '.api_get_path(SYS_PATH).'var/home/'] +); + +$form->addElement( + 'text', + 'upload_real_root', + [$plugin->get_lang('UploadRealRoot'), 'Example: '.api_get_path(SYS_PATH).'var/upload/'] +); + +$form->addElement('header', $plugin->get_lang('mysqlcmds')); +$form->addElement('text', 'cmd_mysql', [$plugin->get_lang('mysqlcmd'), 'Example: /usr/bin/mysql']); +$form->addElement('text', 'cmd_mysqldump', [$plugin->get_lang('mysqldumpcmd'), 'Example: /usr/bin/mysqldump']); +$form->addElement('header', $plugin->get_lang('proxysettings')); +$form->addElement('text', 'httpproxyhost', $plugin->get_lang('httpproxyhost')); +$form->addElement('text', 'httpproxyport', $plugin->get_lang('httpproxyport')); +$form->addElement('text', 'httpproxybypass', $plugin->get_lang('httpproxybypass')); +$form->addElement('text', 'httpproxyuser', $plugin->get_lang('httpproxyuser')); +$form->addElement('text', 'httpproxypassword', $plugin->get_lang('httpproxypassword')); +$form->addButtonSave($plugin->get_lang('Save')); + +$plugin_info['settings_form'] = $form; + +// Set the templates that are going to be used +$plugin_info['templates'] = ['template.tpl']; + +$plugin_info['plugin_class'] = get_class($plugin); diff --git a/plugin/vchamilo/template.tpl b/plugin/vchamilo/template.tpl new file mode 100644 index 000000000..b96f52adf --- /dev/null +++ b/plugin/vchamilo/template.tpl @@ -0,0 +1,10 @@ +
    +

    {{title}}

    +
    +
    + +
    \ No newline at end of file diff --git a/plugin/vchamilo/templates/README.txt b/plugin/vchamilo/templates/README.txt new file mode 100644 index 000000000..35fd168cf --- /dev/null +++ b/plugin/vchamilo/templates/README.txt @@ -0,0 +1,2 @@ +This directory would be http server writable for templates snapshot to be created. +Set GID to web server group, or give write access to everyone. \ No newline at end of file diff --git a/plugin/vchamilo/uninstall.php b/plugin/vchamilo/uninstall.php new file mode 100644 index 000000000..b98643036 --- /dev/null +++ b/plugin/vchamilo/uninstall.php @@ -0,0 +1,9 @@ +ACTIVATION = 'cli'; // choose how individual cron are launched, 'cli' or 'web' +$VCRON->STRATEGY = ROUND_ROBIN; // choose vcron rotation mode +$VCRON->PERIOD = 15 * MINSECS; // used if LOWEST_POSSIBLE_GAP to setup the max gap +$VCRON->TIMEOUT = 300; // time out for CURL call to effective cron +// $VCRON->TRACE = $_configuration['root_sys'].'plugin/vchamilo/log/vcrontrace.log'; // Trace file where to collect cron outputs +$VCRON->TRACE = '/data/log/chamilo/vcrontrace.log'; // Trace file where to collect cron outputs +$VCRON->TRACE_ENABLE = true; // enables tracing + +if (!is_dir($_configuration['root_sys'].'plugin/vchamilo/log')) { + $mode = api_get_permissions_for_new_directories(); + mkdir($_configuration['root_sys'].'plugin/vchamilo/log', $mode, true); +} + +/** + * fire a cron URL using CURL. + */ +function fire_vhost_cron($vhost) +{ + global $VCRON; + + if ($VCRON->TRACE_ENABLE) { + $CRONTRACE = fopen($VCRON->TRACE, 'a'); + } + $ch = curl_init($vhost->root_web.'/main/cron/run.php'); + + $http_proxy_host = api_get_setting('vchamilo_httpproxyhost', 'vchamilo'); + $http_proxy_port = api_get_setting('vchamilo_httpproxyport', 'vchamilo'); + $http_proxy_bypass = api_get_setting('vchamilo_httpproxybypass', 'vchamilo'); + $http_proxy_user = api_get_setting('vchamilo_httpproxyuser', 'vchamilo'); + $http_proxy_password = api_get_setting('vchamilo_httpproxypassword', 'vchamilo'); + + curl_setopt($ch, CURLOPT_TIMEOUT, $VCRON->TIMEOUT); + curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); + curl_setopt($ch, CURLOPT_POST, true); + curl_setopt($ch, CURLOPT_USERAGENT, 'Chamilo'); + curl_setopt($ch, CURLOPT_POSTFIELDS, ''); + curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: text/xml charset=UTF-8"]); + curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); + curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); + + // Check for proxy. + if (!empty($http_proxy_host) && !is_proxybypass($uri)) { + curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, false); + + if (empty($http_proxy_port)) { + echo "Using proxy $http_proxy_host\n"; + curl_setopt($ch, CURLOPT_PROXY, $http_proxy_host); + } else { + echo "Using proxy $http_proxy_host:$http_proxy_port\n"; + curl_setopt($ch, CURLOPT_PROXY, $http_proxy_host.':'.$http_proxy_port); + } + + if (!empty($http_proxy_user) and !empty($http_proxy_password)) { + curl_setopt($ch, CURLOPT_PROXYUSERPWD, $http_proxy_user.':'.$http_proxy_password); + if (defined('CURLOPT_PROXYAUTH')) { + // any proxy authentication if PHP 5.1 + curl_setopt($ch, CURLOPT_PROXYAUTH, CURLAUTH_BASIC | CURLAUTH_NTLM); + } + } + } + + $timestamp_send = time(); + $rawresponse = curl_exec($ch); + $timestamp_receive = time(); + + if ($rawresponse === false) { + $error = curl_errno($ch).':'.curl_error($ch); + if ($VCRON->TRACE_ENABLE) { + if ($CRONTRACE) { + fputs($CRONTRACE, "VCron start on $vhost->root_web : ".api_time_to_hms($timestamp_send)."\n"); + fputs($CRONTRACE, "VCron Error : $error \n"); + fputs($CRONTRACE, "VCron stop on $vhost->root_web : $timestamp_receive\n#################\n\n"); + fclose($CRONTRACE); + } + } + echo "VCron started on $vhost->root_web : ".api_time_to_hms($timestamp_send)."\n"; + echo "VCron Error : $error \n"; + echo "VCron stop on $vhost->root_web : ".api_time_to_hms($timestamp_receive)."\n#################\n\n"; + + return false; + } + + if ($VCRON->TRACE_ENABLE) { + if ($CRONTRACE) { + fputs($CRONTRACE, "VCron start on $vhost->vhostname : ".api_time_to_hms($timestamp_send)."\n"); + fputs($CRONTRACE, $rawresponse."\n"); + fputs($CRONTRACE, "VCron stop on $vhost->vhostname : ".api_time_to_hms($timestamp_receive)."\n#################\n\n"); + fclose($CRONTRACE); + } + } + echo "VCron start on $vhost->root_web : ".api_time_to_hms($timestamp_send)."\n"; + echo $rawresponse."\n"; + echo "VCron stop on $vhost->root_web : ".api_time_to_hms($timestamp_receive)."\n#################\n\n"; + $vhost->lastcrongap = time() - $vhost->lastcron; + $vhost->lastcron = $timestamp_send; + $vhost->croncount++; + + $vhostid = $vhost->id; + unset($vhost->id); + + Database::update('vchamilo', (array) $vhost, ['id = ?' => $vhostid]); +} + +/** + * fire a cron URL using cli exec. + */ +function exec_vhost_cron($vhost) +{ + global $VCRON, $DB, $_configuration; + + if ($VCRON->TRACE_ENABLE) { + $CRONTRACE = fopen($VCRON->TRACE, 'a'); + } + + $cmd = 'php "'.$_configuration['root_sys'].'/plugin/vchamilo/cli/cron.php" --host='.$vhost->root_web; + + $timestamp_send = time(); + exec($cmd, $rawresponse); + $timestamp_receive = time(); + + if ($VCRON->TRACE_ENABLE) { + if ($CRONTRACE) { + fputs($CRONTRACE, "VCron start on $vhost->root_web : $timestamp_send\n"); + fputs($CRONTRACE, $rawresponse."\n"); + fputs($CRONTRACE, "VCron stop on $vhost->root_web : $timestamp_receive\n#################\n\n"); + fclose($CRONTRACE); + } + } + + echo "VCron start on $vhost->root_web : $timestamp_send\n"; + echo implode("\n", $rawresponse)."\n"; + echo "VCron stop on $vhost->root_web : $timestamp_receive\n#################\n\n"; + + $vhost->lastcrongap = time() - $vhost->lastcron; + $vhost->lastcron = $timestamp_send; + $vhost->croncount++; + + $DB->update_record('vchamilo', $vhost, 'id'); +} + +/** + * check if $url matches anything in proxybypass list. + * + * any errors just result in the proxy being used (least bad) + * + * @global object + * + * @param string $url url to check + * + * @return bool true if we should bypass the proxy + */ +function is_proxybypass($url) +{ + $http_proxy_host = api_get_setting('vchamilo_httpproxyhost', 'vchamilo'); + $http_proxy_port = api_get_setting('vchamilo_httpproxyport', 'vchamilo'); + $http_proxy_bypass = api_get_setting('vchamilo_httpproxybypass', 'vchamilo'); + + // sanity check + if (empty($http_proxy_host) or empty($http_proxy_bypass)) { + return false; + } + + // get the host part out of the url + if (!$host = parse_url($url, PHP_URL_HOST)) { + return false; + } + + // get the possible bypass hosts into an array + $matches = explode(',', $http_proxy_bypass); + + // check for a match + // (IPs need to match the left hand side and hosts the right of the url, + // but we can recklessly check both as there can't be a false +ve) + $bypass = false; + foreach ($matches as $match) { + $match = trim($match); + + // try for IP match (Left side) + $lhs = substr($host, 0, strlen($match)); + if (strcasecmp($match, $lhs) == 0) { + return true; + } + + // try for host match (Right side) + $rhs = substr($host, -strlen($match)); + if (strcasecmp($match, $rhs) == 0) { + return true; + } + } + + // nothing matched. + return false; +} + +// Main execution sequence + +if (!$vchamilos = Database::select('*', 'vchamilo', [], 'all')) { + exit("Nothing to do. No Vhosts"); +} + +$allvhosts = array_values($vchamilos); + +echo "
    ";
+echo "Chamilo VCron... start\n";
+echo "Last croned : ".api_get_setting('vchamilo_cron_lasthost', 'vchamilo')."\n";
+
+if ($VCRON->STRATEGY == ROUND_ROBIN) {
+    $rr = 0;
+    foreach ($allvhosts as $vhostassoc) {
+        $vhost = (object) $vhostassoc;
+        if ($rr == 1) {
+            api_set_setting('vchamilo_cron_lasthost', $vhost->id);
+            echo "Round Robin : ".$vhost->root_web."\n";
+            if ($VCRON->ACTIVATION == 'cli') {
+                exec_vhost_cron($vhost);
+            } else {
+                fire_vhost_cron($vhost);
+            }
+
+            exit('Done.');
+        }
+        if ($vhost->id == api_get_setting('vchamilo_cron_lasthost', 'vchamilo')) {
+            $rr = 1; // take next one
+        }
+    }
+
+    // We were at last. Loop back and take first.
+    $firsthost = (object) $allvhosts[0];
+    api_set_setting('vchamilo_cron_lasthost', $firsthost->id, 'vchamilo');
+    echo "Round Robin : ".$firsthost->root_web."\n";
+    if ($VCRON->ACTIVATION == 'cli') {
+        exec_vhost_cron($firsthost);
+    } else {
+        fire_vhost_cron($firsthost);
+    }
+} elseif ($VCRON->STRATEGY == LOWEST_POSSIBLE_GAP) {
+    // First make measurement of cron period.
+    if (api_get_setting('vcrontickperiod', 'vchamilo')) {
+        api_set_setting('vcrontime', time(), 'vchamilo');
+
+        return;
+    }
+    api_set_setting('vcrontickperiod', time() - api_get_setting('vcrontime', 'vchamilo'), 'vchamilo');
+    $hostsperturn = max(1, $VCRON->PERIOD / api_get_setting('vcrontickperiod', 'vchamilo') * count($allvhosts));
+    $i = 0;
+    foreach ($allvhosts as $vhostassoc) {
+        $vhost = (object) $vhostassoc;
+        if ((time() - $vhost->lastcron) > $VCRON->PERIOD) {
+            if ($VCRON->ACTIVATION == 'cli') {
+                exec_vhost_cron($vhost);
+            } else {
+                fire_vhost_cron($vhost);
+            }
+            $i++;
+            if ($i >= $hostsperturn) {
+                return;
+            }
+        }
+    }
+}
diff --git a/plugin/vchamilo/views/editinstance.php b/plugin/vchamilo/views/editinstance.php
new file mode 100644
index 000000000..70d3d21c3
--- /dev/null
+++ b/plugin/vchamilo/views/editinstance.php
@@ -0,0 +1,78 @@
+';
+
+// get parameters
+$id = isset($_REQUEST['vid']) ? $_REQUEST['vid'] : '';
+$action = isset($_REQUEST['what']) ? $_REQUEST['what'] : '';
+$registeronly = isset($_REQUEST['registeronly']) ? $_REQUEST['registeronly'] : 0;
+$plugin = VChamiloPlugin::create();
+$thisurl = api_get_path(WEB_PLUGIN_PATH).'vchamilo/views/manage.php';
+
+if ($id) {
+    $mode = 'update';
+} else {
+    $mode = $registeronly ? 'register' : 'add';
+}
+
+$vhost = (array) Virtual::getInstance($id);
+
+$form = new InstanceForm($plugin, $mode, $vhost);
+
+if ($data = $form->get_data()) {
+    switch ($data->what) {
+        case 'addinstance':
+        case 'registerinstance':
+            Virtual::addInstance($data);
+            echo 'Continue';
+            exit;
+            break;
+        case 'updateinstance':
+            unset($data->what);
+            unset($data->submitbutton);
+            unset($data->registeronly);
+            unset($data->template);
+            $data->lastcron = 0;
+            $data->lastcrongap = 0;
+            $data->croncount = 0;
+            $id = $data->vid;
+            unset($data->vid);
+            unset($data->testconnection);
+            unset($data->testdatapath);
+            unset($data->vid);
+
+            Database::update('vchamilo', (array) $data, ['id = ?' => $id], false);
+            Display::addFlash(Display::return_message(get_lang('Updated')));
+            Virtual::redirect(api_get_path(WEB_PLUGIN_PATH).'vchamilo/views/manage.php');
+            break;
+    }
+}
+
+if ($id) {
+    $vhost['vid'] = $vhost['id'];
+    unset($vhost['id']);
+    $form->set_data($vhost);
+} else {
+    $vhost['db_host'] = 'localhost';
+    $vhost['registeronly'] = $registeronly;
+    $form->set_data($vhost);
+}
+
+$content = $form->return_form();
+
+$interbreadcrumb[] = ['url' => 'manage.php', 'name' => get_lang('VChamilo')];
+
+$tpl = new Template(get_lang('Instance'), true, true, false, true, false);
+$tpl->assign('content', $content);
+$tpl->display_one_col_template();
diff --git a/plugin/vchamilo/views/editinstance_form.php b/plugin/vchamilo/views/editinstance_form.php
new file mode 100644
index 000000000..cdbda36a8
--- /dev/null
+++ b/plugin/vchamilo/views/editinstance_form.php
@@ -0,0 +1,579 @@
+_mode = $mode;
+        $this->_cancelurl = $cancelurl;
+        $this->_customdata = $customdata;
+
+        $attributes = ['style' => 'width: 60%; float: '.($text_dir == 'rtl' ? 'right;' : 'left;')];
+        $this->_form = new FormValidator(
+            $mode.'_instance',
+            'post',
+            $returnurl,
+            '',
+            $attributes
+        );
+    }
+
+    abstract public function definition();
+
+    abstract public function validation($data, $files = null);
+
+    public function validate()
+    {
+        return $this->_form->validate();
+    }
+
+    public function display()
+    {
+        return $this->_form->display();
+    }
+
+    public function definition_after_data()
+    {
+    }
+
+    public function return_form()
+    {
+        return $this->_form->toHtml();
+    }
+
+    public function is_in_add_mode()
+    {
+        return $this->_mode == 'add';
+    }
+
+    /**
+     * Return submitted data if properly submitted or returns NULL if validation fails or
+     * if there is no submitted data.
+     *
+     * @param bool $slashed true means return data with addslashes applied
+     *
+     * @return object submitted data; NULL if not valid or not submitted
+     */
+    public function get_data($slashed = true)
+    {
+        $cform = &$this->_form;
+
+        if ($this->is_submitted() and $this->is_validated()) {
+            $data = $cform->exportValues(null, $slashed);
+            unset($data['sesskey']); // we do not need to return sesskey
+            if (empty($data)) {
+                return null;
+            } else {
+                return (object) $data;
+            }
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Return submitted data without validation or NULL if there is no submitted data.
+     *
+     * @param bool $slashed true means return data with addslashes applied
+     *
+     * @return object submitted data; NULL if not submitted
+     */
+    public function get_submitted_data($slashed = true)
+    {
+        $cform = &$this->_form;
+
+        if ($this->is_submitted()) {
+            $data = $cform->exportValues(null, $slashed);
+            unset($data['sesskey']); // we do not need to return sesskey
+            if (empty($data)) {
+                return null;
+            } else {
+                return (object) $data;
+            }
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Check that form was submitted. Does not check validity of submitted data.
+     *
+     * @return bool true if form properly submitted
+     */
+    public function is_submitted()
+    {
+        return $this->_form->isSubmitted();
+    }
+
+    /**
+     * Return true if a cancel button has been pressed resulting in the form being submitted.
+     *
+     * @return bool true if a cancel button has been pressed
+     */
+    public function is_cancelled()
+    {
+        $cform = &$this->_form;
+        if ($cform->isSubmitted()) {
+            foreach ($cform->_cancelButtons as $cancelbutton) {
+                if (optional_param($cancelbutton, 0, PARAM_RAW)) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Check that form data is valid.
+     * You should almost always use this, rather than {@see validate_defined_fields}.
+     *
+     * @return bool true if form data valid
+     */
+    public function is_validated()
+    {
+        //finalize the form definition before any processing
+        if (!$this->_definition_finalized) {
+            $this->_definition_finalized = true;
+            $this->definition_after_data();
+        }
+
+        return $this->validate_defined_fields();
+    }
+
+    /**
+     * Validate the form.
+     *
+     * You almost always want to call {@see is_validated} instead of this
+     * because it calls {@see definition_after_data} first, before validating the form,
+     * which is what you want in 99% of cases.
+     *
+     * This is provided as a separate function for those special cases where
+     * you want the form validated before definition_after_data is called
+     * for example, to selectively add new elements depending on a no_submit_button press,
+     * but only when the form is valid when the no_submit_button is pressed,
+     *
+     * @param bool $validateonnosubmit optional, defaults to false.  The default behaviour
+     *                                 is NOT to validate the form when a no submit button has been pressed.
+     *                                 pass true here to override this behaviour
+     *
+     * @return bool true if form data valid
+     */
+    public function validate_defined_fields($validateonnosubmit = false)
+    {
+        static $validated = null; // one validation is enough
+        $cform = &$this->_form;
+
+        if ($this->no_submit_button_pressed() && empty($validateonnosubmit)) {
+            return false;
+        } elseif ($validated === null) {
+            $internal_val = $cform->validate();
+
+            $files = [];
+            $file_val = $this->_validate_files($files);
+            if ($file_val !== true) {
+                if (!empty($file_val)) {
+                    foreach ($file_val as $element => $msg) {
+                        $cform->setElementError($element, $msg);
+                    }
+                }
+                $file_val = false;
+            }
+
+            $data = $cform->exportValues(null, true);
+            $chamilo_val = $this->validation($data, $files);
+            if ((is_array($chamilo_val) && count($chamilo_val) !== 0)) {
+                // non-empty array means errors
+                foreach ($chamilo_val as $element => $msg) {
+                    $cform->setElementError($element, $msg);
+                }
+                $chamilo_val = false;
+            } else {
+                // anything else means validation ok
+                $chamilo_val = true;
+            }
+
+            $validated = ($internal_val && $chamilo_val && $file_val);
+        }
+
+        return $validated;
+    }
+
+    public function no_submit_button_pressed()
+    {
+        static $nosubmit = null; // one check is enough
+
+        if (!is_null($nosubmit)) {
+            return $nosubmit;
+        }
+
+        $cform = &$this->_form;
+        $nosubmit = false;
+        if (!$this->is_submitted()) {
+            return false;
+        }
+
+        /*
+        foreach ($cform->_noSubmitButtons as $nosubmitbutton){
+            if (optional_param($nosubmitbutton, 0, PARAM_RAW)){
+                $nosubmit = true;
+                break;
+            }
+        }
+        return $nosubmit;
+        */
+        return false;
+    }
+
+    /**
+     * Load in existing data as form defaults. Usually new entry defaults are stored directly in
+     * form definition (new entry form); this function is used to load in data where values
+     * already exist and data is being edited (edit entry form).
+     *
+     * @param mixed $default_values object or array of default values
+     * @param bool  $slashed        true if magic quotes applied to data values
+     */
+    public function set_data($default_values, $slashed = false)
+    {
+        if (is_object($default_values)) {
+            $default_values = (array) $default_values;
+        }
+        $filter = $slashed ? 'stripslashes' : null;
+        $this->_form->setDefaults($default_values, $filter);
+    }
+
+    /**
+     * Internal method. Validates all uploaded files.
+     */
+    public function _validate_files(&$files)
+    {
+        $files = [];
+
+        if (empty($_FILES)) {
+            // we do not need to do any checks because no files were submitted
+            // note: server side rules do not work for files - use custom verification in validate() instead
+            return true;
+        }
+
+        $errors = [];
+        $mform = &$this->_form;
+
+        // check the files
+        $status = $this->_upload_manager->preprocess_files();
+
+        // now check that we really want each file
+        foreach ($_FILES as $elname => $file) {
+            if ($mform->elementExists($elname) and $mform->getElementType($elname) == 'file') {
+                $required = $mform->isElementRequired($elname);
+                if (!empty($this->_upload_manager->files[$elname]['uploadlog']) &&
+                    empty($this->_upload_manager->files[$elname]['clear'])
+                ) {
+                    if (!$required and $file['error'] == UPLOAD_ERR_NO_FILE) {
+                        // file not uploaded and not required - ignore it
+                        continue;
+                    }
+                    $errors[$elname] = $this->_upload_manager->files[$elname]['uploadlog'];
+                } elseif (!empty($this->_upload_manager->files[$elname]['clear'])) {
+                    $files[$elname] = $this->_upload_manager->files[$elname]['tmp_name'];
+                }
+            } else {
+                error('Incorrect upload attempt!');
+            }
+        }
+
+        // return errors if found
+        if ($status && 0 == count($errors)) {
+            return true;
+        } else {
+            $files = [];
+
+            return $errors;
+        }
+    }
+}
+
+/**
+ * Class InstanceForm.
+ */
+class InstanceForm extends ChamiloForm
+{
+    /** @var Plugin */
+    public $_plugin;
+    public $instance;
+
+    /**
+     * InstanceForm constructor.
+     *
+     * @param $plugin
+     * @param string $mode
+     */
+    public function __construct($plugin, $mode = 'add', $instance = [])
+    {
+        global $_configuration;
+
+        $this->_plugin = $plugin;
+        $returnUrl = $_configuration['root_web'].'plugin/vchamilo/views/editinstance.php';
+        if ($mode == 'update') {
+            $returnUrl = $_configuration['root_web'].'plugin/vchamilo/views/editinstance.php?vid='.intval($_GET['vid']);
+        }
+
+        $cancelurl = $_configuration['root_web'].'plugin/vchamilo/views/manage.php';
+        parent::__construct($mode, $returnUrl, $cancelurl);
+        $this->instance = $instance;
+        $this->definition();
+    }
+
+    public function definition()
+    {
+        global $_configuration;
+
+        $form = $this->_form;
+        $plugin = $this->_plugin;
+
+        $form->addElement('hidden', 'vid');
+        $form->addElement('hidden', 'what', $this->_mode.'instance');
+        $form->addElement('hidden', 'registeronly');
+
+        $form->addHeader($plugin->get_lang('hostdefinition'));
+        $form->addText(
+            'sitename',
+            [
+                $plugin->get_lang('sitename'),
+                $plugin->get_lang('SiteNameExample'),
+            ]
+        );
+        $form->applyFilter('sitename', 'trim');
+        $form->addText(
+            'institution',
+            [
+                $plugin->get_lang('institution'),
+                $plugin->get_lang('InstitutionExample'),
+            ]
+        );
+        $form->applyFilter('institution', 'trim');
+
+        // Host's name.
+        $elementWeb = $form->addElement(
+            'text',
+            'root_web',
+            [$this->_plugin->get_lang('rootweb'), $plugin->get_lang('RootWebExample')]
+        );
+        $form->applyFilter('root_web', 'trim');
+
+        $form->addElement(
+            'text',
+            'url_append',
+            ['url_append', $plugin->get_lang('UrlAppendExample')]
+        );
+
+        if ($this->_mode == 'update') {
+            $encryptList = Virtual::getEncryptList();
+            $encryptMethod = $form->addElement(
+                'select',
+                'password_encryption',
+                get_lang('EncryptMethodUserPass'),
+                $encryptList
+            );
+            $encryptMethod->freeze();
+            $elementWeb->freeze();
+        }
+
+        /*
+         * Database fieldset.
+         */
+        $form->addElement('header', $plugin->get_lang('dbgroup'));
+
+        // Database host.
+        $form->addElement(
+            'text',
+            'db_host',
+            $this->_plugin->get_lang('dbhost'),
+            ['id' => 'id_vdbhost']
+        );
+        $form->applyFilter('db_host', 'trim');
+
+        // Database login.
+        $form->addElement(
+            'text',
+            'db_user',
+            $this->_plugin->get_lang('dbuser'),
+            ['id' => 'id_vdbuser']
+        );
+        $form->applyFilter('db_user', 'trim');
+
+        // Database password.
+        $form->addElement(
+            'password',
+            'db_password',
+            $this->_plugin->get_lang('dbpassword'),
+            ['id' => 'id_vdbpassword']
+        );
+
+        // Database name.
+        $form->addText(
+            'main_database',
+            [
+                $plugin->get_lang('maindatabase'),
+                $plugin->get_lang('DatabaseDescription'),
+            ]
+        );
+
+        // Button for testing database connection.
+        $form->addElement(
+            'button',
+            'testconnection',
+            $this->_plugin->get_lang('testconnection'),
+            'check',
+            'default',
+            'default',
+            '',
+            'onclick="opencnxpopup(\''.$_configuration['root_web'].'\'); return false;"'
+        );
+
+        $form->addText('archive_url', $this->_plugin->get_lang('ArchiveUrl'));
+        $form->addText('home_url', $this->_plugin->get_lang('HomeUrl'));
+        $form->addText('upload_url', $this->_plugin->get_lang('UploadUrl'));
+        $form->addText(
+            'css_theme_folder',
+            [
+                $this->_plugin->get_lang('ThemeFolder'),
+                $this->_plugin->get_lang('ThemeFolderExplanation'),
+            ],
+            false
+        );
+        //$form->addText('course_url', $this->_plugin->get_lang('CourseUrl'));
+
+        /**
+         * Template selection.
+         */
+        if ($this->is_in_add_mode()) {
+            $form->addElement('header', $this->_plugin->get_lang('templating'));
+
+            $templateoptions = Virtual::getAvailableTemplates();
+
+            // Template choice
+            $form->addSelect(
+                'template',
+                $this->_plugin->get_lang('template'),
+                $templateoptions
+            );
+        } else {
+            if ($this->instance) {
+                $form->addLabel(
+                    'slug',
+                    $this->instance['slug']
+                );
+
+                $form->addLabel(
+                    'archive_real_root',
+                    api_add_trailing_slash(Virtual::getConfig('vchamilo', 'archive_real_root')).
+                    $this->instance['slug']
+                );
+
+                $form->addLabel(
+                    'course_real_root',
+                    api_add_trailing_slash(Virtual::getConfig('vchamilo', 'course_real_root')).
+                        $this->instance['slug']
+                );
+
+                $form->addLabel(
+                    'home_real_root',
+                    api_add_trailing_slash(Virtual::getConfig('vchamilo', 'home_real_root')).$this->instance['slug']
+                );
+
+                $form->addLabel(
+                    'upload_real_root',
+                    api_add_trailing_slash(Virtual::getConfig('vchamilo', 'upload_real_root')).$this->instance['slug']
+                );
+
+                $form->addLabel(
+                    $this->_plugin->get_lang('template'),
+                    $this->instance['template']
+                );
+            }
+        }
+
+        $form->addButtonSave(
+            $this->_plugin->get_lang('savechanges'),
+            'submitbutton'
+        );
+
+        // Rules
+        $form->addRule(
+            'sitename',
+            $this->_plugin->get_lang('sitenameinputerror'),
+            'required',
+            null,
+            'client'
+        );
+        $form->addRule(
+            'institution',
+            $this->_plugin->get_lang('institutioninputerror'),
+            'required',
+            null,
+            'client'
+        );
+
+        $form->addRule(
+            'root_web',
+            $this->_plugin->get_lang('rootwebinputerror'),
+            'required',
+            null,
+            'client'
+        );
+        $form->addRule(
+            'main_database',
+            $this->_plugin->get_lang('databaseinputerror'),
+            'required',
+            null,
+            'client'
+        );
+    }
+
+    /**
+     * @param array $data
+     * @param null  $files
+     *
+     * @return array
+     */
+    public function validation($data, $files = null)
+    {
+        global $plugin;
+
+        $errors = [];
+        $tablename = Database::get_main_table('vchamilo');
+        $vchamilo = Database::select(
+            '*',
+            $tablename,
+            ['where' => [' root_web = ? ' => [$data['root_web']]]],
+            'first'
+        );
+
+        if ($vchamilo && isset($data['vid']) && $data['vid'] != $vchamilo['id']) {
+            $errors['root_web'] = $plugin->get_lang('RootWebExists');
+        }
+
+        if (!empty($errors)) {
+            return $errors;
+        }
+    }
+}
diff --git a/plugin/vchamilo/views/import.php b/plugin/vchamilo/views/import.php
new file mode 100644
index 000000000..91143dd72
--- /dev/null
+++ b/plugin/vchamilo/views/import.php
@@ -0,0 +1,196 @@
+ 'manage.php', 'name' => get_lang('VChamilo')];
+
+// Security
+api_protect_admin_script();
+
+Virtual::checkSettings();
+
+$plugin = VChamiloPlugin::create();
+$form = new FormValidator('import', 'post', api_get_self());
+
+// Database host.
+$form->addHeader(get_lang('From'));
+
+$form->addText('root_web', [$plugin->get_lang('rootweb'), 'Example: http://www.chamilo.org/']);
+$form->addText('db_host', $plugin->get_lang('dbhost'));
+$form->applyFilter('db_host', 'trim');
+
+// Database login.
+$form->addText('db_user', $plugin->get_lang('dbuser'));
+$form->applyFilter('db_user', 'trim');
+
+// Database password.
+$form->addElement(
+    'password',
+    'db_password',
+    $plugin->get_lang('dbpassword'),
+    ['id' => 'id_vdbpassword']
+);
+
+// Database name.
+$form->addText('main_database', [$plugin->get_lang('maindatabase')]);
+
+$form->addText(
+    'configuration_file',
+    [
+        $plugin->get_lang('ConfigurationPath'),
+        get_lang('Example').': /var/www/site/app/config/configuration.php',
+    ],
+    true
+);
+
+$encryptList = Virtual::getEncryptList();
+
+$form->addSelect(
+    'password_encryption',
+    get_lang('EncryptMethodUserPass'),
+    $encryptList
+);
+
+$encryptList = Virtual::getEncryptList();
+
+$versionList = [
+    '1.11.x',
+    '1.10.x',
+    '1.9.x',
+];
+
+$form->addSelect(
+    'version',
+    $plugin->get_lang('FromVersion'),
+    array_combine($versionList, $versionList)
+);
+
+$form->addText(
+    'course_path',
+    [
+        $plugin->get_lang('CoursePath'),
+        get_lang('Example').': /var/www/site/virtual/var/courses',
+    ],
+    true
+);
+
+$form->addText(
+    'home_path',
+    [
+        $plugin->get_lang('HomePath'),
+        get_lang('Example').': /var/www/site/virtual/var/home',
+    ],
+    true
+);
+
+$form->addText(
+    'upload_path',
+    [
+        $plugin->get_lang('UploadPath'),
+        get_lang('Example').': /var/www/site/virtual/var/upload',
+    ],
+    true
+);
+
+$form->addHeader(get_lang('To'));
+
+$form->addText('to_db_host', $plugin->get_lang('dbhost'));
+$form->applyFilter('to_db_host', 'trim');
+
+// Database login.
+$form->addText('to_db_user', $plugin->get_lang('dbuser'));
+$form->applyFilter('to_db_user', 'trim');
+
+// Database password.
+$form->addElement(
+    'password',
+    'to_db_password',
+    $plugin->get_lang('dbpassword'),
+    ['id' => 'id_vdbpassword']
+);
+
+// Database name.
+$form->addText(
+    'to_main_database',
+    [
+        $plugin->get_lang('maindatabase'),
+        $plugin->get_lang('DatabaseDescription'),
+    ]
+);
+
+$form->addButtonSave($plugin->get_lang('savechanges'), 'submitbutton');
+$content = $form->returnForm();
+
+if ($form->validate()) {
+    $values = $form->getSubmitValues();
+
+    $coursePath = $values['course_path'];
+    $homePath = $values['home_path'];
+    $confFile = $values['configuration_file'];
+    $uploadPath = $values['upload_path'];
+
+    $isPharFile = str_starts_with(strtolower($confFile), 'phar://')
+        || str_starts_with(strtolower($coursePath), 'phar://')
+        || str_starts_with(strtolower($homePath), 'phar://')
+        || str_starts_with(strtolower($uploadPath), 'phar://');
+
+    if ($isPharFile) {
+        Display::addFlash(
+            Display::return_message(
+                $plugin->get_lang('NotAllowed'),
+                'error'
+            )
+        );
+    } else {
+        $isWritable = is_dir($coursePath)
+            && is_dir($homePath)
+            && is_dir($uploadPath)
+            && file_exists($confFile)
+            && is_readable($confFile);
+
+        if ($isWritable) {
+            $currentHost = api_get_configuration_value('db_host');
+            $currentDatabase = api_get_configuration_value('main_database');
+            $currentUser = api_get_configuration_value('db_user');
+            $currentPassword = api_get_configuration_value('db_password');
+
+            if ($values['to_main_database'] !== $currentDatabase &&
+                $values['to_db_user'] !== $currentUser &&
+                $values['to_db_password'] !== $currentPassword
+            ) {
+            } else {
+                Display::addFlash(
+                    Display::return_message(
+                        $plugin->get_lang('DatabaseAccessShouldBeDifferentThanMasterChamilo'),
+                        'warning'
+                    )
+                );
+            }
+
+            $vchamilo = new stdClass();
+            $vchamilo->main_database = $values['main_database'];
+            $vchamilo->db_user = $values['db_user'];
+            $vchamilo->db_password = $values['db_password'];
+            $vchamilo->db_host = $values['db_host'];
+            $vchamilo->root_web = $values['root_web'];
+            $vchamilo->import_to_main_database = $values['to_main_database'];
+            $vchamilo->import_to_db_user = $values['to_db_user'];
+            $vchamilo->import_to_db_password = $values['to_db_password'];
+            $vchamilo->import_to_db_host = $values['to_db_host'];
+            $vchamilo->course_path = $values['course_path'];
+            $vchamilo->home_path = $values['home_path'];
+            $vchamilo->upload_path = $values['upload_path'];
+            $vchamilo->password_encryption = $values['password_encryption'];
+
+            Virtual::importInstance($vchamilo, $values['version']);
+
+            Virtual::redirect(api_get_path(WEB_PLUGIN_PATH).'vchamilo/views/manage.php');
+        }
+    }
+}
+
+$tpl = new Template(get_lang('Import'), true, true, false, true, false);
+$tpl->assign('content', $content);
+$tpl->display_one_col_template();
diff --git a/plugin/vchamilo/views/manage.controller.php b/plugin/vchamilo/views/manage.controller.php
new file mode 100644
index 000000000..00052587a
--- /dev/null
+++ b/plugin/vchamilo/views/manage.controller.php
@@ -0,0 +1,373 @@
+ ["id IN ('$vidlist')" => []]]);
+            }
+        } else {
+            $todelete = Database::select(
+                '*',
+                'vchamilo',
+                ['where' => ["root_web = '{$n->root_web}' " => []]]
+            );
+        }
+
+        if ($todelete) {
+            foreach ($todelete as $fooid => $instance) {
+                $slug = $instance['slug'];
+
+                if (!empty($slug)) {
+                    // Remove all files and eventual symlinks
+                    $absalternatecourse = Virtual::getConfig('vchamilo', 'course_real_root');
+                    $coursedir = $absalternatecourse.$slug;
+
+                    Display::addFlash(Display::return_message("Deleting $coursedir"));
+
+                    removeDir($coursedir);
+
+                    if ($absalternatehome = Virtual::getConfig('vchamilo', 'home_real_root')) {
+                        $homedir = $absalternatehome.'/'.$slug;
+
+                        Display::addFlash(Display::return_message("Deleting $homedir"));
+                        removeDir($homedir);
+                    }
+
+                    // delete archive
+                    if ($absalternatearchive = Virtual::getConfig('vchamilo', 'archive_real_root')) {
+                        $archivedir = $absalternatearchive.'/'.$slug;
+
+                        Display::addFlash(Display::return_message("Deleting $archivedir"));
+                        removeDir($archivedir);
+                    }
+
+                    // Delete upload
+                    if ($dir = Virtual::getConfig('vchamilo', 'upload_real_root')) {
+                        $dir = $dir.'/'.$slug;
+
+                        Display::addFlash(Display::return_message("Deleting $dir"));
+                        removeDir($dir);
+                    }
+                }
+
+                $sql = "DELETE FROM {$table} WHERE id = ".$instance['id'];
+                Database::query($sql);
+
+                Display::addFlash(Display::return_message("Removing instance: ".$instance['root_web']));
+
+                Virtual::dropDatabase((object) $instance);
+            }
+        }
+        break;
+    case 'snapshotinstance':
+        $interbreadcrumb[] = ['url' => 'manage.php', 'name' => get_lang('VChamilo')];
+
+        $vid = isset($_REQUEST['vid']) ? $_REQUEST['vid'] : '';
+        if ($vid) {
+            $vhosts = Database::select('*', 'vchamilo', ['where' => ['id = ?' => $vid]]);
+            $vhost = (object) array_pop($vhosts);
+        } else {
+            $vhost = (object) $_configuration;
+            $vhost->slug = Virtual::getSlugFromUrl($vhost->root_web);
+            $vhost->id = 0;
+        }
+
+        // Parsing url for building the template name.
+        $wwwroot = $vhost->root_web;
+        $vchamilostep = isset($_REQUEST['step']) ? $_REQUEST['step'] : '';
+
+        // Make template directory (files and SQL).
+        $separator = DIRECTORY_SEPARATOR;
+        $dirMode = api_get_permissions_for_new_directories();
+
+        $backupDir = api_get_path(SYS_PATH).'plugin'.$separator.'vchamilo'.$separator.'templates'.$separator.$vhost->slug.$separator;
+
+        $absolute_datadir = $backupDir.'data';
+        $absolute_sqldir = $backupDir.'dump.sql';
+
+        if (!is_dir($backupDir)) {
+            $result = mkdir($backupDir, $dirMode, true);
+            if ($result) {
+                Display::addFlash(
+                    Display::return_message('Directory created: '.$backupDir)
+                );
+            } else {
+                Display::addFlash(
+                    Display::return_message("Cannot create directory: $backupDir check the folder permissions", 'error')
+                );
+            }
+        }
+
+        if ($vchamilostep == 0) {
+            // Create directories, if necessary.
+            if (!is_dir($absolute_datadir)) {
+                mkdir($absolute_datadir, $dirMode, true);
+                mkdir($absolute_datadir.'/home', $dirMode, true);
+            }
+
+            if (empty($fullautomation)) {
+                $actionurl = $_configuration['root_web'].'/plugin/vchamilo/views/manage.php';
+                $content = '';
+                $content .= '';
+                $content .= '';
+                $content .= '';
+                $content .= '';
+                $content .= '';
+                $content .= '';
+
+                $tpl = new Template(get_lang('Snapshot'), true, true, false, true, false);
+                $tpl->assign('message', '
    '.$plugin->get_lang('vchamilosnapshot1').'
    ');
+                $tpl->assign('content', $content);
+                $tpl->display_one_col_template();
+
+                exit;
+            } else {
+                // continue next step
+                $vchamilostep = 1;
+            }
+        }
+
+        if ($vchamilostep >= 1) {
+            if ($wwwroot == $_configuration['root_web']) {
+                // Make fake Vchamilo record.
+                $vchamilo = Virtual::makeThis();
+                $coursePath = api_get_path(SYS_COURSE_PATH);
+                $homePath = api_get_path(SYS_HOME_PATH);
+                $archivePath = api_get_path(SYS_ARCHIVE_PATH);
+                $uploadPath = api_get_path(SYS_UPLOAD_PATH);
+            } else {
+                // Get Vchamilo known record.
+                $vchamilo = Database::select('*', 'vchamilo', ['where' => ['root_web = ?' => [$wwwroot]]], 'first');
+                $vchamilo = (object) $vchamilo;
+                $coursePath = Virtual::getConfig('vchamilo', 'course_real_root');
+                $homePath = Virtual::getConfig('vchamilo', 'home_real_root');
+                $archivePath = Virtual::getConfig('vchamilo', 'archive_real_root');
+                $uploadPath = Virtual::getConfig('vchamilo', 'upload_real_root');
+
+                $coursePath = $coursePath.'/'.$vchamilo->slug;
+                $homePath = $homePath.'/'.$vchamilo->slug;
+                $archivePath = $archivePath.'/'.$vchamilo->slug;
+                $uploadPath = $uploadPath.'/'.$vchamilo->slug;
+            }
+
+            $content = '';
+            if ($vchamilostep == 1) {
+                // Auto dump the databases in a master template folder.
+                // this will create three files : dump.sql
+                $result = Virtual::backupDatabase($vchamilo, $absolute_sqldir);
+
+                if (empty($fullautomation)) {
+                    if (!$result) {
+                        $actionurl = $_configuration['root_web'].'/plugin/vchamilo/views/manage.php';
+                        $content .= '
    ';
+                        $content .= '';
+                        $content .= '
    ';
+                    } else {
+                        $actionurl = $_configuration['root_web'].'/plugin/vchamilo/views/manage.php';
+
+                        $message = $plugin->get_lang('vchamilosnapshot2');
+
+                        Display::addFlash(
+                            Display::return_message('Database file created: '.$absolute_sqldir)
+                        );
+
+                        $content .= '
    ';
+                        $content .= '';
+                        $content .= '';
+                        $content .= '';
+                        $content .= '';
+                        $content .= '
    ';
+                    }
+
+                    $tpl = new Template(get_lang('Snapshot'), true, true, false, true, false);
+                    $tpl->assign('message', '
    '.$message.'
    ');
+                    $tpl->assign('content', $content);
+                    $tpl->display_one_col_template();
+
+                    exit;
+                }
+            }
+
+            Display::addFlash(Display::return_message("Copying from '$homePath' to '{$absolute_datadir}/home' "));
+            copyDirTo($homePath, $absolute_datadir.'/home/', false);
+
+            Display::addFlash(Display::return_message("Copying from '$coursePath' to '$absolute_datadir/courses' "));
+            copyDirTo($coursePath, $absolute_datadir.'/courses/', false);
+
+            Display::addFlash(Display::return_message("Copying from '$uploadPath' to '$absolute_datadir/upload' "));
+            copyDirTo($uploadPath, $absolute_datadir.'/upload/', false);
+
+            // Store original hostname and some config info for further database or filestore replacements.
+            $FILE = fopen($backupDir.$separator.'manifest.php', 'w');
+            fwrite($FILE, '<'.'?php ');
+            fwrite($FILE, "\$templatewwwroot = '".$wwwroot."';\n");
+            fwrite($FILE, '?'.'>');
+            fclose($FILE);
+
+            // Every step was SUCCESS.
+            if (empty($fullautomation)) {
+                Display::addFlash(
+                    Display::return_message(
+                        $plugin->get_lang('successfinishedcapture'),
+                        'success'
+                    )
+                );
+
+                if (empty($vid)) {
+                    $template = Virtual::getConfig('vchamilo', 'default_template');
+                    if (empty($template)) {
+                        Display::addFlash(
+                            Display::return_message('Set default template as '.$vhost->slug.'', 'success', false)
+                        );
+                        $params = [
+                            'subkey' => 'vchamilo',
+                            'title' => 'default_template',
+                            'type' => 'setting',
+                            'category' => 'Plugins',
+                            'variable' => 'vchamilo_default_template',
+                            'selected_value' => $vhost->slug,
+                            'access_url_changeable' => 0,
+                        ];
+                        api_set_setting_simple($params);
+                    } else {
+                        Display::addFlash(
+                            Display::return_message('Default template is: '.$vhost->slug.'', 'success', false)
+                        );
+                    }
+                }
+
+                $actionurl = $_configuration['root_web'].'/plugin/vchamilo/views/manage.php';
+                $content .= '
    ';
+                $content .= '';
+                $content .= '
    ';
+
+                $tpl = new Template(get_lang('Snapshot'), true, true, false, true, false);
+                $tpl->assign('message', $plugin->get_lang('vchamilosnapshot3'));
+                $tpl->assign('content', $content);
+                $tpl->display_one_col_template();
+
+                exit;
+            }
+        }
+        break;
+    case 'clearcache':
+        // Removes cache directory.
+        if (empty($automation)) {
+            if (array_key_exists('vids', $_REQUEST)) {
+                $toclear = Database::select('*', 'vchamilo', ['where' => ["id IN ('$vidlist')" => []]]);
+            } else {
+                $vid = isset($_REQUEST['vid']) ? $_REQUEST['vid'] : 0;
+                if ($vid) {
+                    $vhosts = Database::select('*', 'vchamilo', ['where' => ['id = ?' => $vid]]);
+                    $vhost = (object) array_pop($vhosts);
+                    $toclear[$vhost->id] = $vhost;
+                } else {
+                    $toclear[0] = (object) $_configuration;
+                }
+            }
+        } else {
+            $toclear = Database::select(
+                '*',
+                'vchamilo',
+                ['where' => ["root_web = '{$n->root_web}' " => []]]
+            );
+        }
+
+        foreach ($toclear as $fooid => $instance) {
+            if ($fooid == 0) {
+                $templatepath = api_get_path(SYS_ARCHIVE_PATH).'twig';
+                Display::addFlash(Display::return_message("Deleting master cache $templatepath \n"));
+                removeDir($templatepath);
+            } else {
+                $coursePath = Virtual::getConfig('vchamilo', 'course_real_root');
+                $homePath = Virtual::getConfig('vchamilo', 'home_real_root');
+                $archivePath = Virtual::getConfig('vchamilo', 'archive_real_root');
+                //$uploadPath = Virtual::getConfig('vchamilo', 'upload_real_root');
+
+                // Get instance archive
+                $archivepath = api_get_path(SYS_ARCHIVE_PATH, (array) $instance);
+                $templatepath = $archivePath.'/'.$instance['slug'].'/twig';
+                Display::addFlash(Display::return_message("Deleting cache $templatepath \n"));
+                removeDir($templatepath);
+            }
+        }
+        break;
+    case 'setconfigvalue':
+        $select = '';
+
+        if (empty($vidlist)) {
+            api_not_allowed(true, 'No virtual chamilo selected');
+        }
+
+        Display::display_header();
+        echo '
    '.$plugin->get_lang('sendconfigvalue').'
    ';
+        echo '
    ';
+        echo '';
+        echo '';
+        echo '';
+        echo '';
+        echo '';
+        echo '';
+        echo '';
+        echo '';
+        echo '
    '.get_lang('variable').''.get_lang('subkey').'
    '.$select.'
    ';
+        echo '
    ';
+        echo '
    ';
+        Display::display_footer();
+        exit;
+        break;
+}
diff --git a/plugin/vchamilo/views/manage.php b/plugin/vchamilo/views/manage.php
new file mode 100644
index 000000000..07706e805
--- /dev/null
+++ b/plugin/vchamilo/views/manage.php
@@ -0,0 +1,157 @@
+id] = $instance;
+}
+
+$templates = Virtual::getAvailableTemplates();
+
+if (empty($templates)) {
+    $url = api_get_path(WEB_PLUGIN_PATH).'vchamilo/views/manage.php?what=snapshotinstance';
+    $url = Display::url($url, $url);
+    Display::addFlash(
+        Display::return_message('You need to create a snapshot of master first here:'.$url, 'info', false)
+    );
+}
+
+$table = new HTML_Table(['class' => 'table table-hover table-striped data_table']);
+$column = 0;
+$row = 0;
+
+// $table->set_additional_parameters($parameters);
+$headers = [
+    '',
+    $plugin->get_lang('sitename'),
+    $plugin->get_lang('dbhost').' - '.get_lang('Database'),
+    $plugin->get_lang('coursefolder'),
+    $plugin->get_lang('enabled'),
+    $plugin->get_lang('lastcron'),
+    '',
+];
+$attrs = ['center' => 'left'];
+$table->addRow($headers, $attrs, 'th');
+
+$i = 0;
+foreach ($instances as $instance) {
+    $checkbox = '';
+    $sitelink = $instance->sitename;
+
+    if ($instance->visible) {
+        $status = '
+                  '.Display::returnFontAwesomeIcon('toggle-on', 2).'';
+    } else {
+        $status = '
+                  '.Display::returnFontAwesomeIcon('toggle-off', 2).'';
+    }
+
+    $cmd = ' 
+            '.Display::returnFontAwesomeIcon('pencil', 2).'';
+    $cmd .= ' 
+        '.Display::returnFontAwesomeIcon('camera', 2).'';
+
+    $cmd .= '
+          '.Display::returnFontAwesomeIcon('wrench', 2).' ';
+
+    if (!$instance->visible) {
+        $cmd .= '
+         '.Display::returnFontAwesomeIcon('remove', 2).' ';
+    } else {
+        $cmd .= '
+          '.Display::returnFontAwesomeIcon('remove', 2).' ';
+    }
+
+    $crondate = $instance->lastcron ? date('r', $instance->lastcron) : '';
+    $data = [
+        $checkbox,
+        $sitelink.' '.$instance->institution.' ('.Display::url($instance->root_web, $instance->root_web, ['target' => '_blank']).')',
+        $instance->db_host.' - '.$instance->main_database,
+        $instance->slug,
+        $status,
+        $crondate,
+        $cmd,
+    ];
+    $attrs = ['center' => 'left'];
+    $table->addRow($data, $attrs, 'td');
+    $i++;
+}
+
+$items = [
+    [
+        'url' => $thisurl.'?what=newinstance',
+        'content' => $plugin->get_lang('newinstance'),
+    ],
+    [
+        'url' => $thisurl.'?what=import',
+        'content' => $plugin->get_lang('ImportInstance'),
+    ],
+    [
+        'url' => $thisurl.'?what=snapshotinstance&vid=0',
+        'content' => $plugin->get_lang('snapshotmaster'),
+    ],
+    [
+        'url' => $thisurl.'?what=clearcache&vid=0',
+        'content' => $plugin->get_lang('clearmastercache'),
+    ],
+    [
+        'url' => api_get_path(WEB_PLUGIN_PATH).'vchamilo/views/syncparams.php',
+        'content' => $plugin->get_lang('sync_settings'),
+    ],
+    [
+        'url' => api_get_path(WEB_CODE_PATH).'admin/configure_plugin.php?name=vchamilo',
+        'content' => get_lang('Settings'),
+    ],
+];
+
+$content = Display::page_header('VChamilo Instances');
+
+$content .= Display::actions($items);
+$content .= '
    ';
+$content .= $table->toHtml();
+
+$selectionoptions = [''];
+$selectionoptions[] = '';
+$selectionoptions[] = '';
+$selectionoptions[] = '';
+$selectionoptions[] = '';
+$selectionoptions[] = '';
+$selectionaction = '';
+
+$content .= '
    
+'.$plugin->get_lang('selectall').' -
+'.$plugin->get_lang('selectnone').' -
+  - '.$plugin->get_lang('withselection').' '.$selectionaction.'
    ';
+
+$content .= '
    ';
+
+if (empty($templates)) {
+    $content = '';
+}
+
+$tpl = new Template(get_lang('VChamilo'), true, true, false, true, false);
+$tpl->assign('content', $content);
+$tpl->display_one_col_template();
diff --git a/plugin/vchamilo/views/manage.testcnx.php b/plugin/vchamilo/views/manage.testcnx.php
new file mode 100644
index 000000000..489d61fbe
--- /dev/null
+++ b/plugin/vchamilo/views/manage.testcnx.php
@@ -0,0 +1,55 @@
+ 'pdo_mysql',
+    'host' => $_REQUEST['vdbhost'],
+    'user' => $_REQUEST['vdblogin'],
+    'password' => $_REQUEST['vdbpass'],
+    //'dbname' => isset($_configuration['main_database']) ? $_configuration['main_database'] : '',
+    // Only relevant for pdo_sqlite, specifies the path to the SQLite database.
+    //'path' => isset($_configuration['db_path']) ? $_configuration['db_path'] : '',
+    // Only relevant for pdo_mysql, pdo_pgsql, and pdo_oci/oci8,
+    //'port' => isset($_configuration['db_port']) ? $_configuration['db_port'] : '',
+];
+
+try {
+    $database = new \Database();
+    $connection = $database->connect(
+        $dbParams,
+        $_configuration['root_sys'],
+        $_configuration['root_sys'],
+        true
+    );
+
+    $list = $connection->getSchemaManager()->listDatabases();
+    echo $plugin->get_lang('connectionok');
+} catch (Exception $e) {
+    echo $plugin->get_lang('badconnection');
+    exit();
+}
diff --git a/plugin/vchamilo/views/manage.testdatapath.php b/plugin/vchamilo/views/manage.testdatapath.php
new file mode 100644
index 000000000..29e403f2e
--- /dev/null
+++ b/plugin/vchamilo/views/manage.testdatapath.php
@@ -0,0 +1,3 @@
+ $settingId]);
+
+            $params = [
+                'title' => $setting['title'],
+                'variable' => $setting['variable'],
+                'subkey' => $setting['subkey'],
+                'category' => $setting['category'],
+                'access_url' => $setting['access_url'],
+            ];
+
+            foreach ($vchamilos as $chm) {
+                $table = $chm['main_database'].".settings_current ";
+                $sql = " SELECT * FROM $table
+                     WHERE
+                        variable = '{{$setting['variable']}}' AND
+                        access_url = '{$setting['access_url']}'
+                    ";
+                $result = Database::query($sql);
+
+                if (Database::num_rows($result)) {
+                    Database::update($table, ['selected_Value' => $value, ['id' => $settingId]]);
+                }
+            }
+        }
+        break;
+    case 'syncthis':
+        $settingId = isset($_GET['settingid']) ? (int) $_GET['settingid'] : 0;
+
+        if ($settingId) {
+            $deleteIfEmpty = $_REQUEST['del'] ?? '';
+            $value = $_REQUEST['value'];
+            // Getting the local setting record.
+            $setting = api_get_settings_params_simple(['id = ?' => $settingId]);
+            if (empty($setting)) {
+                return 0;
+            }
+
+            $params = [
+                'access_url_changeable' => $setting['access_url_changeable'],
+                'title' => $setting['title'],
+                'variable' => $setting['variable'],
+                'subkey' => $setting['subkey'],
+                'category' => $setting['category'],
+                'type' => $setting['type'],
+                'comment' => $setting['comment'],
+                'access_url' => $setting['access_url'],
+            ];
+
+            $errors = '';
+            foreach ($vchamilos as $instance) {
+                $table = 'settings_current';
+                $config = new Configuration();
+                $connectionParams = [
+                    'dbname' => $instance['main_database'],
+                    'user' => $instance['db_user'],
+                    'password' => $instance['db_password'],
+                    'host' => $instance['db_host'],
+                    'driver' => 'pdo_mysql',
+                ];
+                try {
+                    $connection = DriverManager::getConnection($connectionParams, $config);
+
+                    $variable = $setting['variable'];
+                    $subKey = $setting['subkey'];
+                    $category = $setting['category'];
+                    $accessUrl = $setting['access_url'];
+
+                    if ($deleteIfEmpty && empty($value)) {
+                        $connection->delete($table, ['selected_value' => $value, 'variable' => $variable, 'access_url' => $accessUrl]);
+                        $case = 'delete';
+                    } else {
+                        $sql = "SELECT * FROM $table
+                                WHERE
+                                    variable = '$variable' AND
+                                    access_url = '$accessUrl'
+                                ";
+                        $result = $connection->fetchAllAssociative($sql);
+
+                        if (!empty($result)) {
+                            //$sql = "UPDATE $table SET selected_value = '$value' WHERE id = $settingId";
+                            $criteria = ['variable' => $variable];
+                            if (!empty($subKey)) {
+                                $criteria['subkey'] = $subKey;
+                            }
+                            if (!empty($category)) {
+                                $criteria['category'] = $category;
+                            }
+                            $connection->update($table, ['selected_value' => $value], $criteria);
+                        } else {
+                            $connection->insert($table, $params);
+                        }
+                    }
+                } catch (Exception $e) {
+                    echo $e->getMessage();
+                }
+            }
+
+            return $errors;
+        } else {
+            return "Bad ID. Non numeric";
+        }
+        break;
+}
+
+return 0;
diff --git a/plugin/vchamilo/views/syncparams.php b/plugin/vchamilo/views/syncparams.php
new file mode 100644
index 000000000..eb0ef9768
--- /dev/null
+++ b/plugin/vchamilo/views/syncparams.php
@@ -0,0 +1,83 @@
+ 'table']);
+$column = 0;
+$row = 0;
+$headers = [
+    '',
+    $plugin->get_lang('variable').' ['.$plugin->get_lang('subkey').']',
+    $plugin->get_lang('category'),
+    $plugin->get_lang('accessurl'),
+    $plugin->get_lang('value'),
+    '',
+];
+$attrs = ['center' => 'left'];
+$table->addRow($headers, $attrs, 'th');
+
+foreach ($settings as $param) {
+    if ($param['subkey'] == 'vchamilo') {
+        continue;
+    }
+    $check = '';
+    $attrs = ['center' => 'left'];
+    $syncButton = '
+        
+        ';
+    $data = [
+        $check,
+        isset($param['subkey']) && !empty($param['subkey']) ? $param['variable'].' ['.$param['subkey'].']' : $param['variable'],
+        $param['category'],
+        $param['access_url'],
+        ''.
+        '
    Master value: '.$param['selected_value'],
+        $syncButton,
+    ];
+    $row = $table->addRow($data, $attrs, 'td');
+    $table->setRowAttributes($row, ['id' => 'row_'.$param['id']], true);
+}
+
+$content = '
    ';
+$content .= '';
+$content .= $table->toHtml();
+$content .= '
    ';
+
+Display::addFlash(Display::return_message($plugin->get_lang('Sync your master settings to all instances.')));
+
+$interbreadcrumb[] = ['url' => 'manage.php', 'name' => get_lang('VChamilo')];
+$htmlHeadXtra[] = "";
+
+$tpl = new Template($plugin->get_lang('SyncSettings'), true, true, false, true, false);
+$tpl->assign('content', $content);
+$tpl->display_one_col_template();
diff --git a/plugin/vchamilo/views/upgrade.php b/plugin/vchamilo/views/upgrade.php
new file mode 100644
index 000000000..eac7c3121
--- /dev/null
+++ b/plugin/vchamilo/views/upgrade.php
@@ -0,0 +1,65 @@
+ 'manage.php', 'name' => get_lang('VChamilo')];
+
+// Security
+api_protect_admin_script();
+Virtual::checkSettings();
+
+$plugin = VChamiloPlugin::create();
+
+$id = isset($_REQUEST['vid']) ? (int) $_REQUEST['vid'] : 0;
+
+$instance = Virtual::getInstance($id);
+$canBeUpgraded = Virtual::canBeUpgraded($instance);
+
+$form = new FormValidator('upgrade', 'post', api_get_self().'?vid='.$id);
+// Database host.
+$form->addHeader(get_lang('Upgrade'));
+
+$form->addText('root_web', $plugin->get_lang('rootweb'));
+$form->addText('db_host', $plugin->get_lang('dbhost'));
+$form->addText('db_user', $plugin->get_lang('dbuser'));
+$form->addText('main_database', [$plugin->get_lang('maindatabase')]);
+
+$form->setDefaults((array) $instance);
+if ($canBeUpgraded) {
+    $form->addLabel(get_lang('From'), $canBeUpgraded);
+    $form->addLabel(get_lang('To'), api_get_setting('chamilo_database_version'));
+    $form->addButtonSave(get_lang('Upgrade'));
+} else {
+    Display::addFlash(Display::return_message(get_lang('NothingToUpgrade')));
+}
+
+$form->freeze();
+$content = $form->returnForm();
+
+if ($form->validate() && $canBeUpgraded) {
+    $values = $form->getSubmitValues();
+
+    require_once api_get_path(SYS_CODE_PATH).'install/install.lib.php';
+
+    $manager = Virtual::getConnectionFromInstance($instance, true);
+    if ($manager) {
+        ob_start();
+        $result = migrateSwitch($canBeUpgraded, $manager, false);
+        $data = ob_get_clean();
+        if ($result) {
+            Display::addFlash(Display::return_message(get_lang('Upgraded')));
+        } else {
+            Display::addFlash(Display::return_message(get_lang('Error')));
+        }
+        $content = $data;
+    } else {
+        Display::addFlash(Display::return_message(get_lang('Error')));
+    }
+}
+
+$tpl = new Template(get_lang('Upgrade'), true, true, false, true, false);
+$tpl->assign('content', $content);
+$tpl->display_one_col_template();
diff --git a/plugin/whispeakauth/Controller/AuthenticationController.php b/plugin/whispeakauth/Controller/AuthenticationController.php
new file mode 100644
index 000000000..64af1bf95
--- /dev/null
+++ b/plugin/whispeakauth/Controller/AuthenticationController.php
@@ -0,0 +1,366 @@
+plugin->toolIsEnabled()) {
+            throw new \Exception(get_lang('NotAllowed'));
+        }
+
+        /** @var array $lpQuestionInfo */
+        $lpQuestionInfo = ChamiloSession::read(WhispeakAuthPlugin::SESSION_QUIZ_QUESTION, []);
+
+        if (ChamiloSession::read(WhispeakAuthPlugin::SESSION_AUTH_PASSWORD, false)) {
+            ChamiloSession::erase(WhispeakAuthPlugin::SESSION_AUTH_PASSWORD);
+
+            if (empty($lpQuestionInfo)) {
+                $message = $this->plugin->get_lang('MaxAttemptsReached')
+                    .'
    '.$this->plugin->get_lang('LoginWithUsernameAndPassword').'';
+
+                Display::addFlash(
+                    Display::return_message($message, 'warning')
+                );
+            }
+
+            header('Location: '.api_get_path(WEB_PLUGIN_PATH).'whispeakauth/authentify_password.php');
+            exit;
+        }
+
+        /** @var array $lpItemInfo */
+        $lpItemInfo = ChamiloSession::read(WhispeakAuthPlugin::SESSION_LP_ITEM, []);
+        /** @var \learnpath $oLp */
+        $oLp = ChamiloSession::read('oLP', null);
+        /** @var \Exercise $objExercise */
+        $objExercise = ChamiloSession::read('objExercise', null);
+
+        $isAuthOnLp = !empty($lpItemInfo) && !empty($oLp);
+        $isAuthOnQuiz = !empty($lpQuestionInfo) && !empty($objExercise);
+        $showFullPage = !$isAuthOnLp && !$isAuthOnQuiz;
+
+        $user = api_get_user_entity(
+            ChamiloSession::read(WhispeakAuthPlugin::SESSION_2FA_USER, 0) ?: api_get_user_id()
+        );
+
+        $showForm = !$user;
+
+        if ($user) {
+            if (!WhispeakAuthPlugin::getAuthUidValue($user)) {
+                $message = Display::return_message($this->plugin->get_lang('SpeechAuthNotEnrolled'), 'warning');
+
+                if (!empty($lpQuestionInfo) && empty($lpItemInfo)) {
+                    echo $message;
+                } else {
+                    Display::addFlash($message);
+                }
+
+                header('Location: '.api_get_path(WEB_PLUGIN_PATH).'whispeakauth/authentify_password.php');
+
+                exit;
+            }
+        }
+
+        if (!empty($lpQuestionInfo) && empty($lpItemInfo)) {
+            echo api_get_js('rtc/RecordRTC.js');
+            echo api_get_js_simple(api_get_path(WEB_PLUGIN_PATH).'whispeakauth/assets/js/RecordAudio.js');
+        }
+
+        $request = new ApiRequest();
+        $response = $request->createAuthenticationSessionToken($user);
+
+        if (empty($response['text'])) {
+            $varNumber = mt_rand(1, 6);
+            $response['text'] = $this->plugin->get_lang("AuthentifySampleText$varNumber");
+        }
+
+        ChamiloSession::write(WhispeakAuthPlugin::SESSION_SENTENCE_TEXT, $response['token']);
+
+        if (!empty($lpQuestionInfo) && empty($lpItemInfo)) {
+            $template = new \Template('', $showFullPage, $showFullPage, false, true, false);
+            $template->assign('show_form', $showForm);
+            $template->assign('sample_text', $response['text']);
+
+            echo $template->fetch('whispeakauth/view/authentify_recorder.html.twig');
+            exit;
+        }
+
+        $this->displayPage(
+            $showFullPage,
+            [
+                'show_form' => $showForm,
+                'sample_text' => $response['text'],
+            ]
+        );
+    }
+
+    /**
+     * @throws \Exception
+     */
+    public function ajax()
+    {
+        $userId = api_get_user_id();
+        $user2fa = ChamiloSession::read(WhispeakAuthPlugin::SESSION_2FA_USER, 0);
+
+        $result = [];
+
+        if (!empty($user2fa) || !empty($userId)) {
+            $isAllowed = !empty($_FILES['audio']);
+        } else {
+            $isAllowed = !empty($_POST['username']) && !empty($_FILES['audio']);
+        }
+
+        if (!$isAllowed || !$this->plugin->toolIsEnabled()) {
+            throw new \Exception(get_lang('NotAllowed'));
+        }
+
+        if (!empty($user2fa)) {
+            $user = api_get_user_entity($user2fa);
+        } elseif (!empty($userId)) {
+            $user = api_get_user_entity($userId);
+        } else {
+            /** @var User|null $user */
+            $user = \UserManager::getRepository()->findOneBy(['username' => $_POST['username']]);
+        }
+
+        if (!$user) {
+            throw new \Exception(get_lang('NotFound'));
+        }
+
+        $audioFilePath = $this->uploadAudioFile($user);
+
+        $failedLogins = ChamiloSession::read(WhispeakAuthPlugin::SESSION_FAILED_LOGINS, 0);
+        $maxAttempts = $this->plugin->getMaxAttempts();
+
+        if ($maxAttempts && $failedLogins >= $maxAttempts) {
+            throw new \Exception($this->plugin->get_lang('MaxAttemptsReached'));
+        }
+
+        $token = \ChamiloSession::read(\WhispeakAuthPlugin::SESSION_SENTENCE_TEXT);
+
+        \ChamiloSession::erase(\WhispeakAuthPlugin::SESSION_SENTENCE_TEXT);
+
+        /** @var array $lpItemInfo */
+        $lpItemInfo = ChamiloSession::read(WhispeakAuthPlugin::SESSION_LP_ITEM, []);
+        /** @var array $quizQuestionInfo */
+        $quizQuestionInfo = ChamiloSession::read(WhispeakAuthPlugin::SESSION_QUIZ_QUESTION, []);
+
+        $success = true;
+
+        $request = new ApiRequest();
+
+        try {
+            $request->performAuthentication($token, $user, $audioFilePath);
+
+            $message = $this->plugin->get_lang('AuthentifySuccess');
+        } catch (\Exception $exception) {
+            $message = $this->plugin->get_lang('AuthentifyFailed')
+                .PHP_EOL
+                .$exception->getMessage();
+
+            $success = false;
+        }
+
+        if (!$success) {
+            if (!empty($lpItemInfo)) {
+                $this->plugin->addAttemptInLearningPath(
+                    LogEvent::STATUS_FAILED,
+                    $user->getId(),
+                    $lpItemInfo['lp_item'],
+                    $lpItemInfo['lp']
+                );
+            }
+
+            if (!empty($quizQuestionInfo)) {
+                $this->plugin->addAttemptInQuiz(
+                    LogEvent::STATUS_FAILED,
+                    $user->getId(),
+                    $quizQuestionInfo['question'],
+                    $quizQuestionInfo['quiz']
+                );
+            }
+
+            if (empty($lpItemInfo) && empty($quizQuestionInfo)) {
+                $this->plugin->addAuthenticationAttempt(LogEvent::STATUS_FAILED, $user->getId());
+            }
+
+            $authTokenRequest = new ApiRequest();
+            $authTokenResponse = $authTokenRequest->createAuthenticationSessionToken($user);
+
+            if (empty($authTokenResponse['text'])) {
+                $varNumber = mt_rand(1, 6);
+                $authTokenResponse['text'] = $this->plugin->get_lang("AuthentifySampleText$varNumber");
+            }
+
+            $result['text'] = $authTokenResponse['text'];
+
+            ChamiloSession::write(WhispeakAuthPlugin::SESSION_SENTENCE_TEXT, $authTokenResponse['token']);
+
+            ChamiloSession::write(WhispeakAuthPlugin::SESSION_FAILED_LOGINS, ++$failedLogins);
+
+            if ($maxAttempts && $failedLogins >= $maxAttempts) {
+                $message .= PHP_EOL
+                    .''.$this->plugin->get_lang('MaxAttemptsReached').''
+                    .PHP_EOL.PHP_EOL
+                    .''
+                    .$this->plugin->get_lang('LoginWithUsernameAndPassword')
+                    .'';
+
+                if (!empty($user2fa)) {
+                    Display::addFlash(
+                        Display::return_message($message, 'warning', false)
+                    );
+                }
+            } else {
+                $message .= PHP_EOL.$this->plugin->get_lang('TryAgain');
+
+                if ('true' === api_get_setting('allow_lostpassword')) {
+                    $message .= PHP_EOL
+                        .Display::url(
+                            get_lang('LostPassword'),
+                            api_get_path(WEB_CODE_PATH).'auth/lostPassword.php',
+                            ['target' => $lpItemInfo ? '_top' : '_self']
+                        );
+                }
+            }
+        }
+
+        $result['resultHtml'] = Display::return_message(
+            nl2br($message),
+            $success ? 'success' : 'warning',
+            false
+        );
+
+        if (!$success && $maxAttempts && $failedLogins >= $maxAttempts) {
+            ChamiloSession::erase(WhispeakAuthPlugin::SESSION_FAILED_LOGINS);
+
+            if (!empty($lpItemInfo)) {
+                $result['resultHtml'] .= '';
+
+                return $result;
+            }
+
+            if (!empty($quizQuestionInfo)) {
+                $url = api_get_path(WEB_CODE_PATH).'exercise/exercise_submit.php?'.$quizQuestionInfo['url_params'];
+
+                ChamiloSession::write(WhispeakAuthPlugin::SESSION_AUTH_PASSWORD, true);
+
+                $result['resultHtml'] .= "";
+
+                return $result;
+            }
+
+            $result['resultHtml'] .= '';
+
+            return $result;
+        }
+
+        if ($success) {
+            ChamiloSession::erase(WhispeakAuthPlugin::SESSION_SENTENCE_TEXT);
+            ChamiloSession::erase(WhispeakAuthPlugin::SESSION_FAILED_LOGINS);
+
+            if (!empty($lpItemInfo)) {
+                ChamiloSession::erase(WhispeakAuthPlugin::SESSION_LP_ITEM);
+                ChamiloSession::erase(WhispeakAuthPlugin::SESSION_2FA_USER);
+
+                $this->plugin->addAttemptInLearningPath(
+                    LogEvent::STATUS_SUCCESS,
+                    $user->getId(),
+                    $lpItemInfo['lp_item'],
+                    $lpItemInfo['lp']
+                );
+
+                $result['resultHtml'] .= '';
+
+                return $result;
+            }
+
+            if (!empty($quizQuestionInfo)) {
+                $quizQuestionInfo['passed'] = true;
+                $url = api_get_path(WEB_CODE_PATH).'exercise/exercise_submit.php?'.$quizQuestionInfo['url_params'];
+
+                ChamiloSession::write(WhispeakAuthPlugin::SESSION_QUIZ_QUESTION, $quizQuestionInfo);
+
+                $this->plugin->addAttemptInQuiz(
+                    LogEvent::STATUS_SUCCESS,
+                    $user->getId(),
+                    $quizQuestionInfo['question'],
+                    $quizQuestionInfo['quiz']
+                );
+
+                $result['resultHtml'] .= '';
+
+                return $result;
+            }
+
+            if (empty($lpItemInfo) && empty($quizQuestionInfo)) {
+                $this->plugin->addAuthenticationAttempt(LogEvent::STATUS_SUCCESS, $user->getId());
+            }
+
+            $loggedUser = [
+                'user_id' => $user->getId(),
+                'status' => $user->getStatus(),
+                'uidReset' => true,
+            ];
+
+            if (empty($user2fa)) {
+                ChamiloSession::write(WhispeakAuthPlugin::SESSION_2FA_USER, $user->getId());
+            }
+
+            ChamiloSession::erase(WhispeakAuthPlugin::SESSION_FAILED_LOGINS);
+            ChamiloSession::write('_user', $loggedUser);
+            Login::init_user($user->getId(), true);
+
+            $result['resultHtml'] .= '';
+
+            return $result;
+        }
+
+        return $result;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function displayPage($isFullPage, array $variables)
+    {
+        global $htmlHeadXtra;
+
+        $htmlHeadXtra[] = api_get_js('rtc/RecordRTC.js');
+        $htmlHeadXtra[] = api_get_js_simple(api_get_path(WEB_PLUGIN_PATH).'whispeakauth/assets/js/RecordAudio.js');
+
+        $pageTitle = $this->plugin->get_title();
+
+        $template = new \Template($pageTitle, $isFullPage, $isFullPage, !$isFullPage);
+
+        foreach ($variables as $key => $value) {
+            $template->assign($key, $value);
+        }
+
+        $pageContent = $template->fetch('whispeakauth/view/authentify_recorder.html.twig');
+
+        $template->assign('header', $pageTitle);
+        $template->assign('content', $pageContent);
+        $template->display_one_col_template();
+    }
+}
diff --git a/plugin/whispeakauth/Controller/BaseController.php b/plugin/whispeakauth/Controller/BaseController.php
new file mode 100644
index 000000000..bc0cd2781
--- /dev/null
+++ b/plugin/whispeakauth/Controller/BaseController.php
@@ -0,0 +1,67 @@
+plugin = \WhispeakAuthPlugin::create();
+    }
+
+    /**
+     * @param bool $isFullPage
+     *
+     * @return mixed
+     */
+    abstract protected function displayPage($isFullPage, array $variables);
+
+    /**
+     * @throws \Exception
+     *
+     * @return string
+     */
+    protected function uploadAudioFile(User $user)
+    {
+        $pluginName = $this->plugin->get_name();
+
+        $path = api_upload_file($pluginName, $_FILES['audio'], $user->getId());
+
+        if (false === $path) {
+            throw new \Exception(get_lang('UploadError'));
+        }
+
+        $fullPath = api_get_path(SYS_UPLOAD_PATH).$pluginName.$path['path_to_save'];
+        $mimeType = mime_content_type($fullPath);
+
+        if ('wav' !== substr($mimeType, -3)) {
+            $ffmpeg = FFMpeg::create();
+
+            $audioFile = $ffmpeg->open($fullPath);
+
+            $fullPath = dirname($fullPath).'/audio.wav';
+
+            $audioFile->save(new Wav(), $fullPath);
+        }
+
+        return $fullPath;
+    }
+}
diff --git a/plugin/whispeakauth/Controller/EnrollmentController.php b/plugin/whispeakauth/Controller/EnrollmentController.php
new file mode 100644
index 000000000..6a7bbb4c0
--- /dev/null
+++ b/plugin/whispeakauth/Controller/EnrollmentController.php
@@ -0,0 +1,116 @@
+plugin->toolIsEnabled()) {
+            throw new \Exception(get_lang('NotAllowed'));
+        }
+
+        $user = api_get_user_entity(api_get_user_id());
+
+        $userIsEnrolled = \WhispeakAuthPlugin::checkUserIsEnrolled($user->getId());
+
+        if ($userIsEnrolled) {
+            throw new \Exception($this->plugin->get_lang('SpeechAuthAlreadyEnrolled'));
+        }
+
+        $request = new ApiRequest();
+        $response = $request->createEnrollmentSessionToken($user);
+
+        \ChamiloSession::write(\WhispeakAuthPlugin::SESSION_SENTENCE_TEXT, $response['token']);
+
+        $this->displayPage(
+            true,
+            [
+                'action' => 'enrollment',
+                'sample_text' => $response['text'],
+            ]
+        );
+    }
+
+    /**
+     * @throws \Exception
+     */
+    public function ajax()
+    {
+        $result = ['resultHtml' => ''];
+
+        if (!$this->plugin->toolIsEnabled() || empty($_FILES['audio'])) {
+            throw new \Exception(get_lang('NotAllowed'));
+        }
+
+        $user = api_get_user_entity(api_get_user_id());
+
+        $audioFilePath = $this->uploadAudioFile($user);
+
+        $token = \ChamiloSession::read(\WhispeakAuthPlugin::SESSION_SENTENCE_TEXT);
+
+        if (empty($token)) {
+            throw new \Exception($this->plugin->get_lang('EnrollmentFailed'));
+        }
+
+        $request = new ApiRequest();
+
+        try {
+            $response = $request->createEnrollment($token, $audioFilePath, $user);
+        } catch (\Exception $exception) {
+            $enrollTokenRequest = new ApiRequest();
+            $enrollTokenResponse = $enrollTokenRequest->createEnrollmentSessionToken($user);
+
+            \ChamiloSession::write(\WhispeakAuthPlugin::SESSION_SENTENCE_TEXT, $enrollTokenResponse['token']);
+
+            return [
+                'resultHtml' => \Display::return_message($exception->getMessage(), 'error'),
+                'text' => $enrollTokenResponse['text'],
+            ];
+        }
+
+        \ChamiloSession::erase(\WhispeakAuthPlugin::SESSION_SENTENCE_TEXT);
+
+        $this->plugin->saveEnrollment($user, $response['speaker']);
+
+        $result['resultHtml'] .= \Display::return_message($this->plugin->get_lang('EnrollmentSuccess'), 'success');
+
+        return $result;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function displayPage($isFullPage, array $variables)
+    {
+        global $htmlHeadXtra;
+
+        $htmlHeadXtra[] = api_get_js('rtc/RecordRTC.js');
+        $htmlHeadXtra[] = api_get_js_simple(api_get_path(WEB_PLUGIN_PATH).'whispeakauth/assets/js/RecordAudio.js');
+
+        $pageTitle = $this->plugin->get_lang('EnrollmentTitle');
+
+        $template = new \Template($pageTitle);
+
+        foreach ($variables as $key => $value) {
+            $template->assign($key, $value);
+        }
+
+        $pageContent = $template->fetch('whispeakauth/view/record_audio.html.twig');
+
+        $template->assign('header', $pageTitle);
+        $template->assign('content', $pageContent);
+        $template->display_one_col_template();
+    }
+}
diff --git a/plugin/whispeakauth/Entity/LogEvent.php b/plugin/whispeakauth/Entity/LogEvent.php
new file mode 100644
index 000000000..bec31ede2
--- /dev/null
+++ b/plugin/whispeakauth/Entity/LogEvent.php
@@ -0,0 +1,145 @@
+id;
+    }
+
+    /**
+     * @param int $id
+     *
+     * @return LogEvent
+     */
+    public function setId($id)
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    /**
+     * @return DateTime
+     */
+    public function getDatetime()
+    {
+        return $this->datetime;
+    }
+
+    /**
+     * @param DateTime $datetime
+     *
+     * @return LogEvent
+     */
+    public function setDatetime($datetime)
+    {
+        $this->datetime = $datetime;
+
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function getActionStatus()
+    {
+        return $this->actionStatus;
+    }
+
+    /**
+     * @param int $actionStatus
+     *
+     * @return LogEvent
+     */
+    public function setActionStatus($actionStatus)
+    {
+        $this->actionStatus = $actionStatus;
+
+        return $this;
+    }
+
+    /**
+     * @return User
+     */
+    public function getUser()
+    {
+        return $this->user;
+    }
+
+    /**
+     * @param User $user
+     *
+     * @return LogEvent
+     */
+    public function setUser($user)
+    {
+        $this->user = $user;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getTypeString()
+    {
+        return '-';
+    }
+}
diff --git a/plugin/whispeakauth/Entity/LogEventLp.php b/plugin/whispeakauth/Entity/LogEventLp.php
new file mode 100644
index 000000000..6b42cf927
--- /dev/null
+++ b/plugin/whispeakauth/Entity/LogEventLp.php
@@ -0,0 +1,84 @@
+lpItem;
+    }
+
+    /**
+     * @param CLpItem $lpItem
+     *
+     * @return LogEventLp
+     */
+    public function setLpItem($lpItem)
+    {
+        $this->lpItem = $lpItem;
+
+        return $this;
+    }
+
+    /**
+     * @return CLp
+     */
+    public function getLp()
+    {
+        return $this->lp;
+    }
+
+    /**
+     * @param CLp $lp
+     *
+     * @return LogEventLp
+     */
+    public function setLp($lp)
+    {
+        $this->lp = $lp;
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTypeString()
+    {
+        $lpName = $this->lp->getName();
+        $itemTitle = $this->getLpItem()->getTitle();
+
+        return "$lpName > $itemTitle";
+    }
+}
diff --git a/plugin/whispeakauth/Entity/LogEventQuiz.php b/plugin/whispeakauth/Entity/LogEventQuiz.php
new file mode 100644
index 000000000..c35c24f39
--- /dev/null
+++ b/plugin/whispeakauth/Entity/LogEventQuiz.php
@@ -0,0 +1,84 @@
+question;
+    }
+
+    /**
+     * @param CQuizQuestion $question
+     *
+     * @return LogEventQuiz
+     */
+    public function setQuestion($question)
+    {
+        $this->question = $question;
+
+        return $this;
+    }
+
+    /**
+     * @return CQuiz
+     */
+    public function getQuiz()
+    {
+        return $this->quiz;
+    }
+
+    /**
+     * @param CQuiz $quiz
+     *
+     * @return LogEventQuiz
+     */
+    public function setQuiz($quiz)
+    {
+        $this->quiz = $quiz;
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTypeString()
+    {
+        $quiz = strip_tags($this->getQuiz()->getTitle());
+        $question = strip_tags($this->getQuestion()->getQuestion());
+
+        return "$quiz > $question";
+    }
+}
diff --git a/plugin/whispeakauth/README.md b/plugin/whispeakauth/README.md
new file mode 100644
index 000000000..b963a2bf9
--- /dev/null
+++ b/plugin/whispeakauth/README.md
@@ -0,0 +1,23 @@
+Speech authentication with Whispeak
+===================================
+
+**Notice:**
+
+This plugin requires the user to grant permission to use the microphone connected on the web browser. Currently,
+browsers are limiting this permission to be used only in a secure environment with HTTPS. 
+**If your portal does not work with HTTPS, then Whispeak authentication may not work.**
+
+Installation:
+-------------
+
+*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. This might imply a manual change on your server (outside of the Chamilo
+interface).*
+
+1. Install plugin in Chamilo.
+2. Set the plugin configuration enabling the plugin and (optionally) set the max attempts. 
+3. Set the `login_bottom` region to the plugin. 
+4. Add `$_configuration['whispeak_auth_enabled'] = true;` to `configuration.php` file.
+5. Optionally, you can add the `menu_administrator` region to se the user logged activities from Whispeak.
+
+To have more information about whispeak or create an account to be able to use it on Chamilo you can go here Whispeak
diff --git a/plugin/whispeakauth/Request/ApiRequest.php b/plugin/whispeakauth/Request/ApiRequest.php
new file mode 100644
index 000000000..9a08b70ed
--- /dev/null
+++ b/plugin/whispeakauth/Request/ApiRequest.php
@@ -0,0 +1,230 @@
+plugin = \WhispeakAuthPlugin::create();
+        $this->apiKey = $this->plugin->get(\WhispeakAuthPlugin::SETTING_TOKEN);
+    }
+
+    /**
+     * Create a session token to perform an enrollment.
+     *
+     * @throws \Exception
+     *
+     * @return array
+     */
+    public function createEnrollmentSessionToken(User $user)
+    {
+        $apiKey = $this->plugin->get(\WhispeakAuthPlugin::SETTING_TOKEN);
+        $langIso = api_get_language_isocode($user->getLanguage());
+
+        return $this->sendRequest(
+            'get',
+            'enroll',
+            $apiKey,
+            $langIso
+        );
+    }
+
+    /**
+     * @param string $token
+     * @param string $audioFilePath
+     *
+     * @throws \Exception
+     *
+     * @return array
+     */
+    public function createEnrollment($token, $audioFilePath, User $user)
+    {
+        $langIso = api_get_language_isocode($user->getLanguage());
+
+        return $this->sendRequest(
+            'post',
+            'enroll',
+            $token,
+            $langIso,
+            [
+                [
+                    'name' => 'file',
+                    'contents' => fopen($audioFilePath, 'r'),
+                    'filename' => basename($audioFilePath),
+                ],
+            ]
+        );
+    }
+
+    /**
+     * @throws \Exception
+     *
+     * @return array
+     */
+    public function createAuthenticationSessionToken(User $user = null)
+    {
+        $apiKey = $this->plugin->get(\WhispeakAuthPlugin::SETTING_TOKEN);
+
+        $langIso = api_get_language_isocode($user ? $user->getLanguage() : null);
+
+        return $this->sendRequest(
+            'get',
+            'auth',
+            $apiKey,
+            $langIso
+        );
+    }
+
+    /**
+     * @throws \Exception
+     *
+     * @return array
+     */
+    public function deleteEnrollment(User $user)
+    {
+        $apiKey = $this->plugin->get(\WhispeakAuthPlugin::SETTING_TOKEN);
+        $langIso = api_get_language_isocode($user->getLanguage());
+        $userAuthKey = \WhispeakAuthPlugin::getAuthUidValue($user->getId());
+
+        if (empty($userAuthKey) || empty($userAuthKey->getValue())) {
+            throw new \Exception(get_plugin_lang('NoEnrollment', 'WhispeakAuthPlugin'));
+        }
+
+        $queryData = ['speaker' => $userAuthKey->getValue()];
+
+        return $this->sendRequest(
+            'delete',
+            'enroll',
+            $apiKey,
+            $langIso,
+            [],
+            $queryData
+        );
+    }
+
+    /**
+     * @param string $token
+     * @param string $audioFilePath
+     *
+     * @throws \Exception
+     *
+     * @return bool
+     */
+    public function performAuthentication($token, User $user, $audioFilePath)
+    {
+        $wsid = \WhispeakAuthPlugin::getAuthUidValue($user->getId());
+
+        if (empty($wsid)) {
+            throw new \Exception($this->plugin->get_lang('SpeechAuthNotEnrolled'));
+        }
+
+        $langIso = api_get_language_isocode($user ? $user->getLanguage() : null);
+
+        $this->sendRequest(
+            'post',
+            'auth',
+            $token,
+            $langIso,
+            [
+                [
+                    'name' => 'speaker',
+                    'contents' => $wsid->getValue(),
+                ],
+                [
+                    'name' => 'file',
+                    'contents' => fopen($audioFilePath, 'r'),
+                    'filename' => basename($audioFilePath),
+                ],
+            ]
+        );
+    }
+
+    /**
+     * @param string $method
+     * @param string $uri
+     * @param string $authBearer
+     * @param string $lang
+     * @param array  $queryParams
+     *
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     *
+     * @return array
+     */
+    private function sendRequest($method, $uri, $authBearer, $lang, array $multipart = [], $queryParams = [])
+    {
+        $httpClient = new Client(['base_uri' => $this->plugin->getApiUrl()]);
+
+        $options = [];
+        $options['headers'] = [
+            'Authorization' => "Bearer $authBearer",
+            'Accept-Language' => $lang,
+        ];
+
+        if ($queryParams) {
+            $options['query'] = $queryParams;
+        } else {
+            $options['multipart'] = $multipart;
+        }
+
+        try {
+            $responseBody = $httpClient
+                ->request(
+                    $method,
+                    $uri,
+                    $options
+                )
+                ->getBody()
+                ->getContents();
+
+            return json_decode($responseBody, true);
+        } catch (RequestException $requestException) {
+            if (!$requestException->hasResponse()) {
+                throw new \Exception($requestException->getMessage());
+            }
+
+            $responseBody = $requestException->getResponse()->getBody()->getContents();
+            $json = json_decode($responseBody, true);
+
+            $message = '';
+
+            if (isset($json['asserts'])) {
+                foreach ($json['asserts'] as $assert) {
+                    if ('invalid_' === substr($assert['value'], 0, 8)) {
+                        $message .= $assert['message'].PHP_EOL;
+                    }
+                }
+            } elseif (empty($json['message'])) {
+                $message = $requestException->getMessage();
+            } else {
+                $message = is_array($json['message']) ? implode(PHP_EOL, $json['message']) : $json['message'];
+            }
+
+            throw new \Exception($message);
+        } catch (Exception $exception) {
+            throw new \Exception($exception->getMessage());
+        }
+    }
+}
diff --git a/plugin/whispeakauth/WhispeakAuthPlugin.php b/plugin/whispeakauth/WhispeakAuthPlugin.php
new file mode 100644
index 000000000..d1562beed
--- /dev/null
+++ b/plugin/whispeakauth/WhispeakAuthPlugin.php
@@ -0,0 +1,804 @@
+ 'boolean',
+                self::SETTING_API_URL => 'text',
+                self::SETTING_TOKEN => 'text',
+                self::SETTING_MAX_ATTEMPTS => 'text',
+                self::SETTING_2FA => 'boolean',
+            ]
+        );
+    }
+
+    /**
+     * Get the admin URL for the plugin if Plugin::isAdminPlugin is true.
+     *
+     * @return string
+     */
+    public function getAdminUrl()
+    {
+        $webPath = api_get_path(WEB_PLUGIN_PATH).$this->get_name();
+
+        return "$webPath/admin.php";
+    }
+
+    /**
+     * @return WhispeakAuthPlugin
+     */
+    public static function create()
+    {
+        static $result = null;
+
+        return $result ? $result : $result = new self();
+    }
+
+    /**
+     * @throws \Doctrine\ORM\Tools\ToolsException
+     */
+    public function install()
+    {
+        $this->installExtraFields();
+        $this->installEntities();
+        $this->installHook();
+    }
+
+    public function uninstall()
+    {
+        $this->uninstallHook();
+        $this->uninstallExtraFields();
+        $this->uninstallEntities();
+    }
+
+    /**
+     * @return ExtraField
+     */
+    public static function getAuthUidExtraField()
+    {
+        $em = Database::getManager();
+        $efRepo = $em->getRepository('ChamiloCoreBundle:ExtraField');
+
+        /** @var ExtraField $extraField */
+        $extraField = $efRepo->findOneBy(
+            [
+                'variable' => self::EXTRAFIELD_AUTH_UID,
+                'extraFieldType' => ExtraField::USER_FIELD_TYPE,
+            ]
+        );
+
+        return $extraField;
+    }
+
+    /**
+     * @return ExtraField
+     */
+    public static function getLpItemExtraField()
+    {
+        $efRepo = Database::getManager()->getRepository('ChamiloCoreBundle:ExtraField');
+
+        /** @var ExtraField $extraField */
+        $extraField = $efRepo->findOneBy(
+            [
+                'variable' => self::EXTRAFIELD_LP_ITEM,
+                'extraFieldType' => ExtraField::LP_ITEM_FIELD_TYPE,
+            ]
+        );
+
+        return $extraField;
+    }
+
+    /**
+     * @return ExtraField
+     */
+    public static function getQuizQuestionExtraField()
+    {
+        $efRepo = Database::getManager()->getRepository('ChamiloCoreBundle:ExtraField');
+
+        /** @var ExtraField $extraField */
+        $extraField = $efRepo->findOneBy(
+            [
+                'variable' => self::EXTRAFIELD_QUIZ_QUESTION,
+                'extraFieldType' => ExtraField::QUESTION_FIELD_TYPE,
+            ]
+        );
+
+        return $extraField;
+    }
+
+    /**
+     * @param int $userId
+     *
+     * @return ExtraFieldValues
+     */
+    public static function getAuthUidValue($userId)
+    {
+        $extraField = self::getAuthUidExtraField();
+        $em = Database::getManager();
+        $efvRepo = $em->getRepository('ChamiloCoreBundle:ExtraFieldValues');
+
+        /** @var ExtraFieldValues $value */
+        $value = $efvRepo->findOneBy(['field' => $extraField, 'itemId' => $userId]);
+
+        return $value;
+    }
+
+    /**
+     * Get the whispeak_lp_item value for a LP item ID.
+     *
+     * @param int $lpItemId
+     *
+     * @return array|false
+     */
+    public static function getLpItemValue($lpItemId)
+    {
+        $efv = new ExtraFieldValue('lp_item');
+        $value = $efv->get_values_by_handler_and_field_variable($lpItemId, self::EXTRAFIELD_LP_ITEM);
+
+        return $value;
+    }
+
+    /**
+     * @param int $lpItemId
+     *
+     * @return bool
+     */
+    public static function isLpItemMarked($lpItemId)
+    {
+        if (!self::create()->isEnabled()) {
+            return false;
+        }
+
+        $value = self::getLpItemValue($lpItemId);
+
+        return !empty($value) && !empty($value['value']);
+    }
+
+    /**
+     * Get the whispeak_quiz_question value for a quiz question ID.
+     *
+     * @param int $questionId
+     *
+     * @return array|false
+     */
+    public static function getQuizQuestionValue($questionId)
+    {
+        $efv = new ExtraFieldValue('question');
+        $value = $efv->get_values_by_handler_and_field_variable($questionId, self::EXTRAFIELD_QUIZ_QUESTION);
+
+        return $value;
+    }
+
+    /**
+     * @param int $questionId
+     *
+     * @return bool
+     */
+    public static function isQuizQuestionMarked($questionId)
+    {
+        if (!self::create()->isEnabled()) {
+            return false;
+        }
+
+        $value = self::getQuizQuestionValue($questionId);
+
+        return !empty($value) && !empty($value['value']);
+    }
+
+    /**
+     * @param int $questionId
+     *
+     * @return bool
+     */
+    public static function questionRequireAuthentify($questionId)
+    {
+        $isMarked = self::isQuizQuestionMarked($questionId);
+
+        if (!$isMarked) {
+            return false;
+        }
+
+        $questionInfo = ChamiloSession::read(self::SESSION_QUIZ_QUESTION, []);
+
+        if (empty($questionInfo)) {
+            return true;
+        }
+
+        if ((int) $questionId !== $questionInfo['question']) {
+            return true;
+        }
+
+        if (false === $questionInfo['passed']) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param int $userId
+     *
+     * @return bool
+     */
+    public static function checkUserIsEnrolled($userId)
+    {
+        $value = self::getAuthUidValue($userId);
+
+        if (empty($value)) {
+            return false;
+        }
+
+        return !empty($value->getValue());
+    }
+
+    /**
+     * @return string
+     */
+    public static function getEnrollmentUrl()
+    {
+        return api_get_path(WEB_PLUGIN_PATH).'whispeakauth/enrollment.php';
+    }
+
+    /**
+     * @param string $uid
+     *
+     * @throws \Doctrine\ORM\OptimisticLockException
+     */
+    public function saveEnrollment(User $user, $uid)
+    {
+        $em = Database::getManager();
+        $extraFieldValue = self::getAuthUidValue($user->getId());
+
+        if (empty($extraFieldValue)) {
+            $extraField = self::getAuthUidExtraField();
+            $now = new DateTime('now', new DateTimeZone('UTC'));
+
+            $extraFieldValue = new ExtraFieldValues();
+            $extraFieldValue
+                ->setField($extraField)
+                ->setItemId($user->getId())
+                ->setUpdatedAt($now);
+        }
+
+        $extraFieldValue->setValue($uid);
+
+        $em->persist($extraFieldValue);
+        $em->flush();
+    }
+
+    /**
+     * @return bool
+     */
+    public function toolIsEnabled()
+    {
+        return 'true' === $this->get(self::SETTING_ENABLE);
+    }
+
+    /**
+     * Access not allowed when tool is not enabled.
+     *
+     * @param bool $printHeaders Optional. Print headers.
+     */
+    public function protectTool($printHeaders = true)
+    {
+        if ($this->toolIsEnabled()) {
+            return;
+        }
+
+        api_not_allowed($printHeaders);
+    }
+
+    /**
+     * Get the max_attemtps option.
+     *
+     * @return int
+     */
+    public function getMaxAttempts()
+    {
+        return (int) $this->get(self::SETTING_MAX_ATTEMPTS);
+    }
+
+    /**
+     * Install hook when saving the plugin configuration.
+     *
+     * @return WhispeakAuthPlugin
+     */
+    public function performActionsAfterConfigure()
+    {
+        $observer = WhispeakConditionalLoginHook::create();
+
+        if ('true' === $this->get(self::SETTING_2FA)) {
+            HookConditionalLogin::create()->attach($observer);
+        } else {
+            HookConditionalLogin::create()->detach($observer);
+        }
+
+        return $this;
+    }
+
+    /**
+     * This method will call the Hook management insertHook to add Hook observer from this plugin.
+     */
+    public function installHook()
+    {
+        $observer = WhispeakMyStudentsLpTrackingHook::create();
+        HookMyStudentsLpTracking::create()->attach($observer);
+
+        $observer = WhispeakMyStudentsQuizTrackingHook::create();
+        HookMyStudentsQuizTracking::create()->attach($observer);
+    }
+
+    /**
+     * This method will call the Hook management deleteHook to disable Hook observer from this plugin.
+     */
+    public function uninstallHook()
+    {
+        $observer = WhispeakConditionalLoginHook::create();
+        HookConditionalLogin::create()->detach($observer);
+
+        $observer = WhispeakMyStudentsLpTrackingHook::create();
+        HookMyStudentsLpTracking::create()->detach($observer);
+    }
+
+    /**
+     * @param int $userId
+     *
+     * @throws \Doctrine\ORM\OptimisticLockException
+     *
+     * @return bool
+     */
+    public static function deleteEnrollment($userId)
+    {
+        $extraFieldValue = self::getAuthUidValue($userId);
+
+        if (empty($extraFieldValue)) {
+            return false;
+        }
+
+        $em = Database::getManager();
+        $em->remove($extraFieldValue);
+        $em->flush();
+
+        return true;
+    }
+
+    /**
+     * Check if the WhispeakAuth plugin is installed and enabled.
+     *
+     * @param bool $checkEnabled Check if, additionnally to being installed, the plugin is enabled
+     */
+    public function isEnabled(bool $checkEnabled = false): bool
+    {
+        return parent::isEnabled() && 'true' === api_get_plugin_setting('whispeakauth', self::SETTING_ENABLE);
+    }
+
+    /**
+     * @param int $lpItemId
+     *
+     * @return bool
+     */
+    public static function isAllowedToSaveLpItem($lpItemId)
+    {
+        if (!self::isLpItemMarked($lpItemId)) {
+            return true;
+        }
+
+        $markedItem = ChamiloSession::read(self::SESSION_LP_ITEM, []);
+
+        if (empty($markedItem)) {
+            return true;
+        }
+
+        if ((int) $lpItemId !== (int) $markedItem['lp_item']) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Display a error message.
+     *
+     * @param string|null $error Optional. The message text
+     */
+    public static function displayNotAllowedMessage($error = null)
+    {
+        $error = empty($error) ? get_lang('NotAllowed') : $error;
+
+        echo Display::return_message($error, 'error', false);
+
+        exit;
+    }
+
+    /**
+     * @param int $questionId
+     *
+     * @throws Exception
+     *
+     * @return string
+     */
+    public static function quizQuestionAuthentify($questionId, Exercise $exercise)
+    {
+        ChamiloSession::write(
+            self::SESSION_QUIZ_QUESTION,
+            [
+                'quiz' => (int) $exercise->iid,
+                'question' => (int) $questionId,
+                'url_params' => $_SERVER['QUERY_STRING'],
+                'passed' => false,
+            ]
+        );
+
+        $template = new Template('', false, false, false, true, false, false);
+        $template->assign('question', $questionId);
+        $template->assign('exercise', $exercise->iid);
+        $content = $template->fetch('whispeakauth/view/quiz_question.html.twig');
+
+        echo $content;
+    }
+
+    /**
+     * @param int $status
+     * @param int $userId
+     * @param int $lpItemId
+     * @param int $lpId
+     *
+     * @throws \Doctrine\ORM\ORMException
+     * @throws \Doctrine\ORM\OptimisticLockException
+     * @throws \Doctrine\ORM\TransactionRequiredException
+     *
+     * @return LogEventLp|null
+     */
+    public function addAttemptInLearningPath($status, $userId, $lpItemId, $lpId)
+    {
+        $em = Database::getManager();
+
+        $user = api_get_user_entity($userId);
+        $lpItem = $em->find('ChamiloCourseBundle:CLpItem', $lpItemId);
+        $lp = $em->find('ChamiloCourseBundle:CLp', $lpId);
+
+        if (empty($lp) || empty($lpItem)) {
+            return null;
+        }
+
+        $logEvent = new LogEventLp();
+        $logEvent
+            ->setLpItem($lpItem)
+            ->setLp($lp)
+            ->setUser($user)
+            ->setDatetime(
+                api_get_utc_datetime(null, false, true)
+            )
+            ->setActionStatus($status);
+
+        $em->persist($logEvent);
+        $em->flush();
+
+        return $logEvent;
+    }
+
+    /**
+     * @param int $status
+     * @param int $userId
+     * @param int $questionId
+     * @param int $quizId
+     *
+     * @throws \Doctrine\ORM\ORMException
+     * @throws \Doctrine\ORM\OptimisticLockException
+     * @throws \Doctrine\ORM\TransactionRequiredException
+     *
+     * @return LogEventQuiz|null
+     */
+    public function addAttemptInQuiz($status, $userId, $questionId, $quizId)
+    {
+        $em = Database::getManager();
+
+        $user = api_get_user_entity($userId);
+        $question = $em->find('ChamiloCourseBundle:CQuizQuestion', $questionId);
+        $quiz = $em->find('ChamiloCourseBundle:CQuiz', $quizId);
+
+        if (empty($quiz) || empty($question)) {
+            return null;
+        }
+
+        $logEvent = new LogEventQuiz();
+        $logEvent
+            ->setQuestion($question)
+            ->setQuiz($quiz)
+            ->setUser($user)
+            ->setDatetime(
+                api_get_utc_datetime(null, false, true)
+            )
+            ->setActionStatus($status);
+
+        $em->persist($logEvent);
+        $em->flush();
+
+        return $logEvent;
+    }
+
+    /**
+     * @param int $status
+     * @param int $userId
+     *
+     * @throws \Doctrine\ORM\ORMException
+     * @throws \Doctrine\ORM\OptimisticLockException
+     * @throws \Doctrine\ORM\TransactionRequiredException
+     *
+     * @return LogEvent|null
+     */
+    public function addAuthenticationAttempt($status, $userId)
+    {
+        $em = Database::getManager();
+
+        $user = api_get_user_entity($userId);
+
+        $logEvent = new LogEvent();
+        $logEvent
+            ->setUser($user)
+            ->setDatetime(
+                api_get_utc_datetime(null, false, true)
+            )
+            ->setActionStatus($status);
+
+        $em->persist($logEvent);
+        $em->flush();
+
+        return $logEvent;
+    }
+
+    /**
+     * @param int $lpId
+     * @param int $userId
+     *
+     * @throws \Doctrine\ORM\Query\QueryException
+     *
+     * @return string
+     */
+    public static function countAllAttemptsInLearningPath($lpId, $userId)
+    {
+        $query = Database::getManager()
+            ->createQuery(
+                'SELECT COUNT(log) AS c FROM ChamiloPluginBundle:WhispeakAuth\LogEventLp log
+                WHERE log.lp = :lp AND log.user = :user'
+            )
+            ->setParameters(['lp' => $lpId, 'user' => $userId]);
+
+        $totalCount = (int) $query->getSingleScalarResult();
+
+        return $totalCount;
+    }
+
+    /**
+     * @param int $lpId
+     * @param int $userId
+     *
+     * @throws \Doctrine\ORM\Query\QueryException
+     *
+     * @return string
+     */
+    public static function countSuccessAttemptsInLearningPath($lpId, $userId)
+    {
+        $query = Database::getManager()
+            ->createQuery(
+                'SELECT COUNT(log) AS c FROM ChamiloPluginBundle:WhispeakAuth\LogEventLp log
+                WHERE log.lp = :lp AND log.user = :user AND log.actionStatus = :status'
+            )
+            ->setParameters(['lp' => $lpId, 'user' => $userId, 'status' => LogEvent::STATUS_SUCCESS]);
+
+        $totalCount = (int) $query->getSingleScalarResult();
+
+        return $totalCount;
+    }
+
+    /**
+     * @param int $quizId
+     * @param int $userId
+     *
+     * @throws \Doctrine\ORM\Query\QueryException
+     *
+     * @return string
+     */
+    public static function countAllAttemptsInQuiz($quizId, $userId)
+    {
+        $query = Database::getManager()
+            ->createQuery(
+                'SELECT COUNT(log) AS c FROM ChamiloPluginBundle:WhispeakAuth\LogEventQuiz log
+                WHERE log.quiz = :quiz AND log.user = :user'
+            )
+            ->setParameters(['quiz' => $quizId, 'user' => $userId]);
+
+        $totalCount = (int) $query->getSingleScalarResult();
+
+        return $totalCount;
+    }
+
+    /**
+     * @param int $quizId
+     * @param int $userId
+     *
+     * @throws \Doctrine\ORM\Query\QueryException
+     *
+     * @return string
+     */
+    public static function countSuccessAttemptsInQuiz($quizId, $userId)
+    {
+        $query = Database::getManager()
+            ->createQuery(
+                'SELECT COUNT(log) AS c FROM ChamiloPluginBundle:WhispeakAuth\LogEventQuiz log
+                WHERE log.quiz = :quiz AND log.user = :user AND log.actionStatus = :status'
+            )
+            ->setParameters(['quiz' => $quizId, 'user' => $userId, 'status' => LogEvent::STATUS_SUCCESS]);
+
+        $totalCount = (int) $query->getSingleScalarResult();
+
+        return $totalCount;
+    }
+
+    /**
+     * @return string
+     */
+    public function getApiUrl()
+    {
+        $url = $this->get(self::SETTING_API_URL);
+
+        return trim($url, " \t\n\r \v/").'/';
+    }
+
+    /**
+     * Install extra fields for user, learning path and quiz question.
+     */
+    private function installExtraFields()
+    {
+        UserManager::create_extra_field(
+            self::EXTRAFIELD_AUTH_UID,
+            \ExtraField::FIELD_TYPE_TEXT,
+            $this->get_lang('Whispeak uid'),
+            ''
+        );
+
+        LpItem::createExtraField(
+            self::EXTRAFIELD_LP_ITEM,
+            \ExtraField::FIELD_TYPE_CHECKBOX,
+            $this->get_lang('MarkForSpeechAuthentication'),
+            '0',
+            true,
+            true
+        );
+
+        $extraField = new \ExtraField('question');
+        $params = [
+            'variable' => self::EXTRAFIELD_QUIZ_QUESTION,
+            'field_type' => \ExtraField::FIELD_TYPE_CHECKBOX,
+            'display_text' => $this->get_lang('MarkForSpeechAuthentication'),
+            'default_value' => '0',
+            'changeable' => true,
+            'visible_to_self' => true,
+            'visible_to_others' => false,
+        ];
+
+        $extraField->save($params);
+    }
+
+    /**
+     * Install the Doctrine's entities.
+     *
+     * @throws \Doctrine\ORM\Tools\ToolsException
+     */
+    private function installEntities()
+    {
+        $em = Database::getManager();
+
+        if ($em->getConnection()->getSchemaManager()->tablesExist(['whispeak_log_event'])) {
+            return;
+        }
+
+        $schemaTool = new SchemaTool($em);
+        $schemaTool->createSchema(
+            [
+                $em->getClassMetadata(LogEvent::class),
+                $em->getClassMetadata(LogEventLp::class),
+                $em->getClassMetadata(LogEventQuiz::class),
+            ]
+        );
+    }
+
+    /**
+     * Uninstall extra fields for user, learning path and quiz question.
+     */
+    private function uninstallExtraFields()
+    {
+        $em = Database::getManager();
+
+        $authIdExtrafield = self::getAuthUidExtraField();
+
+        if (!empty($authIdExtrafield)) {
+            $em
+                ->createQuery('DELETE FROM ChamiloCoreBundle:ExtraFieldValues efv WHERE efv.field = :field')
+                ->execute(['field' => $authIdExtrafield]);
+
+            $em->remove($authIdExtrafield);
+            $em->flush();
+        }
+
+        $lpItemExtrafield = self::getLpItemExtraField();
+
+        if (!empty($lpItemExtrafield)) {
+            $em
+                ->createQuery('DELETE FROM ChamiloCoreBundle:ExtraFieldValues efv WHERE efv.field = :field')
+                ->execute(['field' => $lpItemExtrafield]);
+
+            $em->remove($lpItemExtrafield);
+            $em->flush();
+        }
+
+        $quizQuestionExtrafield = self::getQuizQuestionExtraField();
+
+        if (!empty($quizQuestionExtrafield)) {
+            $em
+                ->createQuery('DELETE FROM ChamiloCoreBundle:ExtraFieldValues efv WHERE efv.field = :field')
+                ->execute(['field' => $quizQuestionExtrafield]);
+
+            $em->remove($quizQuestionExtrafield);
+            $em->flush();
+        }
+    }
+
+    /**
+     * Uninstall the Doctrine's entities.
+     */
+    private function uninstallEntities()
+    {
+        $em = Database::getManager();
+
+        if (!$em->getConnection()->getSchemaManager()->tablesExist(['whispeak_log_event'])) {
+            return;
+        }
+
+        $schemaTool = new SchemaTool($em);
+        $schemaTool->dropSchema(
+            [
+                $em->getClassMetadata(LogEvent::class),
+                $em->getClassMetadata(LogEventLp::class),
+                $em->getClassMetadata(LogEventQuiz::class),
+            ]
+        );
+    }
+}
diff --git a/plugin/whispeakauth/WhispeakConditionalLoginHook.php b/plugin/whispeakauth/WhispeakConditionalLoginHook.php
new file mode 100644
index 000000000..b4611b0bf
--- /dev/null
+++ b/plugin/whispeakauth/WhispeakConditionalLoginHook.php
@@ -0,0 +1,59 @@
+
+     * [
+     *     'conditional_function' => function (array $userInfo) {},
+     *     'url' => '',
+     * ]
+     * 
+     * conditional_function returns false to redirect to the url and returns true to continue with the classical login.
+     *
+     * @return array
+     */
+    public function hookConditionalLogin(HookConditionalLoginEventInterface $hook)
+    {
+        return [
+            'conditional_function' => function (array $userInfo) {
+                $isEnrolled = WhispeakAuthPlugin::checkUserIsEnrolled($userInfo['user_id']);
+
+                if (!$isEnrolled) {
+                    return true;
+                }
+
+                $user2fa = (int) ChamiloSession::read(WhispeakAuthPlugin::SESSION_2FA_USER, 0);
+
+                if ($user2fa === (int) $userInfo['user_id']) {
+                    ChamiloSession::erase(WhispeakAuthPlugin::SESSION_2FA_USER);
+
+                    return true;
+                }
+
+                ChamiloSession::write(WhispeakAuthPlugin::SESSION_2FA_USER, $userInfo['user_id']);
+
+                return false;
+            },
+            'url' => api_get_path(WEB_PLUGIN_PATH).$this->getPluginName().'/authentify.php',
+        ];
+    }
+}
diff --git a/plugin/whispeakauth/WhispeakMyStudentsLpTrackingHook.php b/plugin/whispeakauth/WhispeakMyStudentsLpTrackingHook.php
new file mode 100644
index 000000000..85e33278c
--- /dev/null
+++ b/plugin/whispeakauth/WhispeakMyStudentsLpTrackingHook.php
@@ -0,0 +1,67 @@
+isEnabled()) {
+            return [];
+        }
+
+        return [
+            'value' => WhispeakAuthPlugin::create()->get_lang('plugin_title'),
+            'attrs' => ['class' => 'text-center'],
+        ];
+    }
+
+    /**
+     * @throws \Doctrine\ORM\Query\QueryException
+     *
+     * @return array
+     */
+    public function trackingContent(HookMyStudentsLpTrackingEventInterface $hook)
+    {
+        if (false === WhispeakAuthPlugin::create()->isEnabled()) {
+            return [];
+        }
+
+        $data = $hook->getEventData();
+
+        $totalCount = WhispeakAuthPlugin::countAllAttemptsInLearningPath($data['lp_id'], $data['student_id']);
+
+        if (0 === $totalCount) {
+            return [
+                'value' => '-',
+                'attrs' => ['class' => 'text-center'],
+            ];
+        }
+
+        $successCount = WhispeakAuthPlugin::countSuccessAttemptsInLearningPath($data['lp_id'], $data['student_id']);
+
+        $attrs = ['class' => 'text-center '];
+        $attrs['class'] .= $successCount <= $totalCount / 2 ? 'text-danger' : 'text-success';
+
+        return [
+            'value' => Display::tag('strong', "$successCount / $totalCount"),
+            'attrs' => $attrs,
+        ];
+    }
+}
diff --git a/plugin/whispeakauth/WhispeakMyStudentsQuizTrackingHook.php b/plugin/whispeakauth/WhispeakMyStudentsQuizTrackingHook.php
new file mode 100644
index 000000000..1f35bb329
--- /dev/null
+++ b/plugin/whispeakauth/WhispeakMyStudentsQuizTrackingHook.php
@@ -0,0 +1,84 @@
+
+     * [
+     *     'value' => 'Users online',
+     *     'attrs' => ['class' => 'text-center'],
+     * ]
+     * .
+     *
+     * @return array
+     */
+    public function trackingHeader(HookMyStudentsQuizTrackingEventInterface $hook)
+    {
+        if (false === WhispeakAuthPlugin::create()->isEnabled()) {
+            return [];
+        }
+
+        return [
+            'value' => WhispeakAuthPlugin::create()->get_lang('plugin_title'),
+            'attrs' => [
+                'class' => 'text-center',
+            ],
+        ];
+    }
+
+    /**
+     * Return an associative array this value and attributes.
+     * 
+     * [
+     *     'value' => '5 connected users ',
+     *     'attrs' => ['class' => 'text-center text-success'],
+     * ]
+     * .
+     *
+     * @throws \Doctrine\ORM\Query\QueryException
+     *
+     * @return array
+     */
+    public function trackingContent(HookMyStudentsQuizTrackingEventInterface $hook)
+    {
+        if (false === WhispeakAuthPlugin::create()->isEnabled()) {
+            return [];
+        }
+        $data = $hook->getEventData();
+
+        $totalCount = WhispeakAuthPlugin::countAllAttemptsInQuiz($data['quiz_id'], $data['student_id']);
+
+        if (0 === $totalCount) {
+            return [
+                'value' => '-',
+                'attrs' => ['class' => 'text-center'],
+            ];
+        }
+
+        $successCount = WhispeakAuthPlugin::countSuccessAttemptsInQuiz($data['quiz_id'], $data['student_id']);
+
+        $attrs = ['class' => 'text-center '];
+        $attrs['class'] .= $successCount <= $totalCount / 2 ? 'text-danger' : 'text-success';
+
+        return [
+            'value' => Display::tag('strong', "$successCount / $totalCount"),
+            'attrs' => $attrs,
+        ];
+    }
+}
diff --git a/plugin/whispeakauth/admin.php b/plugin/whispeakauth/admin.php
new file mode 100644
index 000000000..c35c21c98
--- /dev/null
+++ b/plugin/whispeakauth/admin.php
@@ -0,0 +1,149 @@
+protectTool();
+
+$form = new FormValidator('frm_filter', 'GET');
+$form->addHeader($plugin->get_lang('ActionRegistryPerUser'));
+$slctUsers = $form->addSelectAjax(
+    'users',
+    get_lang('Users'),
+    [],
+    [
+        'url' => api_get_path(WEB_AJAX_PATH).'user_manager.ajax.php?a=get_user_like',
+        'id' => 'user_id',
+        'multiple' => true,
+    ]
+);
+$form->addDatePicker('date', get_lang('Date'));
+$form->addButtonSearch(get_lang('Search'));
+$form->addRule('users', get_lang('ThisFieldIsRequired'), 'required');
+$form->addRule('date', get_lang('ThisFieldIsRequired'), 'required');
+
+$results = [];
+
+if ($form->validate()) {
+    $formValues = $form->exportValues();
+    $userIds = $formValues['users'] ?: [];
+    /** @var \DateTime $date */
+    $starDate = api_get_utc_datetime($formValues['date'], true, true);
+    $endDate = clone $starDate;
+    $endDate->modify('next day');
+
+    $em = Database::getManager();
+    $repo = $em->getRepository('ChamiloPluginBundle:WhispeakAuth\LogEvent');
+
+    foreach ($userIds as $userId) {
+        $qb = $em->createQueryBuilder();
+        $results[$userId] = $qb
+            ->select('event')
+            ->from('ChamiloPluginBundle:WhispeakAuth\LogEvent', 'event')
+            ->where(
+                $qb->expr()->gte('event.datetime', ':start_date')
+            )
+            ->andWhere(
+                $qb->expr()->lt('event.datetime', ':end_date')
+            )
+            ->andWhere(
+                $qb->expr()->eq('event.user', ':user')
+            )
+            ->setParameters(
+                [
+                    'start_date' => $starDate->format('Y-m-d H:i:s'),
+                    'end_date' => $endDate->format('Y-m-d H:i:s'),
+                    'user' => $userId,
+                ]
+            )
+            ->getQuery()
+            ->getResult();
+    }
+}
+
+$pageContent = '';
+
+/**
+ * @var int              $userId
+ * @var array|LogEvent[] $logEvents
+ */
+foreach ($results as $userId => $logEvents) {
+    if (empty($logEvents)) {
+        continue;
+    }
+
+    $user = $logEvents[0]->getUser();
+
+    $slctUsers->addOption($user->getCompleteNameWithUsername(), $user->getId());
+
+    $tableHeaders = [get_lang('DateTime'), get_lang('Type'), get_lang('Item'), get_lang('Result')];
+    $tableData = [];
+
+    foreach ($logEvents as $i => $logEvent) {
+        $type = '';
+
+        switch (get_class($logEvent)) {
+            case LogEventQuiz::class:
+                $type = get_lang('Question');
+                break;
+            case LogEventLp::class:
+                $type = get_lang('LearningPath');
+                break;
+        }
+
+        $tableData[] = [
+            api_convert_and_format_date($logEvent->getDatetime(), DATE_TIME_FORMAT_SHORT),
+            $type,
+            $logEvent->getTypeString(),
+            $logEvent->getActionStatus() === LogEvent::STATUS_SUCCESS
+                ? Display::span(get_lang('Success'), ['class' => 'text-success'])
+                : Display::span(get_lang('Failed'), ['class' => 'text-danger']),
+        ];
+    }
+
+    $table = new HTML_Table(['class' => 'data_table table table-bordered table-hover table-striped table-condensed']);
+    $table->setHeaders($tableHeaders);
+    $table->setData($tableData);
+    $table->updateColAttributes(0, ['class' => 'text-center']);
+    $table->updateColAttributes(3, ['class' => 'text-center']);
+
+    $pageContent .= Display::page_subheader($user->getCompleteNameWithUsername(), null, 'h4');
+    $pageContent .= $table->toHtml();
+}
+
+$interbreadcrumb[] = [
+    'name' => get_lang('Administration'),
+    'url' => api_get_path(WEB_CODE_PATH).'admin/index.php',
+];
+
+$actionsLeft = '';
+
+if (!empty($results)) {
+    $actionsLeft = Display::url(
+        Display::return_icon('back.png', $plugin->get_lang('Back'), [], ICON_SIZE_MEDIUM),
+        api_get_self()
+    );
+}
+
+$actionsRight = Display::url(
+    Display::return_icon('delete_terms.png', $plugin->get_lang('Revocation'), [], ICON_SIZE_MEDIUM),
+    'revocation.php'
+);
+
+$template = new Template($plugin->get_title());
+$template->assign('actions', Display::toolbarAction('whispeak_admin', [$actionsLeft, $actionsRight]));
+$template->assign(
+    'content',
+    $form->returnForm().PHP_EOL.$pageContent
+);
+$template->display_one_col_template();
diff --git a/plugin/whispeakauth/ajax/authentify_password.php b/plugin/whispeakauth/ajax/authentify_password.php
new file mode 100644
index 000000000..1e583ea36
--- /dev/null
+++ b/plugin/whispeakauth/ajax/authentify_password.php
@@ -0,0 +1,140 @@
+protectTool(false);
+
+$tokenIsValid = Security::check_token();
+
+if (!$tokenIsValid) {
+    WhispeakAuthPlugin::displayNotAllowedMessage();
+}
+
+$maxAttempts = $plugin->getMaxAttempts();
+$failedLogins = ChamiloSession::read(WhispeakAuthPlugin::SESSION_FAILED_LOGINS, 0);
+
+if ($maxAttempts && $failedLogins >= $maxAttempts) {
+    echo Display::return_message($plugin->get_lang('MaxAttemptsReached'), 'warning');
+
+    exit;
+}
+
+$user = api_get_user_entity(api_get_user_id());
+$password = isset($_POST['password']) ? $_POST['password'] : null;
+
+if (empty($password) || empty($user)) {
+    WhispeakAuthPlugin::displayNotAllowedMessage();
+}
+
+if (!in_array($user->getAuthSource(), [PLATFORM_AUTH_SOURCE, CAS_AUTH_SOURCE])) {
+    WhispeakAuthPlugin::displayNotAllowedMessage();
+}
+
+/** @var array $lpItemInfo */
+$lpItemInfo = ChamiloSession::read(WhispeakAuthPlugin::SESSION_LP_ITEM, []);
+/** @var array $quizQuestionInfo */
+$quizQuestionInfo = ChamiloSession::read(WhispeakAuthPlugin::SESSION_QUIZ_QUESTION, []);
+
+$isValidPassword = UserManager::checkPassword($user->getPassword(), $password, $user->getSalt(), $user->getId());
+$isActive = $user->isActive();
+$isExpired = empty($user->getExpirationDate()) || $user->getExpirationDate() > api_get_utc_datetime(null, false, true);
+
+$userPass = true;
+
+if (!$isValidPassword || !$isActive || !$isExpired) {
+    if (!empty($lpItemInfo)) {
+        $plugin->addAttemptInLearningPath(
+            LogEvent::STATUS_FAILED,
+            $user->getId(),
+            $lpItemInfo['lp_item'],
+            $lpItemInfo['lp']
+        );
+    } elseif (!empty($quizQuestionInfo)) {
+        $plugin->addAttemptInQuiz(
+            LogEvent::STATUS_FAILED,
+            $user->getId(),
+            $quizQuestionInfo['question'],
+            $quizQuestionInfo['quiz']
+        );
+    }
+
+    $userPass = false;
+
+    $message = $plugin->get_lang('AuthentifyFailed');
+
+    if (!$isActive) {
+        $message .= PHP_EOL.get_lang('Account inactive');
+    }
+
+    if (!$isExpired) {
+        $message .= PHP_EOL.get_lang('AccountExpired');
+    }
+
+    ChamiloSession::write(WhispeakAuthPlugin::SESSION_FAILED_LOGINS, ++$failedLogins);
+
+    if ($maxAttempts && $failedLogins >= $maxAttempts) {
+        $message .= PHP_EOL.''.$plugin->get_lang('MaxAttemptsReached').'';
+    } else {
+        $message .= PHP_EOL.$plugin->get_lang('TryAgain');
+    }
+
+    echo Display::return_message($message, 'error', false);
+
+    if (!$maxAttempts ||
+        ($maxAttempts && $failedLogins >= $maxAttempts)
+    ) {
+        $userPass = true;
+    }
+} elseif ($isValidPassword) {
+    ChamiloSession::erase(WhispeakAuthPlugin::SESSION_FAILED_LOGINS);
+    ChamiloSession::erase(WhispeakAuthPlugin::SESSION_2FA_USER);
+
+    if (!empty($lpItemInfo)) {
+        $plugin->addAttemptInLearningPath(
+            LogEvent::STATUS_SUCCESS,
+            $user->getId(),
+            $lpItemInfo['lp_item'],
+            $lpItemInfo['lp']
+        );
+    } elseif (!empty($quizQuestionInfo)) {
+        $plugin->addAttemptInQuiz(
+            LogEvent::STATUS_SUCCESS,
+            $user->getId(),
+            $quizQuestionInfo['question'],
+            $quizQuestionInfo['quiz']
+        );
+    }
+
+    echo Display::return_message($plugin->get_lang('AuthentifySuccess'), 'success');
+}
+
+if ($userPass) {
+    $url = '';
+
+    ChamiloSession::erase(WhispeakAuthPlugin::SESSION_FAILED_LOGINS);
+    ChamiloSession::erase(WhispeakAuthPlugin::SESSION_2FA_USER);
+
+    if ($lpItemInfo) {
+        ChamiloSession::erase(WhispeakAuthPlugin::SESSION_LP_ITEM);
+
+        $url = $lpItemInfo['src'];
+    } elseif ($quizQuestionInfo) {
+        $quizQuestionInfo['passed'] = true;
+        $url = api_get_path(WEB_CODE_PATH).'exercise/exercise_submit.php?'.$quizQuestionInfo['url_params'];
+
+        ChamiloSession::write(WhispeakAuthPlugin::SESSION_QUIZ_QUESTION, $quizQuestionInfo);
+    }
+
+    if (!empty($url)) {
+        echo '
+            
+        ';
+    }
+}
diff --git a/plugin/whispeakauth/ajax/record_audio.php b/plugin/whispeakauth/ajax/record_audio.php
new file mode 100644
index 000000000..53d120812
--- /dev/null
+++ b/plugin/whispeakauth/ajax/record_audio.php
@@ -0,0 +1,48 @@
+ajax());
+    } catch (Exception $exception) {
+        echo json_encode(
+            [
+                'resultHtml' => Display::return_message($exception->getMessage(), 'error', false),
+            ]
+        );
+    }
+    exit;
+}
+
+if ($isAuthentify) {
+    $controller = new AuthenticationController();
+
+    header('Content-Type: application/json');
+
+    try {
+        echo json_encode($controller->ajax());
+    } catch (Exception $exception) {
+        echo json_encode(
+            [
+                'resultHtml' => Display::return_message($exception->getMessage(), 'error', false),
+            ]
+        );
+    }
+}
diff --git a/plugin/whispeakauth/assets/js/RecordAudio.js b/plugin/whispeakauth/assets/js/RecordAudio.js
new file mode 100644
index 000000000..35dfda001
--- /dev/null
+++ b/plugin/whispeakauth/assets/js/RecordAudio.js
@@ -0,0 +1,191 @@
+/* For licensing terms, see /license.txt */
+
+window.RecordAudio = (function () {
+    var timerInterval = 0,
+        $txtTimer = null;
+
+    function startTimer() {
+        stopTimer();
+
+        $txtTimer = $('#txt-timer');
+
+        $txtTimer.text('00:00').css('visibility', 'visible');
+
+        var timerData = {
+            hour: 0,
+            minute: 0,
+            second: 0
+        };
+
+        timerInterval = setInterval(function(){
+            timerData.second++;
+
+            if (timerData.second >= 60) {
+                timerData.second = 0;
+                timerData.minute++;
+            }
+
+
+            $txtTimer.text(
+                function () {
+                    var txtSeconds = timerData.minute < 10 ? '0' + timerData.minute : timerData.minute,
+                        txtMinutes = timerData.second < 10 ? '0' + timerData.second : timerData.second;
+
+                    return txtSeconds + ':' + txtMinutes;
+                }
+            );
+        }, 1000);
+    }
+
+    function stopTimer() {
+        if (timerInterval) {
+            clearInterval(timerInterval);
+        }
+
+        if ($txtTimer) {
+            $txtTimer.css('visibility', 'hidden');
+        }
+    }
+
+    function useRecordRTC(rtcInfo) {
+        $(rtcInfo.blockId).show();
+
+        var mediaConstraints = {audio: true},
+            localStream = null,
+            recordRTC = null,
+            btnStart = $(rtcInfo.btnStartId),
+            btnStop = $(rtcInfo.btnStopId),
+            tagAudio = $(rtcInfo.plyrPreviewId);
+
+        function saveAudio() {
+            var recordedBlob = recordRTC.getBlob();
+
+            if (!recordedBlob) {
+                return;
+            }
+
+            var btnStopText = btnStop.html();
+            var fileExtension = recordedBlob.type.split('/')[1];
+
+            var formData = new FormData();
+            formData.append('audio', recordedBlob, 'audio.' + fileExtension);
+
+            for (var prop in rtcInfo.data) {
+                if (!rtcInfo.data.hasOwnProperty(prop)) {
+                    continue;
+                }
+
+                formData.append(prop, rtcInfo.data[prop]);
+            }
+
+            $.ajax({
+                url: _p.web_plugin + 'whispeakauth/ajax/record_audio.php',
+                data: formData,
+                processData: false,
+                contentType: false,
+                type: 'POST',
+                beforeSend: function () {
+                    btnStart.prop('disabled', true);
+                    btnStop.prop('disabled', true).text(btnStop.data('loadingtext'));
+                }
+            }).done(function (response) {
+                if (response.text) {
+                    $('#txt-sample-text').text(response.text);
+                }
+
+                $('#messages-deck').html(response.resultHtml);
+
+                if ($('#messages-deck > .alert.alert-success').length > 0) {
+                    tagAudio.parents('#audio-wrapper').addClass('hidden').removeClass('show');
+                } else {
+                    tagAudio.parents('#audio-wrapper').removeClass('hidden').addClass('show');
+                }
+
+                btnStop.prop('disabled', true).html(btnStopText).parent().addClass('hidden');
+
+                if ($('#messages-deck > .alert.alert-success').length > 0 ||
+                    $('#messages-deck > .alert.alert-warning [data-reach-attempts]').length > 0
+                ) {
+                    btnStart.prop('disabled', true);
+                } else {
+                    btnStart.prop('disabled', false);
+                }
+
+                btnStart.parent().removeClass('hidden');
+            });
+        }
+
+        btnStart.on('click', function () {
+            tagAudio.prop('src', '');
+
+            function successCallback(stream) {
+                localStream = stream;
+
+                recordRTC = RecordRTC(stream, {
+                    recorderType: RecordRTC.StereoAudioRecorder,
+                    type: 'audio',
+                    mimeType: 'audio/wav',
+                    numberOfAudioChannels: 2
+                });
+                recordRTC.startRecording();
+
+                btnStop.prop('disabled', false).parent().removeClass('hidden');
+                btnStart.prop('disabled', true).parent().addClass('hidden');
+                tagAudio.removeClass('show').parents('#audio-wrapper').addClass('hidden');
+
+                $('.fa-microphone').addClass('text-danger');
+
+                startTimer();
+            }
+
+            function errorCallback(error) {
+                alert(error);
+            }
+
+            if(!!(navigator.getUserMedia || navigator.webkitGetUserMedia || navigator.mozGetUserMedia)) {
+                navigator.getUserMedia = navigator.getUserMedia || navigator.webkitGetUserMedia || navigator.mozGetUserMedia;
+                navigator.getUserMedia(mediaConstraints, successCallback, errorCallback);
+                return;
+            }
+
+            navigator.mediaDevices.getUserMedia(mediaConstraints)
+                .then(successCallback)
+                .catch(errorCallback);
+        });
+
+        btnStop.on('click', function () {
+            if (!recordRTC) {
+                return;
+            }
+
+            $('.fa-microphone').removeClass('text-danger');
+
+            stopTimer();
+
+            recordRTC.stopRecording(function (audioURL) {
+                tagAudio.prop('src', audioURL);
+
+                localStream.getTracks()[0].stop();
+
+                saveAudio();
+            });
+        });
+    }
+
+    return {
+        init: function (rtcInfo) {
+            $(rtcInfo.blockId).hide();
+
+            var userMediaEnabled = (navigator.mediaDevices && navigator.mediaDevices.getUserMedia) ||
+                !!navigator.webkitGetUserMedia ||
+                !!navigator.mozGetUserMedia ||
+                !!navigator.getUserMedia;
+
+            if (!userMediaEnabled) {
+                return;
+            }
+
+            useRecordRTC(rtcInfo);
+        }
+    };
+})();
\ No newline at end of file
diff --git a/plugin/whispeakauth/authentify.php b/plugin/whispeakauth/authentify.php
new file mode 100644
index 000000000..114ac052f
--- /dev/null
+++ b/plugin/whispeakauth/authentify.php
@@ -0,0 +1,17 @@
+index();
+} catch (Exception $exception) {
+    api_not_allowed(
+        true,
+        Display::return_message($exception->getMessage(), 'warning')
+    );
+}
diff --git a/plugin/whispeakauth/authentify_password.php b/plugin/whispeakauth/authentify_password.php
new file mode 100644
index 000000000..ab450adfe
--- /dev/null
+++ b/plugin/whispeakauth/authentify_password.php
@@ -0,0 +1,79 @@
+protectTool();
+
+$userId = ChamiloSession::read(WhispeakAuthPlugin::SESSION_2FA_USER, 0) ?: api_get_user_id();
+
+/** @var array $lpItemInfo */
+$lpItemInfo = ChamiloSession::read(WhispeakAuthPlugin::SESSION_LP_ITEM, []);
+/** @var learnpath $oLp */
+$oLp = ChamiloSession::read('oLP', null);
+/** @var array $lpQuestionInfo */
+$lpQuestionInfo = ChamiloSession::read(WhispeakAuthPlugin::SESSION_QUIZ_QUESTION, []);
+/** @var Exercise $objExercise */
+$objExercise = ChamiloSession::read('objExercise', null);
+
+$isAuthOnLp = !empty($lpItemInfo) && !empty($oLp);
+$isAuthOnQuiz = !empty($lpQuestionInfo) && !empty($objExercise);
+
+$showFullPage = !$isAuthOnLp && !$isAuthOnQuiz;
+
+if (empty($userId)) {
+    api_not_allowed($showFullPage);
+}
+
+if (!empty($lpQuestionInfo) && empty($lpItemInfo)) {
+    echo Display::return_message(
+        $plugin->get_lang('MaxAttemptsReached').'
    '
+        .''.$plugin->get_lang('LoginWithUsernameAndPassword').'',
+        'warning',
+        false
+    );
+}
+
+$form = new FormValidator(
+    'form-login',
+    'POST',
+    api_get_path(WEB_PLUGIN_PATH).'whispeakauth/ajax/authentify_password.php',
+    null,
+    null,
+    FormValidator::LAYOUT_BOX_NO_LABEL
+);
+$form->addElement(
+    'password',
+    'password',
+    get_lang('Pass'),
+    ['id' => 'password', 'icon' => 'lock fa-fw', 'placeholder' => get_lang('Pass')]
+);
+$form->addHidden('sec_token', '');
+$form->setConstants(['sec_token' => Security::get_token()]);
+$form->addButton('submitAuth', get_lang('LoginEnter'), 'check', 'primary', 'default', 'btn-block');
+
+$template = new Template(
+    !$showFullPage ? '' : $plugin->get_title(),
+    $showFullPage,
+    $showFullPage,
+    false,
+    true,
+    false
+);
+$template->assign('form', $form->returnForm());
+
+$content = $template->fetch('whispeakauth/view/authentify_password.html.twig');
+
+if (!empty($lpQuestionInfo) && empty($lpItemInfo)) {
+    echo $content;
+
+    exit;
+}
+
+$template->assign('header', $plugin->get_title());
+$template->assign('content', $content);
+$template->display_one_col_template();
diff --git a/plugin/whispeakauth/enrollment.php b/plugin/whispeakauth/enrollment.php
new file mode 100644
index 000000000..1eb4e5f0f
--- /dev/null
+++ b/plugin/whispeakauth/enrollment.php
@@ -0,0 +1,21 @@
+index();
+} catch (Exception $exception) {
+    api_not_allowed(
+        true,
+        Display::return_message($exception->getMessage(), 'warning')
+    );
+}
diff --git a/plugin/whispeakauth/index.php b/plugin/whispeakauth/index.php
new file mode 100644
index 000000000..420d242d3
--- /dev/null
+++ b/plugin/whispeakauth/index.php
@@ -0,0 +1,14 @@
+toolIsEnabled()) {
+    echo Display::toolbarButton(
+        $plugin->get_lang('SpeechAuthentication'),
+        api_get_path(WEB_PLUGIN_PATH).'whispeakauth/authentify.php',
+        'sign-in',
+        'info',
+        ['class' => 'btn-block']
+    );
+}
diff --git a/plugin/whispeakauth/install.php b/plugin/whispeakauth/install.php
new file mode 100644
index 000000000..adf5155af
--- /dev/null
+++ b/plugin/whispeakauth/install.php
@@ -0,0 +1,4 @@
+install();
diff --git a/plugin/whispeakauth/lang/english.php b/plugin/whispeakauth/lang/english.php
new file mode 100644
index 000000000..68061492e
--- /dev/null
+++ b/plugin/whispeakauth/lang/english.php
@@ -0,0 +1,48 @@
+$_configuration[\'whispeak_auth_enabled\'] = true; in the configuration.php file';
+$strings['api_url'] = 'API URL';
+$strings['api_url_help'] = 'http://api.whispeak.io:8080/v1/';
+$strings['token'] = 'API key';
+$strings['max_attempts'] = 'Max attempts';
+$strings['max_attempts_help'] = '(Optional) If the Whispeak authentication is failed x times, then ask and verify the password of the user';
+$strings['2fa'] = 'Two-Factor Authentication';
+$strings['2fa_help'] = 'Allows extend the login page with a Two-Factor Authentication process. After the classic login, the user must authenticate through Whispeak.';
+$strings['ActionRegistryPerUser'] = 'Action registry per user';
+
+$strings['EnrollmentSampleText'] = 'The famous Mona Lisa painting was painted by Leonardo Da Vinci.';
+$strings['AuthentifySampleText1'] = 'Dropping Like Flies.';
+$strings['AuthentifySampleText2'] = 'Keep Your Eyes Peeled.';
+$strings['AuthentifySampleText3'] = 'The fox screams at midnight.';
+$strings['AuthentifySampleText4'] = 'Go Out On a Limb.';
+$strings['AuthentifySampleText5'] = 'Under the Water.';
+$strings['AuthentifySampleText6'] = 'Barking Up The Wrong Tree.';
+$strings['RepeatThisPhrase'] = 'Allow audio recording and then read this sentence out loud:';
+$strings['SpeechAuthAlreadyEnrolled'] = 'Speech authentication already enrolled previously.';
+$strings['SpeechAuthNotEnrolled'] = 'Speech authentication not enrolled previously.';
+$strings['SpeechAuthentication'] = 'Speech authentication';
+$strings['EnrollmentFailed'] = 'Enrollment failed.';
+$strings['EnrollmentSuccess'] = 'Enrollment success.';
+$strings['AuthentifyFailed'] = 'Login failed.';
+$strings['AuthentifySuccess'] = 'Authentication success!';
+$strings['TryAgain'] = 'Try again';
+$strings['MaxAttemptsReached'] = 'You reached the maximum number of attempts allowed.';
+$strings['LoginWithUsernameAndPassword'] = 'You should login using the username and password.';
+$strings['YouNeedToIdentifyYourselfToAnswerThisQuestion'] = 'You need to identify yourself to answer this question.';
+$strings['IdentifyMe'] = 'Identify me';
+$strings['PleaseWaitWhileLoading'] = "Please wait while loading...";
+$strings['Quality'] = 'Quality';
+$strings['Failed'] = "Failed";
+$strings['ActivityId'] = "Activity ID";
+$strings['Success'] = "Success";
+$strings['MarkForSpeechAuthentication'] = 'Mark it for speech authentication';
+$strings['EnrollmentTitle'] = "Enrollment to generate voice print with Whispeak";
+$strings['Revocation'] = "Revocation";
+$strings['DeleteEnrollments'] = "Delete enrollments";
+$strings['NoEnrollment'] = "No enrollment.";
+$strings['EnrollmentDeleted'] = "Enrollment deleted";
diff --git a/plugin/whispeakauth/lang/french.php b/plugin/whispeakauth/lang/french.php
new file mode 100644
index 000000000..990d0a7f1
--- /dev/null
+++ b/plugin/whispeakauth/lang/french.php
@@ -0,0 +1,48 @@
+Ajoutez $_configuration[\'whispeak_auth_enabled\'] = true; dans le fichier configuration.php
    ';
+$strings['api_url'] = 'URL de l\'API';
+$strings['api_url_help'] = 'http://api.whispeak.io:8080/v1.1/';
+$strings['token'] = 'Clef API';
+$strings['max_attempts'] = 'Tentatives maximum';
+$strings['max_attempts_help'] = '(Optionnel) Si l\'authentification Whispeak échoue x fois, alors abandonner et demander le mot de passe de l\'utilisateur';
+$strings['2fa'] = 'Authentification à 2 facteurs (2FA)';
+$strings['2fa_help'] = 'Autoriser l\'extension du formulaire de login par une page d\'authentification forte. Après le login classique, l\'utilisateur/trice devra aussi s\'authentifier au travers de Whispeak.';
+$strings['ActionRegistryPerUser'] = 'Registre d\'actions par utilisateur';
+
+$strings['EnrollmentSampleText'] = 'Le fameux chef-d\'oeuvre Mona Lisa a été peint par Léonardo da Vinci.';
+$strings['AuthentifySampleText1'] = 'Tomber comme des mouches.';
+$strings['AuthentifySampleText2'] = 'Restez vigilants.';
+$strings['AuthentifySampleText3'] = 'Le renard hurle à minuit.';
+$strings['AuthentifySampleText4'] = 'Errer dans la campagne.';
+$strings['AuthentifySampleText5'] = 'Sous l\'océan.';
+$strings['AuthentifySampleText6'] = 'Prendre la mouche.';
+$strings['RepeatThisPhrase'] = 'Autorisez l\'enregistrement audio puis lisez cette phrase à voix haute :';
+$strings['SpeechAuthAlreadyEnrolled'] = 'L\'authentification de voix a déjà réussi précédemment.';
+$strings['SpeechAuthNotEnrolled'] = 'L\'authentification de voix n\'a pas encore été enregistrée.';
+$strings['SpeechAuthentication'] = 'Authentification par la voix';
+$strings['EnrollmentFailed'] = 'Échec à l\'inscription.';
+$strings['EnrollmentSuccess'] = 'Inscription réussie.';
+$strings['AuthentifyFailed'] = 'Échec de l\'authentification.';
+$strings['AuthentifySuccess'] = 'Authentification réussie!';
+$strings['TryAgain'] = 'Essayez encore';
+$strings['MaxAttemptsReached'] = 'Vous avez atteint le nombre maximum de tentatives autorisées.';
+$strings['LoginWithUsernameAndPassword'] = 'Authentifiez-vous en utilisant votre mot de passe.';
+$strings['YouNeedToIdentifyYourselfToAnswerThisQuestion'] = 'Vous devez vous authentifier pour répondre à cette question.';
+$strings['IdentifyMe'] = 'M\'identifier';
+$strings['PleaseWaitWhileLoading'] = 'Connexion au serveur d\'authentification. Veuillez patienter...';
+$strings['Quality'] = 'Quality';
+$strings['Failed'] = "Failed";
+$strings['ActivityId'] = "Activity ID";
+$strings['Success'] = "Success";
+$strings['MarkForSpeechAuthentication'] = 'Cocher pour l\'authentification par la voix';
+$strings['EnrollmentTitle'] = "Enrôlement pour générer l'empreinte vocale avec Whispeak";
+$strings['Revocation'] = "Révocation";
+$strings['DeleteEnrollments'] = "Supprimer les inscriptions";
+$strings['NoEnrollment'] = "Aucune inscription";
+$strings['EnrollmentDeleted'] = "Inscription supprimée.";
diff --git a/plugin/whispeakauth/lang/spanish.php b/plugin/whispeakauth/lang/spanish.php
new file mode 100644
index 000000000..1b5a389ae
--- /dev/null
+++ b/plugin/whispeakauth/lang/spanish.php
@@ -0,0 +1,48 @@
+Agrega $_configuration[\'whispeak_auth_enabled\'] = true; al archivo configuration.php
    ';
+$strings['api_url'] = 'URL del API';
+$strings['api_url_help'] = 'http://api.whispeak.io:8080/v1/';
+$strings['token'] = 'Llave del API';
+$strings['max_attempts'] = 'Máximo de intentos';
+$strings['max_attempts_help'] = '(Opcional) Si la autenticación de Whispeak falla x intentos, preguntar y verificar la contraseña del usuario';
+$strings['2fa'] = 'Autenticación en dos factores';
+$strings['2fa_help'] = 'Permite extender la página de inicio de sesión con un proceso de dos factores. Después del inicio de sesión clásico, el usuario deberá autenticarse a través de Whispeak.';
+$strings['ActionRegistryPerUser'] = 'Registro de acciones por usuario';
+
+$strings['EnrollmentSampleText'] = 'El famoso cuadro de Mona Lisa fue pintado por Leonardo Da Vinci.';
+$strings['AuthentifySampleText1'] = 'Cayendo como moscas.';
+$strings['AuthentifySampleText2'] = 'Mantén tus ojos abiertos.';
+$strings['AuthentifySampleText3'] = 'El zorro grita a medianoche.';
+$strings['AuthentifySampleText4'] = 'Ir por las ramas.';
+$strings['AuthentifySampleText5'] = 'Debajo del agua.';
+$strings['AuthentifySampleText6'] = 'Ladrando al árbol equivocado.';
+$strings['RepeatThisPhrase'] = 'Permita la grabación de audio y luego lea esta oración en voz alta:';
+$strings['SpeechAuthAlreadyEnrolled'] = 'Autenticación de voz registrada anteriormente.';
+$strings['SpeechAuthNotEnrolled'] = 'Autenticación de voz no registrada previamente.';
+$strings['SpeechAuthentication'] = 'Atenticación con voz';
+$strings['EnrollmentFailed'] = 'Inscripción fallida.';
+$strings['EnrollmentSuccess'] = 'Inscripción correcta.';
+$strings['AuthentifyFailed'] = 'Inicio de sesión fallido.';
+$strings['AuthentifySuccess'] = '¡Autenticación correcta!';
+$strings['TryAgain'] = 'Intente de nuevo.';
+$strings['MaxAttemptsReached'] = 'Ha alcanzado el número máximo de intentos permitidos.';
+$strings['LoginWithUsernameAndPassword'] = 'Debe iniciar sesión usando su nombre de usuario y contraseña.';
+$strings['YouNeedToIdentifyYourselfToAnswerThisQuestion'] = 'Necesita identificarse para responder esta pregunta.';
+$strings['IdentifyMe'] = 'Identificarme';
+$strings['PleaseWaitWhileLoading'] = "Por favor, espere mientras dure la carga...";
+$strings['Quality'] = 'Calidad';
+$strings['Failed'] = "Fallido";
+$strings['ActivityId'] = "Identificador de actividad";
+$strings['Success'] = "Satisfactotio";
+$strings['MarkForSpeechAuthentication'] = 'Marcarlo para autenticación con voz';
+$strings['EnrollmentTitle'] = "Inscripción para generar huella de voz con Whispeak";
+$strings['Revocation'] = "Revocación";
+$strings['DeleteEnrollments'] = "Eliminar inscripciones";
+$strings['NoEnrollment'] = "Sin inscripción.";
+$strings['EnrollmentDeleted'] = "Inscripción anulada.";
diff --git a/plugin/whispeakauth/plugin.php b/plugin/whispeakauth/plugin.php
new file mode 100644
index 000000000..c990a9158
--- /dev/null
+++ b/plugin/whispeakauth/plugin.php
@@ -0,0 +1,4 @@
+get_info();
diff --git a/plugin/whispeakauth/revocation.php b/plugin/whispeakauth/revocation.php
new file mode 100644
index 000000000..675ced4bd
--- /dev/null
+++ b/plugin/whispeakauth/revocation.php
@@ -0,0 +1,94 @@
+protectTool();
+
+$pageContent = '';
+
+$form = new FormValidator('frm_revocation', 'GET');
+$form->setAttribute('onsubmit', "return confirm('".addslashes(get_lang('AreYouSureToDelete'))."');");
+$slctUsers = $form->addSelectAjax(
+    'users',
+    get_lang('Users'),
+    [],
+    [
+        'url' => api_get_path(WEB_AJAX_PATH).'user_manager.ajax.php?a=get_user_like',
+        'id' => 'user_id',
+        'multiple' => true,
+    ]
+);
+$form->addButton('asubmit', $plugin->get_lang('DeleteEnrollments'), 'times', 'danger');
+$form->addRule('users', get_lang('ThisFieldIsRequired'), 'required');
+
+$userIds = [];
+
+if ($form->validate()) {
+    $formValues = $form->exportValues();
+    $userIds = $formValues['users'] ?: [];
+
+    /** @var int $userId */
+    foreach ($userIds as $userId) {
+        $user = api_get_user_entity($userId);
+
+        if (null === $user) {
+            continue;
+        }
+
+        $slctUsers->addOption($user->getCompleteNameWithUsername(), $user->getId());
+
+        $request = new ApiRequest();
+
+        $pageContent .= Display::page_subheader($user->getCompleteNameWithUsername(), null, 'h4');
+
+        try {
+            $request->deleteEnrollment($user);
+
+            $response = WhispeakAuthPlugin::deleteEnrollment($user->getId());
+
+            $pageContent .= Display::return_message(
+                $plugin->get_lang('EnrollmentDeleted'),
+                'success'
+            );
+        } catch (Exception $e) {
+            $pageContent .= Display::return_message(
+                $e->getMessage(),
+                'error'
+            );
+        }
+    }
+}
+
+$interbreadcrumb[] = [
+    'name' => get_lang('Administration'),
+    'url' => api_get_path(WEB_CODE_PATH).'admin/index.php',
+];
+$interbreadcrumb[] = [
+    'name' => $plugin->get_title(),
+    'url' => 'admin.php',
+];
+
+$actionsLeft = Display::url(
+    Display::return_icon('back.png', $plugin->get_lang('Back'), [], ICON_SIZE_MEDIUM),
+    'admin.php'
+);
+
+$pageTitle = $plugin->get_lang('Revocation');
+
+$template = new Template($pageTitle);
+$template->assign('actions', Display::toolbarAction('whispeak_admin', [$actionsLeft]));
+$template->assign('header', $pageTitle);
+$template->assign(
+    'content',
+    $form->returnForm().PHP_EOL.$pageContent
+);
+$template->display_one_col_template();
diff --git a/plugin/whispeakauth/uninstall.php b/plugin/whispeakauth/uninstall.php
new file mode 100644
index 000000000..4f811df4d
--- /dev/null
+++ b/plugin/whispeakauth/uninstall.php
@@ -0,0 +1,4 @@
+uninstall();
diff --git a/plugin/whispeakauth/view/authentify_password.html.twig b/plugin/whispeakauth/view/authentify_password.html.twig
new file mode 100644
index 000000000..236859a6c
--- /dev/null
+++ b/plugin/whispeakauth/view/authentify_password.html.twig
@@ -0,0 +1,44 @@
+
    
+    
    
+        {{ form }}
+
+        
    
+
+        
    
+    
    
+
    
+
+
diff --git a/plugin/whispeakauth/view/authentify_recorder.html.twig b/plugin/whispeakauth/view/authentify_recorder.html.twig
new file mode 100644
index 000000000..a47675112
--- /dev/null
+++ b/plugin/whispeakauth/view/authentify_recorder.html.twig
@@ -0,0 +1,44 @@
+{% extends 'whispeakauth/view/record_audio.html.twig' %}
+
+{% block intro %}
+    {% if show_form %}
+        
    
+            
    
+                
+                
    
+                    
+                
    
+            
    
+        
    
+
+        
    
+    {% endif %}
+
+    {{ parent() }}
+{% endblock %}
+
+{% block config_data %}
+    {% if show_form %}
+        $('#username').on('change', function () {
+            $('#record-audio-recordrtc, #btn-start-record, #btn-stop-record, #btn-save-record').off('click', '');
+    {% endif %}
+        RecordAudio.init(
+            {
+                blockId: '#record-audio-recordrtc',
+                btnStartId: '#btn-start-record',
+                btnStopId: '#btn-stop-record',
+                btnSaveId: '#btn-save-record',
+                plyrPreviewId: '#record-preview',
+                data: {
+                    action: 'authentify',
+                    username: $('#username').val()
+                }
+            }
+        );
+
+    {% if show_form %}
+        });
+    {% endif %}
+{% endblock %}
diff --git a/plugin/whispeakauth/view/quiz_question.html.twig b/plugin/whispeakauth/view/quiz_question.html.twig
new file mode 100644
index 000000000..0cd394a43
--- /dev/null
+++ b/plugin/whispeakauth/view/quiz_question.html.twig
@@ -0,0 +1,45 @@
+
    
+    
    {{ 'YouNeedToIdentifyYourselfToAnswerThisQuestion'|get_plugin_lang('WhispeakAuthPlugin') }}
    
+
+    
+
    
+
+
diff --git a/plugin/whispeakauth/view/record_audio.html.twig b/plugin/whispeakauth/view/record_audio.html.twig
new file mode 100644
index 000000000..42d6cfa6b
--- /dev/null
+++ b/plugin/whispeakauth/view/record_audio.html.twig
@@ -0,0 +1,59 @@
+
    
+    
    
+        {% block intro %}
+            
    {{ 'RepeatThisPhrase'|get_plugin_lang('WhispeakAuthPlugin') }}
    
+            
    
+                
    
+                    
    
+                        
+                        
+                    
    
+                    
    
+                        
    {{ sample_text }}
    
+                    
    
+                
    
+            
    
+        {% endblock %}
+
+        
    
+            
    
+                
+            
    
+            
+        
    
+    
    
+    
    
+        
    
+        
    
+        
+    
    
+
    
+
+
diff --git a/plugin/xapi/.htaccess b/plugin/xapi/.htaccess
new file mode 100644
index 000000000..a3851a941
--- /dev/null
+++ b/plugin/xapi/.htaccess
@@ -0,0 +1 @@
+AcceptPathInfo On
\ No newline at end of file
diff --git a/plugin/xapi/README.md b/plugin/xapi/README.md
new file mode 100644
index 000000000..64a7c88c2
--- /dev/null
+++ b/plugin/xapi/README.md
@@ -0,0 +1,88 @@
+# Experience API (xAPI)
+
+Allows you to connect to an external Learning Record Store and use activities with the xAPI standard.
+
+> You can import and use TinCan packages.
+> Import CMI5 packages is to be considered a Beta state and still in development. 
+
+**Configuration**
+
+Set LRS endpoint, username and password to integrate an external LRS in Chamilo LMS.
+
+The fields "Learning path item viewed", "Learning path ended", "Quiz question answered" and "Quiz ended" allow enabling
+hooks when the user views an item in learning path, completes a learning path, answers a quiz question and ends the exam.
+
+The statements generated with these hooks are logged in Chamilo database, waiting to be sent to the LRS by a cron job.
+The cron job to configure on your server is located in `CHAMILO_PATH/plugin/xapi/cron/send_statements.php`.
+
+**Use the Statement API from Chamilo LMS**
+
+You can use xAPI's "Statement API" to save some statements from another service.
+You need to create credentials (username/password) to do this. First you need to enable the "menu_administrator" region
+in the plugin configuration. You will then be able to create the credentials with the new page "Experience API (xAPI)"
+inside de Plugins block in the Administration panel.
+The endpoint for the statements API is "https://CHAMILO_DOMAIN/plugin/xapi/lrs.php/";
+
+```mysql
+CREATE TABLE xapi_attachment (identifier INT AUTO_INCREMENT NOT NULL, statement_id VARCHAR(255) DEFAULT NULL, usageType VARCHAR(255) NOT NULL, contentType VARCHAR(255) NOT NULL, length INT NOT NULL, sha2 VARCHAR(255) NOT NULL, display LONGTEXT NOT NULL COMMENT '(DC2Type:json)', hasDescription TINYINT(1) NOT NULL, description LONGTEXT DEFAULT NULL COMMENT '(DC2Type:json)', fileUrl VARCHAR(255) DEFAULT NULL, content LONGTEXT DEFAULT NULL, INDEX IDX_7148C9A1849CB65B (statement_id), PRIMARY KEY(identifier)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+CREATE TABLE xapi_object (identifier INT AUTO_INCREMENT NOT NULL, group_id INT DEFAULT NULL, actor_id INT DEFAULT NULL, verb_id INT DEFAULT NULL, object_id INT DEFAULT NULL, type VARCHAR(255) DEFAULT NULL, activityId VARCHAR(255) DEFAULT NULL, hasActivityDefinition TINYINT(1) DEFAULT NULL, hasActivityName TINYINT(1) DEFAULT NULL, activityName LONGTEXT DEFAULT NULL COMMENT '(DC2Type:json)', hasActivityDescription TINYINT(1) DEFAULT NULL, activityDescription LONGTEXT DEFAULT NULL COMMENT '(DC2Type:json)', activityType VARCHAR(255) DEFAULT NULL, activityMoreInfo VARCHAR(255) DEFAULT NULL, mbox VARCHAR(255) DEFAULT NULL, mboxSha1Sum VARCHAR(255) DEFAULT NULL, openId VARCHAR(255) DEFAULT NULL, accountName VARCHAR(255) DEFAULT NULL, accountHomePage VARCHAR(255) DEFAULT NULL, name VARCHAR(255) DEFAULT NULL, referenced_statement_id VARCHAR(255) DEFAULT NULL, activityExtensions_id INT DEFAULT NULL, parentContext_id INT DEFAULT NULL, groupingContext_id INT DEFAULT NULL, categoryContext_id INT DEFAULT NULL, otherContext_id INT DEFAULT NULL, UNIQUE INDEX UNIQ_E2B68640303C7F1D (activityExtensions_id), INDEX IDX_E2B68640FE54D947 (group_id), UNIQUE INDEX UNIQ_E2B6864010DAF24A (actor_id), UNIQUE INDEX UNIQ_E2B68640C1D03483 (verb_id), UNIQUE INDEX UNIQ_E2B68640232D562B (object_id), INDEX IDX_E2B68640988A4CEC (parentContext_id), INDEX IDX_E2B686404F542860 (groupingContext_id), INDEX IDX_E2B68640AEA1B132 (categoryContext_id), INDEX IDX_E2B68640B73EEAB7 (otherContext_id), PRIMARY KEY(identifier)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+CREATE TABLE xapi_result (identifier INT AUTO_INCREMENT NOT NULL, extensions_id INT DEFAULT NULL, hasScore TINYINT(1) NOT NULL, scaled DOUBLE PRECISION DEFAULT NULL, raw DOUBLE PRECISION DEFAULT NULL, min DOUBLE PRECISION DEFAULT NULL, max DOUBLE PRECISION DEFAULT NULL, success TINYINT(1) DEFAULT NULL, completion TINYINT(1) DEFAULT NULL, response VARCHAR(255) DEFAULT NULL, duration VARCHAR(255) DEFAULT NULL, UNIQUE INDEX UNIQ_5971ECBFD0A19400 (extensions_id), PRIMARY KEY(identifier)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+CREATE TABLE xapi_verb (identifier INT AUTO_INCREMENT NOT NULL, id VARCHAR(255) NOT NULL, display LONGTEXT NOT NULL COMMENT '(DC2Type:json)', PRIMARY KEY(identifier)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+CREATE TABLE xapi_extensions (identifier INT AUTO_INCREMENT NOT NULL, extensions LONGTEXT NOT NULL COMMENT '(DC2Type:json)', PRIMARY KEY(identifier)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+CREATE TABLE xapi_context (identifier INT AUTO_INCREMENT NOT NULL, instructor_id INT DEFAULT NULL, team_id INT DEFAULT NULL, extensions_id INT DEFAULT NULL, registration VARCHAR(255) DEFAULT NULL, hasContextActivities TINYINT(1) DEFAULT NULL, revision VARCHAR(255) DEFAULT NULL, platform VARCHAR(255) DEFAULT NULL, language VARCHAR(255) DEFAULT NULL, statement VARCHAR(255) DEFAULT NULL, UNIQUE INDEX UNIQ_3D7771908C4FC193 (instructor_id), UNIQUE INDEX UNIQ_3D777190296CD8AE (team_id), UNIQUE INDEX UNIQ_3D777190D0A19400 (extensions_id), PRIMARY KEY(identifier)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+CREATE TABLE xapi_actor (identifier INT AUTO_INCREMENT NOT NULL, type VARCHAR(255) DEFAULT NULL, mbox VARCHAR(255) DEFAULT NULL, mboxSha1Sum VARCHAR(255) DEFAULT NULL, openId VARCHAR(255) DEFAULT NULL, accountName VARCHAR(255) DEFAULT NULL, accountHomePage VARCHAR(255) DEFAULT NULL, name VARCHAR(255) DEFAULT NULL, members VARCHAR(255) NOT NULL, PRIMARY KEY(identifier)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+CREATE TABLE xapi_statement (id VARCHAR(255) NOT NULL, actor_id INT DEFAULT NULL, verb_id INT DEFAULT NULL, object_id INT DEFAULT NULL, result_id INT DEFAULT NULL, authority_id INT DEFAULT NULL, context_id INT DEFAULT NULL, created BIGINT DEFAULT NULL, `stored` BIGINT DEFAULT NULL, hasAttachments TINYINT(1) DEFAULT NULL, UNIQUE INDEX UNIQ_BAF6663B10DAF24A (actor_id), UNIQUE INDEX UNIQ_BAF6663BC1D03483 (verb_id), UNIQUE INDEX UNIQ_BAF6663B232D562B (object_id), UNIQUE INDEX UNIQ_BAF6663B7A7B643 (result_id), UNIQUE INDEX UNIQ_BAF6663B81EC865B (authority_id), UNIQUE INDEX UNIQ_BAF6663B6B00C1CF (context_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+ALTER TABLE xapi_attachment ADD CONSTRAINT FK_7148C9A1849CB65B FOREIGN KEY (statement_id) REFERENCES xapi_statement (id);
+ALTER TABLE xapi_object ADD CONSTRAINT FK_E2B68640303C7F1D FOREIGN KEY (activityExtensions_id) REFERENCES xapi_extensions (identifier);
+ALTER TABLE xapi_object ADD CONSTRAINT FK_E2B68640FE54D947 FOREIGN KEY (group_id) REFERENCES xapi_object (identifier);
+ALTER TABLE xapi_object ADD CONSTRAINT FK_E2B6864010DAF24A FOREIGN KEY (actor_id) REFERENCES xapi_object (identifier);
+ALTER TABLE xapi_object ADD CONSTRAINT FK_E2B68640C1D03483 FOREIGN KEY (verb_id) REFERENCES xapi_verb (identifier);
+ALTER TABLE xapi_object ADD CONSTRAINT FK_E2B68640232D562B FOREIGN KEY (object_id) REFERENCES xapi_object (identifier);
+ALTER TABLE xapi_object ADD CONSTRAINT FK_E2B68640988A4CEC FOREIGN KEY (parentContext_id) REFERENCES xapi_context (identifier);
+ALTER TABLE xapi_object ADD CONSTRAINT FK_E2B686404F542860 FOREIGN KEY (groupingContext_id) REFERENCES xapi_context (identifier);
+ALTER TABLE xapi_object ADD CONSTRAINT FK_E2B68640AEA1B132 FOREIGN KEY (categoryContext_id) REFERENCES xapi_context (identifier);
+ALTER TABLE xapi_object ADD CONSTRAINT FK_E2B68640B73EEAB7 FOREIGN KEY (otherContext_id) REFERENCES xapi_context (identifier);
+ALTER TABLE xapi_result ADD CONSTRAINT FK_5971ECBFD0A19400 FOREIGN KEY (extensions_id) REFERENCES xapi_extensions (identifier);
+ALTER TABLE xapi_context ADD CONSTRAINT FK_3D7771908C4FC193 FOREIGN KEY (instructor_id) REFERENCES xapi_object (identifier);
+ALTER TABLE xapi_context ADD CONSTRAINT FK_3D777190296CD8AE FOREIGN KEY (team_id) REFERENCES xapi_object (identifier);
+ALTER TABLE xapi_context ADD CONSTRAINT FK_3D777190D0A19400 FOREIGN KEY (extensions_id) REFERENCES xapi_extensions (identifier);
+ALTER TABLE xapi_statement ADD CONSTRAINT FK_BAF6663B10DAF24A FOREIGN KEY (actor_id) REFERENCES xapi_object (identifier);
+ALTER TABLE xapi_statement ADD CONSTRAINT FK_BAF6663BC1D03483 FOREIGN KEY (verb_id) REFERENCES xapi_verb (identifier);
+ALTER TABLE xapi_statement ADD CONSTRAINT FK_BAF6663B232D562B FOREIGN KEY (object_id) REFERENCES xapi_object (identifier);
+ALTER TABLE xapi_statement ADD CONSTRAINT FK_BAF6663B7A7B643 FOREIGN KEY (result_id) REFERENCES xapi_result (identifier);
+ALTER TABLE xapi_statement ADD CONSTRAINT FK_BAF6663B81EC865B FOREIGN KEY (authority_id) REFERENCES xapi_object (identifier);
+ALTER TABLE xapi_statement ADD CONSTRAINT FK_BAF6663B6B00C1CF FOREIGN KEY (context_id) REFERENCES xapi_context (identifier);
+
+CREATE TABLE xapi_shared_statement (id INT AUTO_INCREMENT NOT NULL, uuid VARCHAR(255) DEFAULT NULL, statement LONGTEXT NOT NULL COMMENT '(DC2Type:array)', sent TINYINT(1) DEFAULT '0' NOT NULL, INDEX idx_uuid (uuid), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+
+CREATE TABLE xapi_lrs_auth (id INT AUTO_INCREMENT NOT NULL, username VARCHAR(255) NOT NULL, password VARCHAR(255) NOT NULL, enabled TINYINT(1) NOT NULL, created_at DATETIME NOT NULL, PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+
+CREATE TABLE xapi_tool_launch (id INT AUTO_INCREMENT NOT NULL, c_id INT NOT NULL, session_id INT DEFAULT NULL, title VARCHAR(255) NOT NULL, description LONGTEXT DEFAULT NULL, launch_url VARCHAR(255) NOT NULL, activity_id VARCHAR(255) DEFAULT NULL, activity_type VARCHAR(255) DEFAULT NULL, allow_multiple_attempts TINYINT(1) DEFAULT '1' NOT NULL, lrs_url VARCHAR(255) DEFAULT NULL, lrs_auth_username VARCHAR(255) DEFAULT NULL, lrs_auth_password VARCHAR(255) DEFAULT NULL, INDEX IDX_E18CB58391D79BD3 (c_id), INDEX IDX_E18CB583613FECDF (session_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+ALTER TABLE xapi_tool_launch ADD CONSTRAINT FK_E18CB58391D79BD3 FOREIGN KEY (c_id) REFERENCES course (id);
+ALTER TABLE xapi_tool_launch ADD CONSTRAINT FK_E18CB583613FECDF FOREIGN KEY (session_id) REFERENCES session (id);
+
+CREATE TABLE xapi_cmi5_item (id INT AUTO_INCREMENT NOT NULL, tree_root INT DEFAULT NULL, parent_id INT DEFAULT NULL, identifier VARCHAR(255) NOT NULL, type VARCHAR(255) NOT NULL, title LONGTEXT NOT NULL COMMENT '(DC2Type:json)', description LONGTEXT NOT NULL COMMENT '(DC2Type:json)', url VARCHAR(255) DEFAULT NULL, activity_type VARCHAR(255) DEFAULT NULL, launch_method VARCHAR(255) DEFAULT NULL, move_on VARCHAR(255) DEFAULT NULL, mastery_score DOUBLE PRECISION DEFAULT NULL, launch_parameters VARCHAR(255) DEFAULT NULL, entitlement_key VARCHAR(255) DEFAULT NULL, status VARCHAR(255) DEFAULT NULL, lft INT NOT NULL, lvl INT NOT NULL, rgt INT NOT NULL, tool_id INT DEFAULT NULL, INDEX IDX_7CA116D88F7B22CC (tool_id), INDEX IDX_7CA116D8A977936C (tree_root), INDEX IDX_7CA116D8727ACA70 (parent_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+ALTER TABLE xapi_cmi5_item ADD CONSTRAINT FK_7CA116D8A977936C FOREIGN KEY (tree_root) REFERENCES xapi_cmi5_item (id) ON DELETE CASCADE;
+ALTER TABLE xapi_cmi5_item ADD CONSTRAINT FK_7CA116D8727ACA70 FOREIGN KEY (parent_id) REFERENCES xapi_cmi5_item (id) ON DELETE CASCADE;
+
+CREATE TABLE xapi_activity_state (id INT AUTO_INCREMENT NOT NULL, state_id VARCHAR(255) NOT NULL, activity_id VARCHAR(255) NOT NULL, agent LONGTEXT NOT NULL COMMENT '(DC2Type:json)', document_data LONGTEXT NOT NULL COMMENT '(DC2Type:json)', PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+CREATE TABLE xapi_activity_profile (id INT AUTO_INCREMENT NOT NULL, profile_id VARCHAR(255) NOT NULL, activity_id VARCHAR(255) NOT NULL, document_data LONGTEXT NOT NULL COMMENT '(DC2Type:json)', PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+```
+
+**From 0.2 (beta) [2021-10-15]**
+- With the LRS an internal log is registered based on the actor mbox's email or the actor account's name coming from the statement
+To update, execute this queries:
+
+```sql
+CREATE TABLE xapi_internal_log (id INT AUTO_INCREMENT NOT NULL, user_id INT DEFAULT NULL, statement_id VARCHAR(255) NOT NULL, verb VARCHAR(255) NOT NULL, object_id VARCHAR(255) NOT NULL, activity_name VARCHAR(255) DEFAULT NULL, activity_description VARCHAR(255) DEFAULT NULL, score_scaled DOUBLE PRECISION DEFAULT NULL, score_raw DOUBLE PRECISION DEFAULT NULL, score_min DOUBLE PRECISION DEFAULT NULL, score_max DOUBLE PRECISION DEFAULT NULL, created_at DATETIME DEFAULT NULL, INDEX IDX_C1C667ACA76ED395 (user_id), PRIMARY KEY(id)) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
+ALTER TABLE xapi_internal_log ADD CONSTRAINT FK_C1C667ACA76ED395 FOREIGN KEY (user_id) REFERENCES user (id);
+```
+
+**From 0.3 (beta) [2021-11-11]**
+
+- Fix: Add foreign keys with course/session in tool_launch table and foreign key with user in internal_log table.
+```sql
+ALTER TABLE xapi_internal_log ADD CONSTRAINT FK_C1C667ACA76ED395 FOREIGN KEY (user_id) REFERENCES user (id) ON DELETE CASCADE;
+ALTER TABLE xapi_tool_launch ADD CONSTRAINT FK_E18CB58391D79BD3 FOREIGN KEY (c_id) REFERENCES course (id) ON DELETE CASCADE;
+ALTER TABLE xapi_tool_launch ADD CONSTRAINT FK_E18CB583613FECDF FOREIGN KEY (session_id) REFERENCES session (id) ON DELETE CASCADE;
+```
diff --git a/plugin/xapi/admin.php b/plugin/xapi/admin.php
new file mode 100644
index 000000000..4affc59fd
--- /dev/null
+++ b/plugin/xapi/admin.php
@@ -0,0 +1,196 @@
+getId()}";
+    }
+
+    $form = new FormValidator('frm_xapi_auth', 'post', $action);
+    $form->addText('username', get_lang('Username'), true);
+    $form->addText('password', get_lang('Password'), true);
+    $form->addCheckBox('enabled', get_lang('Enabled'), get_lang('Yes'));
+
+    $form->addButtonSave(get_lang('Save'));
+
+    if (null != $auth) {
+        $form->setDefaults(
+            [
+                'username' => $auth->getUsername(),
+                'password' => $auth->getPassword(),
+                'enabled' => $auth->isEnabled(),
+            ]
+        );
+    }
+
+    return $form;
+}
+
+switch ($request->query->getAlpha('action')) {
+    case 'add':
+        $form = createForm();
+
+        if ($form->validate()) {
+            $values = $form->exportValues();
+
+            $auth = new LrsAuth();
+            $auth
+                ->setUsername($values['username'])
+                ->setPassword($values['password'])
+                ->setEnabled(isset($values['enabled']))
+                ->setCreatedAt(
+                    api_get_utc_datetime(null, false, true)
+                );
+
+            $em->persist($auth);
+            $em->flush();
+
+            Display::addFlash(
+                Display::return_message(get_lang('ItemAdded'), 'success')
+            );
+
+            header('Location: '.$pageBaseUrl);
+            exit;
+        }
+
+        $pageActions = Display::url(
+            Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM),
+            $pageBaseUrl
+        );
+        $pageContent = $form->returnForm();
+        break;
+    case 'edit':
+        $auth = $em->find(LrsAuth::class, $request->query->getInt('id'));
+
+        if (null == $auth) {
+            api_not_allowed(true);
+        }
+
+        $form = createForm($auth);
+
+        if ($form->validate()) {
+            $values = $form->exportValues();
+
+            $auth
+                ->setUsername($values['username'])
+                ->setPassword($values['password'])
+                ->setEnabled(isset($values['enabled']))
+                ->setCreatedAt(
+                    api_get_utc_datetime(null, false, true)
+                );
+
+            $em->persist($auth);
+            $em->flush();
+
+            Display::addFlash(
+                Display::return_message(get_lang('ItemUpdated'), 'success')
+            );
+
+            header('Location: '.$pageBaseUrl);
+            exit;
+        }
+
+        $pageActions = Display::url(
+            Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM),
+            $pageBaseUrl
+        );
+        $pageContent = $form->returnForm();
+        break;
+    case 'delete':
+        $auth = $em->find(LrsAuth::class, $request->query->getInt('id'));
+
+        if (null == $auth) {
+            api_not_allowed(true);
+        }
+
+        $em->remove($auth);
+        $em->flush();
+
+        Display::addFlash(
+            Display::return_message(get_lang('ItemDeleted'), 'success')
+        );
+
+        header('Location: '.$pageBaseUrl);
+        exit;
+    case 'list':
+    default:
+        $pageActions = Display::url(
+            Display::return_icon('add.png', get_lang('Add'), [], ICON_SIZE_MEDIUM),
+            $pageBaseUrl.'?action=add'
+        );
+        $pageContent = Display::return_message(get_lang('NoData'), 'warning');
+
+        $auths = $em->getRepository(LrsAuth::class)->findAll();
+
+        if (count($auths) > 0) {
+            $row = 0;
+
+            $table = new HTML_Table(['class' => 'table table-striped table-hover']);
+            $table->setHeaderContents($row, 0, get_lang('Username'));
+            $table->setHeaderContents($row, 1, get_lang('Password'));
+            $table->setHeaderContents($row, 2, get_lang('Enabled'));
+            $table->setHeaderContents($row, 3, get_lang('CreatedAt'));
+            $table->setHeaderContents($row, 4, get_lang('Actions'));
+
+            foreach ($auths as $auth) {
+                $row++;
+
+                $actions = [
+                    Display::url(
+                        Display::return_icon('edit.png', get_lang('Edit')),
+                        $pageBaseUrl.'?action=edit&id='.$auth->getId()
+                    ),
+                    Display::url(
+                        Display::return_icon('delete.png', get_lang('Edit')),
+                        $pageBaseUrl.'?action=delete&id='.$auth->getId()
+                    ),
+                ];
+
+                $table->setCellContents($row, 0, $auth->getUsername());
+                $table->setCellContents($row, 1, $auth->getPassword());
+                $table->setCellContents($row, 2, $auth->isEnabled() ? get_lang('Yes') : get_lang('No'));
+                $table->setCellContents($row, 3, api_convert_and_format_date($auth->getCreatedAt()));
+                $table->setCellContents($row, 4, implode(PHP_EOL, $actions));
+            }
+
+            $pageContent = $table->toHtml();
+        }
+        break;
+}
+
+$interbreadcrumb[] = [
+    'name' => get_lang('Administration'),
+    'url' => api_get_path(WEB_CODE_PATH).'admin/index.php',
+];
+
+$view = new Template($plugin->get_title());
+$view->assign('actions', Display::toolbarAction('xapi_actions', [$pageActions]));
+$view->assign('content', $pageContent);
+$view->display_one_col_template();
diff --git a/plugin/xapi/assets/css/cmi5_launch.css b/plugin/xapi/assets/css/cmi5_launch.css
new file mode 100644
index 000000000..eaa82c2da
--- /dev/null
+++ b/plugin/xapi/assets/css/cmi5_launch.css
@@ -0,0 +1,40 @@
+.section-global {
+    margin: 0;
+}
+
+#pnl-left ul {
+    list-style: none;
+    margin: 0;
+    padding: 0;
+}
+#pnl-left ul li a {
+    padding: 5px 0;
+    display: block;
+}
+#pnl-left ul ul li {
+    padding: 0 0 0 15px ;
+}
+
+@media (min-width: 992px) {
+    #pnl-left {
+        overflow: auto;
+        position: absolute;
+        top: 0;
+        bottom: 0;
+        left: 0;
+    }
+    #pnl-right {
+        position: absolute;
+        right: 0;
+        top: 0;
+        bottom: 0;
+    }
+    #ifr-content {
+        min-width: 100%;
+        min-height: 100%;
+        padding: 0;
+        margin: 0;
+        position: absolute;
+        right: 0;
+    }
+}
\ No newline at end of file
diff --git a/plugin/xapi/assets/js/cmi5_launch.js b/plugin/xapi/assets/js/cmi5_launch.js
new file mode 100644
index 000000000..22d2d963e
--- /dev/null
+++ b/plugin/xapi/assets/js/cmi5_launch.js
@@ -0,0 +1,2 @@
+$(function () {
+});
\ No newline at end of file
diff --git a/plugin/xapi/cmi5/launch.php b/plugin/xapi/cmi5/launch.php
new file mode 100644
index 000000000..9c9c65536
--- /dev/null
+++ b/plugin/xapi/cmi5/launch.php
@@ -0,0 +1,188 @@
+find(Cmi5Item::class, $request->query->getInt('id'));
+$toolLaunch = $item->getTool();
+
+if ($toolLaunch->getId() !== $request->query->getInt('tool')) {
+    api_not_allowed(
+        false,
+        Display::return_message(get_lang('NotAllwed'), 'error')
+    );
+}
+
+$plugin = XApiPlugin::create();
+$user = api_get_user_entity(api_get_user_id());
+$nowDate = api_get_utc_datetime(null, false, true)->format('c');
+
+$registration = (string) Uuid::uuid4();
+$actor = new Agent(
+    InverseFunctionalIdentifier::withAccount(
+        new Account(
+            $user->getCompleteName(),
+            IRL::fromString(api_get_path(WEB_PATH))
+        )
+    ),
+    $user->getCompleteName()
+);
+$verb = new Verb(
+    IRI::fromString('http://adlnet.gov/expapi/verbs/launched'),
+    LanguageMap::create($plugin->getLangMap('Launched'))
+);
+$customActivityId = $plugin->generateIri($item->getId(), 'cmi5_item');
+
+$activity = new Activity(
+    $customActivityId,
+    new Definition(
+        LanguageMap::create($item->getTitle()),
+        LanguageMap::create($item->getDescription()),
+        IRI::fromString($item->getIdentifier())
+    )
+);
+
+$context = (new Context())
+    ->withPlatform(
+        api_get_setting('Institution').' - '.api_get_setting('siteName')
+    )
+    ->withLanguage(api_get_language_isocode())
+    ->withRegistration($registration);
+
+$statementUuid = Uuid::uuid5(
+    $plugin->get(XApiPlugin::SETTING_UUID_NAMESPACE),
+    "cmi5_item/{$item->getId()}"
+);
+
+$statement = new Statement(
+    StatementId::fromUuid($statementUuid),
+    $actor,
+    $verb,
+    $activity,
+    null,
+    null,
+    api_get_utc_datetime(null, false, true),
+    null,
+    $context
+);
+
+$statementClient = XApiPlugin::create()->getXApiStatementClient();
+
+//try {
+//    $statementClient->storeStatement($statement);
+//} catch (ConflictException $e) {
+//    echo Display::return_message($e->getMessage(), 'error');
+//
+//    exit;
+//} catch (XApiException $e) {
+//    echo Display::return_message($e->getMessage(), 'error');
+//
+//    exit;
+//}
+
+$viewSessionId = (string) Uuid::uuid4();
+
+$state = new State(
+    $activity,
+    $actor,
+    'LMS.LaunchData',
+    (string) $registration
+);
+
+$documentDataData = [];
+$documentDataData['contentTemplate'] = [
+    'extensions' => [
+        'https://w3id.org/xapi/cmi5/context/extensions/sessionid' => $viewSessionId,
+    ],
+];
+$documentDataData['launchMode'] = 'Normal';
+$documentDataData['launchMethod'] = $item->getLaunchMethod();
+
+if ($item->getLaunchParameters()) {
+    $documentDataData['launchParameteres'] = $item->getLaunchParameters();
+}
+
+if ($item->getMasteryScore()) {
+    $documentDataData['masteryScore'] = $item->getMasteryScore();
+}
+
+if ($item->getEntitlementKey()) {
+    $documentDataData['entitlementKey'] = [
+        'courseStructure' => $item->getEntitlementKey(),
+    ];
+}
+
+$documentData = new DocumentData($documentDataData);
+
+try {
+    $plugin
+        ->getXApiStateClient()
+        ->createOrReplaceDocument(
+            new StateDocument($state, $documentData)
+        );
+} catch (Exception $exception) {
+    echo Display::return_message($exception->getMessage(), 'error');
+
+    exit;
+}
+
+$launchUrl = $plugin->generateLaunchUrl(
+    'cmi5',
+    $item->getUrl(),
+    $customActivityId->getValue(),
+    $actor,
+    $registration,
+    $toolLaunch->getLrsUrl(),
+    $toolLaunch->getLrsAuthUsername(),
+    $toolLaunch->getLrsAuthPassword(),
+    $viewSessionId
+);
+
+if ('OwnWindow' === $item->getLaunchMethod()) {
+    Display::display_reduced_header();
+
+    echo '
    ';
+    echo Display::toolbarButton(
+        $plugin->get_lang('LaunchNewAttempt'),
+        $launchUrl,
+        'external-link fa-fw',
+        'success',
+        [
+            'target' => '_blank',
+        ]
+    );
+    echo '';
+
+    Display::display_reduced_footer();
+
+    exit;
+}
+
+header("Location: $launchUrl");
diff --git a/plugin/xapi/cmi5/token.php b/plugin/xapi/cmi5/token.php
new file mode 100644
index 000000000..be04b7e18
--- /dev/null
+++ b/plugin/xapi/cmi5/token.php
@@ -0,0 +1,22 @@
+getMethod()) {
+    $token = base64_encode(uniqid());
+
+    $response->setStatusCode(Response::HTTP_OK);
+    $response->setData(['auth-token' => $token]);
+}
+
+$response->send();
diff --git a/plugin/xapi/cmi5/view.php b/plugin/xapi/cmi5/view.php
new file mode 100644
index 000000000..dc0f08335
--- /dev/null
+++ b/plugin/xapi/cmi5/view.php
@@ -0,0 +1,84 @@
+find(
+    ToolLaunch::class,
+    $request->query->getInt('id')
+);
+
+if (null === $toolLaunch
+    || 'cmi5' !== $toolLaunch->getActivityType()
+) {
+    header('Location: '.api_get_course_url());
+    exit;
+}
+
+$plugin = XApiPlugin::create();
+$course = api_get_course_entity();
+$session = api_get_session_entity();
+$cidReq = api_get_cidreq();
+$user = api_get_user_entity(api_get_user_id());
+$interfaceLanguage = api_get_interface_language();
+
+$itemsRepo = $em->getRepository(Cmi5Item::class);
+
+$query = $em->createQueryBuilder()
+    ->select('item')
+    ->from(Cmi5Item::class, 'item')
+    ->where('item.tool = :tool')
+    ->setParameter('tool', $toolLaunch->getId())
+    ->getQuery();
+
+$tocHtml = $itemsRepo->buildTree(
+    $query->getArrayResult(),
+    [
+        'decorate' => true,
+        'rootOpen' => '
      ',
+        'rootClose' => '
    ',
+        'childOpen' => '
  • ',
+        'childClose' => '
    • ',
+        'nodeDecorator' => function ($node) use ($interfaceLanguage, $cidReq, $toolLaunch) {
+            $titleMap = LanguageMap::create($node['title']);
+            $title = XApiPlugin::extractVerbInLanguage($titleMap, $interfaceLanguage);
+
+            if ('block' === $node['type']) {
+                return Display::page_subheader($title, null, 'h4');
+            }
+
+            return Display::url(
+                $title,
+                "launch.php?tool={$toolLaunch->getId()}&id={$node['id']}&$cidReq",
+                [
+                    'target' => 'ifr_content',
+                    'class' => 'text-left btn-link',
+                ]
+            );
+        },
+    ]
+);
+
+$webPluginPath = api_get_path(WEB_PLUGIN_PATH);
+
+$htmlHeadXtra[] = api_get_css($webPluginPath.'xapi/assets/css/cmi5_launch.css');
+$htmlHeadXtra[] = api_get_js_simple($webPluginPath.'xapi/assets/js/cmi5_launch.js');
+
+$view = new Template('', false, false, true, true, false);
+$view->assign('tool', $toolLaunch);
+$view->assign('toc_html', $tocHtml);
+$view->assign('content', $view->fetch('xapi/views/cmi5_launch.twig'));
+$view->display_no_layout_template();
diff --git a/plugin/xapi/cron/send_statements.php b/plugin/xapi/cron/send_statements.php
new file mode 100644
index 000000000..21cfc2bcb
--- /dev/null
+++ b/plugin/xapi/cron/send_statements.php
@@ -0,0 +1,79 @@
+getRepository(SharedStatement::class)
+    ->findBy(
+        ['uuid' => null, 'sent' => false],
+        null,
+        100
+    );
+$countNotSent = count($notSentSharedStatements);
+
+if ($countNotSent > 0) {
+    echo '['.time().'] Trying to send '.$countNotSent.' statements to LRS'.PHP_EOL;
+
+    $client = XApiPlugin::create()->getXapiStatementCronClient();
+
+    /** @var SharedStatement $notSentSharedStatement */
+    foreach ($notSentSharedStatements as $notSentSharedStatement) {
+        $notSentStatement = $statementSerializer->deserializeStatement(
+            json_encode($notSentSharedStatement->getStatement())
+        );
+
+        if (null == $notSentStatement->getId()) {
+            $notSentStatement = $notSentStatement->withId(
+                StatementId::fromUuid(Uuid::uuid4())
+            );
+        }
+
+        try {
+            echo '['.time()."] Sending shared statement ({$notSentSharedStatement->getId()})";
+
+            $sentStatement = $client->storeStatement($notSentStatement);
+
+            echo "\t\tStatement ID received: \"{$sentStatement->getId()->getValue()}\"";
+        } catch (ConflictException $e) {
+            echo $e->getMessage().PHP_EOL;
+
+            continue;
+        } catch (XApiException $e) {
+            echo $e->getMessage().PHP_EOL;
+
+            continue;
+        }
+
+        $notSentSharedStatement
+            ->setUuid($sentStatement->getId()->getValue())
+            ->setSent(true);
+
+        $em->persist($notSentSharedStatement);
+
+        echo "\t\tShared statement updated".PHP_EOL;
+    }
+
+    $em->flush();
+} else {
+    echo 'No statements to process.'.PHP_EOL;
+}
diff --git a/plugin/xapi/install.php b/plugin/xapi/install.php
new file mode 100644
index 000000000..c939bf532
--- /dev/null
+++ b/plugin/xapi/install.php
@@ -0,0 +1,5 @@
+install();
diff --git a/plugin/xapi/lang/english.php b/plugin/xapi/lang/english.php
new file mode 100644
index 000000000..bee4d9a2b
--- /dev/null
+++ b/plugin/xapi/lang/english.php
@@ -0,0 +1,56 @@
+This is generated automatically by Chamilo LMS. Don\'t replace it.';
+$strings['lrs_url'] = 'LRS endpoint';
+$strings['lrs_url_help'] = 'Base URL of the LRS';
+$strings['lrs_auth_username'] = 'LRS user';
+$strings['lrs_auth_username_help'] = 'Username for basic HTTP authentication';
+$strings['lrs_auth_password'] = 'LRS password';
+$strings['lrs_auth_password_help'] = 'Password for basic HTTP authentication';
+$strings['cron_lrs_url'] = 'Cron: LRS endpoint';
+$strings['cron_lrs_url_help'] = 'Alternative base URL of the LRS for the cron process';
+$strings['cron_lrs_auth_username'] = 'Cron: LRS user';
+$strings['cron_lrs_auth_username_help'] = 'Alternative username for basic HTTP authentication for the cron process';
+$strings['cron_lrs_auth_password'] = 'Cron: LRS password';
+$strings['cron_lrs_auth_password_help'] = 'Alternative password for basic HTTP authentication for the cron process';
+$strings['lrs_lp_item_viewed_active'] = 'Learning path item viewed';
+$strings['lrs_lp_end_active'] = 'Learning path ended';
+$strings['lrs_quiz_active'] = 'Quiz ended';
+$strings['lrs_quiz_question_active'] = 'Quiz question answered';
+$strings['lrs_portfolio_active'] = 'Portfolio events';
+
+$strings['NoActivities'] = 'No activities added yet';
+$strings['ActivityTitle'] = 'Activity';
+$strings['AddActivity'] = 'Add activity';
+$strings['TinCanPackage'] = 'TinCan package (zip)';
+$strings['Cmi5Package'] = 'Cmi5 package (zip)';
+$strings['OnlyZipAllowed'] = 'Only ZIP file allowed (.zip).';
+$strings['ActivityImported'] = 'Activity imported.';
+$strings['EditActivity'] = 'Edit activity';
+$strings['ActivityUpdated'] = 'Activity updated';
+$strings['ActivityLaunchUrl'] = 'Launch URL';
+$strings['ActivityId'] = 'Activity ID';
+$strings['ActivityType'] = 'Activity type';
+$strings['ActivityDeleted'] = 'Activity deleted';
+$strings['ActivityLaunch'] = 'Launch';
+$strings['ActivityFirstLaunch'] = 'First launch at';
+$strings['ActivityLastLaunch'] = 'Last launch at';
+$strings['LaunchNewAttempt'] = 'Launch new attempt';
+$strings['LrsConfiguration'] = 'LRS Configuration';
+$strings['Verb'] = 'Verb';
+$strings['Actor'] = 'Actor';
+$strings['ToolTinCan'] = 'Activities';
+$strings['Terminated'] = 'Terminated';
+$strings['Completed'] = 'Completed';
+$strings['Answered'] = 'Answered';
+$strings['Viewed'] = 'Viewed';
+$strings['ActivityAddedToLPCannotBeAccessed'] = 'This activity has been included in a learning path, so it cannot be accessed by students directly from here.';
+$strings['XApiPackage'] = 'XApi Package';
+$strings['TinCanAllowMultipleAttempts'] = 'Allow multiple attempts';
diff --git a/plugin/xapi/lang/french.php b/plugin/xapi/lang/french.php
new file mode 100644
index 000000000..d53ea9794
--- /dev/null
+++ b/plugin/xapi/lang/french.php
@@ -0,0 +1,49 @@
+Cette valeur est générée automatiquement par Chamilo, ne la modifiez pas.';
+$strings['lrs_url'] = 'Point d\'entrée LRS';
+$strings['lrs_url_help'] = 'URL de base du LRS';
+$strings['lrs_auth_username'] = 'Utilisateur LRS';
+$strings['lrs_auth_username_help'] = 'Nom d\'utilisateur pour l\'authentification HTTP de base';
+$strings['lrs_auth_password'] = 'Mot de passe LRS';
+$strings['lrs_auth_password_help'] = 'Mot de passe pour l\'authentification HTTP de base';
+$strings['cron_lrs_url'] = 'Cron: LRS endpoint';
+$strings['cron_lrs_url_help'] = 'Alternative base URL of the LRS for the cron process';
+$strings['cron_lrs_auth_username'] = 'Cron: LRS user';
+$strings['cron_lrs_auth_username_help'] = 'Alternative username for basic HTTP authentication for the cron process';
+$strings['cron_lrs_auth_password'] = 'Cron: LRS password';
+$strings['cron_lrs_auth_password_help'] = 'Alternative password for basic HTTP authentication for the cron process';
+$strings['lrs_lp_item_viewed_active'] = 'Élément de parcours visionné';
+$strings['lrs_lp_end_active'] = 'Parcours terminé';
+$strings['lrs_quiz_active'] = 'Exercice terminé';
+$strings['lrs_quiz_question_active'] = 'Question d\'exercice répondue';
+$strings['lrs_portfolio_active'] = 'Événements de portfolio';
+
+$strings['NoActivities'] = 'Aucune activité ajoutée pour l\'instant';
+$strings['ActivityTitle'] = 'Activité';
+$strings['AddActivity'] = 'Ajouter activité';
+$strings['TinCanPackage'] = 'Paquet TinCan (zip)';
+$strings['OnlyZipAllowed'] = 'Seuls les fichiers ZIP sont autorisés (.zip).';
+$strings['ActivityImported'] = 'Activité importée.';
+$strings['EditActivity'] = 'Éditer activité';
+$strings['ActivityUpdated'] = 'Activité mise à jour';
+$strings['ActivityLaunchUrl'] = 'URL de lancement';
+$strings['ActivityId'] = 'ID d\'activité';
+$strings['ActivityType'] = 'Type d\'activité';
+$strings['ActivityDeleted'] = 'Activité supprimée';
+$strings['ActivityLaunch'] = 'Lancer';
+$strings['ActivityFirstLaunch'] = 'Premier lancement à';
+$strings['ActivityLastLaunch'] = 'Dernier lancement à';
+$strings['LaunchNewAttempt'] = 'Lancer nouvelle tentative';
+$strings['LrsConfiguration'] = 'Configuration LRS';
+$strings['Verb'] = 'Verbe';
+$strings['Actor'] = 'Acteur';
+$strings['ToolTinCan'] = 'Activités';
+$strings['ActivityAddedToLPCannotBeAccessed'] = 'Cet activité fait partie d\'un parcours d\'apprentissage, il n\'est donc pas accessible par les étudiants depuis cette page';
diff --git a/plugin/xapi/lang/spanish.php b/plugin/xapi/lang/spanish.php
new file mode 100644
index 000000000..2056da671
--- /dev/null
+++ b/plugin/xapi/lang/spanish.php
@@ -0,0 +1,56 @@
+Esto es generado automáticamente por Chamilo LMS. No reemplazarlo.';
+$strings['lrs_url'] = 'LRS endpoint';
+$strings['lrs_url_help'] = 'Base de la URL del LRS';
+$strings['lrs_auth_username'] = 'Usuario del LRS';
+$strings['lrs_auth_username_help'] = 'Usuario para autenticación con HTTP básica';
+$strings['lrs_auth_password'] = 'Contraseña del LRS';
+$strings['lrs_auth_password_help'] = 'Contraseña para autenticación con HTTP básica';
+$strings['cron_lrs_url'] = 'Cron: LRS endpoint';
+$strings['cron_lrs_url_help'] = 'Opcional. Base de la URL alternativa del LRS del proceso cron.';
+$strings['cron_lrs_auth_username'] = 'Cron: Usuario del LRS';
+$strings['cron_lrs_auth_username_help'] = 'Opcional. Usuario alternativo para autenticación con HTTP básica del proceso cron';
+$strings['cron_lrs_auth_password'] = 'Cron: Contraseña del LRS';
+$strings['cron_lrs_auth_password_help'] = 'Opcional. Contraseña alternativa para autenticación con HTTP básica del proceso cron';
+$strings['lrs_lp_item_viewed_active'] = 'Visualización de contenido de lección';
+$strings['lrs_lp_end_active'] = 'Finalización de lección';
+$strings['lrs_quiz_active'] = 'Finalización de ejercicio';
+$strings['lrs_quiz_question_active'] = 'Resolución de pregunta en ejercicio';
+$strings['lrs_portfolio_active'] = 'Eventos en portafolio';
+
+$strings['NoActivities'] = 'No hay actividades aún';
+$strings['ActivityTitle'] = 'Actividad';
+$strings['AddActivity'] = 'Agregar actividad';
+$strings['TinCanPackage'] = 'Paquete TinCan (zip)';
+$strings['Cmi5Package'] = 'Paquete Cmi5(zip)';
+$strings['OnlyZipAllowed'] = 'Sólo archivos ZIP están permitidos (.zip).';
+$strings['ActivityImported'] = 'Actividad importada.';
+$strings['EditActivity'] = 'Editar actividad';
+$strings['ActivityUpdated'] = 'Actividad actualizada';
+$strings['ActivityLaunchUrl'] = 'URL de inicio';
+$strings['ActivityId'] = 'ID de actividad';
+$strings['ActivityType'] = 'Tipo de actividad';
+$strings['ActivityDeleted'] = 'Actividad eliminada';
+$strings['ActivityLaunch'] = 'Iniciar';
+$strings['ActivityFirstLaunch'] = 'Primer inicio';
+$strings['ActivityLastLaunch'] = 'Últimmo inicio';
+$strings['LaunchNewAttempt'] = 'Iniciar nuevo intento';
+$strings['LrsConfiguration'] = 'Configuración de LRS';
+$strings['Verb'] = 'Verbo';
+$strings['Actor'] = 'Actor';
+$strings['ToolTinCan'] = 'Actividades';
+$strings['Terminated'] = 'Terminó';
+$strings['Completed'] = 'Completó';
+$strings['Answered'] = 'Respondió';
+$strings['Viewed'] = 'Visualizó';
+$strings['ActivityAddedToLPCannotBeAccessed'] = 'Esta actividad ha sido incluida en una secuencia de aprendizaje, por lo cual no podrá ser accesible directamente por los estudiantes desde aquí.';
+$strings['XApiPackage'] = 'Paquete XApi';
+$strings['TinCanAllowMultipleAttempts'] = 'Permitir múltiples intentos';
diff --git a/plugin/xapi/lrs.php b/plugin/xapi/lrs.php
new file mode 100644
index 000000000..4fe9df4fd
--- /dev/null
+++ b/plugin/xapi/lrs.php
@@ -0,0 +1,12 @@
+send();
diff --git a/plugin/xapi/php-xapi/lrs-bundle/LICENSE b/plugin/xapi/php-xapi/lrs-bundle/LICENSE
new file mode 100644
index 000000000..de1d823c3
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2016-2017 Christian Flothmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/plugin/xapi/php-xapi/lrs-bundle/README.md b/plugin/xapi/php-xapi/lrs-bundle/README.md
new file mode 100644
index 000000000..e69de29bb
diff --git a/plugin/xapi/php-xapi/lrs-bundle/composer.json b/plugin/xapi/php-xapi/lrs-bundle/composer.json
new file mode 100644
index 000000000..874027f02
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/composer.json
@@ -0,0 +1,51 @@
+{
+    "name": "php-xapi/lrs-bundle",
+    "type": "symfony-bundle",
+    "description": "Experience API (xAPI) Learning Record Store (LRS) based on the Symfony Framework",
+    "keywords": ["xAPI", "Experience API", "Tin Can API", "LRS", "Learning Record Store", "Symfony", "bundle"],
+    "homepage": "https://github.com/php-xapi/lrs-bundle",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Christian Flothmann",
+            "homepage": "https://github.com/xabbuh"
+        },
+        {
+            "name": "Jérôme Parmentier",
+            "homepage": "https://github.com/Lctrs"
+        }
+    ],
+    "require": {
+        "php": "^7.1",
+        "php-xapi/exception": "^0.1 || ^0.2",
+        "php-xapi/model": "^1.1 || ^2.0 || ^3.0",
+        "php-xapi/repository-api": "^0.3@dev || ^0.4@dev",
+        "php-xapi/serializer": "^1.0 || ^2.0",
+        "php-xapi/symfony-serializer": "^1.0 || ^2.0",
+        "symfony/config": "^3.4 || ^4.3",
+        "symfony/dependency-injection": "^3.4 || ^4.3",
+        "symfony/http-foundation": "^3.4 || ^4.3",
+        "symfony/http-kernel": "^3.4 || ^4.3"
+    },
+    "require-dev": {
+        "phpspec/phpspec": "~2.3",
+        "php-xapi/json-test-fixtures": "^1.0 || ^2.0",
+        "php-xapi/test-fixtures": "^1.0.1",
+        "ramsey/uuid": "^2.9 || ^3.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "XApi\\LrsBundle\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "spec\\XApi\\LrsBundle\\": "spec/"
+        }
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-master": "0.1.x-dev"
+        }
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementGetController.php b/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementGetController.php
new file mode 100644
index 000000000..88469b337
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementGetController.php
@@ -0,0 +1,209 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\LrsBundle\Controller;
+
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\ParameterBag;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+use Xabbuh\XApi\Common\Exception\NotFoundException;
+use Xabbuh\XApi\Model\IRL;
+use Xabbuh\XApi\Model\Statement;
+use Xabbuh\XApi\Model\StatementId;
+use Xabbuh\XApi\Model\StatementResult;
+use Xabbuh\XApi\Serializer\StatementResultSerializerInterface;
+use Xabbuh\XApi\Serializer\StatementSerializerInterface;
+use XApi\LrsBundle\Model\StatementsFilterFactory;
+use XApi\LrsBundle\Response\AttachmentResponse;
+use XApi\LrsBundle\Response\MultipartResponse;
+use XApi\Repository\Api\StatementRepositoryInterface;
+
+/**
+ * @author Jérôme Parmentier 
+ */
+class StatementGetController
+{
+    protected static $getParameters = [
+        'statementId' => true,
+        'voidedStatementId' => true,
+        'agent' => true,
+        'verb' => true,
+        'activity' => true,
+        'registration' => true,
+        'related_activities' => true,
+        'related_agents' => true,
+        'since' => true,
+        'until' => true,
+        'limit' => true,
+        'format' => true,
+        'attachments' => true,
+        'ascending' => true,
+        'cursor' => true,
+    ];
+
+    protected $repository;
+    protected $statementSerializer;
+    protected $statementResultSerializer;
+    protected $statementsFilterFactory;
+
+    public function __construct(StatementRepositoryInterface $repository, StatementSerializerInterface $statementSerializer, StatementResultSerializerInterface $statementResultSerializer, StatementsFilterFactory $statementsFilterFactory)
+    {
+        $this->repository = $repository;
+        $this->statementSerializer = $statementSerializer;
+        $this->statementResultSerializer = $statementResultSerializer;
+        $this->statementsFilterFactory = $statementsFilterFactory;
+    }
+
+    /**
+     * @throws BadRequestHttpException if the query parameters does not comply with xAPI specification
+     *
+     * @return Response
+     */
+    public function getStatement(Request $request)
+    {
+        $query = new ParameterBag(\array_intersect_key($request->query->all(), self::$getParameters));
+
+        $this->validate($query);
+
+        $includeAttachments = $query->filter('attachments', false, FILTER_VALIDATE_BOOLEAN);
+        try {
+            if (($statementId = $query->get('statementId')) !== null) {
+                $statement = $this->repository->findStatementById(StatementId::fromString($statementId));
+
+                $response = $this->buildSingleStatementResponse($statement, $includeAttachments);
+            } elseif (($voidedStatementId = $query->get('voidedStatementId')) !== null) {
+                $statement = $this->repository->findVoidedStatementById(StatementId::fromString($voidedStatementId));
+
+                $response = $this->buildSingleStatementResponse($statement, $includeAttachments);
+            } else {
+                $statements = $this->repository->findStatementsBy($this->statementsFilterFactory->createFromParameterBag($query));
+
+                $response = $this->buildMultiStatementsResponse($statements, $query, $includeAttachments);
+            }
+        } catch (NotFoundException $e) {
+            $response = $this->buildMultiStatementsResponse([], $query)
+                             ->setStatusCode(Response::HTTP_NOT_FOUND)
+                             ->setContent('');
+        } catch (\Exception $exception) {
+            $response = Response::create('', Response::HTTP_BAD_REQUEST);
+        }
+
+        $now = new \DateTime();
+        $response->headers->set('X-Experience-API-Consistent-Through', $now->format(\DateTime::ATOM));
+        $response->headers->set('Content-Type', 'application/json');
+
+        return $response;
+    }
+
+    /**
+     * @param bool $includeAttachments true to include the attachments in the response, false otherwise
+     *
+     * @return JsonResponse|MultipartResponse
+     */
+    protected function buildSingleStatementResponse(Statement $statement, $includeAttachments = false)
+    {
+        $json = $this->statementSerializer->serializeStatement($statement);
+
+        $response = new Response($json, 200);
+
+        if ($includeAttachments) {
+            $response = $this->buildMultipartResponse($response, [$statement]);
+        }
+
+        $response->setLastModified($statement->getStored());
+
+        return $response;
+    }
+
+    /**
+     * @param Statement[] $statements
+     * @param bool        $includeAttachments true to include the attachments in the response, false otherwise
+     *
+     * @return JsonResponse|MultipartResponse
+     */
+    protected function buildMultiStatementsResponse(array $statements, ParameterBag $query, $includeAttachments = false)
+    {
+        $moreUrlPath = $statements ? $this->generateMoreIrl($query) : null;
+
+        $json = $this->statementResultSerializer->serializeStatementResult(
+            new StatementResult($statements, $moreUrlPath)
+        );
+
+        $response = new Response($json, 200);
+
+        if ($includeAttachments) {
+            $response = $this->buildMultipartResponse($response, $statements);
+        }
+
+        return $response;
+    }
+
+    /**
+     * @param Statement[] $statements
+     *
+     * @return MultipartResponse
+     */
+    protected function buildMultipartResponse(JsonResponse $statementResponse, array $statements)
+    {
+        $attachmentsParts = [];
+
+        foreach ($statements as $statement) {
+            foreach ((array) $statement->getAttachments() as $attachment) {
+                $attachmentsParts[] = new AttachmentResponse($attachment);
+            }
+        }
+
+        return new MultipartResponse($statementResponse, $attachmentsParts);
+    }
+
+    /**
+     * Validate the parameters.
+     *
+     * @throws BadRequestHttpException if the parameters does not comply with the xAPI specification
+     */
+    protected function validate(ParameterBag $query)
+    {
+        $hasStatementId = $query->has('statementId');
+        $hasVoidedStatementId = $query->has('voidedStatementId');
+
+        if ($hasStatementId && $hasVoidedStatementId) {
+            throw new BadRequestHttpException('Request must not have both statementId and voidedStatementId parameters at the same time.');
+        }
+
+        $hasAttachments = $query->has('attachments');
+        $hasFormat = $query->has('format');
+        $queryCount = $query->count();
+
+        if (($hasStatementId || $hasVoidedStatementId) && $hasAttachments && $hasFormat && $queryCount > 3) {
+            throw new BadRequestHttpException('Request must not contain statementId or voidedStatementId parameters, and also any other parameter besides "attachments" or "format".');
+        }
+
+        if (($hasStatementId || $hasVoidedStatementId) && ($hasAttachments || $hasFormat) && $queryCount > 2) {
+            throw new BadRequestHttpException('Request must not contain statementId or voidedStatementId parameters, and also any other parameter besides "attachments" or "format".');
+        }
+
+        if (($hasStatementId || $hasVoidedStatementId) && $queryCount > 1) {
+            throw new BadRequestHttpException('Request must not contain statementId or voidedStatementId parameters, and also any other parameter besides "attachments" or "format".');
+        }
+    }
+
+    protected function generateMoreIrl(ParameterBag $query): IRL
+    {
+        $params = $query->all();
+        $params['cursor'] = empty($params['cursor']) ? 1 : $params['cursor'] + 1;
+
+        return IRL::fromString(
+            '/plugin/xapi/lrs.php/statements?'.http_build_query($params)
+        );
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementHeadController.php b/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementHeadController.php
new file mode 100644
index 000000000..224a44185
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementHeadController.php
@@ -0,0 +1,27 @@
+setContent('');
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementPostController.php b/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementPostController.php
new file mode 100644
index 000000000..d42625417
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementPostController.php
@@ -0,0 +1,67 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\LrsBundle\Controller;
+
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Exception\ConflictHttpException;
+use Xabbuh\XApi\Common\Exception\NotFoundException;
+use Xabbuh\XApi\Model\Statement;
+use XApi\Repository\Api\StatementRepositoryInterface;
+
+/**
+ * @author Jérôme Parmentier 
+ */
+final class StatementPostController
+{
+    /**
+     * @var StatementRepositoryInterface
+     */
+    private $repository;
+
+    public function __construct(StatementRepositoryInterface $repository)
+    {
+        $this->repository = $repository;
+    }
+
+    public function postStatements(Request $request, array $statements): JsonResponse
+    {
+        $statementsToStore = [];
+
+        /** @var Statement $statement */
+        foreach ($statements as $statement) {
+            if (null === $statementId = $statement->getId()) {
+                $statementsToStore[] = $statement;
+
+                continue;
+            }
+
+            try {
+                $existingStatement = $this->repository->findStatementById($statement->getId());
+
+                if (!$existingStatement->equals($statement)) {
+                    throw new ConflictHttpException('The new statement is not equal to an existing statement with the same id.');
+                }
+            } catch (NotFoundException $e) {
+                $statementsToStore[] = $statement;
+            }
+        }
+
+        $uuids = [];
+
+        foreach ($statementsToStore as $statement) {
+            $uuids[] = $this->repository->storeStatement($statement, true)->getValue();
+        }
+
+        return new JsonResponse($uuids);
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementPutController.php b/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementPutController.php
new file mode 100644
index 000000000..660f99b36
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Controller/StatementPutController.php
@@ -0,0 +1,65 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\LrsBundle\Controller;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+use Symfony\Component\HttpKernel\Exception\ConflictHttpException;
+use Xabbuh\XApi\Common\Exception\NotFoundException;
+use Xabbuh\XApi\Model\Statement;
+use Xabbuh\XApi\Model\StatementId;
+use XApi\Repository\Api\StatementRepositoryInterface;
+
+/**
+ * @author Christian Flothmann 
+ */
+final class StatementPutController
+{
+    private $repository;
+
+    public function __construct(StatementRepositoryInterface $repository)
+    {
+        $this->repository = $repository;
+    }
+
+    public function putStatement(Request $request, Statement $statement): Response
+    {
+        if (null === $statementId = $request->query->get('statementId')) {
+            throw new BadRequestHttpException('Required statementId parameter is missing.');
+        }
+
+        try {
+            $id = StatementId::fromString($statementId);
+        } catch (\InvalidArgumentException $e) {
+            throw new BadRequestHttpException(sprintf('Parameter statementId ("%s") is not a valid UUID.', $statementId), $e);
+        }
+
+        if (null !== $statement->getId() && !$id->equals($statement->getId())) {
+            throw new ConflictHttpException(sprintf('Id parameter ("%s") and statement id ("%s") do not match.', $id->getValue(), $statement->getId()->getValue()));
+        }
+
+        try {
+            $existingStatement = $this->repository->findStatementById($id);
+
+            if (!$existingStatement->equals($statement)) {
+                throw new ConflictHttpException('The new statement is not equal to an existing statement with the same id.');
+            }
+        } catch (NotFoundException $e) {
+            $statement = $statement->withId($id);
+
+            $this->repository->storeStatement($statement, true);
+        }
+
+        return new Response('', 204);
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/DependencyInjection/Configuration.php b/plugin/xapi/php-xapi/lrs-bundle/src/DependencyInjection/Configuration.php
new file mode 100644
index 000000000..40cfa8755
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/DependencyInjection/Configuration.php
@@ -0,0 +1,35 @@
+
+ */
+final class Configuration implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder();
+
+        $treeBuilder
+            ->root('xapi_lrs')
+                ->beforeNormalization()
+                    ->ifTrue(function ($v) { return isset($v['type']) && in_array($v['type'], ['mongodb', 'orm']) && !isset($v['object_manager_service']); })
+                    ->thenInvalid('You need to configure the object manager service when the repository type is "mongodb" or orm".')
+                ->end()
+                ->children()
+                    ->enumNode('type')
+                        ->isRequired()
+                        ->values(['in_memory', 'mongodb', 'orm'])
+                    ->end()
+                    ->scalarNode('object_manager_service')->end()
+                ->end()
+            ->end()
+        ;
+
+        return $treeBuilder;
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/DependencyInjection/XApiLrsExtension.php b/plugin/xapi/php-xapi/lrs-bundle/src/DependencyInjection/XApiLrsExtension.php
new file mode 100644
index 000000000..e2ff9e6d1
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/DependencyInjection/XApiLrsExtension.php
@@ -0,0 +1,60 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\LrsBundle\DependencyInjection;
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
+use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+
+/**
+ * @author Christian Flothmann 
+ */
+final class XApiLrsExtension extends Extension
+{
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $configuration = new Configuration();
+        $config = $this->processConfiguration($configuration, $configs);
+
+        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+
+        $loader->load('controller.xml');
+        $loader->load('event_listener.xml');
+        $loader->load('factory.xml');
+        $loader->load('serializer.xml');
+
+        switch ($config['type']) {
+            case 'in_memory':
+                break;
+            case 'mongodb':
+                $loader->load('doctrine.xml');
+                $loader->load('mongodb.xml');
+
+                $container->setAlias('xapi_lrs.doctrine.object_manager', $config['object_manager_service']);
+                $container->setAlias('xapi_lrs.repository.statement', 'xapi_lrs.repository.statement.doctrine');
+                break;
+            case 'orm':
+                $loader->load('doctrine.xml');
+                $loader->load('orm.xml');
+
+                $container->setAlias('xapi_lrs.doctrine.object_manager', $config['object_manager_service']);
+                $container->setAlias('xapi_lrs.repository.statement', 'xapi_lrs.repository.statement.doctrine');
+                break;
+        }
+    }
+
+    public function getAlias()
+    {
+        return 'xapi_lrs';
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/AlternateRequestSyntaxListener.php b/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/AlternateRequestSyntaxListener.php
new file mode 100644
index 000000000..ef4a5a1ea
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/AlternateRequestSyntaxListener.php
@@ -0,0 +1,73 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\LrsBundle\EventListener;
+
+use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+
+/**
+ * @author Jérôme Parmentier 
+ */
+class AlternateRequestSyntaxListener
+{
+    public function onKernelRequest(GetResponseEvent $event)
+    {
+        if (!$event->isMasterRequest()) {
+            return;
+        }
+
+        $request = $event->getRequest();
+
+        if (!$request->attributes->has('xapi_lrs.route')) {
+            return;
+        }
+
+        if ('POST' !== $request->getMethod()) {
+            return;
+        }
+
+        if (null === $method = $request->query->get('method')) {
+            return;
+        }
+
+        if ($request->query->count() > 1) {
+            throw new BadRequestHttpException('Including other query parameters than "method" is not allowed. You have to send them as POST parameters inside the request body.');
+        }
+
+        $request->setMethod($method);
+        $request->query->remove('method');
+
+        if (null !== $content = $request->request->get('content')) {
+            $request->request->remove('content');
+
+            $request->initialize(
+                $request->query->all(),
+                $request->request->all(),
+                $request->attributes->all(),
+                $request->cookies->all(),
+                $request->files->all(),
+                $request->server->all(),
+                $content
+            );
+        }
+
+        foreach ($request->request as $key => $value) {
+            if (in_array($key, ['Authorization', 'X-Experience-API-Version', 'Content-Type', 'Content-Length', 'If-Match', 'If-None-Match'], true)) {
+                $request->headers->set($key, $value);
+            } else {
+                $request->query->set($key, $value);
+            }
+
+            $request->request->remove($key);
+        }
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/ExceptionListener.php b/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/ExceptionListener.php
new file mode 100644
index 000000000..956f2f27e
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/ExceptionListener.php
@@ -0,0 +1,17 @@
+
+ */
+class ExceptionListener
+{
+    public function onKernelException(GetResponseForExceptionEvent $event)
+    {
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/SerializerListener.php b/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/SerializerListener.php
new file mode 100644
index 000000000..3bdda2f66
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/SerializerListener.php
@@ -0,0 +1,40 @@
+
+ */
+class SerializerListener
+{
+    private $statementSerializer;
+
+    public function __construct(StatementSerializerInterface $statementSerializer)
+    {
+        $this->statementSerializer = $statementSerializer;
+    }
+
+    public function onKernelRequest(GetResponseEvent $event)
+    {
+        $request = $event->getRequest();
+
+        if (!$request->attributes->has('xapi_lrs.route')) {
+            return;
+        }
+
+        try {
+            switch ($request->attributes->get('xapi_serializer')) {
+                case 'statement':
+                    $request->attributes->set('statement', $this->statementSerializer->deserializeStatement($request->getContent()));
+                    break;
+            }
+        } catch (BaseSerializerException $e) {
+            throw new BadRequestHttpException(sprintf('The content of the request cannot be deserialized into a valid xAPI %s.', $request->attributes->get('xapi_serializer')), $e);
+        }
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/VersionListener.php b/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/VersionListener.php
new file mode 100644
index 000000000..f82af7595
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/EventListener/VersionListener.php
@@ -0,0 +1,66 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\LrsBundle\EventListener;
+
+use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
+use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+
+/**
+ * @author Jérôme Parmentier 
+ */
+class VersionListener
+{
+    public function onKernelRequest(GetResponseEvent $event)
+    {
+        if (!$event->isMasterRequest()) {
+            return;
+        }
+
+        $request = $event->getRequest();
+
+        if (!$request->attributes->has('xapi_lrs.route')) {
+            return;
+        }
+
+        if (null === $version = $request->headers->get('X-Experience-API-Version')) {
+            throw new BadRequestHttpException('Missing required "X-Experience-API-Version" header.');
+        }
+
+        if (preg_match('/^1\.0(?:\.\d+)?$/', $version)) {
+            if ('1.0' === $version) {
+                $request->headers->set('X-Experience-API-Version', '1.0.0');
+            }
+
+            return;
+        }
+
+        throw new BadRequestHttpException(sprintf('xAPI version "%s" is not supported.', $version));
+    }
+
+    public function onKernelResponse(FilterResponseEvent $event)
+    {
+        if (!$event->isMasterRequest()) {
+            return;
+        }
+
+        if (!$event->getRequest()->attributes->has('xapi_lrs.route')) {
+            return;
+        }
+
+        $headers = $event->getResponse()->headers;
+
+        if (!$headers->has('X-Experience-API-Version')) {
+            $headers->set('X-Experience-API-Version', '1.0.3');
+        }
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Model/StatementsFilterFactory.php b/plugin/xapi/php-xapi/lrs-bundle/src/Model/StatementsFilterFactory.php
new file mode 100644
index 000000000..7e1ba67f4
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Model/StatementsFilterFactory.php
@@ -0,0 +1,86 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\LrsBundle\Model;
+
+use Symfony\Component\HttpFoundation\ParameterBag;
+use Xabbuh\XApi\Model\Activity;
+use Xabbuh\XApi\Model\IRI;
+use Xabbuh\XApi\Model\StatementsFilter;
+use Xabbuh\XApi\Model\Verb;
+use Xabbuh\XApi\Serializer\ActorSerializerInterface;
+
+/**
+ * @author Jérôme Parmentier 
+ */
+class StatementsFilterFactory
+{
+    private $actorSerializer;
+
+    public function __construct(ActorSerializerInterface $actorSerializer)
+    {
+        $this->actorSerializer = $actorSerializer;
+    }
+
+    /**
+     * @return StatementsFilter
+     */
+    public function createFromParameterBag(ParameterBag $parameters)
+    {
+        $filter = new StatementsFilter();
+
+        if (($actor = $parameters->get('agent')) !== null) {
+            $filter->byActor($this->actorSerializer->deserializeActor($actor));
+        }
+
+        if (($verbId = $parameters->get('verb')) !== null) {
+            $filter->byVerb(new Verb(IRI::fromString($verbId)));
+        }
+
+        if (($activityId = $parameters->get('activity')) !== null) {
+            $filter->byActivity(new Activity(IRI::fromString($activityId)));
+        }
+
+        if (($registration = $parameters->get('registration')) !== null) {
+            $filter->byRegistration($registration);
+        }
+
+        if ($parameters->filter('related_activities', false, FILTER_VALIDATE_BOOLEAN)) {
+            $filter->enableRelatedActivityFilter();
+        } else {
+            $filter->disableRelatedActivityFilter();
+        }
+
+        if ($parameters->filter('related_agents', false, FILTER_VALIDATE_BOOLEAN)) {
+            $filter->enableRelatedAgentFilter();
+        } else {
+            $filter->disableRelatedAgentFilter();
+        }
+
+        if (($since = $parameters->get('since')) !== null) {
+            $filter->since(\DateTime::createFromFormat(\DateTime::ATOM, $since));
+        }
+
+        if (($until = $parameters->get('until')) !== null) {
+            $filter->until(\DateTime::createFromFormat(\DateTime::ATOM, $until));
+        }
+
+        if ($parameters->filter('ascending', false, FILTER_VALIDATE_BOOLEAN)) {
+            $filter->ascending();
+        } else {
+            $filter->descending();
+        }
+
+        $filter->limit($parameters->getInt('limit'));
+
+        return $filter;
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/controller.xml b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/controller.xml
new file mode 100644
index 000000000..053e487df
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/controller.xml
@@ -0,0 +1,21 @@
+
+
+
+    
+        
+            
+            
+            
+            
+        
+        
+        
+        
+        
+            
+        
+    
+
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/doctrine.xml b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/doctrine.xml
new file mode 100644
index 000000000..1eb2760b6
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/doctrine.xml
@@ -0,0 +1,12 @@
+
+
+
+    
+        
+            
+        
+    
+
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/event_listener.xml b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/event_listener.xml
new file mode 100644
index 000000000..08ad38c13
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/event_listener.xml
@@ -0,0 +1,25 @@
+
+
+
+    
+        
+            
+        
+    
+        
+        
+
+        
+            
+            
+        
+
+        
+            
+            
+        
+    
+
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/factory.xml b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/factory.xml
new file mode 100644
index 000000000..4c43d9db1
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/factory.xml
@@ -0,0 +1,12 @@
+
+
+
+    
+        
+            
+        
+    
+
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/orm.xml b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/orm.xml
new file mode 100644
index 000000000..a7c820478
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/orm.xml
@@ -0,0 +1,18 @@
+
+
+
+    
+        
+            XApi\Repository\Api\Mapping\MappedStatement
+            
+        
+
+        
+            
+            
+        
+    
+
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/routing.xml b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/routing.xml
new file mode 100644
index 000000000..27c4d2bc1
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/routing.xml
@@ -0,0 +1,29 @@
+
+
+
+    
+        xapi_lrs.controller.statement.put:putStatement
+        statement
+        
+            true
+        
+    
+
+    
+        xapi_lrs.controller.statement.post:postStatement
+        statement
+        
+            true
+        
+    
+
+    
+        xapi_lrs.controller.statement.get:getStatement
+        
+            true
+        
+    
+
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/serializer.xml b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/serializer.xml
new file mode 100644
index 000000000..2ce345a97
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Resources/config/serializer.xml
@@ -0,0 +1,32 @@
+
+
+
+    
+        
+            
+        
+
+        
+            
+        
+
+        
+            
+        
+
+        
+            
+        
+
+        
+            
+        
+
+        
+            
+        
+    
+
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Response/AttachmentResponse.php b/plugin/xapi/php-xapi/lrs-bundle/src/Response/AttachmentResponse.php
new file mode 100644
index 000000000..860de13f0
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Response/AttachmentResponse.php
@@ -0,0 +1,76 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\LrsBundle\Response;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Xabbuh\XApi\Model\Attachment;
+
+/**
+ * @author Jérôme Parmentier 
+ */
+class AttachmentResponse extends Response
+{
+    protected $attachment;
+
+    public function __construct(Attachment $attachment)
+    {
+        parent::__construct(null);
+
+        $this->attachment = $attachment;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function prepare(Request $request)
+    {
+        if (!$this->headers->has('Content-Type')) {
+            $this->headers->set('Content-Type', $this->attachment->getContentType());
+        }
+
+        $this->headers->set('Content-Transfer-Encoding', 'binary');
+        $this->headers->set('X-Experience-API-Hash', $this->attachment->getSha2());
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @throws \LogicException
+     */
+    public function sendContent()
+    {
+        throw new \LogicException('An AttachmentResponse is only meant to be part of a multipart Response.');
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @throws \LogicException when the content is not null
+     */
+    public function setContent($content)
+    {
+        if (null !== $content) {
+            throw new \LogicException('The content cannot be set on an AttachmentResponse instance.');
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return string|null
+     */
+    public function getContent()
+    {
+        return $this->attachment->getContent();
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/Response/MultipartResponse.php b/plugin/xapi/php-xapi/lrs-bundle/src/Response/MultipartResponse.php
new file mode 100644
index 000000000..a5cb9e1f5
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/Response/MultipartResponse.php
@@ -0,0 +1,135 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\LrsBundle\Response;
+
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @author Jérôme Parmentier 
+ */
+class MultipartResponse extends Response
+{
+    protected $subtype;
+    protected $boundary;
+    protected $statementPart;
+    /**
+     * @var Response[]
+     */
+    protected $parts;
+
+    /**
+     * @param AttachmentResponse[] $attachmentsParts
+     * @param int                  $status
+     * @param string|null          $subtype
+     */
+    public function __construct(JsonResponse $statementPart, array $attachmentsParts = [], $status = 200, array $headers = [], $subtype = null)
+    {
+        parent::__construct(null, $status, $headers);
+
+        if (null === $subtype) {
+            $subtype = 'mixed';
+        }
+
+        $this->subtype = $subtype;
+        $this->boundary = uniqid('', true);
+        $this->statementPart = $statementPart;
+
+        $this->setAttachmentsParts($attachmentsParts);
+    }
+
+    /**
+     * @return $this
+     */
+    public function addAttachmentPart(AttachmentResponse $part)
+    {
+        if ($part->getContent() !== null) {
+            $this->parts[] = $part;
+        }
+
+        return $this;
+    }
+
+    /**
+     * @param AttachmentResponse[] $attachmentsParts
+     *
+     * @return $this
+     */
+    public function setAttachmentsParts(array $attachmentsParts)
+    {
+        $this->parts = [$this->statementPart];
+
+        foreach ($attachmentsParts as $part) {
+            $this->addAttachmentPart($part);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function prepare(Request $request)
+    {
+        foreach ($this->parts as $part) {
+            $part->prepare($request);
+        }
+
+        $this->headers->set('Content-Type', sprintf('multipart/%s; boundary="%s"', $this->subtype, $this->boundary));
+        $this->headers->set('Transfer-Encoding', 'chunked');
+
+        return parent::prepare($request);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function sendContent()
+    {
+        $content = '';
+        foreach ($this->parts as $part) {
+            $content .= sprintf('--%s', $this->boundary)."\r\n";
+            $content .= $part->headers."\r\n";
+            $content .= $part->getContent();
+            $content .= "\r\n";
+        }
+
+        $content .= sprintf('--%s--', $this->boundary)."\r\n";
+
+        echo $content;
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @throws \LogicException when the content is not null
+     */
+    public function setContent($content)
+    {
+        if (null !== $content) {
+            throw new \LogicException('The content cannot be set on a MultipartResponse instance.');
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @return false
+     */
+    public function getContent()
+    {
+        return false;
+    }
+}
diff --git a/plugin/xapi/php-xapi/lrs-bundle/src/XApiLrsBundle.php b/plugin/xapi/php-xapi/lrs-bundle/src/XApiLrsBundle.php
new file mode 100644
index 000000000..33d7775ff
--- /dev/null
+++ b/plugin/xapi/php-xapi/lrs-bundle/src/XApiLrsBundle.php
@@ -0,0 +1,26 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\LrsBundle;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+use XApi\LrsBundle\DependencyInjection\XApiLrsExtension;
+
+/**
+ * @author Christian Flothmann 
+ */
+class XApiLrsBundle extends Bundle
+{
+    public function getContainerExtension()
+    {
+        return new XApiLrsExtension();
+    }
+}
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/LICENSE b/plugin/xapi/php-xapi/repository-doctrine-orm/LICENSE
new file mode 100644
index 000000000..de1d823c3
--- /dev/null
+++ b/plugin/xapi/php-xapi/repository-doctrine-orm/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2016-2017 Christian Flothmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/README.md b/plugin/xapi/php-xapi/repository-doctrine-orm/README.md
new file mode 100644
index 000000000..e69de29bb
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/composer.json b/plugin/xapi/php-xapi/repository-doctrine-orm/composer.json
new file mode 100644
index 000000000..dace61cba
--- /dev/null
+++ b/plugin/xapi/php-xapi/repository-doctrine-orm/composer.json
@@ -0,0 +1,41 @@
+{
+    "name": "php-xapi/repository-doctrine-orm",
+    "description": "Doctrine based ORM implementations of an Experience API (xAPI) repository",
+    "keywords": ["xAPI", "Tin Can API", "Experience API", "storage", "database", "repository", "entity", "Doctrine", "ORM"],
+    "homepage": "https://github.com/php-xapi/repository-orm/",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Christian Flothmann",
+            "homepage": "https://github.com/xabbuh"
+        }
+    ],
+    "require": {
+        "php": "^5.6 || ^7.0",
+        "doctrine/orm": "^2.3",
+        "php-xapi/repository-api": "^0.4",
+        "php-xapi/repository-doctrine": "^0.4"
+    },
+    "require-dev": {
+        "symfony/phpunit-bridge": "^3.4 || ^4.0"
+    },
+    "provide": {
+        "php-xapi/repository-implementation": "0.3"
+    },
+    "autoload": {
+        "psr-4": {
+            "XApi\\Repository\\ORM\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "XApi\\Repository\\ORM\\Tests\\": "tests/"
+        }
+    },
+    "minimum-stability": "dev",
+    "extra": {
+        "branch-alias": {
+            "dev-master": "0.1.x-dev"
+        }
+    }
+}
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Actor.orm.xml b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Actor.orm.xml
new file mode 100644
index 000000000..040148a09
--- /dev/null
+++ b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Actor.orm.xml
@@ -0,0 +1,19 @@
+
+
+    
+        
+            
+        
+
+        
+        
+        
+        
+        
+        
+        
+    
+
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Attachment.orm.xml b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Attachment.orm.xml
new file mode 100644
index 000000000..4fb517de6
--- /dev/null
+++ b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Attachment.orm.xml
@@ -0,0 +1,23 @@
+
+
+    
+        
+            
+        
+
+        
+        
+        
+        
+        
+        
+        
+        
+        
+
+        
+    
+
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Context.orm.xml b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Context.orm.xml
new file mode 100644
index 000000000..a33661e1c
--- /dev/null
+++ b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Context.orm.xml
@@ -0,0 +1,59 @@
+
+
+    
+        
+            
+        
+
+        
+        
+        
+        
+        
+        
+
+        
+            
+                
+            
+            
+        
+        
+            
+                
+            
+            
+        
+        
+            
+                
+            
+            
+        
+
+        
+        
+            
+                
+            
+        
+        
+            
+                
+            
+        
+        
+            
+                
+            
+        
+        
+            
+                
+            
+        
+    
+
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Extensions.orm.xml b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Extensions.orm.xml
new file mode 100644
index 000000000..efec34632
--- /dev/null
+++ b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Extensions.orm.xml
@@ -0,0 +1,13 @@
+
+
+    
+        
+            
+        
+
+        
+    
+
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Result.orm.xml b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Result.orm.xml
new file mode 100644
index 000000000..d1ffe5305
--- /dev/null
+++ b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Result.orm.xml
@@ -0,0 +1,28 @@
+
+
+    
+        
+            
+        
+
+        
+        
+        
+        
+        
+        
+        
+        
+        
+
+        
+            
+                
+            
+            
+        
+    
+
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Statement.orm.xml b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Statement.orm.xml
new file mode 100644
index 000000000..321d5b864
--- /dev/null
+++ b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Statement.orm.xml
@@ -0,0 +1,62 @@
+
+
+    
+
+        
+            
+        
+
+        
+        
+        
+
+        
+            
+                
+            
+            
+        
+        
+            
+                
+            
+            
+        
+        
+            
+                
+            
+            
+        
+        
+            
+                
+            
+            
+        
+        
+            
+                
+            
+            
+        
+        
+            
+                
+            
+            
+        
+
+        
+        
+            
+                
+            
+        
+    
+
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/StatementObject.orm.xml b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/StatementObject.orm.xml
new file mode 100644
index 000000000..22464ce3f
--- /dev/null
+++ b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/StatementObject.orm.xml
@@ -0,0 +1,83 @@
+
+
+    
+        
+            
+        
+
+        
+        
+
+        
+        
+        
+        
+        
+        
+        
+        
+        
+
+        
+        
+        
+        
+        
+        
+        
+
+        
+        
+
+        
+        
+            
+                
+            
+            
+        
+        
+            
+                
+            
+            
+        
+        
+            
+                
+            
+            
+        
+
+        
+        
+            
+                
+            
+            
+        
+
+        
+        
+        
+            
+        
+
+        
+        
+            
+        
+        
+            
+        
+        
+            
+        
+        
+            
+        
+    
+
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Verb.orm.xml b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Verb.orm.xml
new file mode 100644
index 000000000..2e2277c6d
--- /dev/null
+++ b/plugin/xapi/php-xapi/repository-doctrine-orm/metadata/Verb.orm.xml
@@ -0,0 +1,14 @@
+
+
+    
+        
+            
+        
+
+        
+        
+    
+
diff --git a/plugin/xapi/php-xapi/repository-doctrine-orm/src/StatementRepository.php b/plugin/xapi/php-xapi/repository-doctrine-orm/src/StatementRepository.php
new file mode 100644
index 000000000..a551eb1d5
--- /dev/null
+++ b/plugin/xapi/php-xapi/repository-doctrine-orm/src/StatementRepository.php
@@ -0,0 +1,67 @@
+
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace XApi\Repository\ORM;
+
+use Doctrine\ORM\EntityRepository;
+use XApi\Repository\Doctrine\Mapping\Context;
+use XApi\Repository\Doctrine\Mapping\Statement;
+use XApi\Repository\Doctrine\Repository\Mapping\StatementRepository as BaseStatementRepository;
+
+/**
+ * @author Christian Flothmann 
+ */
+final class StatementRepository extends EntityRepository implements BaseStatementRepository
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function findStatement(array $criteria)
+    {
+        return parent::findOneBy($criteria);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function findStatements(array $criteria)
+    {
+        if (!empty($criteria['registration'])) {
+            $contexts = $this->_em->getRepository(Context::class)->findBy([
+                'registration' => $criteria['registration'],
+            ]);
+
+            $criteria['context'] = $contexts;
+        }
+
+        unset(
+            $criteria['registration'],
+            $criteria['related_activities'],
+            $criteria['related_agents'],
+            $criteria['ascending'],
+            $criteria['limit']
+        );
+
+        return parent::findBy($criteria, ['created' => 'ASC']);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function storeStatement(Statement $mappedStatement, $flush = true)
+    {
+        $this->_em->persist($mappedStatement);
+
+        if ($flush) {
+            $this->_em->flush();
+        }
+    }
+}
diff --git a/plugin/xapi/plugin.php b/plugin/xapi/plugin.php
new file mode 100644
index 000000000..0e2770b43
--- /dev/null
+++ b/plugin/xapi/plugin.php
@@ -0,0 +1,5 @@
+get_info();
diff --git a/plugin/xapi/src/Entity/ActivityProfile.php b/plugin/xapi/src/Entity/ActivityProfile.php
new file mode 100644
index 000000000..82f07523c
--- /dev/null
+++ b/plugin/xapi/src/Entity/ActivityProfile.php
@@ -0,0 +1,93 @@
+id;
+    }
+
+    public function setId(int $id): ActivityProfile
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    public function getProfileId(): string
+    {
+        return $this->profileId;
+    }
+
+    public function setProfileId(string $profileId): ActivityProfile
+    {
+        $this->profileId = $profileId;
+
+        return $this;
+    }
+
+    public function getActivityId(): string
+    {
+        return $this->activityId;
+    }
+
+    public function setActivityId(string $activityId): ActivityProfile
+    {
+        $this->activityId = $activityId;
+
+        return $this;
+    }
+
+    public function getDocumentData(): array
+    {
+        return $this->documentData;
+    }
+
+    public function setDocumentData(array $documentData): ActivityProfile
+    {
+        $this->documentData = $documentData;
+
+        return $this;
+    }
+}
diff --git a/plugin/xapi/src/Entity/ActivityState.php b/plugin/xapi/src/Entity/ActivityState.php
new file mode 100644
index 000000000..f63d03b66
--- /dev/null
+++ b/plugin/xapi/src/Entity/ActivityState.php
@@ -0,0 +1,111 @@
+id;
+    }
+
+    public function setId(int $id): ActivityState
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    public function getStateId(): string
+    {
+        return $this->stateId;
+    }
+
+    public function setStateId(string $stateId): ActivityState
+    {
+        $this->stateId = $stateId;
+
+        return $this;
+    }
+
+    public function getActivityId(): string
+    {
+        return $this->activityId;
+    }
+
+    public function setActivityId(string $activityId): ActivityState
+    {
+        $this->activityId = $activityId;
+
+        return $this;
+    }
+
+    public function getAgent(): array
+    {
+        return $this->agent;
+    }
+
+    public function setAgent(array $agent): ActivityState
+    {
+        $this->agent = $agent;
+
+        return $this;
+    }
+
+    public function getDocumentData(): array
+    {
+        return $this->documentData;
+    }
+
+    public function setDocumentData(array $documentData): ActivityState
+    {
+        $this->documentData = $documentData;
+
+        return $this;
+    }
+}
diff --git a/plugin/xapi/src/Entity/Cmi5Item.php b/plugin/xapi/src/Entity/Cmi5Item.php
new file mode 100644
index 000000000..c3f86deea
--- /dev/null
+++ b/plugin/xapi/src/Entity/Cmi5Item.php
@@ -0,0 +1,372 @@
+children = new ArrayCollection();
+    }
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    public function setId(int $id): Cmi5Item
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    public function getIdentifier(): string
+    {
+        return $this->identifier;
+    }
+
+    public function setIdentifier(string $identifier): Cmi5Item
+    {
+        $this->identifier = $identifier;
+
+        return $this;
+    }
+
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    public function setType(string $type): Cmi5Item
+    {
+        $this->type = $type;
+
+        return $this;
+    }
+
+    public function getTitle(): array
+    {
+        return $this->title;
+    }
+
+    public function setTitle(array $title): Cmi5Item
+    {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    public function getDescription(): array
+    {
+        return $this->description;
+    }
+
+    public function setDescription(array $description): Cmi5Item
+    {
+        $this->description = $description;
+
+        return $this;
+    }
+
+    public function getUrl(): ?string
+    {
+        return $this->url;
+    }
+
+    public function setUrl(?string $url): Cmi5Item
+    {
+        $this->url = $url;
+
+        return $this;
+    }
+
+    public function getActivityType(): ?string
+    {
+        return $this->activityType;
+    }
+
+    public function setActivityType(?string $activityType): Cmi5Item
+    {
+        $this->activityType = $activityType;
+
+        return $this;
+    }
+
+    public function getLaunchMethod(): ?string
+    {
+        return $this->launchMethod;
+    }
+
+    public function setLaunchMethod(?string $launchMethod): Cmi5Item
+    {
+        $this->launchMethod = $launchMethod;
+
+        return $this;
+    }
+
+    public function getMoveOn(): ?string
+    {
+        return $this->moveOn;
+    }
+
+    public function setMoveOn(?string $moveOn): Cmi5Item
+    {
+        $this->moveOn = $moveOn;
+
+        return $this;
+    }
+
+    public function getMasteryScore(): ?float
+    {
+        return $this->masteryScore;
+    }
+
+    public function setMasteryScore(?float $masteryScore): Cmi5Item
+    {
+        $this->masteryScore = $masteryScore;
+
+        return $this;
+    }
+
+    public function getLaunchParameters(): ?string
+    {
+        return $this->launchParameters;
+    }
+
+    public function setLaunchParameters(?string $launchParameters): Cmi5Item
+    {
+        $this->launchParameters = $launchParameters;
+
+        return $this;
+    }
+
+    public function getEntitlementKey(): ?string
+    {
+        return $this->entitlementKey;
+    }
+
+    public function setEntitlementKey(?string $entitlementKey): Cmi5Item
+    {
+        $this->entitlementKey = $entitlementKey;
+
+        return $this;
+    }
+
+    /**
+     * @return \Chamilo\PluginBundle\Entity\XApi\Cmi5Item|null
+     */
+    public function getParent(): ?Cmi5Item
+    {
+        return $this->parent;
+    }
+
+    /**
+     * @param \Chamilo\PluginBundle\Entity\XApi\Cmi5Item|null $parent
+     */
+    public function setParent(?Cmi5Item $parent): Cmi5Item
+    {
+        $this->parent = $parent;
+
+        return $this;
+    }
+
+    public function getChildren(): ArrayCollection
+    {
+        return $this->children;
+    }
+
+    public function setChildren(ArrayCollection $children): Cmi5Item
+    {
+        $this->children = $children;
+
+        return $this;
+    }
+
+    public function getStatus(): ?string
+    {
+        return $this->status;
+    }
+
+    public function setStatus(?string $status): Cmi5Item
+    {
+        $this->status = $status;
+
+        return $this;
+    }
+
+    /**
+     * @return \Chamilo\PluginBundle\Entity\XApi\ToolLaunch
+     */
+    public function getTool(): ToolLaunch
+    {
+        return $this->tool;
+    }
+
+    /**
+     * @param \Chamilo\PluginBundle\Entity\XApi\ToolLaunch $tool
+     */
+    public function setTool(ToolLaunch $tool): Cmi5Item
+    {
+        $this->tool = $tool;
+
+        return $this;
+    }
+
+    /**
+     * @return \Chamilo\PluginBundle\Entity\XApi\Cmi5Item
+     */
+    public function getRoot(): Cmi5Item
+    {
+        return $this->root;
+    }
+}
diff --git a/plugin/xapi/src/Entity/InternalLog.php b/plugin/xapi/src/Entity/InternalLog.php
new file mode 100644
index 000000000..b9c807f94
--- /dev/null
+++ b/plugin/xapi/src/Entity/InternalLog.php
@@ -0,0 +1,227 @@
+id;
+    }
+
+    public function getUser(): User
+    {
+        return $this->user;
+    }
+
+    public function setUser(User $user): InternalLog
+    {
+        $this->user = $user;
+
+        return $this;
+    }
+
+    public function getStatementId(): string
+    {
+        return $this->statementId;
+    }
+
+    public function setStatementId(string $statementId): InternalLog
+    {
+        $this->statementId = $statementId;
+
+        return $this;
+    }
+
+    public function getVerb(): string
+    {
+        return $this->verb;
+    }
+
+    public function setVerb(string $verb): InternalLog
+    {
+        $this->verb = $verb;
+
+        return $this;
+    }
+
+    public function getObjectId(): string
+    {
+        return $this->objectId;
+    }
+
+    public function setObjectId(string $objectId): InternalLog
+    {
+        $this->objectId = $objectId;
+
+        return $this;
+    }
+
+    public function getActivityName(): ?string
+    {
+        return $this->activityName;
+    }
+
+    public function setActivityName(?string $activityName): InternalLog
+    {
+        $this->activityName = $activityName;
+
+        return $this;
+    }
+
+    public function getActivityDescription(): ?string
+    {
+        return $this->activityDescription;
+    }
+
+    public function setActivityDescription(?string $activityDescription): InternalLog
+    {
+        $this->activityDescription = $activityDescription;
+
+        return $this;
+    }
+
+    public function getScoreScaled(): ?float
+    {
+        return $this->scoreScaled;
+    }
+
+    public function setScoreScaled(?float $scoreScaled): InternalLog
+    {
+        $this->scoreScaled = $scoreScaled;
+
+        return $this;
+    }
+
+    public function getScoreRaw(): ?float
+    {
+        return $this->scoreRaw;
+    }
+
+    public function setScoreRaw(?float $scoreRaw): InternalLog
+    {
+        $this->scoreRaw = $scoreRaw;
+
+        return $this;
+    }
+
+    public function getScoreMin(): ?float
+    {
+        return $this->scoreMin;
+    }
+
+    public function setScoreMin(?float $scoreMin): InternalLog
+    {
+        $this->scoreMin = $scoreMin;
+
+        return $this;
+    }
+
+    public function getScoreMax(): ?float
+    {
+        return $this->scoreMax;
+    }
+
+    public function setScoreMax(?float $scoreMax): InternalLog
+    {
+        $this->scoreMax = $scoreMax;
+
+        return $this;
+    }
+
+    public function getCreatedAt(): ?DateTime
+    {
+        return $this->createdAt;
+    }
+
+    public function setCreatedAt(?DateTime $createdAt): InternalLog
+    {
+        $this->createdAt = $createdAt;
+
+        return $this;
+    }
+}
diff --git a/plugin/xapi/src/Entity/LrsAuth.php b/plugin/xapi/src/Entity/LrsAuth.php
new file mode 100644
index 000000000..69cc839ea
--- /dev/null
+++ b/plugin/xapi/src/Entity/LrsAuth.php
@@ -0,0 +1,104 @@
+id;
+    }
+
+    public function getUsername(): string
+    {
+        return $this->username;
+    }
+
+    public function setUsername(string $username): LrsAuth
+    {
+        $this->username = $username;
+
+        return $this;
+    }
+
+    public function getPassword(): string
+    {
+        return $this->password;
+    }
+
+    public function setPassword(string $password): LrsAuth
+    {
+        $this->password = $password;
+
+        return $this;
+    }
+
+    public function isEnabled(): bool
+    {
+        return $this->enabled;
+    }
+
+    public function setEnabled(bool $enabled): LrsAuth
+    {
+        $this->enabled = $enabled;
+
+        return $this;
+    }
+
+    public function getCreatedAt(): \DateTime
+    {
+        return $this->createdAt;
+    }
+
+    public function setCreatedAt(\DateTime $createdAt): LrsAuth
+    {
+        $this->createdAt = $createdAt;
+
+        return $this;
+    }
+}
diff --git a/plugin/xapi/src/Entity/Repository/ToolLaunchRepository.php b/plugin/xapi/src/Entity/Repository/ToolLaunchRepository.php
new file mode 100644
index 000000000..0446c9fc0
--- /dev/null
+++ b/plugin/xapi/src/Entity/Repository/ToolLaunchRepository.php
@@ -0,0 +1,85 @@
+ $course,
+            'session' => null,
+        ];
+
+        if ($session) {
+            $criteria['session'] = $session;
+        }
+
+        return $this->findBy($criteria, $orderBy, $limit, $start);
+    }
+
+    public function countByCourseAndSession(Course $course, Session $session = null, $filteredForStudent = false): int
+    {
+        $qb = $this->createQueryBuilder('tl');
+        $qb->select($qb->expr()->count('tl'))
+            ->where($qb->expr()->eq('tl.course', ':course'))
+            ->setParameter('course', $course);
+
+        if ($session) {
+            $qb->andWhere($qb->expr()->eq('tl.session', ':session'))
+                ->setParameter('session', $session);
+        } else {
+            $qb->andWhere($qb->expr()->isNull('tl.session'));
+        }
+
+        if ($filteredForStudent) {
+            $qb
+                ->leftJoin(
+                    CLpItem::class,
+                    'lpi',
+                    Join::WITH,
+                    "tl.id = lpi.path AND tl.course = lpi.cId AND lpi.itemType = 'xapi'"
+                )
+                ->andWhere($qb->expr()->isNull('lpi.path'));
+        }
+
+        $query = $qb->getQuery();
+
+        return (int) $query->getSingleScalarResult();
+    }
+
+    public function wasAddedInLp(ToolLaunch $toolLaunch): int
+    {
+        $qb = $this->getEntityManager()->createQueryBuilder();
+
+        return (int) $qb->select($qb->expr()->count('lp'))
+            ->from(CLp::class, 'lp')
+            ->innerJoin(CLpItem::class, 'lpi', Join::WITH, 'lp.id = lpi.lpId')
+            ->where('lpi.itemType = :type')
+            ->andWhere('lpi.path = :tool_id')
+            ->setParameter('type', TOOL_XAPI)
+            ->setParameter('tool_id', $toolLaunch->getId())
+            ->getQuery()
+            ->getSingleScalarResult();
+    }
+}
diff --git a/plugin/xapi/src/Entity/SharedStatement.php b/plugin/xapi/src/Entity/SharedStatement.php
new file mode 100644
index 000000000..5c4d81caa
--- /dev/null
+++ b/plugin/xapi/src/Entity/SharedStatement.php
@@ -0,0 +1,105 @@
+statement = $statement;
+        $this->uuid = $uuid;
+        $this->sent = $sent;
+    }
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    public function getUuid(): ?string
+    {
+        return $this->uuid;
+    }
+
+    public function setUuid(?string $uuid): SharedStatement
+    {
+        $this->uuid = $uuid;
+
+        return $this;
+    }
+
+    public function getStatement(): array
+    {
+        return $this->statement;
+    }
+
+    public function setStatement(array $statement): SharedStatement
+    {
+        $this->statement = $statement;
+
+        return $this;
+    }
+
+    public function isSent(): bool
+    {
+        return $this->sent;
+    }
+
+    public function setSent(bool $sent): SharedStatement
+    {
+        $this->sent = $sent;
+
+        return $this;
+    }
+}
diff --git a/plugin/xapi/src/Entity/ToolLaunch.php b/plugin/xapi/src/Entity/ToolLaunch.php
new file mode 100644
index 000000000..6d9d4f5b8
--- /dev/null
+++ b/plugin/xapi/src/Entity/ToolLaunch.php
@@ -0,0 +1,295 @@
+allowMultipleAttempts = true;
+        $this->items = new ArrayCollection();
+    }
+
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    public function setId(int $id): ToolLaunch
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    public function getTitle(): string
+    {
+        return $this->title;
+    }
+
+    public function setTitle(string $title): ToolLaunch
+    {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    public function getDescription(): ?string
+    {
+        return $this->description;
+    }
+
+    public function setDescription(?string $description): ToolLaunch
+    {
+        $this->description = $description;
+
+        return $this;
+    }
+
+    public function getCourse(): Course
+    {
+        return $this->course;
+    }
+
+    public function setCourse(Course $course): ToolLaunch
+    {
+        $this->course = $course;
+
+        return $this;
+    }
+
+    public function getSession(): ?Session
+    {
+        return $this->session;
+    }
+
+    public function setSession(?Session $session): ToolLaunch
+    {
+        $this->session = $session;
+
+        return $this;
+    }
+
+    public function getLaunchUrl(): string
+    {
+        return $this->launchUrl;
+    }
+
+    public function setLaunchUrl(string $launchUrl): ToolLaunch
+    {
+        $this->launchUrl = $launchUrl;
+
+        return $this;
+    }
+
+    public function getActivityId(): ?string
+    {
+        return $this->activityId;
+    }
+
+    public function setActivityId(?string $activityId): ToolLaunch
+    {
+        $this->activityId = $activityId;
+
+        return $this;
+    }
+
+    public function getCreatedAt(): DateTime
+    {
+        return $this->createdAt;
+    }
+
+    public function setCreatedAt(DateTime $createdAt): ToolLaunch
+    {
+        $this->createdAt = $createdAt;
+
+        return $this;
+    }
+
+    public function getActivityType(): ?string
+    {
+        return $this->activityType;
+    }
+
+    public function setActivityType(?string $activityType): ToolLaunch
+    {
+        $this->activityType = $activityType;
+
+        return $this;
+    }
+
+    public function isAllowMultipleAttempts(): bool
+    {
+        return $this->allowMultipleAttempts;
+    }
+
+    public function setAllowMultipleAttempts(bool $allowMultipleAttempts): ToolLaunch
+    {
+        $this->allowMultipleAttempts = $allowMultipleAttempts;
+
+        return $this;
+    }
+
+    public function getLrsUrl(): ?string
+    {
+        return $this->lrsUrl;
+    }
+
+    public function setLrsUrl(?string $lrsUrl): ToolLaunch
+    {
+        $this->lrsUrl = $lrsUrl;
+
+        return $this;
+    }
+
+    public function getLrsAuthUsername(): ?string
+    {
+        return $this->lrsAuthUsername;
+    }
+
+    public function setLrsAuthUsername(?string $lrsAuthUsername): ToolLaunch
+    {
+        $this->lrsAuthUsername = $lrsAuthUsername;
+
+        return $this;
+    }
+
+    public function getLrsAuthPassword(): ?string
+    {
+        return $this->lrsAuthPassword;
+    }
+
+    public function setLrsAuthPassword(?string $lrsAuthPassword): ToolLaunch
+    {
+        $this->lrsAuthPassword = $lrsAuthPassword;
+
+        return $this;
+    }
+
+    public function getItems(): ArrayCollection
+    {
+        return $this->items;
+    }
+
+    /**
+     * @param \Chamilo\PluginBundle\Entity\XApi\Cmi5Item $cmi5Item
+     *
+     * @return $this
+     */
+    public function addItem(Cmi5Item $cmi5Item)
+    {
+        $cmi5Item->setTool($this);
+
+        $this->items->add($cmi5Item);
+
+        return $this;
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiActivityHookObserver.php b/plugin/xapi/src/Hook/XApiActivityHookObserver.php
new file mode 100644
index 000000000..c622e5eee
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiActivityHookObserver.php
@@ -0,0 +1,66 @@
+plugin = XApiPlugin::create();
+    }
+
+    /**
+     * @throws \Doctrine\ORM\ORMException
+     * @throws \Doctrine\ORM\OptimisticLockException
+     *
+     * @return \Chamilo\PluginBundle\Entity\XApi\SharedStatement|null
+     */
+    protected function saveSharedStatement(Statement $statement)
+    {
+        $statementSerialized = $this->serializeStatement($statement);
+
+        $sharedStmt = new SharedStatement(
+            json_decode($statementSerialized, true)
+        );
+
+        $em = Database::getManager();
+        $em->persist($sharedStmt);
+        $em->flush();
+
+        return $sharedStmt;
+    }
+
+    /**
+     * Serialize a statement to JSON.
+     *
+     * @return string
+     */
+    private function serializeStatement(Statement $statement)
+    {
+        $serializer = Serializer::createSerializer();
+        $statementSerializer = new StatementSerializer($serializer);
+
+        return $statementSerializer->serializeStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiCreateCourseHookObserver.php b/plugin/xapi/src/Hook/XApiCreateCourseHookObserver.php
new file mode 100644
index 000000000..dd5ca328b
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiCreateCourseHookObserver.php
@@ -0,0 +1,37 @@
+getEventData();
+
+        $type = $data['type'];
+        $courseInfo = $data['course_info'];
+
+        $plugin = XApiPlugin::create();
+
+        if (HOOK_EVENT_TYPE_POST == $type) {
+            $plugin->addCourseToolForTinCan($courseInfo['real_id']);
+        }
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiLearningPathEndHookObserver.php b/plugin/xapi/src/Hook/XApiLearningPathEndHookObserver.php
new file mode 100644
index 000000000..5993cfacc
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiLearningPathEndHookObserver.php
@@ -0,0 +1,26 @@
+getEventData();
+        $em = Database::getManager();
+
+        $lpView = $em->find('ChamiloCourseBundle:CLpView', $data['lp_view_id']);
+        $lp = $em->find('ChamiloCourseBundle:CLp', $lpView->getLpId());
+
+        $learningPathEnded = new LearningPathCompleted($lpView, $lp);
+
+        $statement = $learningPathEnded->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiLearningPathItemViewedHookObserver.php b/plugin/xapi/src/Hook/XApiLearningPathItemViewedHookObserver.php
new file mode 100644
index 000000000..676b504c3
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiLearningPathItemViewedHookObserver.php
@@ -0,0 +1,35 @@
+getEventData();
+        $em = Database::getManager();
+
+        $lpItemView = $em->find('ChamiloCourseBundle:CLpItemView', $data['item_view_id']);
+        $lpItem = $em->find('ChamiloCourseBundle:CLpItem', $lpItemView->getLpItemId());
+
+        if ('quiz' == $lpItem->getItemType()) {
+            return null;
+        }
+
+        $lpView = $em->find('ChamiloCourseBundle:CLpView', $lpItemView->getLpViewId());
+
+        $lpItemViewed = new LearningPathItemViewed($lpItemView, $lpItem, $lpView);
+
+        $statement = $lpItemViewed->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiPortfolioCommentEditedHookObserver.php b/plugin/xapi/src/Hook/XApiPortfolioCommentEditedHookObserver.php
new file mode 100644
index 000000000..4bd43bfd0
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiPortfolioCommentEditedHookObserver.php
@@ -0,0 +1,19 @@
+getEventData()['comment'];
+
+        $statement = (new PortfolioCommentEdited($comment))->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiPortfolioCommentScoredHookObserver.php b/plugin/xapi/src/Hook/XApiPortfolioCommentScoredHookObserver.php
new file mode 100644
index 000000000..3dcd0de5d
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiPortfolioCommentScoredHookObserver.php
@@ -0,0 +1,19 @@
+getEventData()['comment'];
+
+        $statement = (new PortfolioCommentScored($comment))->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiPortfolioDownloadedHookObserver.php b/plugin/xapi/src/Hook/XApiPortfolioDownloadedHookObserver.php
new file mode 100644
index 000000000..b992006c1
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiPortfolioDownloadedHookObserver.php
@@ -0,0 +1,17 @@
+getEventData()['owner'];
+
+        $statement = (new PortfolioDownloaded($owner))->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiPortfolioItemAddedHookObserver.php b/plugin/xapi/src/Hook/XApiPortfolioItemAddedHookObserver.php
new file mode 100644
index 000000000..5738a1f4f
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiPortfolioItemAddedHookObserver.php
@@ -0,0 +1,25 @@
+getEventData()['portfolio'];
+
+        $portfolioItemShared = new PortfolioItemShared($item);
+
+        $statement = $portfolioItemShared->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiPortfolioItemCommentedHookObserver.php b/plugin/xapi/src/Hook/XApiPortfolioItemCommentedHookObserver.php
new file mode 100644
index 000000000..32bc4a8d8
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiPortfolioItemCommentedHookObserver.php
@@ -0,0 +1,25 @@
+getEventData()['comment'];
+
+        $portfolioItemCommented = new PortfolioItemCommented($comment);
+
+        $statement = $portfolioItemCommented->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiPortfolioItemEditedHookObserver.php b/plugin/xapi/src/Hook/XApiPortfolioItemEditedHookObserver.php
new file mode 100644
index 000000000..a5535c2a2
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiPortfolioItemEditedHookObserver.php
@@ -0,0 +1,19 @@
+getEventData()['item'];
+
+        $statement = (new PortfolioItemEdited($item))->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiPortfolioItemHighlightedHookObserver.php b/plugin/xapi/src/Hook/XApiPortfolioItemHighlightedHookObserver.php
new file mode 100644
index 000000000..9a7092329
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiPortfolioItemHighlightedHookObserver.php
@@ -0,0 +1,22 @@
+getEventData()['item'];
+
+        $statement = (new PortfolioItemHighlighted($item))->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiPortfolioItemScoredHookObserver.php b/plugin/xapi/src/Hook/XApiPortfolioItemScoredHookObserver.php
new file mode 100644
index 000000000..bed2dfb94
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiPortfolioItemScoredHookObserver.php
@@ -0,0 +1,19 @@
+getEventData()['item'];
+
+        $statement = (new PortfolioItemScored($item))->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiPortfolioItemViewedHookObserver.php b/plugin/xapi/src/Hook/XApiPortfolioItemViewedHookObserver.php
new file mode 100644
index 000000000..fbe525066
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiPortfolioItemViewedHookObserver.php
@@ -0,0 +1,25 @@
+getEventData()['portfolio'];
+
+        $statement = (new PortfolioItemViewed($item))->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiQuizEndHookObserver.php b/plugin/xapi/src/Hook/XApiQuizEndHookObserver.php
new file mode 100644
index 000000000..c85407953
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiQuizEndHookObserver.php
@@ -0,0 +1,29 @@
+getEventData();
+        $em = Database::getManager();
+
+        $exe = $em->find('ChamiloCoreBundle:TrackEExercises', $data['exe_id']);
+        $quiz = $em->find('ChamiloCourseBundle:CQuiz', $exe->getExeExoId());
+
+        $quizCompleted = new QuizCompleted($exe, $quiz);
+
+        $statement = $quizCompleted->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Hook/XApiQuizQuestionAnsweredHookObserver.php b/plugin/xapi/src/Hook/XApiQuizQuestionAnsweredHookObserver.php
new file mode 100644
index 000000000..f16454255
--- /dev/null
+++ b/plugin/xapi/src/Hook/XApiQuizQuestionAnsweredHookObserver.php
@@ -0,0 +1,42 @@
+getEventData();
+
+        $em = Database::getManager();
+        $attemptRepo = $em->getRepository(TrackEAttempt::class);
+
+        $exe = $em->find(TrackEExercises::class, $data['exe_id']);
+        $question = $em->find(CQuizQuestion::class, $data['question']['id']);
+        $attempt = $attemptRepo->findOneBy(
+            [
+                'exeId' => $exe->getExeId(),
+                'questionId' => $question->getId(),
+            ]
+        );
+        $quiz = $em->find(CQuiz::class, $data['quiz']['id']);
+
+        $quizQuestionAnswered = new QuizQuestionAnswered($attempt, $question, $quiz);
+
+        $statement = $quizQuestionAnswered->generate();
+
+        $this->saveSharedStatement($statement);
+    }
+}
diff --git a/plugin/xapi/src/Importer/PackageImporter.php b/plugin/xapi/src/Importer/PackageImporter.php
new file mode 100644
index 000000000..25a8b4b1f
--- /dev/null
+++ b/plugin/xapi/src/Importer/PackageImporter.php
@@ -0,0 +1,67 @@
+packageFileInfo = $fileInfo;
+        $this->course = $course;
+
+        $this->courseDirectoryPath = api_get_path(SYS_COURSE_PATH).$this->course->getDirectory();
+    }
+
+    /**
+     * @return \Chamilo\PluginBundle\XApi\Importer\XmlPackageImporter|\Chamilo\PluginBundle\XApi\Importer\ZipPackageImporter
+     */
+    public static function create(array $fileInfo, Course $course)
+    {
+        if ('text/xml' === $fileInfo['type']) {
+            return new XmlPackageImporter($fileInfo, $course);
+        }
+
+        return new ZipPackageImporter($fileInfo, $course);
+    }
+
+    /**
+     * @throws \Exception
+     *
+     * @return mixed
+     */
+    abstract public function import(): string;
+
+    public function getPackageType(): string
+    {
+        return $this->packageType;
+    }
+}
diff --git a/plugin/xapi/src/Importer/XmlPackageImporter.php b/plugin/xapi/src/Importer/XmlPackageImporter.php
new file mode 100644
index 000000000..2a48fddb3
--- /dev/null
+++ b/plugin/xapi/src/Importer/XmlPackageImporter.php
@@ -0,0 +1,29 @@
+packageFileInfo['name'], ['tincan.xml', 'cmi5.xml'])) {
+            throw new Exception('Invalid package');
+        }
+
+        $this->packageType = explode('.', $this->packageFileInfo['name'], 2)[0];
+
+        return $this->packageFileInfo['tmp_name'];
+    }
+}
diff --git a/plugin/xapi/src/Importer/ZipPackageImporter.php b/plugin/xapi/src/Importer/ZipPackageImporter.php
new file mode 100644
index 000000000..ae5be37a2
--- /dev/null
+++ b/plugin/xapi/src/Importer/ZipPackageImporter.php
@@ -0,0 +1,88 @@
+packageFileInfo['tmp_name']);
+        $zipContent = $zipFile->listContent();
+
+        $packageSize = array_reduce(
+            $zipContent,
+            function ($accumulator, $zipEntry) {
+                if (preg_match('~.(php.*|phtml)$~i', $zipEntry['filename'])) {
+                    throw new Exception("File \"{$zipEntry['filename']}\" contains a PHP script");
+                }
+
+                if (in_array($zipEntry['filename'], ['tincan.xml', 'cmi5.xml'])) {
+                    $this->packageType = explode('.', $zipEntry['filename'], 2)[0];
+                }
+
+                return $accumulator + $zipEntry['size'];
+            }
+        );
+
+        if (empty($this->packageType)) {
+            throw new Exception('Invalid package');
+        }
+
+        $this->validateEnoughSpace($packageSize);
+
+        $pathInfo = pathinfo($this->packageFileInfo['name']);
+
+        $packageDirectoryPath = $this->generatePackageDirectory($pathInfo['filename']);
+
+        $zipFile->extract($packageDirectoryPath);
+
+        return "$packageDirectoryPath/{$this->packageType}.xml";
+    }
+
+    /**
+     * @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 storage package.');
+        }
+    }
+
+    private function generatePackageDirectory(string $name): string
+    {
+        $directoryPath = implode(
+            '/',
+            [
+                $this->courseDirectoryPath,
+                $this->packageType,
+                api_replace_dangerous_char($name),
+            ]
+        );
+
+        $fs = new Filesystem();
+        $fs->mkdir(
+            $directoryPath,
+            api_get_permissions_for_new_directories()
+        );
+
+        return $directoryPath;
+    }
+}
diff --git a/plugin/xapi/src/Lrs/AboutController.php b/plugin/xapi/src/Lrs/AboutController.php
new file mode 100644
index 000000000..084f2ddae
--- /dev/null
+++ b/plugin/xapi/src/Lrs/AboutController.php
@@ -0,0 +1,30 @@
+ [
+                '1.0.3',
+                '1.0.2',
+                '1.0.1',
+                '1.0.0',
+            ],
+        ];
+
+        return JsonResponse::create($json);
+    }
+}
diff --git a/plugin/xapi/src/Lrs/ActivitiesProfileController.php b/plugin/xapi/src/Lrs/ActivitiesProfileController.php
new file mode 100644
index 000000000..bf12e82f0
--- /dev/null
+++ b/plugin/xapi/src/Lrs/ActivitiesProfileController.php
@@ -0,0 +1,78 @@
+httpRequest->query->get('profileId');
+        $activityId = $this->httpRequest->query->get('activityId');
+
+        $em = \Database::getManager();
+        $profileRepo = $em->getRepository(ActivityProfile::class);
+
+        /** @var ActivityProfile $activityProfile */
+        $activityProfile = $profileRepo->findOneBy(
+            [
+                'profileId' => $profileId,
+                'activityId' => $activityId,
+            ]
+        );
+
+        if (empty($activityProfile)) {
+            return Response::create(null, Response::HTTP_NO_CONTENT);
+        }
+
+        return Response::create(
+            json_encode($activityProfile->getDocumentData())
+        );
+    }
+
+    public function head(): Response
+    {
+        return $this->get()->setContent('');
+    }
+
+    public function put(): Response
+    {
+        $profileId = $this->httpRequest->query->get('profileId');
+        $activityId = $this->httpRequest->query->get('activityId');
+        $documentData = $this->httpRequest->getContent();
+
+        $em = \Database::getManager();
+        $profileRepo = $em->getRepository(ActivityProfile::class);
+
+        /** @var ActivityProfile $activityProfile */
+        $activityProfile = $profileRepo->findOneBy(
+            [
+                'profileId' => $profileId,
+                'activityId' => $activityId,
+            ]
+        );
+
+        if (empty($activityProfile)) {
+            $activityProfile = new ActivityProfile();
+            $activityProfile
+                ->setProfileId($profileId)
+                ->setActivityId($activityId);
+        }
+
+        $activityProfile->setDocumentData(json_decode($documentData, true));
+
+        $em->persist($activityProfile);
+        $em->flush();
+
+        return Response::create(null, Response::HTTP_NO_CONTENT);
+    }
+}
diff --git a/plugin/xapi/src/Lrs/ActivitiesStateController.php b/plugin/xapi/src/Lrs/ActivitiesStateController.php
new file mode 100644
index 000000000..6d05fc7b8
--- /dev/null
+++ b/plugin/xapi/src/Lrs/ActivitiesStateController.php
@@ -0,0 +1,120 @@
+httpRequest->query->get('agent');
+        $activityId = $this->httpRequest->query->get('activityId');
+        $stateId = $this->httpRequest->query->get('stateId');
+
+        $state = Database::select(
+            '*',
+            Database::get_main_table('xapi_activity_state'),
+            [
+                'where' => [
+                    'state_id = ? AND activity_id = ? AND MD5(agent) = ?' => [
+                        Database::escape_string($stateId),
+                        Database::escape_string($activityId),
+                        md5($requestedAgent),
+                    ],
+                ],
+            ],
+            'first'
+        );
+
+        if (empty($state)) {
+            return JsonResponse::create([], Response::HTTP_NOT_FOUND);
+        }
+
+        $requestedAgent = $serializer->deserialize(
+            $this->httpRequest->query->get('agent'),
+            Actor::class,
+            'json'
+        );
+
+        /** @var Actor $stateAgent */
+        $stateAgent = $serializer->deserialize(
+            $state['agent'],
+            Actor::class,
+            'json'
+        );
+
+        if (!$stateAgent->equals($requestedAgent)) {
+            return JsonResponse::create([], Response::HTTP_NOT_FOUND);
+        }
+
+        $documentData = json_decode($state['document_data'], true);
+
+        return JsonResponse::create($documentData);
+    }
+
+    public function head(): Response
+    {
+        return $this->get()->setContent('');
+    }
+
+    public function post(): Response
+    {
+        return $this->put();
+    }
+
+    public function put(): Response
+    {
+        $activityId = $this->httpRequest->query->get('activityId');
+        $agent = $this->httpRequest->query->get('agent');
+        $stateId = $this->httpRequest->query->get('stateId');
+        $documentData = $this->httpRequest->getContent();
+
+        $state = Database::select(
+            'id',
+            Database::get_main_table('xapi_activity_state'),
+            [
+                'where' => [
+                    'state_id = ? AND activity_id = ? AND MD5(agent) = ?' => [
+                        Database::escape_string($stateId),
+                        Database::escape_string($activityId),
+                        md5($agent),
+                    ],
+                ],
+            ],
+            'first'
+        );
+
+        $em = Database::getManager();
+
+        if (empty($state)) {
+            $state = new ActivityState();
+            $state
+                ->setActivityId($activityId)
+                ->setAgent(json_decode($agent, true))
+                ->setStateId($stateId);
+        } else {
+            $state = $em->find(ActivityState::class, $state['id']);
+        }
+
+        $state->setDocumentData(json_decode($documentData, true));
+
+        $em->persist($state);
+        $em->flush();
+
+        return Response::create('', Response::HTTP_NO_CONTENT);
+    }
+}
diff --git a/plugin/xapi/src/Lrs/BaseController.php b/plugin/xapi/src/Lrs/BaseController.php
new file mode 100644
index 000000000..865b2b71b
--- /dev/null
+++ b/plugin/xapi/src/Lrs/BaseController.php
@@ -0,0 +1,28 @@
+httpRequest = $httpRequest;
+    }
+}
diff --git a/plugin/xapi/src/Lrs/LrsRequest.php b/plugin/xapi/src/Lrs/LrsRequest.php
new file mode 100644
index 000000000..f409f6194
--- /dev/null
+++ b/plugin/xapi/src/Lrs/LrsRequest.php
@@ -0,0 +1,221 @@
+request = HttpRequest::createFromGlobals();
+    }
+
+    public function send()
+    {
+        try {
+            $this->alternateRequestSyntax();
+
+            $controllerName = $this->getControllerName();
+            $methodName = $this->getMethodName();
+
+            $response = $this->generateResponse($controllerName, $methodName);
+        } catch (XApiException $xApiException) {
+            $response = HttpResponse::create('', HttpResponse::HTTP_BAD_REQUEST);
+        } catch (HttpException $httpException) {
+            $response = HttpResponse::create(
+                $httpException->getMessage(),
+                $httpException->getStatusCode()
+            );
+        } catch (\Exception $exception) {
+            $response = HttpResponse::create($exception->getMessage(), HttpResponse::HTTP_BAD_REQUEST);
+        }
+
+        $response->headers->set('X-Experience-API-Version', '1.0.3');
+
+        $response->send();
+    }
+
+    /**
+     * @throws \Xabbuh\XApi\Common\Exception\AccessDeniedException
+     */
+    private function validateAuth(): bool
+    {
+        if (!$this->request->headers->has('Authorization')) {
+            throw new AccessDeniedException();
+        }
+
+        $authHeader = $this->request->headers->get('Authorization');
+
+        $parts = explode('Basic ', $authHeader, 2);
+
+        if (empty($parts[1])) {
+            throw new AccessDeniedException();
+        }
+
+        $authDecoded = base64_decode($parts[1]);
+
+        $parts = explode(':', $authDecoded, 2);
+
+        if (empty($parts) || count($parts) !== 2) {
+            throw new AccessDeniedException();
+        }
+
+        list($username, $password) = $parts;
+
+        $auth = Database::getManager()
+            ->getRepository(LrsAuth::class)
+            ->findOneBy(
+                ['username' => $username, 'password' => $password, 'enabled' => true]
+            );
+
+        if (null == $auth) {
+            throw new AccessDeniedException();
+        }
+
+        return true;
+    }
+
+    private function validateVersion()
+    {
+        $version = $this->request->headers->get('X-Experience-API-Version');
+
+        if (null === $version) {
+            throw new BadRequestHttpException('The "X-Experience-API-Version" header is required.');
+        }
+
+        if (preg_match('/^1\.0(?:\.\d+)?$/', $version)) {
+            if ('1.0' === $version) {
+                $this->request->headers->set('X-Experience-API-Version', '1.0.0');
+            }
+
+            return;
+        }
+
+        throw new BadRequestHttpException("The xAPI version \"$version\" is not supported.");
+    }
+
+    private function getControllerName(): ?string
+    {
+        $segments = explode('/', $this->request->getPathInfo());
+        $segments = array_filter($segments);
+        $segments = array_values($segments);
+
+        if (empty($segments)) {
+            throw new BadRequestHttpException('Bad request');
+        }
+
+        $segments = array_map('ucfirst', $segments);
+        $controllerName = implode('', $segments).'Controller';
+
+        return "Chamilo\\PluginBundle\\XApi\Lrs\\$controllerName";
+    }
+
+    private function getMethodName(): string
+    {
+        $method = $this->request->getMethod();
+
+        return strtolower($method);
+    }
+
+    /**
+     * @throws \Xabbuh\XApi\Common\Exception\AccessDeniedException
+     */
+    private function generateResponse(string $controllerName, string $methodName): HttpResponse
+    {
+        if (!class_exists($controllerName)
+            || !method_exists($controllerName, $methodName)
+        ) {
+            throw new NotFoundHttpException();
+        }
+
+        if ($controllerName !== AboutController::class) {
+            $this->validateAuth();
+            $this->validateVersion();
+        }
+
+        /** @var HttpResponse $response */
+        $response = call_user_func(
+            [
+                new $controllerName($this->request),
+                $methodName,
+            ]
+        );
+
+        return $response;
+    }
+
+    private function alternateRequestSyntax()
+    {
+        if ('POST' !== $this->request->getMethod()) {
+            return;
+        }
+
+        if (null === $method = $this->request->query->get('method')) {
+            return;
+        }
+
+        if ($this->request->query->count() > 1) {
+            throw new BadRequestHttpException('Including other query parameters than "method" is not allowed. You have to send them as POST parameters inside the request body.');
+        }
+
+        $this->request->setMethod($method);
+        $this->request->query->remove('method');
+
+        if (null !== $content = $this->request->request->get('content')) {
+            $this->request->request->remove('content');
+
+            $this->request->initialize(
+                $this->request->query->all(),
+                $this->request->request->all(),
+                $this->request->attributes->all(),
+                $this->request->cookies->all(),
+                $this->request->files->all(),
+                $this->request->server->all(),
+                $content
+            );
+        }
+
+        $headerNames = [
+            'Authorization',
+            'X-Experience-API-Version',
+            'Content-Type',
+            'Content-Length',
+            'If-Match',
+            'If-None-Match',
+        ];
+
+        foreach ($this->request->request as $key => $value) {
+            if (in_array($key, $headerNames, true)) {
+                $this->request->headers->set($key, $value);
+            } else {
+                $this->request->query->set($key, $value);
+            }
+
+            $this->request->request->remove($key);
+        }
+    }
+}
diff --git a/plugin/xapi/src/Lrs/StatementsController.php b/plugin/xapi/src/Lrs/StatementsController.php
new file mode 100644
index 000000000..86dc548b0
--- /dev/null
+++ b/plugin/xapi/src/Lrs/StatementsController.php
@@ -0,0 +1,147 @@
+statementRepository = new StatementRepository(
+            $pluginEm->getRepository(StatementEntity::class)
+        );
+        $this->serializer = Serializer::createSerializer();
+        $this->serializerFactory = new SerializerFactory($this->serializer);
+    }
+
+    public function get(): Response
+    {
+        $getStatementController = new StatementGetController(
+            $this->statementRepository,
+            $this->serializerFactory->createStatementSerializer(),
+            $this->serializerFactory->createStatementResultSerializer(),
+            new StatementsFilterFactory(
+                new ActorSerializer($this->serializer)
+            )
+        );
+
+        return $getStatementController->getStatement($this->httpRequest);
+    }
+
+    public function head(): Response
+    {
+        $headStatementController = new StatementHeadController(
+            $this->statementRepository,
+            $this->serializerFactory->createStatementSerializer(),
+            $this->serializerFactory->createStatementResultSerializer(),
+            new StatementsFilterFactory(
+                new ActorSerializer($this->serializer)
+            )
+        );
+
+        return $headStatementController->getStatement($this->httpRequest);
+    }
+
+    public function put(): Response
+    {
+        $statement = $this->serializerFactory
+            ->createStatementSerializer()
+            ->deserializeStatement(
+                $this->httpRequest->getContent()
+            )
+        ;
+
+        $putStatementController = new StatementPutController($this->statementRepository);
+
+        $response = $putStatementController->putStatement($this->httpRequest, $statement);
+
+        $this->saveLog(
+            [$this->httpRequest->query->get('statementId')]
+        );
+
+        return $response;
+    }
+
+    public function post(): Response
+    {
+        $content = $this->httpRequest->getContent();
+
+        if (substr($content, 0, 1) !== '[') {
+            $content = "[$content]";
+        }
+
+        $statements = $this->serializerFactory
+            ->createStatementSerializer()
+            ->deserializeStatements($content)
+        ;
+
+        $postStatementController = new StatementPostController($this->statementRepository);
+
+        $response = $postStatementController->postStatements($this->httpRequest, $statements);
+
+        $this->saveLog(
+            json_decode($response->getContent(), false)
+        );
+
+        return $response;
+    }
+
+    /**
+     * @param array $statementsId
+     *
+     * @return void
+     */
+    private function saveLog(array $statementsId)
+    {
+        foreach ($statementsId as $statementId) {
+            try {
+                $storedStatement = $this->statementRepository->findStatementById(
+                    StatementId::fromString($statementId)
+                );
+
+                InternalLogUtil::saveStatementForInternalLog($storedStatement);
+            } catch (NotFoundException $e) {
+            }
+        }
+    }
+}
diff --git a/plugin/xapi/src/Lrs/Utils/InternalLogUtil.php b/plugin/xapi/src/Lrs/Utils/InternalLogUtil.php
new file mode 100644
index 000000000..dc9a1cbcd
--- /dev/null
+++ b/plugin/xapi/src/Lrs/Utils/InternalLogUtil.php
@@ -0,0 +1,115 @@
+getActor())) {
+            return;
+        }
+
+        $statementObject = $statement->getObject();
+
+        if (!$statementObject instanceof Activity) {
+            return;
+        }
+
+        $languageIso = api_get_language_isocode();
+        $statementVerbString = XApiPlugin::extractVerbInLanguage($statement->getVerb()->getDisplay(), $languageIso);
+
+        $internalLog = new InternalLog();
+        $internalLog
+            ->setUser($user)
+            ->setVerb($statementVerbString)
+            ->setObjectId($statementObject->getId()->getValue());
+
+        if (null !== $statementId = $statement->getId()) {
+            $internalLog->setStatementId($statementId->getValue());
+        }
+
+        if (null !== $definition = $statementObject->getDefinition()) {
+            if (null !== $nameInLanguages = $definition->getName()) {
+                $internalLog->setActivityName(
+                    XApiPlugin::extractVerbInLanguage($nameInLanguages, $languageIso)
+                );
+            }
+
+            if (null !== $descriptionInLanguage = $definition->getDescription()) {
+                $internalLog->setActivityDescription(
+                    XApiPlugin::extractVerbInLanguage($descriptionInLanguage, $languageIso)
+                );
+            }
+        }
+
+        if (null !== $statementResult = $statement->getResult()) {
+            if (null !== $score = $statementResult->getScore()) {
+                $internalLog
+                    ->setScoreScaled(
+                        $score->getScaled()
+                    )
+                    ->setScoreRaw(
+                        $score->getRaw()
+                    )
+                    ->setScoreMin(
+                        $score->getMin()
+                    )
+                    ->setScoreMax(
+                        $score->getMax()
+                    );
+            }
+        }
+
+        if (null !== $created = $statement->getCreated()) {
+            $internalLog->setCreatedAt($created);
+        }
+
+        $em = Database::getManager();
+        $em->persist($internalLog);
+        $em->flush();
+    }
+
+    private static function getUserFromActor(Actor $actor): ?object
+    {
+        if (!$actor instanceof Agent) {
+            return null;
+        }
+
+        $actorIri = $actor->getInverseFunctionalIdentifier();
+
+        if (null === $actorIri) {
+            return null;
+        }
+
+        $userRepo = UserManager::getRepository();
+
+        $user = null;
+
+        if (null !== $mbox = $actorIri->getMbox()) {
+            if ((null !== $parts = explode(':', $mbox->getValue(), 2)) && !empty($parts[1])) {
+                $user = $userRepo->findOneBy(['email' => $parts[1]]);
+            }
+        } elseif (null !== $account = $actorIri->getAccount()) {
+            $chamiloIrl = IRL::fromString(api_get_path(WEB_PATH));
+
+            if ($account->getHomePage()->equals($chamiloIrl)) {
+                $user = $userRepo->findOneBy(['username' => $account->getName()]);
+            }
+        }
+
+        return $user;
+    }
+}
diff --git a/plugin/xapi/src/Parser/Cmi5Parser.php b/plugin/xapi/src/Parser/Cmi5Parser.php
new file mode 100644
index 000000000..0d7cc96c3
--- /dev/null
+++ b/plugin/xapi/src/Parser/Cmi5Parser.php
@@ -0,0 +1,178 @@
+filePath);
+        $xml = new Crawler($content);
+
+        $courseNode = $xml->filterXPath('//courseStructure/course');
+
+        $toolLaunch = new ToolLaunch();
+        $toolLaunch
+            ->setTitle(
+                current(
+                    $this->getLanguageStrings(
+                        $courseNode->filterXPath('//title')
+                    )
+                )
+            )
+            ->setDescription(
+                current(
+                    $this->getLanguageStrings(
+                        $courseNode->filterXPath('//description')
+                    )
+                )
+            )
+            ->setLaunchUrl('')
+            ->setActivityId($courseNode->attr('id'))
+            ->setActivityType('cmi5')
+            ->setAllowMultipleAttempts(false)
+            ->setCreatedAt(api_get_utc_datetime(null, false, true))
+            ->setCourse($this->course)
+            ->setSession($this->session);
+
+        $toc = $this->generateToC($xml);
+
+        foreach ($toc as $cmi5Item) {
+            $toolLaunch->addItem($cmi5Item);
+        }
+
+        return $toolLaunch;
+    }
+
+    /**
+     * @return array
+     */
+    private function getLanguageStrings(Crawler $node)
+    {
+        $map = [];
+
+        foreach ($node->children() as $child) {
+            $key = $child->attributes['lang']->value;
+            $value = trim($child->textContent);
+
+            $map[$key] = $value;
+        }
+
+        return $map;
+    }
+
+    /**
+     * @return array|\Chamilo\PluginBundle\Entity\XApi\Cmi5Item[]
+     */
+    private function generateToC(Crawler $xml)
+    {
+        $blocksMap = [];
+
+        /** @var array|Cmi5Item[] $items */
+        $items = $xml
+            ->filterXPath('//*')
+            ->reduce(
+                function (Crawler $node, $i) {
+                    return in_array($node->nodeName(), ['au', 'block']);
+                }
+            )
+            ->each(
+                function (Crawler $node, $i) use (&$blocksMap) {
+                    $attributes = ['id', 'activityType', 'launchMethod', 'moveOn', 'masteryScore'];
+
+                    list($id, $activityType, $launchMethod, $moveOn, $masteryMode) = $node->extract($attributes)[0];
+
+                    $item = new Cmi5Item();
+                    $item
+                        ->setIdentifier($id)
+                        ->setType($node->nodeName())
+                        ->setTitle(
+                            $this->getLanguageStrings(
+                                $node->filterXPath('//title')
+                            )
+                        )
+                        ->setDescription(
+                            $this->getLanguageStrings(
+                                $node->filterXPath('//description')
+                            )
+                        );
+
+                    if ('au' === $node->nodeName()) {
+                        $launchParametersNode = $node->filterXPath('//launchParameters');
+                        $entitlementKeyNode = $node->filterXPath('//entitlementKey');
+                        $url
+                            = $item
+                            ->setUrl(
+                                $this->parseLaunchUrl(
+                                    trim($node->filterXPath('//url')->text())
+                                )
+                            )
+                            ->setActivityType($activityType ?: null)
+                            ->setLaunchMethod($launchMethod ?: null)
+                            ->setMoveOn($moveOn ?: 'NotApplicable')
+                            ->setMasteryScore((float) $masteryMode ?: null)
+                            ->setLaunchParameters(
+                                $launchParametersNode->count() > 0 ? trim($launchParametersNode->text()) : null
+                            )
+                            ->setEntitlementKey(
+                                $entitlementKeyNode->count() > 0 ? trim($entitlementKeyNode->text()) : null
+                            );
+                    }
+
+                    $parentNode = $node->parents()->first();
+
+                    if ('block' === $parentNode->nodeName()) {
+                        $blocksMap[$i] = $parentNode->attr('id');
+                    }
+
+                    return $item;
+                }
+            );
+
+        foreach ($blocksMap as $itemPos => $parentIdentifier) {
+            foreach ($items as $item) {
+                if ($parentIdentifier === $item->getIdentifier()) {
+                    $items[$itemPos]->setParent($item);
+                }
+            }
+        }
+
+        return $items;
+    }
+
+    /**
+     * @param string $url
+     *
+     * @return string
+     */
+    private function parseLaunchUrl($url)
+    {
+        $urlInfo = parse_url($url);
+
+        if (empty($urlInfo['scheme'])) {
+            $baseUrl = str_replace(
+                api_get_path(SYS_COURSE_PATH),
+                api_get_path(WEB_COURSE_PATH),
+                dirname($this->filePath)
+            );
+
+            return "$baseUrl/$url";
+        }
+
+        return $url;
+    }
+}
diff --git a/plugin/xapi/src/Parser/PackageParser.php b/plugin/xapi/src/Parser/PackageParser.php
new file mode 100644
index 000000000..0454eca52
--- /dev/null
+++ b/plugin/xapi/src/Parser/PackageParser.php
@@ -0,0 +1,60 @@
+filePath = $filePath;
+        $this->course = $course;
+        $this->session = $session;
+    }
+
+    /**
+     * @throws \Exception
+     *
+     * @return mixed
+     */
+    public static function create(string $packageType, string $filePath, Course $course, Session $session = null)
+    {
+        switch ($packageType) {
+            case 'tincan':
+                return new TinCanParser($filePath, $course, $session);
+            case 'cmi5':
+                return new Cmi5Parser($filePath, $course, $session);
+            default:
+                throw new \Exception('Invalid package.');
+        }
+    }
+
+    abstract public function parse(): \Chamilo\PluginBundle\Entity\XApi\ToolLaunch;
+}
diff --git a/plugin/xapi/src/Parser/TinCanParser.php b/plugin/xapi/src/Parser/TinCanParser.php
new file mode 100644
index 000000000..c8de58dc1
--- /dev/null
+++ b/plugin/xapi/src/Parser/TinCanParser.php
@@ -0,0 +1,69 @@
+filePath);
+
+        $xml = new Crawler($content);
+
+        $activityNode = $xml->filter('tincan activities activity')->first();
+        $nodeName = $activityNode->filter('name');
+        $nodeDescription = $activityNode->filter('description');
+        $nodeLaunch = $activityNode->filter('launch');
+
+        $toolLaunch = new ToolLaunch();
+        $toolLaunch
+            ->setCourse($this->course)
+            ->setSession($this->session)
+            ->setCreatedAt(api_get_utc_datetime(null, false, true))
+            ->setActivityId($activityNode->attr('id'))
+            ->setActivityType($activityNode->attr('type'))
+            ->setLaunchUrl($this->parseLaunchUrl($nodeLaunch));
+
+        if ($nodeName) {
+            $toolLaunch->setTitle($nodeName->text());
+        }
+
+        if ($nodeDescription) {
+            $toolLaunch->setDescription($nodeDescription->text() ?: null);
+        }
+
+        return $toolLaunch;
+    }
+
+    private function parseLaunchUrl(Crawler $launchNode): string
+    {
+        $launchUrl = $launchNode->text();
+
+        $urlInfo = parse_url($launchUrl);
+
+        if (empty($urlInfo['scheme'])) {
+            $baseUrl = str_replace(
+                api_get_path(SYS_COURSE_PATH),
+                api_get_path(WEB_COURSE_PATH),
+                dirname($this->filePath)
+            );
+
+            return "$baseUrl/$launchUrl";
+        }
+
+        return $launchUrl;
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Activity/BaseActivity.php b/plugin/xapi/src/ToolExperience/Activity/BaseActivity.php
new file mode 100644
index 000000000..c16902171
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Activity/BaseActivity.php
@@ -0,0 +1,49 @@
+getCourseLanguage());
+
+        $courseUrl = api_get_course_url(
+            $course->getCode(),
+            $session ? $session->getId() : 0
+        );
+
+        return new Activity(
+            IRI::fromString($courseUrl),
+            new Definition(
+                LanguageMap::create([$languageIso => $course->getTitle()]),
+                null,
+                IRI::fromString('http://id.tincanapi.com/activitytype/lms/course')
+            )
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Activity/LearningPath.php b/plugin/xapi/src/ToolExperience/Activity/LearningPath.php
new file mode 100644
index 000000000..1dad39950
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Activity/LearningPath.php
@@ -0,0 +1,53 @@
+lp = $lp;
+    }
+
+    public function generate(): Activity
+    {
+        $lanIso = api_get_language_isocode();
+
+        $iri = $this->generateIri(
+            WEB_CODE_PATH,
+            'lp/lp_controller.php',
+            [
+                'action' => 'view',
+                'lp_id' => $this->lp->getId(),
+                'isStudentView' => 'true',
+            ]
+        );
+
+        return new Activity(
+            IRI::fromString($iri),
+            new Definition(
+                LanguageMap::create([$lanIso => $this->lp->getName()]),
+                null,
+                IRI::fromString('http://adlnet.gov/expapi/activities/lesson')
+            )
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Activity/LearningPathItem.php b/plugin/xapi/src/ToolExperience/Activity/LearningPathItem.php
new file mode 100644
index 000000000..6ac65fd65
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Activity/LearningPathItem.php
@@ -0,0 +1,54 @@
+lpItem = $lpItem;
+    }
+
+    public function generate(): Activity
+    {
+        $langIso = api_get_language_isocode();
+
+        $iri = $this->generateIri(
+            WEB_CODE_PATH,
+            'lp/lp_controller.php',
+            [
+                'action' => 'view',
+                'lp_id' => $this->lpItem->getLpId(),
+                'isStudentView' => 'true',
+                'lp_item' => $this->lpItem->getId(),
+            ]
+        );
+
+        return new Activity(
+            IRI::fromString($iri),
+            new Definition(
+                LanguageMap::create([$langIso => $this->lpItem->getTitle()]),
+                null,
+                IRI::fromString('http://id.tincanapi.com/activitytype/resource')
+            )
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Activity/Portfolio.php b/plugin/xapi/src/ToolExperience/Activity/Portfolio.php
new file mode 100644
index 000000000..7d391e176
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Activity/Portfolio.php
@@ -0,0 +1,50 @@
+owner = $owner;
+    }
+
+    public function generate(): Activity
+    {
+        $langIso = api_get_language_isocode();
+
+        $iri = $this->generateIri(
+            WEB_CODE_PATH,
+            'portfolio/index.php',
+            [
+                'action' => 'list',
+                'user' => $this->owner->getId(),
+            ]
+        );
+
+        return new Activity(
+            IRI::fromString($iri),
+            new Definition(
+                LanguageMap::create(
+                    [
+                        $langIso => sprintf(
+                            get_lang('XUserPortfolioItems'),
+                            $this->owner->getCompleteNameWithUsername()
+                        ),
+                    ]
+                ),
+                null,
+                IRI::fromString('http://id.tincanapi.com/activitytype/collection-simple')
+            )
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Activity/PortfolioCategory.php b/plugin/xapi/src/ToolExperience/Activity/PortfolioCategory.php
new file mode 100644
index 000000000..5da9324b6
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Activity/PortfolioCategory.php
@@ -0,0 +1,58 @@
+category = $category;
+    }
+
+    public function generate(): Activity
+    {
+        $iri = $this->generateIri(
+            WEB_PATH,
+            'xapi/portfolio/',
+            [
+                'user' => $this->category->getUser()->getId(),
+                'category' => $this->category->getId(),
+            ]
+        );
+
+        $langIso = api_get_language_isocode();
+
+        $categoryDescription = $this->category->getDescription();
+
+        $definitionDescription = $categoryDescription
+            ? LanguageMap::create([$langIso => $categoryDescription])
+            : null;
+
+        return new Activity(
+            IRI::fromString($iri),
+            new Definition(
+                LanguageMap::create([$langIso => $this->category->getTitle()]),
+                $definitionDescription,
+                IRI::fromString('http://id.tincanapi.com/activitytype/category')
+            )
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Activity/PortfolioComment.php b/plugin/xapi/src/ToolExperience/Activity/PortfolioComment.php
new file mode 100644
index 000000000..9e7f91a41
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Activity/PortfolioComment.php
@@ -0,0 +1,50 @@
+comment = $comment;
+    }
+
+    public function generate(): Activity
+    {
+        $iri = $this->generateIri(
+            WEB_CODE_PATH,
+            'portfolio/index.php',
+            [
+                'action' => 'view',
+                'id' => $this->comment->getItem()->getId(),
+                'comment' => $this->comment->getId(),
+            ]
+        );
+
+        return new Activity(
+            IRI::fromString($iri),
+            new Definition(
+                null,
+                null,
+                IRI::fromString('http://activitystrea.ms/schema/1.0/comment')
+            )
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Activity/PortfolioItem.php b/plugin/xapi/src/ToolExperience/Activity/PortfolioItem.php
new file mode 100644
index 000000000..8f995dd8a
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Activity/PortfolioItem.php
@@ -0,0 +1,49 @@
+item = $item;
+    }
+
+    public function generate(): Activity
+    {
+        $langIso = api_get_language_isocode();
+
+        $iri = $this->generateIri(
+            WEB_CODE_PATH,
+            'portfolio/index.php',
+            ['action' => 'view', 'id' => $this->item->getId()]
+        );
+
+        return new Activity(
+            IRI::fromString($iri),
+            new Definition(
+                LanguageMap::create([$langIso => $this->item->getTitle()]),
+                null,
+                IRI::fromString('http://activitystrea.ms/schema/1.0/article')
+            )
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Activity/Quiz.php b/plugin/xapi/src/ToolExperience/Activity/Quiz.php
new file mode 100644
index 000000000..c4f9a5935
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Activity/Quiz.php
@@ -0,0 +1,57 @@
+quiz = $quiz;
+    }
+
+    public function generate(): Activity
+    {
+        $langIso = api_get_language_isocode();
+
+        $iri = $this->generateIri(
+            WEB_CODE_PATH,
+            'exercise/overview.php',
+            ['exerciseId' => $this->quiz->getId()]
+        );
+
+        $definitionDescription = null;
+
+        if ($this->quiz->getDescription()) {
+            $definitionDescription = LanguageMap::create(
+                [$langIso => $this->quiz->getDescription()]
+            );
+        }
+
+        return new Activity(
+            IRI::fromString($iri),
+            new Definition(
+                LanguageMap::create([$langIso => $this->quiz->getTitle()]),
+                $definitionDescription,
+                IRI::fromString('http://adlnet.gov/expapi/activities/assessment')
+            )
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Activity/QuizQuestion.php b/plugin/xapi/src/ToolExperience/Activity/QuizQuestion.php
new file mode 100644
index 000000000..74c9a8110
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Activity/QuizQuestion.php
@@ -0,0 +1,170 @@
+question = $question;
+    }
+
+    public function generate(): Activity
+    {
+        $iri = $this->generateIri(
+            WEB_CODE_PATH,
+            'xapi/quiz/',
+            ['question' => $this->question->getId()]
+        );
+
+        return new Activity(
+            IRI::fromString($iri),
+            $this->generateActivityDefinitionFromQuestionType()
+        );
+    }
+
+    /**
+     * @return \Xabbuh\XApi\Model\Interaction\InteractionDefinition
+     */
+    private function generateActivityDefinitionFromQuestionType()
+    {
+        $languageIso = api_get_language_isocode();
+        $courseId = api_get_course_int_id();
+
+        $questionTitle = strip_tags($this->question->getQuestion());
+        $questionTitle = trim($questionTitle);
+        $questionDescription = strip_tags($this->question->getDescription());
+        $questionDescription = trim($questionDescription);
+
+        $titleMap = LanguageMap::create([$languageIso => $questionTitle]);
+        $descriptionMap = $questionDescription ? LanguageMap::create([$languageIso => $questionDescription]) : null;
+
+        $objAnswer = new Answer($this->question->getId(), $courseId);
+        $objAnswer->read();
+
+        $type = IRI::fromString('http://adlnet.gov/expapi/activities/question');
+
+        switch ($this->question->getType()) {
+            case MULTIPLE_ANSWER:
+            case UNIQUE_ANSWER:
+            case UNIQUE_ANSWER_IMAGE:
+            case READING_COMPREHENSION:
+                $choices = [];
+                $correctResponsesPattern = [];
+
+                for ($i = 1; $i <= $objAnswer->nbrAnswers; $i++) {
+                    $choices[] = new InteractionComponent(
+                        $objAnswer->iid[$i],
+                        LanguageMap::create([$languageIso => $objAnswer->selectAnswer($i)])
+                    );
+
+                    if ($objAnswer->isCorrect($i)) {
+                        $correctResponsesPattern[] = $objAnswer->iid[$i];
+                    }
+                }
+
+                return new ChoiceInteractionDefinition(
+                    $titleMap,
+                    $descriptionMap,
+                    $type,
+                    null,
+                    null,
+                    [implode('[,]', $correctResponsesPattern)],
+                    $choices
+                );
+            case DRAGGABLE:
+                $choices = [];
+
+                for ($i = 1; $i <= $objAnswer->nbrAnswers; $i++) {
+                    if ((int) $objAnswer->correct[$i] > 0) {
+                        $choices[] = new InteractionComponent(
+                            $objAnswer->correct[$i],
+                            LanguageMap::create([$languageIso => $objAnswer->answer[$i]])
+                        );
+                    }
+                }
+
+                $correctResponsesPattern = array_slice($objAnswer->autoId, 0, $objAnswer->nbrAnswers / 2);
+
+                return new SequencingInteractionDefinition(
+                    $titleMap,
+                    $descriptionMap,
+                    $type,
+                    null,
+                    null,
+                    [implode('[,]', $correctResponsesPattern)],
+                    $choices
+                );
+            case MATCHING:
+            case MATCHING_DRAGGABLE:
+                /** @var array|InteractionComponent[] $source */
+                $source = [];
+                /** @var array|InteractionComponent[] $source */
+                $target = [];
+                $correctResponsesPattern = [];
+
+                for ($i = 1; $i <= $objAnswer->nbrAnswers; $i++) {
+                    $interactionComponent = new InteractionComponent(
+                        $objAnswer->selectAutoId($i),
+                        LanguageMap::create([$languageIso => $objAnswer->selectAnswer($i)])
+                    );
+
+                    if ((int) $objAnswer->correct[$i] > 0) {
+                        $source[] = $interactionComponent;
+
+                        $correctResponsesPattern[] = $objAnswer->selectAutoId($i).'[.]'.$objAnswer->correct[$i];
+                    } else {
+                        $target[] = $interactionComponent;
+                    }
+                }
+
+                return new MatchingInteractionDefinition(
+                    $titleMap,
+                    $descriptionMap,
+                    $type,
+                    null,
+                    null,
+                    [implode('[,]', $correctResponsesPattern)],
+                    $source,
+                    $target
+                );
+            case FREE_ANSWER:
+                return new LongFillInInteractionDefinition($titleMap, $descriptionMap, $type);
+            case FILL_IN_BLANKS:
+            case HOT_SPOT:
+            case HOT_SPOT_DELINEATION:
+            case MULTIPLE_ANSWER_COMBINATION:
+            case UNIQUE_ANSWER_NO_OPTION:
+            case MULTIPLE_ANSWER_TRUE_FALSE:
+            case MULTIPLE_ANSWER_TRUE_FALSE_DEGREE_CERTAINTY:
+            case MULTIPLE_ANSWER_COMBINATION_TRUE_FALSE:
+            case GLOBAL_MULTIPLE_ANSWER:
+            case CALCULATED_ANSWER:
+            case ANNOTATION:
+            case ORAL_EXPRESSION:
+            default:
+                return new OtherInteractionDefinition($titleMap, $descriptionMap, $type);
+        }
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Activity/Site.php b/plugin/xapi/src/ToolExperience/Activity/Site.php
new file mode 100644
index 000000000..c074df33f
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Activity/Site.php
@@ -0,0 +1,33 @@
+ $platform])
+            )
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Actor/BaseActor.php b/plugin/xapi/src/ToolExperience/Actor/BaseActor.php
new file mode 100644
index 000000000..3ed8f00d3
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Actor/BaseActor.php
@@ -0,0 +1,17 @@
+user = $user;
+    }
+
+    public function generate(): Agent
+    {
+        return new Agent(
+            InverseFunctionalIdentifier::withMbox(
+                IRI::fromString('mailto:'.$this->user->getEmail())
+            ),
+            $this->user->getCompleteName()
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/BaseStatement.php b/plugin/xapi/src/ToolExperience/Statement/BaseStatement.php
new file mode 100644
index 000000000..370de27e6
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/BaseStatement.php
@@ -0,0 +1,53 @@
+get(XApiPlugin::SETTING_UUID_NAMESPACE),
+            uniqid($type)
+        );
+
+        return StatementId::fromUuid($uuid);
+    }
+
+    protected function generateContext(): Context
+    {
+        $platform = api_get_setting('Institution').' - '.api_get_setting('siteName');
+
+        $groupingActivities = [];
+        $groupingActivities[] = (new SiteActivity())->generate();
+
+        if (api_get_course_id()) {
+            $groupingActivities[] = (new CourseActivity())->generate();
+        }
+
+        return (new Context())
+            ->withPlatform($platform)
+            ->withLanguage(api_get_language_isocode())
+            ->withContextActivities(
+                new ContextActivities(null, $groupingActivities)
+            );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/LearningPathCompleted.php b/plugin/xapi/src/ToolExperience/Statement/LearningPathCompleted.php
new file mode 100644
index 000000000..7629a9a8f
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/LearningPathCompleted.php
@@ -0,0 +1,61 @@
+lpView = $lpView;
+        $this->lp = $lp;
+    }
+
+    public function generate(): Statement
+    {
+        $user = api_get_user_entity($this->lpView->getUserId());
+        $userActor = new UserActor($user);
+        $completedVerb = new Completed();
+        $lpActivity = new LearningPathActivity($this->lp);
+
+        return new Statement(
+            $this->generateStatementId('learning-path'),
+            $userActor->generate(),
+            $completedVerb->generate(),
+            $lpActivity->generate(),
+            new Result(
+                new Score(1, 100, 0, 100),
+                null,
+                true
+            ),
+            null,
+            api_get_utc_datetime(null, false, true),
+            null,
+            $this->generateContext()
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/LearningPathItemViewed.php b/plugin/xapi/src/ToolExperience/Statement/LearningPathItemViewed.php
new file mode 100644
index 000000000..f2cc3942d
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/LearningPathItemViewed.php
@@ -0,0 +1,79 @@
+lpItemView = $lpItemView;
+        $this->lpItem = $lpItem;
+        $this->lpView = $lpView;
+    }
+
+    public function generate(): Statement
+    {
+        $user = api_get_user_entity($this->lpView->getUserId());
+        $lp = Database::getManager()->find(CLp::class, $this->lpView->getLpId());
+
+        $userActor = new UserActor($user);
+        $viewedVerb = new ViewedVerb();
+        $lpItemActivity = new LearningPathItemActivity($this->lpItem);
+        $lpActivity = new LearningPath($lp);
+
+        $context = $this->generateContext();
+        $contextActivities = $context
+            ->getContextActivities()
+            ->withAddedGroupingActivity($lpActivity->generate());
+
+        return new Statement(
+            $this->generateStatementId('learning-path-item'),
+            $userActor->generate(),
+            $viewedVerb->generate(),
+            $lpItemActivity->generate(),
+            new Result(
+                null,
+                null,
+                'completed' === $this->lpItemView->getStatus(),
+                null,
+                'PT'.$this->lpItemView->getTotalTime().'S'
+            ),
+            null,
+            api_get_utc_datetime(null, false, true),
+            null,
+            $context->withContextActivities($contextActivities)
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioAttachmentsTrait.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioAttachmentsTrait.php
new file mode 100644
index 000000000..4e66182f0
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioAttachmentsTrait.php
@@ -0,0 +1,89 @@
+ $portfolioAttachments
+     *
+     * @return array
+     */
+    protected function generateAttachments(array $portfolioAttachments, User $user): array
+    {
+        if (empty($portfolioAttachments)) {
+            return [];
+        }
+
+        $attachments = [];
+
+        $userDirectory = UserManager::getUserPathById($user->getId(), 'system');
+        $attachmentsDirectory = $userDirectory.'portfolio_attachments/';
+
+        $langIso = api_get_language_isocode();
+
+        $cidreq = api_get_cidreq();
+        $baseUrl = api_get_path(WEB_CODE_PATH).'portfolio/index.php?'.($cidreq ? $cidreq.'&' : '');
+
+        foreach ($portfolioAttachments as $portfolioAttachment) {
+            $attachmentFilename = $attachmentsDirectory.$portfolioAttachment->getPath();
+
+            $display = LanguageMap::create(
+                ['und' => $portfolioAttachment->getFilename()]
+            );
+            $description = null;
+
+            if ($portfolioAttachment->getComment()) {
+                $description = LanguageMap::create(
+                    [$langIso => $portfolioAttachment->getComment()]
+                );
+            }
+
+            $attachments[] = new Attachment(
+                IRI::fromString('http://id.tincanapi.com/attachment/supporting_media'),
+                mime_content_type($attachmentFilename),
+                $portfolioAttachment->getSize(),
+                hash_file('sha256', $attachmentFilename),
+                $display,
+                $description,
+                IRL::fromString(
+                    $baseUrl.http_build_query(['action' => 'download', 'file' => $portfolioAttachment->getPath()])
+                )
+            );
+        }
+
+        return $attachments;
+    }
+
+    protected function generateAttachmentsForItem(Portfolio $item): array
+    {
+        $itemAttachments = \Database::getManager()
+            ->getRepository(PortfolioAttachment::class)
+            ->findFromItem($item)
+        ;
+
+        return $this->generateAttachments($itemAttachments, $item->getUser());
+    }
+
+    protected function generateAttachmentsForComment(PortfolioCommentEntity $comment): array
+    {
+        $commentAttachments = \Database::getManager()
+            ->getRepository(PortfolioAttachment::class)
+            ->findFromComment($this->comment)
+        ;
+
+        return $this->generateAttachments($commentAttachments, $comment->getAuthor());
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioComment.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioComment.php
new file mode 100644
index 000000000..f967d6a1c
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioComment.php
@@ -0,0 +1,25 @@
+comment = $comment;
+        $this->item = $this->comment->getItem();
+        $this->parentComment = $this->comment->getParent();
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioCommentEdited.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioCommentEdited.php
new file mode 100644
index 000000000..5c2e2076e
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioCommentEdited.php
@@ -0,0 +1,39 @@
+comment);
+        $context = $this->generateContext();
+        $attachements = $this->generateAttachmentsForComment($this->comment);
+
+        return new Statement(
+            $this->generateStatementId('portfolio-comment'),
+            $actor->generate(),
+            $verb->generate(),
+            $object->generate(),
+            null,
+            null,
+            api_get_utc_datetime(null, false, true),
+            null,
+            $context,
+            $attachements
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioCommentScored.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioCommentScored.php
new file mode 100644
index 000000000..2892173e4
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioCommentScored.php
@@ -0,0 +1,47 @@
+comment->getScore();
+        $scaled = $maxScore ? ($rawScore / $maxScore) : 0;
+
+        $actor = new User($user);
+        $verb = new Scored();
+        $object = new PortfolioCommentActivity($this->comment);
+        $context = $this->generateContext();
+        $attachments = $this->generateAttachmentsForComment($this->comment);
+        $score = new Score($scaled, $rawScore, 0, $maxScore);
+        $result = new Result($score);
+
+        return new Statement(
+            $this->generateStatementId('portfolio-comment'),
+            $actor->generate(),
+            $verb->generate(),
+            $object->generate(),
+            $result,
+            null,
+            api_get_utc_datetime(null, false, true),
+            null,
+            $context,
+            $attachments
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioDownloaded.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioDownloaded.php
new file mode 100644
index 000000000..419f051ff
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioDownloaded.php
@@ -0,0 +1,42 @@
+owner = $owner;
+    }
+
+    public function generate(): Statement
+    {
+        $user = api_get_user_entity(api_get_user_id());
+
+        $actor = new UserActor($user);
+        $verb = new Downloaded();
+        $object = new PortfolioActivity($this->owner);
+        $context = $this->generateContext();
+
+        return new Statement(
+            $this->generateStatementId('portfolio-item'),
+            $actor->generate(),
+            $verb->generate(),
+            $object->generate(),
+            null,
+            null,
+            api_get_utc_datetime(null, false, true),
+            null,
+            $context
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioItem.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioItem.php
new file mode 100644
index 000000000..bc8940eb9
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioItem.php
@@ -0,0 +1,41 @@
+item = $item;
+    }
+
+    protected function generateContext(): Context
+    {
+        $context = parent::generateContext();
+
+        $category = $this->item->getCategory();
+
+        if ($category) {
+            $categoryActivity = new PortfolioCategory($category);
+
+            $contextActivities = $context
+                ->getContextActivities()
+                ->withAddedCategoryActivity(
+                    $categoryActivity->generate()
+                )
+            ;
+
+            $context = $context->withContextActivities($contextActivities);
+        }
+
+        return $context;
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioItemCommented.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemCommented.php
new file mode 100644
index 000000000..4f4e37cac
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemCommented.php
@@ -0,0 +1,74 @@
+generateStatementId('portfolio-comment');
+
+        $userActor = new UserActor($this->comment->getAuthor());
+        $statementResult = new Result(null, null, null, $this->comment->getContent());
+
+        $context = $this->generateContext();
+
+        $em = \Database::getManager();
+        $commentAttachments = $em->getRepository(PortfolioAttachment::class)->findFromComment($this->comment);
+
+        $attachments = $this->generateAttachments(
+            $commentAttachments,
+            $this->comment->getAuthor()
+        );
+
+        if ($this->parentComment) {
+            $repliedVerb = new RepliedVerb();
+
+            $itemActivity = new PortfolioItemActivity($this->item);
+            $parentCommentActivity = new PortfolioCommentActivity($this->parentComment);
+
+            $contextActivities = $context
+                ->getContextActivities()
+                ->withAddedGroupingActivity($itemActivity->generate());
+
+            return new Statement(
+                $statementId,
+                $userActor->generate(),
+                $repliedVerb->generate(),
+                $parentCommentActivity->generate(),
+                $statementResult,
+                null,
+                $this->comment->getDate(),
+                null,
+                $context->withContextActivities($contextActivities),
+                $attachments
+            );
+        } else {
+            $itemShared = new PortfolioItemShared($this->item);
+
+            $commentedVerb = new CommentedVerb();
+
+            return $itemShared->generate()
+                ->withId($statementId)
+                ->withActor($userActor->generate())
+                ->withVerb($commentedVerb->generate())
+                ->withStored($this->comment->getDate())
+                ->withResult($statementResult)
+                ->withContext($context)
+                ->withAttachments($attachments);
+        }
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioItemEdited.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemEdited.php
new file mode 100644
index 000000000..f8ed7ae2e
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemEdited.php
@@ -0,0 +1,39 @@
+item);
+        $context = $this->generateContext();
+        $attachements = $this->generateAttachmentsForItem($this->item);
+
+        return new Statement(
+            $this->generateStatementId('portfolio-item'),
+            $actor->generate(),
+            $verb->generate(),
+            $object->generate(),
+            null,
+            null,
+            api_get_utc_datetime(null, false, true),
+            null,
+            $context,
+            $attachements
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioItemHighlighted.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemHighlighted.php
new file mode 100644
index 000000000..b0d6a33bf
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemHighlighted.php
@@ -0,0 +1,39 @@
+item);
+        $context = $this->generateContext();
+        $attachments = $this->generateAttachmentsForItem($this->item);
+
+        return new Statement(
+            $this->generateStatementId('portfolio-item'),
+            $actor->generate(),
+            $verb->generate(),
+            $object->generate(),
+            null,
+            null,
+            api_get_utc_datetime(null, false, true),
+            null,
+            $context,
+            $attachments
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioItemScored.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemScored.php
new file mode 100644
index 000000000..73977a0d7
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemScored.php
@@ -0,0 +1,47 @@
+item->getScore();
+        $scaled = $maxScore ? ($rawScore / $maxScore) : 0;
+
+        $actor = new User($user);
+        $verb = new Scored();
+        $object = new PortfolioItemActivity($this->item);
+        $context = $this->generateContext();
+        $attachments = $this->generateAttachmentsForItem($this->item);
+        $score = new Score($scaled, $rawScore, 0, $maxScore);
+        $result = new Result($score);
+
+        return new Statement(
+            $this->generateStatementId('portfolio-item'),
+            $actor->generate(),
+            $verb->generate(),
+            $object->generate(),
+            $result,
+            null,
+            api_get_utc_datetime(null, false, true),
+            null,
+            $context,
+            $attachments
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioItemShared.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemShared.php
new file mode 100644
index 000000000..ee44f0473
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemShared.php
@@ -0,0 +1,47 @@
+item->getUser();
+
+        $userActor = new User($itemAuthor);
+        $sharedVerb = new Shared();
+        $itemActivity = new PortfolioItem($this->item);
+
+        $context = $this->generateContext();
+
+        $attachments = $this->generateAttachmentsForItem($this->item);
+
+        return new Statement(
+            $this->generateStatementId('portfolio-item'),
+            $userActor->generate(),
+            $sharedVerb->generate(),
+            $itemActivity->generate(),
+            null,
+            null,
+            $this->item->getCreationDate(),
+            null,
+            $context,
+            $attachments
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/PortfolioItemViewed.php b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemViewed.php
new file mode 100644
index 000000000..3612ab088
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/PortfolioItemViewed.php
@@ -0,0 +1,40 @@
+item);
+        $context = $this->generateContext();
+        $attachments = $this->generateAttachmentsForItem($this->item);
+
+        return new Statement(
+            $this->generateStatementId('portfolio-item'),
+            $actor->generate(),
+            $verb->generate(),
+            $object->generate(),
+            null,
+            null,
+            $this->item->getCreationDate(),
+            null,
+            $context,
+            $attachments
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/QuizCompleted.php b/plugin/xapi/src/ToolExperience/Statement/QuizCompleted.php
new file mode 100644
index 000000000..2a4e9ba51
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/QuizCompleted.php
@@ -0,0 +1,70 @@
+exe = $exe;
+        $this->quiz = $quiz;
+    }
+
+    public function generate(): Statement
+    {
+        $user = api_get_user_entity($this->exe->getExeUserId());
+
+        $userActor = new UserActor($user);
+        $completedVerb = new CompletedVerb();
+        $quizActivity = new QuizActivity($this->quiz);
+
+        $rawResult = $this->exe->getExeResult();
+        $maxResult = $this->exe->getExeWeighting();
+        $scaledResult = $rawResult / $maxResult;
+
+        $duration = $this->exe->getExeDuration();
+
+        return new Statement(
+            $this->generateStatementId('exercise'),
+            $userActor->generate(),
+            $completedVerb->generate(),
+            $quizActivity->generate(),
+            new Result(
+                new Score($scaledResult, $rawResult, 0, $maxResult),
+                null,
+                true,
+                null,
+                $duration ? "PT{$duration}S" : null
+            ),
+            null,
+            $this->exe->getExeDate(),
+            null,
+            $this->generateContext()
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Statement/QuizQuestionAnswered.php b/plugin/xapi/src/ToolExperience/Statement/QuizQuestionAnswered.php
new file mode 100644
index 000000000..f891e4ce4
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Statement/QuizQuestionAnswered.php
@@ -0,0 +1,79 @@
+attempt = $attempt;
+        $this->question = $question;
+        $this->quiz = $quiz;
+    }
+
+    public function generate(): Statement
+    {
+        $user = api_get_user_entity($this->attempt->getUserId());
+
+        $userActor = new UserActor($user);
+        $answeredVerb = new AnsweredVerb();
+        $questionActivity = new QuizQuestionActivity($this->question);
+        $quizActivity = new QuizActivity($this->quiz);
+
+        $rawResult = $this->attempt->getMarks();
+        $maxResult = $this->question->getPonderation();
+        $scaledResult = $maxResult ? ($rawResult / $maxResult) : 0;
+
+        $context = $this->generateContext();
+        $contextActivities = $context
+            ->getContextActivities()
+            ->withAddedGroupingActivity($quizActivity->generate());
+
+        return new Statement(
+            $this->generateStatementId('exercise-question'),
+            $userActor->generate(),
+            $answeredVerb->generate(),
+            $questionActivity->generate(),
+            new Result(
+                new Score($scaledResult, $rawResult, null, $maxResult),
+                $rawResult > 0,
+                true
+            ),
+            null,
+            $this->attempt->getTms(),
+            null,
+            $context->withContextActivities($contextActivities)
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Verb/Answered.php b/plugin/xapi/src/ToolExperience/Verb/Answered.php
new file mode 100644
index 000000000..4007892f3
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Verb/Answered.php
@@ -0,0 +1,21 @@
+iri = $iri;
+        $this->display = $display;
+    }
+
+    public function generate(): Verb
+    {
+        $langIso = api_get_language_isocode();
+
+        return new Verb(
+            IRI::fromString($this->iri),
+            LanguageMap::create(
+                [
+                    $langIso => get_lang($this->display),
+                ]
+            )
+        );
+    }
+}
diff --git a/plugin/xapi/src/ToolExperience/Verb/Commented.php b/plugin/xapi/src/ToolExperience/Verb/Commented.php
new file mode 100644
index 000000000..34865a6b3
--- /dev/null
+++ b/plugin/xapi/src/ToolExperience/Verb/Commented.php
@@ -0,0 +1,21 @@
+',
+        ];
+        $settings = [
+            self::SETTING_UUID_NAMESPACE => 'text',
+
+            self::SETTING_LRS_URL => 'text',
+            self::SETTING_LRS_AUTH_USERNAME => 'text',
+            self::SETTING_LRS_AUTH_PASSWORD => 'text',
+
+            self::SETTING_CRON_LRS_URL => 'text',
+            self::SETTING_CRON_LRS_AUTH_USERNAME => 'text',
+            self::SETTING_CRON_LRS_AUTH_PASSWORD => 'text',
+
+            self::SETTING_LRS_LP_ITEM_ACTIVE => 'boolean',
+            self::SETTING_LRS_LP_ACTIVE => 'boolean',
+            self::SETTING_LRS_QUIZ_ACTIVE => 'boolean',
+            self::SETTING_LRS_QUIZ_QUESTION_ACTIVE => 'boolean',
+            self::SETTING_LRS_PORTFOLIO_ACTIVE => 'boolean',
+        ];
+
+        parent::__construct(
+            $version,
+            implode(', ', $author),
+            $settings
+        );
+    }
+
+    /**
+     * @return \XApiPlugin
+     */
+    public static function create()
+    {
+        static $result = null;
+
+        return $result ? $result : $result = new self();
+    }
+
+    /**
+     * Process to install plugin.
+     */
+    public function install()
+    {
+        $em = Database::getManager();
+
+        $tablesExists = $em->getConnection()->getSchemaManager()->tablesExist(
+            [
+                'xapi_shared_statement',
+                'xapi_tool_launch',
+                'xapi_lrs_auth',
+                'xapi_cmi5_item',
+                'xapi_activity_state',
+                'xapi_activity_profile',
+                'xapi_internal_log',
+
+                'xapi_attachment',
+                'xapi_object',
+                'xapi_result',
+                'xapi_verb',
+                'xapi_extensions',
+                'xapi_context',
+                'xapi_actor',
+                'xapi_statement',
+            ]
+        );
+
+        if ($tablesExists) {
+            return;
+        }
+
+        $this->installPluginDbTables();
+        $this->installInitialConfig();
+        $this->addCourseTools();
+        $this->installHook();
+    }
+
+    /**
+     * Process to uninstall plugin.
+     */
+    public function uninstall()
+    {
+        $this->uninstallHook();
+        $this->uninstallPluginDbTables();
+        $this->deleteCourseTools();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function uninstallHook()
+    {
+        $learningPathItemViewedHook = XApiLearningPathItemViewedHookObserver::create();
+        $learningPathEndHook = XApiLearningPathEndHookObserver::create();
+        $quizQuestionAnsweredHook = XApiQuizQuestionAnsweredHookObserver::create();
+        $quizEndHook = XApiQuizEndHookObserver::create();
+        $createCourseHook = XApiCreateCourseHookObserver::create();
+        $portfolioItemAddedHook = XApiPortfolioItemAddedHookObserver::create();
+        $portfolioItemCommentedHook = XApiPortfolioItemCommentedHookObserver::create();
+        $portfolioItemHighlightedHook = XApiPortfolioItemHighlightedHookObserver::create();
+        $portfolioDownloaded = XApiPortfolioDownloadedHookObserver::create();
+        $portfolioItemScoredHook = XApiPortfolioItemScoredHookObserver::create();
+        $portfolioCommentedScoredHook = XApiPortfolioCommentScoredHookObserver::create();
+        $portfolioItemEditedHook = XApiPortfolioItemEditedHookObserver::create();
+        $portfolioCommentEditedHook = XApiPortfolioCommentEditedHookObserver::create();
+
+        HookLearningPathItemViewed::create()->detach($learningPathItemViewedHook);
+        HookLearningPathEnd::create()->detach($learningPathEndHook);
+        HookQuizQuestionAnswered::create()->detach($quizQuestionAnsweredHook);
+        HookQuizEnd::create()->detach($quizEndHook);
+        HookCreateCourse::create()->detach($createCourseHook);
+        HookPortfolioItemAdded::create()->detach($portfolioItemAddedHook);
+        HookPortfolioItemCommented::create()->detach($portfolioItemCommentedHook);
+        HookPortfolioItemHighlighted::create()->detach($portfolioItemHighlightedHook);
+        HookPortfolioDownloaded::create()->detach($portfolioDownloaded);
+        HookPortfolioItemScored::create()->detach($portfolioItemScoredHook);
+        HookPortfolioCommentScored::create()->detach($portfolioCommentedScoredHook);
+        HookPortfolioItemEdited::create()->detach($portfolioItemEditedHook);
+        HookPortfolioCommentEdited::create()->detach($portfolioCommentEditedHook);
+
+        return 1;
+    }
+
+    public function uninstallPluginDbTables()
+    {
+        $em = Database::getManager();
+        $pluginEm = self::getEntityManager();
+
+        $schemaTool = new SchemaTool($em);
+        $schemaTool->dropSchema(
+            [
+                $em->getClassMetadata(ActivityProfile::class),
+                $em->getClassMetadata(ActivityState::class),
+                $em->getClassMetadata(SharedStatement::class),
+                $em->getClassMetadata(ToolLaunch::class),
+                $em->getClassMetadata(LrsAuth::class),
+                $em->getClassMetadata(Cmi5Item::class),
+                $em->getClassMetadata(InternalLog::class),
+            ]
+        );
+
+        $pluginSchemaTool = new SchemaTool($pluginEm);
+        $pluginSchemaTool->dropSchema(
+            [
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Attachment::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\StatementObject::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Result::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Verb::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Extensions::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Context::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Actor::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Statement::class),
+            ]
+        );
+    }
+
+    /**
+     * @param string|null $lrsUrl
+     * @param string|null $lrsAuthUsername
+     * @param string|null $lrsAuthPassword
+     *
+     * @return \Xabbuh\XApi\Client\Api\StateApiClientInterface
+     */
+    public function getXApiStateClient($lrsUrl = null, $lrsAuthUsername = null, $lrsAuthPassword = null)
+    {
+        return $this
+            ->createXApiClient($lrsUrl, $lrsAuthUsername, $lrsAuthPassword)
+            ->getStateApiClient();
+    }
+
+    public function getXApiStatementClient(): StatementsApiClientInterface
+    {
+        return $this->createXApiClient()->getStatementsApiClient();
+    }
+
+    public function getXapiStatementCronClient(): StatementsApiClientInterface
+    {
+        $lrsUrl = $this->get(self::SETTING_CRON_LRS_URL);
+        $lrsUsername = $this->get(self::SETTING_CRON_LRS_AUTH_USERNAME);
+        $lrsPassword = $this->get(self::SETTING_CRON_LRS_AUTH_PASSWORD);
+
+        return $this
+            ->createXApiClient(
+                empty($lrsUrl) ? null : $lrsUrl,
+                empty($lrsUsername) ? null : $lrsUsername,
+                empty($lrsPassword) ? null : $lrsPassword
+            )
+            ->getStatementsApiClient();
+    }
+
+    /**
+     * Perform actions after save the plugin configuration.
+     *
+     * @return \XApiPlugin
+     */
+    public function performActionsAfterConfigure()
+    {
+        $learningPathItemViewedHook = XApiLearningPathItemViewedHookObserver::create();
+        $learningPathEndHook = XApiLearningPathEndHookObserver::create();
+        $quizQuestionAnsweredHook = XApiQuizQuestionAnsweredHookObserver::create();
+        $quizEndHook = XApiQuizEndHookObserver::create();
+        $portfolioItemAddedHook = XApiPortfolioItemAddedHookObserver::create();
+        $portfolioItemCommentedHook = XApiPortfolioItemCommentedHookObserver::create();
+        $portfolioItemViewedHook = XApiPortfolioItemViewedHookObserver::create();
+        $portfolioItemHighlightedHook = XApiPortfolioItemHighlightedHookObserver::create();
+        $portfolioDownloadedHook = XApiPortfolioDownloadedHookObserver::create();
+        $portfolioItemScoredHook = XApiPortfolioItemScoredHookObserver::create();
+        $portfolioCommentScoredHook = XApiPortfolioCommentScoredHookObserver::create();
+        $portfolioItemEditedHook = XApiPortfolioItemEditedHookObserver::create();
+        $portfolioCommentEditedHook = XApiPortfolioCommentEditedHookObserver::create();
+
+        $learningPathItemViewedEvent = HookLearningPathItemViewed::create();
+        $learningPathEndEvent = HookLearningPathEnd::create();
+        $quizQuestionAnsweredEvent = HookQuizQuestionAnswered::create();
+        $quizEndEvent = HookQuizEnd::create();
+        $portfolioItemAddedEvent = HookPortfolioItemAdded::create();
+        $portfolioItemCommentedEvent = HookPortfolioItemCommented::create();
+        $portfolioItemViewedEvent = HookPortfolioItemViewed::create();
+        $portfolioItemHighlightedEvent = HookPortfolioItemHighlighted::create();
+        $portfolioDownloadedEvent = HookPortfolioDownloaded::create();
+        $portfolioItemScoredEvent = HookPortfolioItemScored::create();
+        $portfolioCommentScoredEvent = HookPortfolioCommentScored::create();
+        $portfolioItemEditedEvent = HookPortfolioItemEdited::create();
+        $portfolioCommentEditedEvent = HookPortfolioCommentEdited::create();
+
+        if ('true' === $this->get(self::SETTING_LRS_LP_ITEM_ACTIVE)) {
+            $learningPathItemViewedEvent->attach($learningPathItemViewedHook);
+        } else {
+            $learningPathItemViewedEvent->detach($learningPathItemViewedHook);
+        }
+
+        if ('true' === $this->get(self::SETTING_LRS_LP_ACTIVE)) {
+            $learningPathEndEvent->attach($learningPathEndHook);
+        } else {
+            $learningPathEndEvent->detach($learningPathEndHook);
+        }
+
+        if ('true' === $this->get(self::SETTING_LRS_QUIZ_ACTIVE)) {
+            $quizQuestionAnsweredEvent->attach($quizQuestionAnsweredHook);
+        } else {
+            $quizQuestionAnsweredEvent->detach($quizQuestionAnsweredHook);
+        }
+
+        if ('true' === $this->get(self::SETTING_LRS_QUIZ_QUESTION_ACTIVE)) {
+            $quizEndEvent->attach($quizEndHook);
+        } else {
+            $quizEndEvent->detach($quizEndHook);
+        }
+
+        if ('true' === $this->get(self::SETTING_LRS_PORTFOLIO_ACTIVE)) {
+            $portfolioItemAddedEvent->attach($portfolioItemAddedHook);
+            $portfolioItemCommentedEvent->attach($portfolioItemCommentedHook);
+            $portfolioItemViewedEvent->attach($portfolioItemViewedHook);
+            $portfolioItemHighlightedEvent->attach($portfolioItemHighlightedHook);
+            $portfolioDownloadedEvent->attach($portfolioDownloadedHook);
+            $portfolioItemScoredEvent->attach($portfolioItemScoredHook);
+            $portfolioCommentScoredEvent->attach($portfolioCommentScoredHook);
+            $portfolioItemEditedEvent->attach($portfolioItemEditedHook);
+            $portfolioCommentEditedEvent->attach($portfolioCommentEditedHook);
+        } else {
+            $portfolioItemAddedEvent->detach($portfolioItemAddedHook);
+            $portfolioItemCommentedEvent->detach($portfolioItemCommentedHook);
+            $portfolioItemViewedEvent->detach($portfolioItemViewedHook);
+            $portfolioItemHighlightedEvent->detach($portfolioItemHighlightedHook);
+            $portfolioDownloadedEvent->detach($portfolioDownloadedHook);
+            $portfolioItemScoredEvent->detach($portfolioItemScoredHook);
+            $portfolioCommentScoredEvent->detach($portfolioCommentScoredHook);
+            $portfolioItemEditedEvent->detach($portfolioItemEditedHook);
+            $portfolioCommentEditedEvent->detach($portfolioCommentEditedHook);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function installHook()
+    {
+        $createCourseHook = XApiCreateCourseHookObserver::create();
+
+        HookCreateCourse::create()->attach($createCourseHook);
+    }
+
+    /**
+     * @param string $variable
+     *
+     * @return array
+     */
+    public function getLangMap($variable)
+    {
+        $platformLanguage = api_get_setting('platformLanguage');
+        $platformLanguageIso = api_get_language_isocode($platformLanguage);
+
+        $map = [];
+        $map[$platformLanguageIso] = $this->getLangFromFile($variable, $platformLanguage);
+
+        try {
+            $interfaceLanguage = api_get_interface_language();
+        } catch (Exception $e) {
+            return $map;
+        }
+
+        if (!empty($interfaceLanguage) && $platformLanguage !== $interfaceLanguage) {
+            $interfaceLanguageIso = api_get_language_isocode($interfaceLanguage);
+
+            $map[$interfaceLanguageIso] = $this->getLangFromFile($variable, $interfaceLanguage);
+        }
+
+        return $map;
+    }
+
+    /**
+     * @param string $value
+     * @param string $type
+     *
+     * @return \Xabbuh\XApi\Model\IRI
+     */
+    public function generateIri($value, $type)
+    {
+        return IRI::fromString(
+            api_get_path(WEB_PATH)."xapi/$type/$value"
+        );
+    }
+
+    /**
+     * @param int $courseId
+     */
+    public function addCourseToolForTinCan($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('ToolTinCan'),
+            $courseId,
+            'sessions_category.png',
+            '../plugin/xapi/start.php',
+            0,
+            'authoring'
+        );
+    }
+
+    /**
+     * @param string $language
+     *
+     * @return mixed|string
+     */
+    public static function extractVerbInLanguage(Xabbuh\XApi\Model\LanguageMap $languageMap, $language)
+    {
+        $iso = self::findLanguageIso($languageMap->languageTags(), $language);
+
+        $text = current($languageMap);
+
+        if (isset($languageMap[$iso])) {
+            $text = trim($languageMap[$iso]);
+        } elseif (isset($languageMap['und'])) {
+            $text = $languageMap['und'];
+        }
+
+        return $text;
+    }
+
+    /**
+     * @param string $needle
+     *
+     * @return string
+     */
+    public static function findLanguageIso(array $haystack, $needle)
+    {
+        if (in_array($needle, $haystack)) {
+            return $needle;
+        }
+
+        foreach ($haystack as $language) {
+            if (strpos($language, $needle) === 0) {
+                return $language;
+            }
+        }
+
+        return $haystack[0];
+    }
+
+    public function generateLaunchUrl(
+        $type,
+        $launchUrl,
+        $activityId,
+        Agent $actor,
+        $attemptId,
+        $customLrsUrl = null,
+        $customLrsUsername = null,
+        $customLrsPassword = null,
+        $viewSessionId = null
+    ) {
+        $lrsUrl = $customLrsUrl ?: $this->get(self::SETTING_LRS_URL);
+        $lrsAuthUsername = $customLrsUsername ?: $this->get(self::SETTING_LRS_AUTH_USERNAME);
+        $lrsAuthPassword = $customLrsPassword ?: $this->get(self::SETTING_LRS_AUTH_PASSWORD);
+
+        $queryData = [
+            'endpoint' => trim($lrsUrl, "/ \t\n\r\0\x0B"),
+            'actor' => Serializer::createSerializer()->serialize($actor, 'json'),
+            'registration' => $attemptId,
+        ];
+
+        if ('tincan' === $type) {
+            $queryData['auth'] = 'Basic '.base64_encode(trim($lrsAuthUsername).':'.trim($lrsAuthPassword));
+            $queryData['activity_id'] = $activityId;
+        } elseif ('cmi5' === $type) {
+            $queryData['fetch'] = api_get_path(WEB_PLUGIN_PATH).'xapi/cmi5/token.php?session='.$viewSessionId;
+            $queryData['activityId'] = $activityId;
+        }
+
+        return $launchUrl.'?'.http_build_query($queryData, null, '&', PHP_QUERY_RFC3986);
+    }
+
+    /**
+     * @return \Doctrine\ORM\EntityManager|null
+     */
+    public static function getEntityManager()
+    {
+        $em = Database::getManager();
+
+        $prefixes = [
+            __DIR__.'/../php-xapi/repository-doctrine-orm/metadata' => 'XApi\Repository\Doctrine\Mapping',
+        ];
+
+        $driver = new SimplifiedXmlDriver($prefixes);
+        $driver->setGlobalBasename('global');
+
+        $config = Database::getDoctrineConfig(api_get_configuration_value('root_sys'));
+        $config->setMetadataDriverImpl($driver);
+
+        try {
+            return EntityManager::create($em->getConnection()->getParams(), $config);
+        } catch (ORMException $e) {
+            api_not_allowed(true, $e->getMessage());
+        }
+
+        return null;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAdminUrl()
+    {
+        $webPath = api_get_path(WEB_PLUGIN_PATH).$this->get_name();
+
+        return "$webPath/admin.php";
+    }
+
+    public function getLpResourceBlock(int $lpId)
+    {
+        $cidReq = api_get_cidreq(true, true, 'lp');
+        $webPath = api_get_path(WEB_PLUGIN_PATH).'xapi/';
+        $course = api_get_course_entity();
+        $session = api_get_session_entity();
+
+        $tools = Database::getManager()
+            ->getRepository(ToolLaunch::class)
+            ->findByCourseAndSession($course, $session);
+
+        $importIcon = Display::return_icon('import_scorm.png');
+        $moveIcon = Display::url(
+            Display::return_icon('move_everywhere.png', get_lang('Move'), [], ICON_SIZE_TINY),
+            '#',
+            ['class' => 'moved']
+        );
+
+        $return = '
    • '
+            .$importIcon
+            .Display::url(
+                get_lang('Import'),
+                $webPath."tool_import.php?$cidReq&".http_build_query(['lp_id' => $lpId])
+            )
+            .'
      • ';
+
+        /** @var ToolLaunch $tool */
+        foreach ($tools as $tool) {
+            $toolAnchor = Display::url(
+                Security::remove_XSS($tool->getTitle()),
+                api_get_self()."?$cidReq&"
+                    .http_build_query(
+                        ['action' => 'add_item', 'type' => TOOL_XAPI, 'file' => $tool->getId(), 'lp_id' => $lpId]
+                    ),
+                ['class' => 'moved']
+            );
+
+            $return .= Display::tag(
+                'li',
+                $moveIcon.$importIcon.$toolAnchor,
+                [
+                    'class' => 'lp_resource_element',
+                    'data_id' => $tool->getId(),
+                    'data_type' => TOOL_XAPI,
+                    'title' => $tool->getTitle(),
+                ]
+            );
+        }
+
+        $return .= '
    ';
+
+        return $return;
+    }
+
+    /**
+     * @throws \Doctrine\ORM\Tools\ToolsException
+     */
+    private function installPluginDbTables()
+    {
+        $em = Database::getManager();
+        $pluginEm = self::getEntityManager();
+
+        $schemaTool = new SchemaTool($em);
+        $schemaTool->createSchema(
+            [
+                $em->getClassMetadata(SharedStatement::class),
+                $em->getClassMetadata(ToolLaunch::class),
+                $em->getClassMetadata(LrsAuth::class),
+                $em->getClassMetadata(Cmi5Item::class),
+                $em->getClassMetadata(ActivityState::class),
+                $em->getClassMetadata(ActivityProfile::class),
+                $em->getClassMetadata(InternalLog::class),
+            ]
+        );
+
+        $pluginSchemaTool = new SchemaTool($pluginEm);
+        $pluginSchemaTool->createSchema(
+            [
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Attachment::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\StatementObject::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Result::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Verb::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Extensions::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Context::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Actor::class),
+                $pluginEm->getClassMetadata(\XApi\Repository\Doctrine\Mapping\Statement::class),
+            ]
+        );
+    }
+
+    /**
+     * @throws \Exception
+     */
+    private function installInitialConfig()
+    {
+        $uuidNamespace = Uuid::uuid1();
+
+        $pluginName = $this->get_name();
+        $urlId = api_get_current_access_url_id();
+
+        api_add_setting(
+            $uuidNamespace,
+            $pluginName.'_'.self::SETTING_UUID_NAMESPACE,
+            $pluginName,
+            'setting',
+            'Plugins',
+            $pluginName,
+            '',
+            '',
+            '',
+            $urlId,
+            1
+        );
+
+        api_add_setting(
+            api_get_path(WEB_PATH).'plugin/xapi/lrs.php',
+            $pluginName.'_'.self::SETTING_LRS_URL,
+            $pluginName,
+            'setting',
+            'Plugins',
+            $pluginName,
+            '',
+            '',
+            '',
+            $urlId,
+            1
+        );
+    }
+
+    /**
+     * @param string|null $lrsUrl
+     * @param string|null $lrsAuthUsername
+     * @param string|null $lrsAuthPassword
+     *
+     * @return \Xabbuh\XApi\Client\XApiClientInterface
+     */
+    private function createXApiClient($lrsUrl = null, $lrsAuthUsername = null, $lrsAuthPassword = null)
+    {
+        $baseUrl = $lrsUrl ?: $this->get(self::SETTING_LRS_URL);
+        $lrsAuthUsername = $lrsAuthUsername ?: $this->get(self::SETTING_LRS_AUTH_USERNAME);
+        $lrsAuthPassword = $lrsAuthPassword ?: $this->get(self::SETTING_LRS_AUTH_PASSWORD);
+
+        $clientBuilder = new XApiClientBuilder();
+        $clientBuilder
+            ->setHttpClient(Client::createWithConfig([RequestOptions::VERIFY => false]))
+            ->setRequestFactory(new GuzzleMessageFactory())
+            ->setBaseUrl(trim($baseUrl, "/ \t\n\r\0\x0B"))
+            ->setAuth(trim($lrsAuthUsername), trim($lrsAuthPassword));
+
+        return $clientBuilder->build();
+    }
+
+    private function addCourseTools()
+    {
+        $courses = Database::getManager()
+            ->createQuery('SELECT c.id FROM ChamiloCoreBundle:Course c')
+            ->getResult();
+
+        foreach ($courses as $course) {
+            $this->addCourseToolForTinCan($course['id']);
+        }
+    }
+
+    private function deleteCourseTools()
+    {
+        Database::getManager()
+            ->createQuery('DELETE FROM ChamiloCourseBundle:CTool t WHERE t.category = :category AND t.link LIKE :link')
+            ->execute(['category' => 'authoring', 'link' => '../plugin/xapi/start.php%']);
+    }
+}
diff --git a/plugin/xapi/start.php b/plugin/xapi/start.php
new file mode 100644
index 000000000..f3d305a4b
--- /dev/null
+++ b/plugin/xapi/start.php
@@ -0,0 +1,151 @@
+getRepository(ToolLaunch::class);
+
+$course = api_get_course_entity();
+$session = api_get_session_entity();
+$userInfo = api_get_user_info();
+
+$cidReq = api_get_cidreq();
+
+$table = new SortableTable(
+    'tbl_xapi',
+    function () use ($em, $course, $session, $isAllowedToEdit) {
+        return $em->getRepository(ToolLaunch::class)
+            ->countByCourseAndSession($course, $session, !$isAllowedToEdit);
+    },
+    function ($start, $limit, $orderBy, $orderDir) use ($toolLaunchRepo, $course, $session, $isAllowedToEdit) {
+        $tools = $toolLaunchRepo->findByCourseAndSession($course, $session, ['title' => $orderDir], $limit, $start);
+
+        $data = [];
+
+        /** @var ToolLaunch $toolLaunch */
+        foreach ($tools as $toolLaunch) {
+            $wasAddedInLp = $toolLaunchRepo->wasAddedInLp($toolLaunch);
+
+            if ($wasAddedInLp && !$isAllowedToEdit) {
+                continue;
+            }
+
+            $datum = [];
+            $datum[] = [
+                $toolLaunch->getId(),
+                $toolLaunch->getTitle(),
+                $toolLaunch->getDescription(),
+                $toolLaunch->getActivityType(),
+                $wasAddedInLp,
+            ];
+
+            if ($isAllowedToEdit) {
+                $datum[] = $toolLaunch->getId();
+            }
+
+            $data[] = $datum;
+        }
+
+        return $data;
+    },
+    0
+);
+$table->set_header(0, $plugin->get_lang('ActivityTitle'), true);
+$table->set_column_filter(
+    0,
+    function (array $toolInfo) use ($cidReq, $session, $userInfo, $plugin) {
+        list($id, $title, $description, $activityType, $wasAddedInLp) = $toolInfo;
+
+        $sessionStar = api_get_session_image(
+            $session ? $session->getId() : 0,
+            $userInfo['status']
+        );
+
+        $data = Display::url(
+            $title.$sessionStar,
+            ('cmi5' === $activityType ? 'cmi5/view.php' : 'tincan/view.php')."?id=$id&$cidReq",
+            ['class' => 'show']
+        );
+
+        if ($description) {
+            $data .= PHP_EOL.Display::tag('small', $description, ['class' => 'text-muted']);
+        }
+
+        if ($wasAddedInLp) {
+            $data .= Display::div(
+                $plugin->get_lang('ActivityAddedToLPCannotBeAccessed'),
+                ['class' => 'lp_content_type_label']
+            );
+        }
+
+        return $data;
+    }
+);
+
+if ($isAllowedToEdit) {
+    $thAttributes = ['class' => 'text-right', 'style' => 'width: 100px;'];
+
+    $table->set_header(1, get_lang('Actions'), false, $thAttributes, $thAttributes);
+    $table->set_column_filter(
+        1,
+        function ($id) use ($cidReq, $isAllowedToEdit) {
+            $actions = [];
+
+            if ($isAllowedToEdit) {
+                $actions[] = Display::url(
+                    Display::return_icon('statistics.png', get_lang('Reporting')),
+                    "tincan/stats.php?$cidReq&id=$id"
+                );
+                $actions[] = Display::url(
+                    Display::return_icon('edit.png', get_lang('Edit')),
+                    "tool_edit.php?$cidReq&edit=$id"
+                );
+                $actions[] = Display::url(
+                    Display::return_icon('delete.png', get_lang('Delete')),
+                    "tool_delete.php?$cidReq&delete=$id"
+                );
+            }
+
+            return implode(PHP_EOL, $actions);
+        }
+    );
+}
+
+$pageTitle = $plugin->get_lang('ToolTinCan');
+$pageContent = Display::return_message($plugin->get_lang('NoActivities'), 'info');
+
+if ($table->get_total_number_of_items() > 0) {
+    $pageContent = $table->return_table();
+}
+
+$view = new Template($pageTitle);
+$view->assign('header', $pageTitle);
+
+if ($isAllowedToEdit) {
+    $actions = Display::url(
+        Display::return_icon('import_scorm.png', get_lang('Import'), [], ICON_SIZE_MEDIUM),
+        "tool_import.php?$cidReq"
+    );
+
+    $view->assign(
+        'actions',
+        Display::toolbarAction(
+            'xapi_actions',
+            [$actions]
+        )
+    );
+}
+
+$view->assign('content', $pageContent);
+$view->display_one_col_template();
diff --git a/plugin/xapi/tincan/launch.php b/plugin/xapi/tincan/launch.php
new file mode 100644
index 000000000..b61eee3bd
--- /dev/null
+++ b/plugin/xapi/tincan/launch.php
@@ -0,0 +1,142 @@
+request->get('attempt_id');
+$toolLaunch = $em->find(
+    ToolLaunch::class,
+    $request->request->getInt('id')
+);
+
+if (empty($attemptId)
+    || null === $toolLaunch
+    || $toolLaunch->getCourse()->getId() !== api_get_course_entity()->getId()
+) {
+    api_not_allowed(true);
+}
+
+$plugin = XApiPlugin::create();
+
+$activity = new Activity(
+    IRI::fromString($toolLaunch->getActivityId())
+);
+$actor = new Agent(
+    InverseFunctionalIdentifier::withMbox(
+        IRI::fromString('mailto:'.$user->getEmail())
+    ),
+    $user->getCompleteName()
+);
+$state = new State(
+    $activity,
+    $actor,
+    $plugin->generateIri('tool-'.$toolLaunch->getId(), 'state')->getValue()
+);
+
+$nowDate = api_get_utc_datetime(null, false, true)->format('c');
+
+try {
+    $stateDocument = $plugin
+        ->getXApiStateClient(
+            $toolLaunch->getLrsUrl(),
+            $toolLaunch->getLrsAuthUsername(),
+            $toolLaunch->getLrsAuthPassword()
+        )
+        ->getDocument($state);
+
+    $data = $stateDocument->getData()->getData();
+
+    if ($stateDocument->offsetExists($attemptId)) {
+        $data[$attemptId][XApiPlugin::STATE_LAST_LAUNCH] = $nowDate;
+    } else {
+        $data[$attemptId] = [
+            XApiPlugin::STATE_FIRST_LAUNCH => $nowDate,
+            XApiPlugin::STATE_LAST_LAUNCH => $nowDate,
+        ];
+    }
+
+    uasort(
+        $data,
+        function ($attemptA, $attemptB) {
+            $timeA = strtotime($attemptA[XApiPlugin::STATE_LAST_LAUNCH]);
+            $timeB = strtotime($attemptB[XApiPlugin::STATE_LAST_LAUNCH]);
+
+            return $timeB - $timeA;
+        }
+    );
+
+    $documentData = new DocumentData($data);
+} catch (NotFoundException $notFoundException) {
+    $documentData = new DocumentData(
+        [
+            $attemptId => [
+                XApiPlugin::STATE_FIRST_LAUNCH => $nowDate,
+                XApiPlugin::STATE_LAST_LAUNCH => $nowDate,
+            ],
+        ]
+    );
+} catch (Exception $exception) {
+    Display::addFlash(
+        Display::return_message($exception->getMessage(), 'error')
+    );
+
+    header('Location: '.api_get_course_url());
+    exit;
+}
+
+try {
+    $plugin
+        ->getXApiStateClient()
+        ->createOrReplaceDocument(
+            new StateDocument($state, $documentData)
+        );
+} catch (Exception $exception) {
+    Display::addFlash(
+        Display::return_message($exception->getMessage(), 'error')
+    );
+
+    header('Location: '.api_get_course_url());
+    exit;
+}
+
+$lrsUrl = $toolLaunch->getLrsUrl() ?: $plugin->get(XApiPlugin::SETTING_LRS_URL);
+$lrsAuthUsername = $toolLaunch->getLrsAuthUsername() ?: $plugin->get(XApiPlugin::SETTING_LRS_AUTH_USERNAME);
+$lrsAuthPassword = $toolLaunch->getLrsAuthPassword() ?: $plugin->get(XApiPlugin::SETTING_LRS_AUTH_PASSWORD);
+
+$activityLaunchUrl = $toolLaunch->getLaunchUrl().'?'
+    .http_build_query(
+        [
+            'endpoint' => trim($lrsUrl, "/ \t\n\r\0\x0B"),
+            'auth' => 'Basic '.base64_encode(trim($lrsAuthUsername).':'.trim($lrsAuthPassword)),
+            'actor' => Serializer::createSerializer()->serialize($actor, 'json'),
+            'registration' => $attemptId,
+            'activity_id' => $toolLaunch->getActivityId(),
+        ],
+        null,
+        '&',
+        PHP_QUERY_RFC3986
+    );
+
+header("Location: $activityLaunchUrl");
diff --git a/plugin/xapi/tincan/stats.php b/plugin/xapi/tincan/stats.php
new file mode 100644
index 000000000..b019db5d9
--- /dev/null
+++ b/plugin/xapi/tincan/stats.php
@@ -0,0 +1,163 @@
+find(
+    ToolLaunch::class,
+    $request->query->getInt('id')
+);
+
+if (null === $toolLaunch) {
+    header('Location: '.api_get_course_url());
+    exit;
+}
+
+$course = api_get_course_entity();
+$session = api_get_session_entity();
+
+$cidReq = api_get_cidreq();
+
+$plugin = XApiPlugin::create();
+
+$length = 20;
+$page = $request->query->getInt('page', 1);
+$start = ($page - 1) * $length;
+$countStudentList = CourseManager::get_student_list_from_course_code(
+    $course->getCode(),
+    (bool) $session,
+    $session ? $session->getId() : 0,
+    null,
+    null,
+    true,
+    0,
+    true
+);
+
+$statsUrl = api_get_self().'?'.api_get_cidreq().'&id='.$toolLaunch->getId();
+
+$paginator = new Paginator();
+$pagination = $paginator->paginate([]);
+$pagination->setTotalItemCount($countStudentList);
+$pagination->setItemNumberPerPage($length);
+$pagination->setCurrentPageNumber($page);
+$pagination->renderer = function ($data) use ($statsUrl) {
+    $render = '';
+    if ($data['pageCount'] > 1) {
+        $render = '
      ';
+        for ($i = 1; $i <= $data['pageCount']; $i++) {
+            $pageContent = '
    • '.$i.'
      • ';
+            if ($data['current'] == $i) {
+                $pageContent = '
    • '.$i.'
      • ';
+            }
+            $render .= $pageContent;
+        }
+        $render .= '
    ';
+    }
+
+    return $render;
+};
+
+$students = CourseManager::get_student_list_from_course_code(
+    $course->getCode(),
+    (bool) $session,
+    $session ? $session->getId() : 0,
+    null,
+    null,
+    true,
+    0,
+    false,
+    $start,
+    $length
+);
+
+$content = '';
+$content .= '
    ';
+
+$loadingMessage = Display::returnFontAwesomeIcon('spinner', '', true, 'fa-pulse').' '.get_lang('Loading');
+
+foreach ($students as $studentInfo) {
+    $content .= Display::panelCollapse(
+        api_get_person_name($studentInfo['firstname'], $studentInfo['lastname']),
+        $loadingMessage,
+        "pnl-student-{$studentInfo['id']}",
+        [
+            'class' => 'pnl-student',
+            'data-student' => $studentInfo['id'],
+            'data-tool' => $toolLaunch->getId(),
+        ],
+        "pnl-student-{$studentInfo['id']}-accordion",
+        "pnl-student-{$studentInfo['id']}-collapse",
+        false
+    );
+}
+
+$content .= '
    ';
+$content .= $pagination;
+
+// View
+$interbreadcrumb[] = [
+    'name' => $plugin->get_title(),
+    'url' => '../start.php',
+];
+
+$htmlHeadXtra[] = "";
+
+$actions = Display::url(
+    Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM),
+    "../start.php?$cidReq"
+);
+
+$view = new Template($toolLaunch->getTitle());
+$view->assign(
+    'actions',
+    Display::toolbarAction('xapi_actions', [$actions])
+);
+$view->assign('header', $toolLaunch->getTitle());
+$view->assign('content', $content);
+$view->display_one_col_template();
diff --git a/plugin/xapi/tincan/stats_attempts.ajax.php b/plugin/xapi/tincan/stats_attempts.ajax.php
new file mode 100644
index 000000000..8339518d9
--- /dev/null
+++ b/plugin/xapi/tincan/stats_attempts.ajax.php
@@ -0,0 +1,131 @@
+isXmlHttpRequest()
+    || !api_is_allowed_to_edit()
+    || !$course
+) {
+    echo Display::return_message(get_lang('NotAllowed'), 'error');
+    exit;
+}
+
+$plugin = XApiPlugin::create();
+$em = Database::getManager();
+
+$toolLaunch = $em->find(
+    ToolLaunch::class,
+    $request->request->getInt('tool')
+);
+
+$student = api_get_user_entity($request->request->getInt('student'));
+
+if (!$toolLaunch || !$student) {
+    echo Display::return_message(get_lang('NotAllowed'), 'error');
+    exit;
+}
+
+$userIsSubscribedToCourse = CourseManager::is_user_subscribed_in_course(
+    $student->getId(),
+    $course->getCode(),
+    (bool) $session,
+    $session ? $session->getId() : 0
+);
+
+if (!$userIsSubscribedToCourse) {
+    echo Display::return_message(get_lang('NotAllowed'), 'error');
+    exit;
+}
+
+$cidReq = api_get_cidreq();
+
+$xApiStateClient = $plugin->getXApiStateClient(
+    $toolLaunch->getLrsUrl(),
+    $toolLaunch->getLrsAuthUsername(),
+    $toolLaunch->getLrsAuthPassword()
+);
+
+$activity = new Activity(
+    IRI::fromString($toolLaunch->getActivityId())
+);
+
+$actor = new Agent(
+    InverseFunctionalIdentifier::withMbox(
+        IRI::fromString('mailto:'.$student->getEmail())
+    ),
+    $student->getCompleteName()
+);
+
+try {
+    $stateDocument = $xApiStateClient->getDocument(
+        new State(
+            $activity,
+            $actor,
+            $plugin->generateIri('tool-'.$toolLaunch->getId(), 'state')->getValue()
+        )
+    );
+} catch (NotFoundException $notFoundException) {
+    echo Display::return_message(get_lang('NoResults'), 'warning');
+    exit;
+} catch (XApiException $exception) {
+    echo Display::return_message($exception->getMessage(), 'error');
+    exit;
+}
+
+$content = '';
+
+if ($stateDocument) {
+    $i = 1;
+
+    foreach ($stateDocument->getData()->getData() as $attemptId => $attempt) {
+        $firstLaunch = api_convert_and_format_date(
+            $attempt[XApiPlugin::STATE_FIRST_LAUNCH],
+            DATE_TIME_FORMAT_LONG
+        );
+        $lastLaunch = api_convert_and_format_date(
+            $attempt[XApiPlugin::STATE_LAST_LAUNCH],
+            DATE_TIME_FORMAT_LONG
+        );
+
+        $content .= '
    '
+            .'
    '.$plugin->get_lang('ActivityFirstLaunch').'
    '
+            .'
    '.$firstLaunch.'
    '
+            .'
    '.$plugin->get_lang('ActivityLastLaunch').'
    '
+            .'
    '.$lastLaunch.'
    '
+            .'
    '
+            .Display::toolbarButton(
+                get_lang('ShowAllAttempts'),
+                '#',
+                'th-list',
+                'default',
+                [
+                    'class' => 'btn_xapi_attempt_detail',
+                    'data-attempt' => $attemptId,
+                    'data-tool' => $toolLaunch->getId(),
+                    'style' => 'margin-bottom: 20px; margin-left: 180px;',
+                    'role' => 'button',
+                ]
+            );
+
+        $i++;
+    }
+}
+
+echo $content;
diff --git a/plugin/xapi/tincan/stats_statements.ajax.php b/plugin/xapi/tincan/stats_statements.ajax.php
new file mode 100644
index 000000000..6d14bf046
--- /dev/null
+++ b/plugin/xapi/tincan/stats_statements.ajax.php
@@ -0,0 +1,113 @@
+isXmlHttpRequest()
+    || !api_is_allowed_to_edit()
+    || !$course
+) {
+    echo Display::return_message(get_lang('NotAllowed'), 'error');
+    exit;
+}
+
+$plugin = XApiPlugin::create();
+$em = Database::getManager();
+
+$toolLaunch = $em->find(
+    ToolLaunch::class,
+    $request->request->getInt('tool')
+);
+
+$attempt = $request->request->get('attempt');
+
+if (!$toolLaunch || !$attempt) {
+    echo Display::return_message(get_lang('NoResults'), 'error');
+    exit;
+}
+
+$cidReq = api_get_cidreq();
+
+$xapiStatementClient = $plugin->getXApiStatementClient();
+
+$activity = new Activity(
+    IRI::fromString($toolLaunch->getActivityId())
+);
+
+$filter = new StatementsFilter();
+$filter
+    ->byRegistration($attempt);
+
+try {
+    $result = $xapiStatementClient->getStatements($filter);
+} catch (XApiException $xApiException) {
+    echo Display::return_message($xApiException->getMessage(), 'error');
+    exit;
+} catch (Exception $exception) {
+    echo Display::return_message($exception->getMessage(), 'error');
+    exit;
+}
+
+$statements = $result->getStatements();
+
+if (count($statements) <= 0) {
+    echo Display::return_message(get_lang('NoResults'), 'warning');
+    exit;
+}
+
+$table = new HTML_Table(['class' => 'table table-condensed table-bordered table-striped table-hover']);
+$table->setHeaderContents(0, 0, get_lang('CreatedAt'));
+$table->setHeaderContents(0, 1, $plugin->get_lang('Actor'));
+$table->setHeaderContents(0, 2, $plugin->get_lang('Verb'));
+$table->setHeaderContents(0, 3, $plugin->get_lang('ActivityId'));
+
+$i = 1;
+
+$languageIso = api_get_language_isocode(api_get_interface_language());
+
+foreach ($statements as $statement) {
+    $timestampStored = $statement->getCreated() ? api_convert_and_format_date($statement->getCreated()) : '-';
+    $actor = $statement->getActor()->getName();
+    $verb = XApiPlugin::extractVerbInLanguage($statement->getVerb()->getDisplay(), $languageIso);
+    $activity = '';
+
+    $statementObject = $statement->getObject();
+
+    if ($statementObject instanceof Activity) {
+        if (null !== $statementObject->getDefinition()) {
+            $definition = $statementObject->getDefinition();
+
+            if (null !== $definition->getName()) {
+                $activity = XApiPlugin::extractVerbInLanguage($definition->getName(), $languageIso).'
    ';
+            }
+        }
+
+        $activity .= Display::tag(
+            'small',
+            $statementObject->getId()->getValue(),
+            ['class' => 'text-muted']
+        );
+    }
+
+    $table->setCellContents($i, 0, $timestampStored);
+    $table->setCellContents($i, 1, $actor);
+    $table->setCellContents($i, 2, $verb);
+    $table->setCellContents($i, 3, $activity);
+
+    $i++;
+}
+
+$table->display();
diff --git a/plugin/xapi/tincan/view.php b/plugin/xapi/tincan/view.php
new file mode 100644
index 000000000..9c259d7f3
--- /dev/null
+++ b/plugin/xapi/tincan/view.php
@@ -0,0 +1,192 @@
+find(
+    ToolLaunch::class,
+    $request->query->getInt('id')
+);
+
+if (null === $toolLaunch
+    || $toolLaunch->getCourse()->getId() !== api_get_course_entity()->getId()
+) {
+    api_not_allowed(true);
+}
+
+$plugin = XApiPlugin::create();
+
+$activity = new Activity(
+    IRI::fromString($toolLaunch->getActivityId())
+);
+$actor = new Agent(
+    InverseFunctionalIdentifier::withMbox(
+        IRI::fromString('mailto:'.$user->getEmail())
+    ),
+    $user->getCompleteName()
+);
+$state = new State(
+    $activity,
+    $actor,
+    $plugin->generateIri('tool-'.$toolLaunch->getId(), 'state')->getValue()
+);
+
+$cidReq = api_get_cidreq();
+
+try {
+    $stateDocument = $plugin
+        ->getXApiStateClient(
+            $toolLaunch->getLrsUrl(),
+            $toolLaunch->getLrsAuthUsername(),
+            $toolLaunch->getLrsAuthPassword()
+        )
+        ->getDocument($state);
+} catch (NotFoundException $notFoundException) {
+    $stateDocument = null;
+} catch (Exception $exception) {
+    Display::addFlash(
+        Display::return_message($exception->getMessage(), 'error')
+    );
+
+    header('Location: '.api_get_course_url());
+    exit;
+}
+
+$formTarget = $originIsLearnpath ? '_self' : '_blank';
+
+$frmNewRegistration = new FormValidator(
+    'launch_new',
+    'post',
+    "launch.php?$cidReq",
+    '',
+    ['target' => $formTarget],
+    FormValidator::LAYOUT_INLINE
+);
+$frmNewRegistration->addHidden('attempt_id', Uuid::uuid4());
+$frmNewRegistration->addHidden('id', $toolLaunch->getId());
+$frmNewRegistration->addButton(
+    'submit',
+    $plugin->get_lang('LaunchNewAttempt'),
+    'external-link fa-fw',
+    'success'
+);
+
+if ($stateDocument) {
+    $row = 0;
+
+    $table = new HTML_Table(['class' => 'table table-hover table-striped']);
+    $table->setHeaderContents($row, 0, $plugin->get_lang('ActivityFirstLaunch'));
+    $table->setHeaderContents($row, 1, $plugin->get_lang('ActivityLastLaunch'));
+    $table->setHeaderContents($row, 2, get_lang('Actions'));
+
+    $row++;
+
+    $langActivityLaunch = $plugin->get_lang('ActivityLaunch');
+
+    foreach ($stateDocument->getData()->getData() as $attemptId => $attempt) {
+        $firstLaunch = api_convert_and_format_date(
+            $attempt[XApiPlugin::STATE_FIRST_LAUNCH],
+            DATE_TIME_FORMAT_LONG
+        );
+        $lastLaunch = api_convert_and_format_date(
+            $attempt[XApiPlugin::STATE_LAST_LAUNCH],
+            DATE_TIME_FORMAT_LONG
+        );
+
+        $frmLaunch = new FormValidator(
+            "launch_$row",
+            'post',
+            "launch.php?$cidReq",
+            '',
+            ['target' => $formTarget],
+            FormValidator::LAYOUT_INLINE
+        );
+        $frmLaunch->addHidden('attempt_id', $attemptId);
+        $frmLaunch->addHidden('id', $toolLaunch->getId());
+        $frmLaunch->addButton(
+            'submit',
+            $langActivityLaunch,
+            'external-link fa-fw',
+            'default'
+        );
+
+        $table->setCellContents($row, 0, $firstLaunch);
+        $table->setCellContents($row, 1, $lastLaunch);
+        $table->setCellContents($row, 2, $frmLaunch->returnForm());
+
+        $row++;
+    }
+
+    $table->setColAttributes(0, ['class' => 'text-center']);
+    $table->setColAttributes(1, ['class' => 'text-center']);
+    $table->setColAttributes(2, ['class' => 'text-center']);
+}
+
+$interbreadcrumb[] = ['url' => '../start.php', 'name' => $plugin->get_lang('ToolTinCan')];
+
+$pageTitle = $toolLaunch->getTitle();
+$pageContent = '';
+
+if ($toolLaunch->getDescription()) {
+    $pageContent .= PHP_EOL;
+    $pageContent .= "
    {$toolLaunch->getDescription()}
    ";
+}
+
+if ($toolLaunch->isAllowMultipleAttempts()
+    || empty($stateDocument)
+) {
+    $pageContent .= Display::div(
+        $frmNewRegistration->returnForm(),
+        ['class' => 'exercise_overview_options']
+    );
+}
+
+if ($stateDocument) {
+    $pageContent .= $table->toHtml();
+}
+
+$actions = '';
+
+if (!$originIsLearnpath) {
+    $actions = Display::url(
+        Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM),
+        '../start.php?'.api_get_cidreq()
+    );
+}
+
+$view = new Template($pageTitle);
+$view->assign('header', $pageTitle);
+
+if ($actions) {
+    $view->assign(
+        'actions',
+        Display::toolbarAction(
+            'xapi_actions',
+            [$actions]
+        )
+    );
+}
+$view->assign('content', $pageContent);
+$view->display_one_col_template();
diff --git a/plugin/xapi/tool_delete.php b/plugin/xapi/tool_delete.php
new file mode 100644
index 000000000..910e4a765
--- /dev/null
+++ b/plugin/xapi/tool_delete.php
@@ -0,0 +1,39 @@
+find(
+    ToolLaunch::class,
+    $request->query->getInt('delete')
+);
+
+if (null === $toolLaunch
+    || $toolLaunch->getCourse()->getId() !== api_get_course_entity()->getId()
+) {
+    api_not_allowed(true);
+}
+
+$plugin = XApiPlugin::create();
+
+$em = Database::getManager();
+$em->remove($toolLaunch);
+$em->flush();
+
+Display::addFlash(
+    Display::return_message($plugin->get_lang('ActivityDeleted'), 'success')
+);
+
+header('Location: '.api_get_course_url());
+exit;
diff --git a/plugin/xapi/tool_edit.php b/plugin/xapi/tool_edit.php
new file mode 100644
index 000000000..fec53f7b3
--- /dev/null
+++ b/plugin/xapi/tool_edit.php
@@ -0,0 +1,145 @@
+find(
+    ToolLaunch::class,
+    $request->query->getInt('edit')
+);
+
+if (null === $toolLaunch) {
+    header('Location: '.api_get_course_url());
+    exit;
+}
+
+$course = api_get_course_entity();
+$session = api_get_session_entity();
+
+$cidReq = api_get_cidreq();
+
+$plugin = XApiPlugin::create();
+
+$toolIsCmi5 = 'cmi5' === $toolLaunch->getActivityType();
+$toolIsTinCan = !$toolIsCmi5;
+
+$langEditActivity = $plugin->get_lang('EditActivity');
+
+$frmActivity = new FormValidator('frm_activity', 'post', api_get_self()."?$cidReq&edit={$toolLaunch->getId()}");
+$frmActivity->addText('title', get_lang('Title'));
+$frmActivity->addTextarea('description', get_lang('Description'));
+
+if ($toolIsTinCan) {
+    $frmActivity->addButtonAdvancedSettings('advanced_params');
+    $frmActivity->addHtml('');
+}
+
+$frmActivity->addButtonAdvancedSettings('lrs_params', $plugin->get_lang('LrsConfiguration'));
+$frmActivity->addHtml('');
+$frmActivity->addButtonUpdate(get_lang('Update'));
+$frmActivity->applyFilter('title', 'trim');
+$frmActivity->applyFilter('description', 'trim');
+$frmActivity->applyFilter('lrs_url', 'trim');
+$frmActivity->applyFilter('lrs_auth', 'trim');
+
+if ($frmActivity->validate()) {
+    $values = $frmActivity->exportValues();
+
+    $toolLaunch
+        ->setTitle($values['title'])
+        ->setDescription(empty($values['description']) ? null : $values['description']);
+
+    if ($toolIsTinCan && isset($values['allow_multiple_attempts'])) {
+        $toolLaunch->setAllowMultipleAttempts(true);
+    }
+
+    if (!empty($values['lrs_url'])
+        && !empty($values['lrs_auth_username'])
+        && !empty($values['lrs_auth_password'])
+    ) {
+        $toolLaunch
+            ->setLrsUrl($values['lrs_url'])
+            ->setLrsAuthUsername($values['lrs_auth_username'])
+            ->setLrsAuthPassword($values['lrs_auth_password']);
+    }
+
+    $em->persist($toolLaunch);
+    $em->flush();
+
+    Display::addFlash(
+        Display::return_message($plugin->get_lang('ActivityUpdated'), 'success')
+    );
+
+    header('Location: '.api_get_course_url());
+    exit;
+}
+
+$frmActivity->setDefaults(
+    [
+        'title' => $toolLaunch->getTitle(),
+        'description' => $toolLaunch->getDescription(),
+        'allow_multiple_attempts' => $toolLaunch->isAllowMultipleAttempts(),
+        'lrs_url' => $toolLaunch->getLrsUrl(),
+        'lrs_auth_username' => $toolLaunch->getLrsAuthUsername(),
+        'lrs_auth_password' => $toolLaunch->getLrsAuthPassword(),
+    ]
+);
+
+$actions = Display::url(
+    Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM),
+    'start.php?'.api_get_cidreq()
+);
+
+$pageContent = $frmActivity->returnForm();
+
+$interbreadcrumb[] = ['url' => 'start.php', 'name' => $plugin->get_lang('ToolTinCan')];
+
+$view = new Template($langEditActivity);
+$view->assign('header', $langEditActivity);
+$view->assign(
+    'actions',
+    Display::toolbarAction(
+        'xapi_actions',
+        [$actions]
+    )
+);
+$view->assign('content', $pageContent);
+$view->display_one_col_template();
diff --git a/plugin/xapi/tool_import.php b/plugin/xapi/tool_import.php
new file mode 100644
index 000000000..7c9fedc59
--- /dev/null
+++ b/plugin/xapi/tool_import.php
@@ -0,0 +1,177 @@
+query->has('lp_id')) {
+    $lp = new learnpath('', $httpRequest->query->getInt('lp_id'), $userId);
+
+    if (!empty($lp->lp_id)) {
+        $pluginIndex = api_get_path(WEB_CODE_PATH)."lp/lp_controller.php?$cidReq&"
+            .http_build_query(['action' => 'add_item', 'type' => 'step', 'lp' => $lp->lp_id, 'lp_build_selected' => 8]);
+    }
+}
+
+$langAddActivity = $plugin->get_lang('AddActivity');
+
+$formAction = api_get_self()."?$cidReq&".($lp ? http_build_query(['lp_id' => $lp->lp_id]) : '');
+
+$frmActivity = new FormValidator('frm_activity', 'post', $formAction);
+$frmActivity->addFile('file', $plugin->get_lang('XApiPackage'));
+$frmActivity->addButtonAdvancedSettings('advanced_params');
+$frmActivity->addHtml('');
+$frmActivity->addButtonAdvancedSettings('lrs_params', $plugin->get_lang('LrsConfiguration'));
+$frmActivity->addHtml('');
+$frmActivity->addButtonImport(get_lang('Import'));
+$frmActivity->addRule('file', get_lang('ThisFileIsRequired'), 'required');
+$frmActivity->addRule(
+    'file',
+    $plugin->get_lang('OnlyZipOrXmlAllowed'),
+    'filetype',
+    ['zip', 'xml']
+);
+$frmActivity->applyFilter('title', 'trim');
+$frmActivity->applyFilter('description', 'trim');
+$frmActivity->applyFilter('lrs_url', 'trim');
+$frmActivity->applyFilter('lrs_auth', 'trim');
+
+if ($frmActivity->validate()) {
+    $values = $frmActivity->exportValues();
+    $zipFileInfo = $_FILES['file'];
+
+    try {
+        $importer = PackageImporter::create($zipFileInfo, $course);
+        $packageFile = $importer->import();
+
+        $parser = PackageParser::create(
+            $importer->getPackageType(),
+            $packageFile,
+            $course,
+            $session
+        );
+        $toolLaunch = $parser->parse();
+    } catch (Exception $e) {
+        Display::addFlash(
+            Display::return_message($e->getMessage(), 'error')
+        );
+
+        header("Location: $pluginIndex");
+        exit;
+    }
+
+    if ('tincan' === $importer->getPackageType() && isset($values['allow_multiple_attempts'])) {
+        $toolLaunch->setAllowMultipleAttempts(true);
+    }
+
+    if (!empty($values['title'])) {
+        $toolLaunch->setTitle($values['title']);
+    }
+
+    if (!empty($values['description'])) {
+        $toolLaunch->setDescription($values['description']);
+    }
+
+    if (!empty($values['lrs_url'])
+        && !empty($values['lrs_auth_username'])
+        && !empty($values['lrs_auth_password'])
+    ) {
+        $toolLaunch
+            ->setLrsUrl($values['lrs_url'])
+            ->setLrsAuthUsername($values['lrs_auth_username'])
+            ->setLrsAuthPassword($values['lrs_auth_password']);
+    }
+
+    $em = Database::getManager();
+    $em->persist($toolLaunch);
+    $em->flush();
+
+    Display::addFlash(
+        Display::return_message($plugin->get_lang('ActivityImported'), 'success')
+    );
+
+    header("Location: $pluginIndex");
+    exit;
+}
+
+$frmActivity->setDefaults(['allow_multiple_attempts' => true]);
+
+$actions = Display::url(
+    Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM),
+    $pluginIndex
+);
+
+$pageContent = $frmActivity->returnForm();
+
+if ($lp) {
+    $interbreadcrumb[] = [
+        'url' => api_get_path(WEB_CODE_PATH).'lp/lp_controller.php?action=list&'.api_get_cidreq(),
+        'name' => get_lang('LearningPaths'),
+    ];
+    $interbreadcrumb[] = [
+        'url' => $pluginIndex,
+        'name' => $lp->getNameNoTags(),
+    ];
+} else {
+    $interbreadcrumb[] = ['url' => $pluginIndex, 'name' => $plugin->get_lang('ToolTinCan')];
+}
+
+$view = new Template($langAddActivity);
+$view->assign('header', $langAddActivity);
+$view->assign(
+    'actions',
+    Display::toolbarAction(
+        'xapi_actions',
+        [$actions]
+    )
+);
+$view->assign('content', $pageContent);
+$view->display_one_col_template();
diff --git a/plugin/xapi/uninstall.php b/plugin/xapi/uninstall.php
new file mode 100644
index 000000000..3bcf57247
--- /dev/null
+++ b/plugin/xapi/uninstall.php
@@ -0,0 +1,5 @@
+uninstall();
diff --git a/plugin/xapi/views/cmi5_launch.twig b/plugin/xapi/views/cmi5_launch.twig
new file mode 100644
index 000000000..8aa5f8359
--- /dev/null
+++ b/plugin/xapi/views/cmi5_launch.twig
@@ -0,0 +1,15 @@
+
    
+    
    
+        
    
+            
    {{ tool.title }}
    
+            
    {{ tool.description }}
    
+
+            
    
+
+            {{ toc_html }}
+        
    
+        
    
+            
+        
    
+    
    
+
    
diff --git a/plugin/zoom/Entity/Meeting.php b/plugin/zoom/Entity/Meeting.php
new file mode 100644
index 000000000..f2995f385
--- /dev/null
+++ b/plugin/zoom/Entity/Meeting.php
@@ -0,0 +1,706 @@
+registrants = new ArrayCollection();
+        $this->recordings = new ArrayCollection();
+        $this->activities = new ArrayCollection();
+        $this->signAttendance = false;
+        $this->sysAnnouncement = null;
+    }
+
+    /**
+     * @return string
+     */
+    public function __toString()
+    {
+        return sprintf('Meeting %d', $this->id);
+    }
+
+    /**
+     * @return int
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * @return int
+     */
+    public function getMeetingId()
+    {
+        return $this->meetingId;
+    }
+
+    /**
+     * @param int $meetingId
+     *
+     * @return Meeting
+     */
+    public function setMeetingId($meetingId)
+    {
+        $this->meetingId = $meetingId;
+
+        return $this;
+    }
+
+    /**
+     * @return User
+     */
+    public function getUser()
+    {
+        return $this->user;
+    }
+
+    /**
+     * @return Course
+     */
+    public function getCourse()
+    {
+        return $this->course;
+    }
+
+    /**
+     * @return Session
+     */
+    public function getSession()
+    {
+        return $this->session;
+    }
+
+    /**
+     * @return Registrant[]|ArrayCollection
+     */
+    public function getRegistrants()
+    {
+        return $this->registrants->filter(function (Registrant $registrant) {
+            return !$registrant instanceof Presenter;
+        });
+    }
+
+    /**
+     * @return ArrayCollection
+     */
+    public function getPresenters(): ArrayCollection
+    {
+        return $this->registrants->filter(function (Registrant $registrant) {
+            return $registrant instanceof Presenter;
+        });
+    }
+
+    public function hasUserAsPresenter(User $user): bool
+    {
+        $presenters = $this->getPresenters();
+
+        $criteria = Criteria::create();
+        $criteria->where(
+            Criteria::expr()->eq('user', $user)
+        );
+
+        return $presenters->matching($criteria)->count() > 0;
+    }
+
+    /**
+     * @return Recording[]|ArrayCollection
+     */
+    public function getRecordings()
+    {
+        return $this->recordings;
+    }
+
+    /**
+     * @return MeetingActivity[]|ArrayCollection
+     */
+    public function getActivities()
+    {
+        return $this->activities;
+    }
+
+    public function addActivity(MeetingActivity $activity)
+    {
+        $activity->setMeeting($this);
+        $this->activities[] = $activity;
+    }
+
+    /**
+     * @param MeetingActivity[]|ArrayCollection $activities
+     *
+     * @return Meeting
+     */
+    public function setActivities($activities)
+    {
+        $this->activities = $activities;
+
+        return $this;
+    }
+
+    /**
+     * @ORM\PostLoad
+     *
+     * @throws Exception
+     */
+    public function postLoad()
+    {
+        if (null !== $this->meetingListItemJson) {
+            $this->meetingListItem = MeetingListItem::fromJson($this->meetingListItemJson);
+        }
+        if (null !== $this->meetingInfoGetJson) {
+            $this->meetingInfoGet = MeetingInfoGet::fromJson($this->meetingInfoGetJson);
+        }
+        $this->initializeDisplayableProperties();
+    }
+
+    /**
+     * @ORM\PostUpdate
+     *
+     * @throws Exception
+     */
+    public function postUpdate()
+    {
+        $this->initializeDisplayableProperties();
+    }
+
+    /**
+     * @ORM\PreFlush
+     */
+    public function preFlush()
+    {
+        if (null !== $this->meetingListItem) {
+            $this->meetingListItemJson = json_encode($this->meetingListItem);
+        }
+        if (null !== $this->meetingInfoGet) {
+            $this->meetingInfoGetJson = json_encode($this->meetingInfoGet);
+        }
+    }
+
+    /**
+     * @return MeetingListItem
+     */
+    public function getMeetingListItem()
+    {
+        return $this->meetingListItem;
+    }
+
+    /**
+     * @return MeetingInfoGet
+     */
+    public function getMeetingInfoGet()
+    {
+        return $this->meetingInfoGet;
+    }
+
+    /**
+     * @param User $user
+     *
+     * @return $this
+     */
+    public function setUser($user)
+    {
+        $this->user = $user;
+
+        return $this;
+    }
+
+    /**
+     * @param Course $course
+     *
+     * @return $this
+     */
+    public function setCourse($course)
+    {
+        $this->course = $course;
+
+        return $this;
+    }
+
+    /**
+     * @param Session $session
+     *
+     * @return $this
+     */
+    public function setSession($session)
+    {
+        $this->session = $session;
+
+        return $this;
+    }
+
+    /**
+     * @return CGroupInfo
+     */
+    public function getGroup()
+    {
+        return $this->group;
+    }
+
+    /**
+     * @param CGroupInfo $group
+     *
+     * @return Meeting
+     */
+    public function setGroup($group)
+    {
+        $this->group = $group;
+
+        return $this;
+    }
+
+    /**
+     * @param MeetingListItem $meetingListItem
+     *
+     * @throws Exception
+     *
+     * @return Meeting
+     */
+    public function setMeetingListItem($meetingListItem)
+    {
+        if (null === $this->meetingId) {
+            $this->meetingId = $meetingListItem->id;
+        } elseif ($this->meetingId != $meetingListItem->id) {
+            throw new Exception('the Meeting identifier differs from the MeetingListItem identifier');
+        }
+        $this->meetingListItem = $meetingListItem;
+
+        return $this;
+    }
+
+    /**
+     * @param MeetingInfoGet|BaseMeetingTrait $meetingInfoGet
+     *
+     * @throws Exception
+     *
+     * @return Meeting
+     */
+    public function setMeetingInfoGet($meetingInfoGet)
+    {
+        if (null === $this->meetingId) {
+            $this->meetingId = $meetingInfoGet->id;
+        } elseif ($this->meetingId != $meetingInfoGet->id) {
+            throw new Exception('the Meeting identifier differs from the MeetingInfoGet identifier');
+        }
+        $this->meetingInfoGet = $meetingInfoGet;
+        $this->initializeDisplayableProperties();
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isCourseMeeting()
+    {
+        return null !== $this->course;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isCourseGroupMeeting()
+    {
+        return null !== $this->course && null !== $this->group;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isUserMeeting()
+    {
+        return null !== $this->user && null === $this->course;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isGlobalMeeting()
+    {
+        return null === $this->user && null === $this->course;
+    }
+
+    public function setStatus($status)
+    {
+        $this->meetingInfoGet->status = $status;
+    }
+
+    /**
+     * Builds the list of users that can register into this meeting.
+     * Zoom requires an email address, therefore users without an email address are excluded from the list.
+     *
+     * @return User[] the list of users
+     */
+    public function getRegistrableUsers()
+    {
+        $users = [];
+        if (!$this->isCourseMeeting()) {
+            $criteria = ['active' => true];
+            $users = Database::getManager()->getRepository('ChamiloUserBundle:User')->findBy($criteria);
+        } elseif (null === $this->session) {
+            if (null !== $this->course) {
+                /** @var CourseRelUser $courseRelUser */
+                foreach ($this->course->getUsers() as $courseRelUser) {
+                    $users[] = $courseRelUser->getUser();
+                }
+            }
+        } else {
+            if (null !== $this->course) {
+                $subscriptions = $this->session->getUserCourseSubscriptionsByStatus($this->course, Session::STUDENT);
+                if ($subscriptions) {
+                    /** @var SessionRelCourseRelUser $sessionCourseUser */
+                    foreach ($subscriptions as $sessionCourseUser) {
+                        $users[] = $sessionCourseUser->getUser();
+                    }
+                }
+            }
+        }
+
+        $activeUsersWithEmail = [];
+        foreach ($users as $user) {
+            if ($user->isActive() && !empty($user->getEmail())) {
+                $activeUsersWithEmail[] = $user;
+            }
+        }
+
+        return $activeUsersWithEmail;
+    }
+
+    /**
+     * @return bool
+     */
+    public function requiresDateAndDuration()
+    {
+        return MeetingInfoGet::TYPE_SCHEDULED === $this->meetingInfoGet->type
+            || MeetingInfoGet::TYPE_RECURRING_WITH_FIXED_TIME === $this->meetingInfoGet->type;
+    }
+
+    public function requiresRegistration(): bool
+    {
+        return true; //MeetingSettings::APPROVAL_TYPE_AUTOMATICALLY_APPROVE === $this->meetingInfoGet->settings->approval_type;
+        /*return
+            MeetingSettings::APPROVAL_TYPE_NO_REGISTRATION_REQUIRED != $this->meetingInfoGet->settings->approval_type;*/
+    }
+
+    /**
+     * @return bool
+     */
+    public function hasCloudAutoRecordingEnabled()
+    {
+        return \ZoomPlugin::RECORDING_TYPE_NONE !== $this->meetingInfoGet->settings->auto_recording;
+    }
+
+    public function getRegistrantByUser(User $user): ?Registrant
+    {
+        $criteria = Criteria::create()
+            ->where(
+                Criteria::expr()->eq('user', $user)
+            )
+        ;
+
+        return $this->registrants->matching($criteria)->first() ?: null;
+    }
+
+    /**
+     * Generates a short presentation of the meeting for the future participant.
+     * To be displayed above the "Enter meeting" link.
+     *
+     * @return string
+     */
+    public function getIntroduction()
+    {
+        $introduction = sprintf('
    %s
    ', $this->getTopic()).PHP_EOL;
+        if (!$this->isGlobalMeeting()) {
+            if (!empty($this->formattedStartTime)) {
+                $introduction .= $this->formattedStartTime;
+                if (!empty($this->formattedDuration)) {
+                    $introduction .= ' ('.$this->formattedDuration.')';
+                }
+                $introduction .= PHP_EOL;
+            }
+        }
+        if ($this->user) {
+            $introduction .= sprintf('
    %s
    ', $this->user->getFullname()).PHP_EOL;
+        } elseif ($this->isCourseMeeting()) {
+            if (null === $this->session) {
+                $introduction .= sprintf('
    %s
    ', $this->course).PHP_EOL;
+            } else {
+                $introduction .= sprintf('
    %s (%s)
    ', $this->course, $this->session).PHP_EOL;
+            }
+        }
+
+        if (!empty($this->getAgenda())) {
+            $introduction .= sprintf('
    %s
    ', $this->getAgenda()).PHP_EOL;
+        }
+
+        return $introduction;
+    }
+
+    public function isSignAttendance(): bool
+    {
+        return $this->signAttendance;
+    }
+
+    public function setSignAttendance(bool $signAttendance): Meeting
+    {
+        $this->signAttendance = $signAttendance;
+
+        return $this;
+    }
+
+    public function getAccountEmail(): ?string
+    {
+        return $this->accountEmail;
+    }
+
+    public function setAccountEmail(?string $accountEmail): self
+    {
+        $this->accountEmail = $accountEmail;
+
+        return $this;
+    }
+
+    public function getReasonToSignAttendance(): ?string
+    {
+        return $this->reasonToSignAttendance;
+    }
+
+    public function setReasonToSignAttendance(string $reasonToSignAttendance): Meeting
+    {
+        $this->reasonToSignAttendance = $reasonToSignAttendance;
+
+        return $this;
+    }
+
+    public function getTopic(): string
+    {
+        return $this->meetingInfoGet->topic;
+    }
+
+    public function getAgenda(): ?string
+    {
+        return $this->meetingInfoGet->agenda;
+    }
+
+    public function getSysAnnouncement(): ?SysAnnouncement
+    {
+        return $this->sysAnnouncement;
+    }
+
+    public function setSysAnnouncement(?SysAnnouncement $sysAnnouncement): Meeting
+    {
+        $this->sysAnnouncement = $sysAnnouncement;
+
+        return $this;
+    }
+
+    /**
+     * @throws Exception on unexpected start_time or duration
+     */
+    protected function initializeDisplayableProperties()
+    {
+        $zoomPlugin = new \ZoomPlugin();
+
+        $typeList = [
+            API\Meeting::TYPE_INSTANT => $zoomPlugin->get_lang('InstantMeeting'),
+            API\Meeting::TYPE_SCHEDULED => $zoomPlugin->get_lang('ScheduledMeeting'),
+            API\Meeting::TYPE_RECURRING_WITH_NO_FIXED_TIME => $zoomPlugin->get_lang('RecurringWithNoFixedTime'),
+            API\Meeting::TYPE_RECURRING_WITH_FIXED_TIME => $zoomPlugin->get_lang('RecurringWithFixedTime'),
+        ];
+        $this->typeName = $typeList[$this->meetingInfoGet->type];
+
+        if (property_exists($this, 'status')) {
+            $statusList = [
+                'waiting' => $zoomPlugin->get_lang('Waiting'),
+                'started' => $zoomPlugin->get_lang('Started'),
+                'finished' => $zoomPlugin->get_lang('Finished'),
+            ];
+            $this->statusName = $statusList[$this->meetingInfoGet->status];
+        }
+        $this->startDateTime = null;
+        $this->formattedStartTime = '';
+        $this->durationInterval = null;
+        $this->formattedDuration = '';
+        if (!empty($this->meetingInfoGet->start_time)) {
+            $this->startDateTime = new DateTime($this->meetingInfoGet->start_time);
+            $this->startDateTime->setTimezone(new DateTimeZone(api_get_timezone()));
+            $this->formattedStartTime = $this->startDateTime->format('Y-m-d H:i');
+        }
+
+        if (!empty($this->meetingInfoGet->duration)) {
+            $now = new DateTime();
+            $later = new DateTime();
+            $later->add(new DateInterval('PT'.$this->meetingInfoGet->duration.'M'));
+            $this->durationInterval = $now->diff($later);
+            $this->formattedDuration = $this->durationInterval->format($zoomPlugin->get_lang('DurationFormat'));
+        }
+    }
+}
diff --git a/plugin/zoom/Entity/MeetingActivity.php b/plugin/zoom/Entity/MeetingActivity.php
new file mode 100644
index 000000000..fdeaf84c5
--- /dev/null
+++ b/plugin/zoom/Entity/MeetingActivity.php
@@ -0,0 +1,208 @@
+createdAt = new \DateTime();
+    }
+
+    /**
+     * @return string
+     */
+    public function __toString()
+    {
+        return sprintf('Activity %d', $this->id);
+    }
+
+    /**
+     * @return int
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * @return Meeting
+     */
+    public function getMeeting()
+    {
+        return $this->meeting;
+    }
+
+    /**
+     * @param Meeting $meeting
+     *
+     * @return MeetingActivity
+     */
+    public function setMeeting($meeting)
+    {
+        $this->meeting = $meeting;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * @param string $name
+     *
+     * @return MeetingActivity
+     */
+    public function setName($name)
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getType()
+    {
+        return $this->type;
+    }
+
+    /**
+     * @param string $type
+     *
+     * @return MeetingActivity
+     */
+    public function setType($type)
+    {
+        $this->type = $type;
+
+        return $this;
+    }
+
+    /**
+     * @return DateTime
+     */
+    public function getCreatedAt()
+    {
+        return $this->createdAt;
+    }
+
+    /**
+     * @return string
+     */
+    public function getEvent()
+    {
+        return $this->event;
+    }
+
+    /**
+     * @return Meeting
+     */
+    public function getUser()
+    {
+        return $this->user;
+    }
+
+    /**
+     * @param Meeting $user
+     *
+     * @return MeetingActivity
+     */
+    public function setUser($user)
+    {
+        $this->user = $user;
+
+        return $this;
+    }
+
+    public function getEventDecoded()
+    {
+        if (!empty($this->event)) {
+            return json_decode($this->event);
+        }
+
+        return '';
+    }
+
+    /**
+     * @param string $event
+     *
+     * @return MeetingActivity
+     */
+    public function setEvent($event)
+    {
+        $this->event = $event;
+
+        return $this;
+    }
+}
diff --git a/plugin/zoom/Entity/Presenter.php b/plugin/zoom/Entity/Presenter.php
new file mode 100644
index 000000000..21b417fae
--- /dev/null
+++ b/plugin/zoom/Entity/Presenter.php
@@ -0,0 +1,38 @@
+id);
+    }
+
+    /**
+     * @ORM\PostLoad()
+     *
+     * @throws Exception
+     */
+    public function postLoad()
+    {
+        parent::postLoad();
+    }
+
+    /**
+     * @ORM\PreFlush()
+     */
+    public function preFlush()
+    {
+        parent::preFlush();
+    }
+}
diff --git a/plugin/zoom/Entity/Recording.php b/plugin/zoom/Entity/Recording.php
new file mode 100644
index 000000000..ac6f1f551
--- /dev/null
+++ b/plugin/zoom/Entity/Recording.php
@@ -0,0 +1,193 @@
+getRecordingMeeting();
+        if (property_exists($object, $name)) {
+            return $object->$name;
+        }
+        throw new Exception(sprintf('%s does not know property %s', $this, $name));
+    }
+
+    /**
+     * @return string
+     */
+    public function __toString()
+    {
+        return sprintf('Recording %d', $this->uuid);
+    }
+
+    /**
+     * @return Meeting
+     */
+    public function getMeeting()
+    {
+        return $this->meeting;
+    }
+
+    /**
+     * @throws Exception
+     *
+     * @return RecordingMeeting
+     */
+    public function getRecordingMeeting()
+    {
+        return $this->recordingMeeting;
+    }
+
+    /**
+     * @param Meeting $meeting
+     *
+     * @return $this
+     */
+    public function setMeeting($meeting)
+    {
+        $this->meeting = $meeting;
+        $this->meeting->getRecordings()->add($this);
+
+        return $this;
+    }
+
+    /**
+     * @param RecordingMeeting $recordingMeeting
+     *
+     * @throws Exception
+     *
+     * @return Recording
+     */
+    public function setRecordingMeeting($recordingMeeting)
+    {
+        if (null === $this->uuid) {
+            $this->uuid = $recordingMeeting->uuid;
+        } elseif ($this->uuid !== $recordingMeeting->uuid) {
+            throw new Exception('the RecordingEntity identifier differs from the RecordingMeeting identifier');
+        }
+        if (null === $this->meeting) {
+            $this->meeting = Database::getManager()->getRepository(Meeting::class)->find($recordingMeeting->id);
+        } elseif ($this->meeting->getMeetingId() != $recordingMeeting->id) {
+            // $this->meeting remains null when the remote RecordingMeeting refers to a deleted meeting.
+            throw new Exception('The RecordingEntity meeting id differs from the RecordingMeeting meeting id');
+        }
+        $this->recordingMeeting = $recordingMeeting;
+
+        return $this;
+    }
+
+    /**
+     * @ORM\PostLoad
+     *
+     * @throws Exception
+     */
+    public function postLoad()
+    {
+        if (null !== $this->recordingMeetingJson) {
+            $this->recordingMeeting = RecordingMeeting::fromJson($this->recordingMeetingJson);
+        }
+        $this->initializeExtraProperties();
+    }
+
+    /**
+     * @ORM\PreFlush
+     */
+    public function preFlush()
+    {
+        if (null !== $this->recordingMeeting) {
+            $this->recordingMeetingJson = json_encode($this->recordingMeeting);
+        }
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function initializeExtraProperties()
+    {
+        $this->startDateTime = new DateTime($this->recordingMeeting->start_time);
+        $this->startDateTime->setTimezone(new DateTimeZone(api_get_timezone()));
+        $this->formattedStartTime = $this->startDateTime->format('Y-m-d H:i');
+
+        $now = new DateTime();
+        $later = new DateTime();
+        $later->add(new DateInterval('PT'.$this->recordingMeeting->duration.'M'));
+        $this->durationInterval = $later->diff($now);
+        $this->formattedDuration = $this->durationInterval->format(get_lang('DurationFormat'));
+    }
+}
diff --git a/plugin/zoom/Entity/Registrant.php b/plugin/zoom/Entity/Registrant.php
new file mode 100644
index 000000000..f65bdc787
--- /dev/null
+++ b/plugin/zoom/Entity/Registrant.php
@@ -0,0 +1,283 @@
+id);
+    }
+
+    /**
+     * @return Meeting
+     */
+    public function getMeeting()
+    {
+        return $this->meeting;
+    }
+
+    /**
+     * @param Meeting $meeting
+     *
+     * @return $this
+     */
+    public function setMeeting($meeting)
+    {
+        $this->meeting = $meeting;
+        $this->meeting->getRegistrants()->add($this);
+
+        return $this;
+    }
+
+    /**
+     * @return User
+     */
+    public function getUser()
+    {
+        return $this->user;
+    }
+
+    /**
+     * @param User $user
+     *
+     * @return $this
+     */
+    public function setUser($user)
+    {
+        $this->user = $user;
+
+        return $this;
+    }
+
+    /**
+     * @throws Exception
+     *
+     * @return MeetingRegistrantListItem
+     */
+    public function getMeetingRegistrantListItem()
+    {
+        return $this->meetingRegistrantListItem;
+    }
+
+    /**
+     * @param MeetingRegistrantListItem $meetingRegistrantListItem
+     *
+     * @throws Exception
+     *
+     * @return $this
+     */
+    public function setMeetingRegistrantListItem($meetingRegistrantListItem)
+    {
+        if (!is_null($this->meeting) && $this->meeting->getId() != $meetingRegistrantListItem->id) {
+            throw new Exception('RegistrantEntity meeting id differs from MeetingRegistrantListItem id');
+        }
+        $this->meetingRegistrantListItem = $meetingRegistrantListItem;
+        $this->computeFullName();
+
+        return $this;
+    }
+
+    public function computeFullName()
+    {
+        $this->fullName = api_get_person_name(
+            $this->meetingRegistrant->first_name,
+            $this->meetingRegistrant->last_name
+        );
+    }
+
+    public function getJoinUrl()
+    {
+        if (!$this->createdRegistration) {
+            return '';
+        }
+
+        return $this->createdRegistration->join_url;
+    }
+
+    /**
+     * @throws Exception
+     *
+     * @return CreatedRegistration
+     */
+    public function getCreatedRegistration()
+    {
+        return $this->createdRegistration;
+    }
+
+    /**
+     * @param CreatedRegistration $createdRegistration
+     *
+     * @throws Exception
+     *
+     * @return $this
+     */
+    public function setCreatedRegistration($createdRegistration)
+    {
+        if (null === $this->id) {
+            $this->id = $createdRegistration->registrant_id;
+        } elseif ($this->id != $createdRegistration->registrant_id) {
+            throw new Exception('RegistrantEntity id differs from CreatedRegistration identifier');
+        }
+        $this->createdRegistration = $createdRegistration;
+
+        return $this;
+    }
+
+    /**
+     * @throws Exception
+     *
+     * @return MeetingRegistrant
+     */
+    public function getMeetingRegistrant()
+    {
+        return $this->meetingRegistrant;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function setMeetingRegistrant(API\RegistrantSchema $meetingRegistrant): Registrant
+    {
+        $this->meetingRegistrant = $meetingRegistrant;
+        $this->computeFullName();
+
+        return $this;
+    }
+
+    /**
+     * @ORM\PostLoad
+     *
+     * @throws Exception
+     */
+    public function postLoad()
+    {
+        if (null !== $this->meetingRegistrantJson) {
+            $this->meetingRegistrant = MeetingRegistrant::fromJson($this->meetingRegistrantJson);
+        }
+        if (null !== $this->createdRegistrationJson) {
+            $this->createdRegistration = CreatedRegistration::fromJson($this->createdRegistrationJson);
+        }
+        if (null !== $this->meetingRegistrantListItemJson) {
+            $this->meetingRegistrantListItem = MeetingRegistrantListItem::fromJson(
+                $this->meetingRegistrantListItemJson
+            );
+        }
+        $this->computeFullName();
+    }
+
+    /**
+     * @ORM\PreFlush
+     */
+    public function preFlush()
+    {
+        if (null !== $this->meetingRegistrant) {
+            $this->meetingRegistrantJson = json_encode($this->meetingRegistrant);
+        }
+        if (null !== $this->createdRegistration) {
+            $this->createdRegistrationJson = json_encode($this->createdRegistration);
+        }
+        if (null !== $this->meetingRegistrantListItem) {
+            $this->meetingRegistrantListItemJson = json_encode($this->meetingRegistrantListItem);
+        }
+    }
+
+    public function setSignature(Signature $signature): void
+    {
+        $this->signature = $signature;
+
+        $signature->setRegistrant($this);
+    }
+
+    public function getSignature(): ?Signature
+    {
+        return $this->signature;
+    }
+}
diff --git a/plugin/zoom/Entity/Signature.php b/plugin/zoom/Entity/Signature.php
new file mode 100644
index 000000000..1413e4f8d
--- /dev/null
+++ b/plugin/zoom/Entity/Signature.php
@@ -0,0 +1,84 @@
+id;
+    }
+
+    public function getRegistrant(): Registrant
+    {
+        return $this->registrant;
+    }
+
+    public function setRegistrant(Registrant $registrant): Signature
+    {
+        $this->registrant = $registrant;
+
+        return $this;
+    }
+
+    public function getFile(): string
+    {
+        return $this->file;
+    }
+
+    public function setFile(string $file): Signature
+    {
+        $this->file = $file;
+
+        return $this;
+    }
+
+    public function getRegisteredAt(): DateTime
+    {
+        return $this->registeredAt;
+    }
+
+    public function setRegisteredAt(DateTime $registeredAt): Signature
+    {
+        $this->registeredAt = $registeredAt;
+
+        return $this;
+    }
+}
diff --git a/plugin/zoom/Entity/Webinar.php b/plugin/zoom/Entity/Webinar.php
new file mode 100644
index 000000000..24f29c06f
--- /dev/null
+++ b/plugin/zoom/Entity/Webinar.php
@@ -0,0 +1,138 @@
+webinarSchema) {
+            $this->webinarSchemaJson = json_encode($this->webinarSchema);
+        }
+    }
+
+    public function postLoad()
+    {
+        if (null !== $this->webinarSchemaJson) {
+            $this->webinarSchema = WebinarSchema::fromJson($this->webinarSchemaJson);
+        }
+
+        $this->initializeDisplayableProperties();
+    }
+
+    /**
+     * @param WebinarSchema|BaseMeetingTrait $webinarSchema
+     *
+     * @throws Exception
+     */
+    public function setWebinarSchema(WebinarSchema $webinarSchema): Webinar
+    {
+        if (null === $this->meetingId) {
+            $this->meetingId = $webinarSchema->id;
+        } elseif ($this->meetingId != $webinarSchema->id) {
+            throw new Exception('the Meeting identifier differs from the MeetingInfoGet identifier');
+        }
+
+        $this->webinarSchema = $webinarSchema;
+
+        $this->initializeDisplayableProperties();
+
+        return $this;
+    }
+
+    public function getWebinarSchema(): WebinarSchema
+    {
+        return $this->webinarSchema;
+    }
+
+    public function hasCloudAutoRecordingEnabled(): bool
+    {
+        return $this->webinarSchema->settings->auto_recording !== ZoomPlugin::RECORDING_TYPE_NONE;
+    }
+
+    public function requiresDateAndDuration(): bool
+    {
+        return WebinarSchema::TYPE_WEBINAR == $this->webinarSchema->type;
+    }
+
+    public function requiresRegistration(): bool
+    {
+        return in_array(
+            $this->webinarSchema->settings->approval_type,
+            [
+                WebinarSettings::APPROVAL_TYPE_AUTOMATICALLY_APPROVE,
+                WebinarSettings::APPROVAL_TYPE_MANUALLY_APPROVE,
+            ]
+        );
+    }
+
+    public function getTopic(): string
+    {
+        return $this->webinarSchema->topic;
+    }
+
+    public function getAgenda(): ?string
+    {
+        return $this->webinarSchema->agenda;
+    }
+
+    protected function initializeDisplayableProperties()
+    {
+        $zoomPlugin = ZoomPlugin::create();
+
+        $namedTypes = [
+            WebinarSchema::TYPE_WEBINAR => $zoomPlugin->get_lang('Webinar'),
+            WebinarSchema::TYPE_RECURRING_NO_FIXED_TIME => $zoomPlugin->get_lang('RecurringWithNoFixedTime'),
+            WebinarSchema::TYPE_RECURRING_FIXED_TIME => $zoomPlugin->get_lang('RecurringWithFixedTime'),
+        ];
+
+        $this->typeName = $namedTypes[$this->webinarSchema->type];
+
+        if ($this->webinarSchema->start_time) {
+            $this->startDateTime = new DateTime(
+                $this->webinarSchema->start_time,
+                new \DateTimeZone(api_get_timezone())
+            );
+            $this->formattedStartTime = $this->startDateTime->format('Y-m-d H:i');
+        }
+
+        if ($this->webinarSchema->duration) {
+            $now = new DateTime();
+            $later = new DateTime();
+            $later->add(
+                new DateInterval('PT'.$this->webinarSchema->duration.'M')
+            );
+            $this->durationInterval = $now->diff($later);
+            $this->formattedDuration = $this->durationInterval->format(
+                $zoomPlugin->get_lang('DurationFormat')
+            );
+        }
+    }
+}
diff --git a/plugin/zoom/README.code.md b/plugin/zoom/README.code.md
new file mode 100644
index 000000000..43c36e981
--- /dev/null
+++ b/plugin/zoom/README.code.md
@@ -0,0 +1,70 @@
+The Chamilo Zoom plugin class itself is defined in _plugin/zoom/lib/ZoomPlugin.php_
+
+It manipulates both **remote Zoom server objects** and **local database entities**:
+
+# Local database entities
+
+The local entities map the remote objects to Chamilo courses/sessions and users.
+
+They also maintain a cache of the matching remote objects.
+
+_Entity/*Entity.php_ are the local database entity classes.
+
+Doctrine entity manager repository classes are in _lib/*EntityRepository.php_.
+
+# Remote Zoom server objets
+
+_lib/API/*.php_ contains the Zoom API data structure definition classes,
+based on Zoom's own API specification:
+
+* https://marketplace.zoom.us/docs/api-reference/zoom-api
+* https://marketplace.zoom.us/docs/api-reference/zoom-api/Zoom%20API.oas2.json
+
+These classes provide methods to list, create, update and delete the remote objects.
+
+# JWT Client
+
+API class methods use a JWT client implemented in _lib/API/JWTClient.php_.
+
+The plugin constructor initializes the JWT Client, giving it required API key and secret.
+
+# Event notification handler
+
+_endpoint.php_ is the Zoom API event notification web hook end point.
+
+It handles notifications sent by Zoom servers on useful events :
+
+* meeting start and end,
+* registrant join and leave,
+* recordings created and deleted
+
+# Administrative interface
+
+_admin.php_ is the administrative interface.
+It lists all meetings and recordings.
+
+# Course tool
+
+_start.php_ is the **course** tool target:
+
+* to the course teacher, it shows a course meeting management interface;
+* to the course learners, it shows the list of scheduled course meetings.
+
+# Home page's profile block (also on "My Courses" page)
+
+This plugin can add 3 kinds of links to "profile block" :
+
+1. _join_meeting.php?meetingId=…_ links to upcoming meetings accessible to the current user.
+_join_meeting.php_ presents the meeting and shows a link to enter the meeting.
+2. _user.php_ is the **user**'s own meeting management interface.
+3. _global.php_ directs the user to _join_meeting.php_ with the **global** meeting.
+
+# Meeting management page
+
+_admin.php_, _start.php_ and _user.php_ link to _meeting.php_.
+
+_meeting.php_ is the meeting management page, where one can manage
+
+* the meeting properties,
+* the list of its registrants and
+* its recordings.
\ No newline at end of file
diff --git a/plugin/zoom/README.md b/plugin/zoom/README.md
new file mode 100644
index 000000000..2e824a74b
--- /dev/null
+++ b/plugin/zoom/README.md
@@ -0,0 +1,148 @@
+This plugin adds Zoom meetings, user registration to meetings and meeting recordings.
+
+> This plugin requires a Zoom account to manage meetings.
+
+Once enabled, it will show as an additional course tool in all courses' homepage: teachers will be able to launch a
+conference and student to join it.
+
+## Configuration
+
+The Zoom API uses JSON Web Tokens (JWT) to authenticate account-level access. JWT apps provide an API Key and Secret
+required to authenticate with JWT. To get them, create a JWT App or a Server-to-Sever OAuth app:
+
+> From June 1, 2023, Zoom recommend that you create a Server-to-Server OAuth application to replace the funcionality of
+> a JWT app in your account.
+
+1. Log into your [Zoom profile page](https://zoom.us/profile)
+2. Click on Advanced / Application Marketplace
+3. Click on [Develop / Build App](https://marketplace.zoom.us/develop/create)
+4. Choose JWT or Server-to-Serve OAuth and then Create
+5. Information: Fill in fields about your "App" (application and company names, contact name and email address)
+6. Click on Continue
+7. App Credentials
+   1. For a JWT application: Copy your API Key and Secret to the plugin configuration
+   2. For a Server-to-Server OAuth application: Copy your *Account ID*, *Client ID* anf *Client secret* to the plugin
+      configuration
+8. Click on Continue 
+9. Feature: enable Event Subscriptions to add a new one with endpoint
+   URL `https://your.chamilo.url/plugin/zoom/endpoint.php` (validate the endpoint to allow to activate the app) and add
+   these event types:
+
+      - Start Meeting
+      - End Meeting
+      - Participant/Host joined meeting
+      - Participant/Host left meeting
+      - Start Webinar
+      - End Webinar
+      - Participant/Host joined webinar
+      - Participant/Host left webinar
+      - All Recordings have completed
+      - Recording transcript files have completed
+
+   Then click on Done then on Save and copy your *Verification Token* if you have a JWT application or the *Secret
+   Token* if you have an Server-to-Server OAuth application to the plugin configuration
+10. click on Continue
+11. Scopes (only for Server-to-Server OAuth application): Click on Add Scopes and select *meeting:write:admin*,
+    *webinar:write:admin*, *recording:write:admin*. Then click on Done.
+    
+## Changelog
+
+**v0.5**
+
+* Added the ability to create a system announcement.
+
+**v0.4**
+
+* The creation of webinars is now allowed.
+* Added signed attendance to allow you to configure an attendance sheet where participants register their signature. The
+signed attendance functionality is similar to that found in the Exercise Signature plugin but does not reuse it.
+* Allows you to use multiple accounts and subaccounts to create meetings/webinars
+
+## Meetings - Webinars
+
+A **meeting** or **webinar** can be linked to a local **user** and/or a local **course**/**session**:
+
+  * a meeting/webinar with a course is a _course meeting/webinar_;
+  * a meeting/webinar with a user and no course is a _user meeting/webinar_;
+  * a meeting/webinar with no course nor user is a _global meeting/webinar_.
+
+A webinar only can be creadted when your Zoom account has a plan with the webinars feature.
+
+## Registrants
+
+A **registrant** is the registration of a local user to a meeting/webinar.
+
+Users do not register themselves to meetings.
+
+* They are registered to a course meeting/webinar by the course manager.
+* They are registered to a user meeting/webinar by that user.
+* They are registered automatically to the global meeting/webinar, when they enter it.
+
+## Recordings
+
+A **recording** is the list of files created during a past meeting/webinar instance.
+
+Course meeting/webinar files can be copied to the course by the course manager.
+
+# Required Zoom user account
+
+Recordings and user registration are only available to paying Zoom customers.
+
+For a non-paying Zoom user, this plugin still works but participants will join anonymously.
+
+The user that starts the meeting/webinar will be identified as the Zoom account that is defined in the plugin. Socreate
+a generic account that works for all the users that start meetings.
+
+# Databace changelog
+
+Please, execute this queries in your database:
+
+**Updatnig to v0.6 from v.0.5**
+```sql
+UPDATE plugin_zoom_registrant SET type = 'registrant';
+
+ALTER TABLE plugin_zoom_registrant
+   ADD type VARCHAR(255) NOT NULL;
+```
+
+**Updating to v0.5 from v.0.4**
+
+```sql
+ALTER TABLE plugin_zoom_meeting
+   ADD sys_announcement_id INT DEFAULT NULL;
+ALTER TABLE plugin_zoom_meeting
+   ADD CONSTRAINT FK_3448092778FB10C FOREIGN KEY (sys_announcement_id) REFERENCES sys_announcement (id) ON DELETE SET NULL;
+CREATE INDEX IDX_3448092778FB10C ON plugin_zoom_meeting (sys_announcement_id);
+```
+
+**Updating to v0.4 from v0.3**
+
+```sql
+ALTER TABLE plugin_zoom_meeting
+   ADD account_email       VARCHAR(255) DEFAULT NULL,
+   ADD type                VARCHAR(255) NOT NULL,
+   ADD webinar_schema_json LONGTEXT     DEFAULT NULL;
+
+CREATE TABLE plugin_zoom_signature (
+      id            INT AUTO_INCREMENT NOT NULL,
+      registrant_id INT DEFAULT NULL,
+      signature     LONGTEXT           NOT NULL,
+      registered_at DATETIME           NOT NULL,
+      UNIQUE INDEX UNIQ_D41895893304A716 (registrant_id),
+      PRIMARY KEY (id)
+   )
+   DEFAULT CHARACTER SET utf8
+   COLLATE `utf8_unicode_ci`
+   ENGINE = InnoDB;
+
+ALTER TABLE plugin_zoom_signature
+   ADD CONSTRAINT FK_D41895893304A716 FOREIGN KEY (registrant_id) REFERENCES plugin_zoom_registrant (id);
+
+ALTER TABLE plugin_zoom_meeting
+   ADD sign_attendance           TINYINT(1) NOT NULL,
+   ADD reason_to_sign_attendance LONGTEXT DEFAULT NULL;
+```
+
+# Contributing
+
+Read README.code.md for an introduction to the plugin's code.
diff --git a/plugin/zoom/activity.php b/plugin/zoom/activity.php
new file mode 100644
index 000000000..d7f7df2df
--- /dev/null
+++ b/plugin/zoom/activity.php
@@ -0,0 +1,55 @@
+get_lang('ZoomVideoConferences');
+$meetingId = isset($_REQUEST['meetingId']) ? (int) $_REQUEST['meetingId'] : 0;
+if (empty($meetingId)) {
+    api_not_allowed(true);
+}
+
+$content = '';
+/** @var Meeting $meeting */
+$meeting = $plugin->getMeetingRepository()->findOneBy(['meetingId' => $meetingId]);
+if (null === $meeting) {
+    api_not_allowed(true);
+}
+
+if (!$plugin->userIsConferenceManager($meeting)) {
+    api_not_allowed(true);
+}
+$returnURL = 'meetings.php';
+$urlExtra = '';
+if ($meeting->isCourseMeeting()) {
+    api_protect_course_script(true);
+    $urlExtra = api_get_cidreq();
+    $returnURL = 'start.php?'.$urlExtra;
+    if (api_is_in_group()) {
+        $interbreadcrumb[] = [
+            'url' => api_get_path(WEB_CODE_PATH).'group/group.php?'.api_get_cidreq(),
+            'name' => get_lang('Groups'),
+        ];
+        $interbreadcrumb[] = [
+            'url' => api_get_path(WEB_CODE_PATH).'group/group_space.php?'.api_get_cidreq(),
+            'name' => get_lang('GroupSpace').' '.$meeting->getGroup()->getName(),
+        ];
+    }
+}
+
+$interbreadcrumb[] = [
+    'url' => $returnURL,
+    'name' => $plugin->get_lang('ZoomVideoConferences'),
+];
+$tpl = new Template($meeting->getMeetingId());
+$tpl->assign('actions', $plugin->getToolbar());
+$tpl->assign('meeting', $meeting);
+$tpl->assign('url_extra', $urlExtra);
+$tpl->assign('content', $tpl->fetch('zoom/view/activity.tpl'));
+$tpl->display_one_col_template();
diff --git a/plugin/zoom/attendance.php b/plugin/zoom/attendance.php
new file mode 100644
index 000000000..979546ab0
--- /dev/null
+++ b/plugin/zoom/attendance.php
@@ -0,0 +1,181 @@
+get('meetingId', 0);
+
+if (empty($meetingId)) {
+    api_not_allowed(true);
+}
+
+$plugin = ZoomPlugin::create();
+$em = Database::getManager();
+/** @var Meeting $meeting */
+$meeting = $plugin->getMeetingRepository()->findOneBy(['meetingId' => $meetingId]);
+$registrantsRepo = $em->getRepository(Registrant::class);
+
+if (null === $meeting) {
+    api_not_allowed(
+        true,
+        Display::return_message($plugin->get_lang('MeetingNotFound'), 'error')
+    );
+}
+
+if (!$plugin->userIsConferenceManager($meeting)
+    || !$meeting->isSignAttendance()
+) {
+    api_not_allowed(
+        true,
+        Display::return_message(get_lang('NotAvailable'), 'warning')
+    );
+}
+
+$getNumberOfSignatures = function () use ($meeting) {
+    return $meeting->getRegistrants()->count();
+};
+
+$getSignaturesData = function (
+    $from,
+    $limit,
+    $column,
+    $direction
+) use ($registrantsRepo, $meeting) {
+    if (0 === $column) {
+        $columnField = 'u.lastname';
+    } elseif (1 === $column) {
+        $columnField = 'u.firstname';
+    } else {
+        $columnField = 's.registeredAt';
+    }
+
+    $result = $registrantsRepo->findByMeetingPaginated($meeting, $from, $limit, $columnField, $direction);
+
+    return array_map(
+        function (Registrant $registrant) {
+            $signature = $registrant->getSignature();
+
+            return [
+                $registrant->getUser()->getLastname(),
+                $registrant->getUser()->getFirstname(),
+                $signature ? $signature->getRegisteredAt() : null,
+                $signature ? $signature->getFile() : null,
+            ];
+        },
+        $result
+    );
+};
+
+if ($httpRequest->query->has('export')) {
+    $plugin->exportSignatures(
+        $meeting,
+        $httpRequest->query->getAlnum('export')
+    );
+}
+
+$table = new SortableTable('zoom_signatures', $getNumberOfSignatures, $getSignaturesData, 2);
+$table->set_header(0, get_lang('LastName'));
+$table->set_header(1, get_lang('FirstName'));
+$table->set_header(2, get_lang('DateTime'), true, ['class' => 'text-center'], ['class' => 'text-center']);
+$table->set_header(3, $plugin->get_lang('Signature'), false, ['style' => 'width: 200px', 'class' => 'text-center']);
+$table->set_additional_parameters(
+    array_filter(
+        $httpRequest->query->all(),
+        function ($key): bool {
+            return strpos($key, 'zoom_signatures_') === false;
+        },
+        ARRAY_FILTER_USE_KEY
+    )
+);
+$table->set_column_filter(
+    2,
+    function ($dateTime) {
+        return $dateTime ? api_convert_and_format_date($dateTime, DATE_TIME_FORMAT_LONG) : null;
+    }
+);
+$table->set_column_filter(
+    3,
+    function ($imgData) use ($plugin) {
+        if (empty($imgData)) {
+            return null;
+        }
+
+        return Display::img(
+            $imgData,
+            $plugin->get_lang('SignatureDone'),
+            ['class' => 'img-thumbnail'],
+            false
+        );
+    }
+);
+
+$cidReq = api_get_cidreq();
+$queryParams = 'meetingId='.$meeting->getMeetingId().'&'.$cidReq;
+$returnURL = 'meetings.php';
+
+if ($meeting->isCourseMeeting()) {
+    api_protect_course_script(true);
+
+    $this_section = SECTION_COURSES;
+
+    $returnURL = 'start.php?'.$cidReq;
+
+    if (api_is_in_group()) {
+        $interbreadcrumb[] = [
+            'url' => api_get_path(WEB_CODE_PATH).'group/group.php?'.$cidReq,
+            'name' => get_lang('Groups'),
+        ];
+        $interbreadcrumb[] = [
+            'url' => api_get_path(WEB_CODE_PATH).'group/group_space.php?'.$cidReq,
+            'name' => get_lang('GroupSpace').' '.$meeting->getGroup()->getName(),
+        ];
+    }
+}
+
+$interbreadcrumb[] = [
+    'url' => $returnURL,
+    'name' => $plugin->get_lang('ZoomVideoConferences'),
+];
+$interbreadcrumb[] = [
+    'url' => 'meeting.php?'.$queryParams,
+    'name' => $meeting->getMeetingInfoGet()->topic,
+];
+
+$exportPdfLink = Display::url(
+    Display::return_icon('pdf.png', get_lang('ExportToPDF'), [], ICON_SIZE_MEDIUM),
+    api_get_self().'?'.$queryParams.'&export=pdf'
+);
+$exportXlsLink = Display::url(
+    Display::return_icon('excel.png', get_lang('ExportAsXLS'), [], ICON_SIZE_MEDIUM),
+    api_get_self().'?'.$queryParams.'&export=xls'
+);
+
+$pageTitle = $plugin->get_lang('Attendance');
+
+$content = '
+        
    
+            
    '.$plugin->get_lang('ReasonToSign').'
    
+            
    '.$meeting->getReasonToSignAttendance().'
    
+        
    
+    '.$table->return_table();
+
+$tpl = new Template($pageTitle);
+$tpl->assign(
+    'actions',
+    Display::toolbarAction(
+        'attendance-actions',
+        [$exportPdfLink.PHP_EOL.$exportXlsLink]
+    )
+);
+$tpl->assign('header', $pageTitle);
+$tpl->assign('content', $content);
+$tpl->display_one_col_template();
diff --git a/plugin/zoom/calendar.ajax.php b/plugin/zoom/calendar.ajax.php
new file mode 100644
index 000000000..4b2b2a471
--- /dev/null
+++ b/plugin/zoom/calendar.ajax.php
@@ -0,0 +1,66 @@
+get('a');
+
+if ($action == 'get_events') {
+    $startDate = $request->query->get('start');
+    $endDate = $request->query->get('end');
+
+    $startDate = api_get_utc_datetime($startDate, true, true);
+    $endDate = api_get_utc_datetime($endDate, true, true);
+
+    $meetings = $plugin
+        ->getMeetingRepository()
+        ->periodMeetings($startDate, $endDate);
+
+    $meetingsAsEvents = array_map(
+        function (Meeting $conference) {
+            $isWebinar = $conference instanceof Webinar;
+            /** @var BaseMeetingTrait $schema */
+            $schema = $isWebinar ? $conference->getWebinarSchema() : $conference->getMeetingInfoGet();
+
+            $endDate = new DateTime($conference->formattedStartTime);
+            $endDate->add($conference->durationInterval);
+
+            return [
+                'id' => 'meeting_'.$conference->getId(),
+                'title' => $schema->topic,
+                'typeName' => $conference->typeName,
+                'editable' => false,
+                'start' => $conference->formattedStartTime,
+                'start_date_localtime' => $conference->formattedStartTime,
+                'end' => $endDate->format('Y-m-d H:i'),
+                'end_date_localtime' => $endDate->format('Y-m-d H:i'),
+                'duration' => $conference->formattedDuration,
+                'description' => $schema->agenda,
+                'allDay' => false,
+                'accountEmail' => $conference->getAccountEmail(),
+            ];
+        },
+        $meetings
+    );
+
+    $response = JsonResponse::create($meetingsAsEvents);
+    $response->send();
+}
diff --git a/plugin/zoom/calendar.php b/plugin/zoom/calendar.php
new file mode 100644
index 000000000..00322ef6e
--- /dev/null
+++ b/plugin/zoom/calendar.php
@@ -0,0 +1,47 @@
+get_lang('ZoomVideoConferences');
+
+$defaultView = api_get_setting('default_calendar_view');
+
+if (empty($defaultView)) {
+    $defaultView = 'month';
+}
+
+$regionValue = api_get_language_isocode();
+
+$htmlHeadXtra[] = api_get_asset('qtip2/jquery.qtip.min.js');
+$htmlHeadXtra[] = api_get_asset('fullcalendar/dist/fullcalendar.js');
+$htmlHeadXtra[] = api_get_asset('fullcalendar/dist/locale-all.js');
+$htmlHeadXtra[] = api_get_css_asset('fullcalendar/dist/fullcalendar.min.css');
+$htmlHeadXtra[] = api_get_css_asset('qtip2/jquery.qtip.min.css');
+
+$tpl = new Template($toolName);
+
+$tpl->assign('web_agenda_ajax_url', 'calendar.ajax.php?sec_token='.Security::get_token());
+$tpl->assign('default_view', $defaultView);
+$tpl->assign('region_value', 'en' === $regionValue ? 'en-GB' : $regionValue);
+
+$onHoverInfo = Agenda::returnOnHoverInfo();
+$tpl->assign('on_hover_info', $onHoverInfo);
+
+$extraSettings = Agenda::returnFullCalendarExtraSettings();
+
+$tpl->assign('fullcalendar_settings', $extraSettings);
+
+$content = $tpl->fetch('zoom/view/calendar.tpl');
+
+$tpl->assign('actions', $plugin->getToolbar());
+$tpl->assign('content', $content);
+$tpl->display_one_col_template();
diff --git a/plugin/zoom/config.php b/plugin/zoom/config.php
new file mode 100644
index 000000000..92a1ce705
--- /dev/null
+++ b/plugin/zoom/config.php
@@ -0,0 +1,5 @@
+isMethod('POST')) {
+    http_response_code(Response::HTTP_NOT_FOUND);
+    exit;
+}
+
+$configAccountId = api_get_plugin_setting('zoom', ZoomPlugin::SETTING_ACCOUNT_ID);
+$configClientId = api_get_plugin_setting('zoom', ZoomPlugin::SETTING_CLIENT_ID);
+$configClientSecret = api_get_plugin_setting('zoom', ZoomPlugin::SETTING_CLIENT_SECRET);
+$configSecretToken = api_get_plugin_setting('zoom', ZoomPlugin::SETTING_SECRET_TOKEN);
+
+$isS2SApp = !empty($configAccountId) && !empty($configClientId) && !empty($configClientSecret);
+$isJwtApp = !$isS2SApp;
+
+$authorizationHeaderValue = $request->headers->get('Authorization');
+
+if ($isJwtApp && api_get_plugin_setting('zoom', 'verificationToken') !== $authorizationHeaderValue) {
+    error_log('verificationToken not valid, please check your zoom configuration');
+    http_response_code(Response::HTTP_UNAUTHORIZED);
+    exit;
+}
+
+$body = file_get_contents('php://input');
+$decoded = json_decode($body);
+
+if ('endpoint.url_validation' === $decoded->event) {
+    $json = json_encode([
+        'plainToken' => $decoded->payload->plainToken,
+        'encryptedToken' => hash_hmac('sha256', $decoded->payload->plainToken, $configSecretToken),
+    ]);
+
+    echo $json;
+    exit();
+}
+
+if (is_null($decoded) || !is_object($decoded) || !isset($decoded->event) || !isset($decoded->payload->object)) {
+    error_log(sprintf('Did not recognize event notification: %s', $body));
+    http_response_code(Response::HTTP_UNPROCESSABLE_ENTITY);
+    exit;
+}
+
+$object = $decoded->payload->object;
+list($objectType, $action) = explode('.', $decoded->event);
+
+$em = Database::getManager();
+
+$meetingRepository = $em->getRepository(Meeting::class);
+$meeting = null;
+if ($object->id) {
+    /** @var Meeting $meeting */
+    $meeting = $meetingRepository->findOneBy(['meetingId' => $object->id]);
+}
+
+if (null === $meeting) {
+    error_log("Meeting not found");
+    error_log(sprintf('Event "%s" on %s was unhandled: %s', $action, $objectType, $body));
+    http_response_code(Response::HTTP_NOT_FOUND);
+    exit;
+}
+
+$activity = new MeetingActivity();
+$activity->setName($action);
+$activity->setType($objectType);
+$activity->setEvent(json_encode($object));
+
+switch ($objectType) {
+    case 'meeting':
+        error_log('Meeting '.$action.' - '.$meeting->getId());
+        error_log(print_r($object, 1));
+
+        switch ($action) {
+            case 'deleted':
+                $em->remove($meeting);
+                break;
+            case 'ended':
+            case 'started':
+                $meeting->setStatus($action);
+                $meeting->addActivity($activity);
+                $em->persist($meeting);
+                break;
+            default:
+                $meeting->addActivity($activity);
+                $em->persist($meeting);
+                break;
+        }
+        $em->flush();
+        break;
+    case 'webinar':
+        $meeting->addActivity($activity);
+        $em->persist($meeting);
+        $em->flush();
+        break;
+    case 'recording':
+        $recordingRepository = $em->getRepository(Recording::class);
+
+        $recordingEntity = null;
+        if ($object->uuid) {
+            /** @var Recording $recordingEntity */
+            $recordingEntity = $recordingRepository->findOneBy(['uuid' => $object->uuid, 'meeting' => $meeting]);
+        }
+
+        error_log("Recording: $action");
+        error_log(print_r($object, 1));
+
+        switch ($action) {
+            case 'completed':
+                $recording = new Recording();
+                $recording->setRecordingMeeting(RecordingMeeting::fromObject($object));
+                $recording->setMeeting($meeting);
+                $meeting->addActivity($activity);
+                $em->persist($meeting);
+                $em->persist($recording);
+                $em->flush();
+                break;
+            case 'recovered':
+                /*if (null === $recordingEntity) {
+                    $em->persist(
+                        (new Recording())->setRecordingMeeting(RecordingMeeting::fromObject($object))
+                    );
+                    $em->flush();
+                }*/
+                break;
+            case 'trashed':
+            case 'deleted':
+                $meeting->addActivity($activity);
+                if (null !== $recordingEntity) {
+                    $recordMeeting = $recordingEntity->getRecordingMeeting();
+                    $recordingToDelete = RecordingMeeting::fromObject($object);
+                    $files = [];
+                    if ($recordingToDelete->recording_files) {
+                        foreach ($recordingToDelete->recording_files as $fileToDelete) {
+                            foreach ($recordMeeting->recording_files as $file) {
+                                if ($fileToDelete->id != $file->id) {
+                                    $files[] = $file;
+                                }
+                            }
+                        }
+                    }
+
+                    if (empty($files)) {
+                        $em->remove($recordingEntity);
+                    } else {
+                        $recordMeeting->recording_files = $files;
+                        $recordingEntity->setRecordingMeeting($recordMeeting);
+                        $em->persist($recordingEntity);
+                    }
+                }
+                $em->persist($meeting);
+                $em->flush();
+                break;
+            default:
+                $meeting->addActivity($activity);
+                $em->persist($meeting);
+                $em->flush();
+                break;
+        }
+        break;
+    default:
+        error_log(sprintf('Event "%s" on %s was unhandled: %s', $action, $objectType, $body));
+        http_response_code(501); // Not Implemented
+        break;
+}
diff --git a/plugin/zoom/global.php b/plugin/zoom/global.php
new file mode 100644
index 000000000..7105b8f2f
--- /dev/null
+++ b/plugin/zoom/global.php
@@ -0,0 +1,13 @@
+getGlobalMeeting()->getMeetingId());
diff --git a/plugin/zoom/index.php b/plugin/zoom/index.php
new file mode 100644
index 000000000..b3d9bbc7f
--- /dev/null
+++ b/plugin/zoom/index.php
@@ -0,0 +1 @@
+install();
diff --git a/plugin/zoom/join_meeting.php b/plugin/zoom/join_meeting.php
new file mode 100644
index 000000000..241f5054d
--- /dev/null
+++ b/plugin/zoom/join_meeting.php
@@ -0,0 +1,114 @@
+getMeetingRepository()->findOneBy(['meetingId' => $meetingId]);
+if (null === $meeting) {
+    api_not_allowed(true, $plugin->get_lang('MeetingNotFound'));
+}
+
+if ($meeting->isCourseMeeting()) {
+    api_protect_course_script(true);
+    if (api_is_in_group()) {
+        $interbreadcrumb[] = [
+            'url' => api_get_path(WEB_CODE_PATH).'group/group.php?'.api_get_cidreq(),
+            'name' => get_lang('Groups'),
+        ];
+        $interbreadcrumb[] = [
+            'url' => api_get_path(WEB_CODE_PATH).'group/group_space.php?'.api_get_cidreq(),
+            'name' => get_lang('GroupSpace').' '.$meeting->getGroup()->getName(),
+        ];
+    }
+}
+
+$startJoinURL = '';
+$detailsURL = '';
+$signature = '';
+$btnAnnouncement = '';
+
+$currentUser = api_get_user_entity(api_get_user_id());
+$isConferenceManager = $plugin->userIsConferenceManager($meeting);
+
+try {
+    $startJoinURL = $plugin->getStartOrJoinMeetingURL($meeting);
+
+    if (empty($startJoinURL)) {
+        Display::addFlash(
+            Display::return_message($plugin->get_lang('ConferenceNotAvailable'), 'warning')
+        );
+    }
+
+    if ($meeting->isSignAttendance() && !$isConferenceManager) {
+        $registrant = $meeting->getRegistrantByUser($currentUser);
+        $signature = $registrant ? $registrant->getSignature() : null;
+
+        Security::get_token('zoom_signature');
+    }
+
+    if ($isConferenceManager) {
+        $detailsURL = api_get_path(WEB_PLUGIN_PATH).'zoom/meeting.php?meetingId='.$meeting->getMeetingId();
+    }
+
+    $allowAnnouncementsToSessionAdmin = api_get_configuration_value('session_admin_access_system_announcement');
+
+    if (api_is_platform_admin($allowAnnouncementsToSessionAdmin)) {
+        $announcementUrl = '';
+
+        if ($announcement = $meeting->getSysAnnouncement()) {
+            $announcementUrl = api_get_path(WEB_CODE_PATH).'admin/system_announcements.php?'
+                .http_build_query(
+                    [
+                        'action' => 'edit',
+                        'id' => $announcement->getId(),
+                    ]
+                );
+        } else {
+            $announcementUrl = api_get_path(WEB_CODE_PATH).'admin/system_announcements.php?'
+                .http_build_query(
+                    [
+                        'action' => 'add',
+                        'type' => 'zoom_conference',
+                        'meeting' => $meeting->getMeetingId(),
+                    ]
+                );
+        }
+
+        $btnAnnouncement = Display::toolbarButton(
+            $announcement ? get_lang('EditSystemAnnouncement') : get_lang('AddSystemAnnouncement'),
+            $announcementUrl,
+            'bullhorn'
+        );
+    }
+} catch (Exception $exception) {
+    Display::addFlash(
+        Display::return_message($exception->getMessage(), 'warning')
+    );
+}
+
+$htmlHeadXtra[] = api_get_asset('signature_pad/signature_pad.umd.js');
+
+$tpl = new Template($meeting->getMeetingId());
+$tpl->assign('meeting', $meeting);
+$tpl->assign('start_url', $startJoinURL);
+$tpl->assign('details_url', $detailsURL);
+$tpl->assign('btn_announcement', $btnAnnouncement);
+$tpl->assign('is_conference_manager', $isConferenceManager);
+$tpl->assign('signature', $signature);
+$content = $tpl->fetch('zoom/view/join.tpl');
+$tpl->assign('actions', $plugin->getToolbar());
+$tpl->assign('content', $content);
+$tpl->display_one_col_template();
diff --git a/plugin/zoom/lang/english.php b/plugin/zoom/lang/english.php
new file mode 100644
index 000000000..5cfe0af28
--- /dev/null
+++ b/plugin/zoom/lang/english.php
@@ -0,0 +1,191 @@
+this app type will be deprecated on 6/1/2023)';
+$strings['apiSecret'] = 'API Secret';
+$strings['apiSecret_help'] = 'For a JWT application type (this app type will be deprecated on 6/1/2023)';
+$strings['verificationToken'] = 'Verification Token';
+$strings['verificationToken_help'] = 'For a JWT application type (this app type will be deprecated on 6/1/2023)';
+$strings[ZoomPlugin::SETTING_ACCOUNT_ID] = 'Account ID';
+$strings[ZoomPlugin::SETTING_ACCOUNT_ID.'_help'] = 'For a Server-to-Server OAuth application type';
+$strings[ZoomPlugin::SETTING_CLIENT_ID] = 'Client ID';
+$strings[ZoomPlugin::SETTING_CLIENT_ID.'_help'] = 'For a Server-to-Server OAuth application type';
+$strings[ZoomPlugin::SETTING_CLIENT_SECRET] = 'Client secret';
+$strings[ZoomPlugin::SETTING_CLIENT_SECRET.'_help'] = 'For a Server-to-Server OAuth application type';
+$strings[ZoomPlugin::SETTING_SECRET_TOKEN] = 'Secret token';
+$strings[ZoomPlugin::SETTING_SECRET_TOKEN.'_help'] = 'For a Server-to-Server OAuth application type';
+$strings['enableParticipantRegistration'] = 'Enable participant registration';
+$strings['enablePresenter'] = 'Enable presenter';
+$strings['enablePresenter_help'] = 'It requires that Enable participant registration settings is enabled.';
+$strings['enableCloudRecording'] = 'Automatic recording type';
+$strings['enableGlobalConference'] = 'Enable global conference';
+$strings['enableGlobalConferencePerUser'] = 'Enable global conference per user';
+$strings['globalConferenceAllowRoles'] = "Global conference link only visible for these user roles";
+$strings['globalConferencePerUserAllowRoles'] = "Global conference per user link only visible for these user roles";
+$strings['accountSelector'] = 'Account selector';
+$strings['accountSelector_help'] = 'It allows you to declare the emails of the different accounts with whom you want to open the Zoom videos. Separated by semicolons (account_one@example.come;account_two@exaple.com).';
+
+$strings['tool_enable_help'] = "Choose whether you want to enable the Zoom videoconference tool.
+Once enabled, it will show as an additional course tool in all courses' homepage :
+teachers will be able to launch a conference and student to join it.
+
    
+This plugin requires a Zoom account to manage meetings.
+
    The Zoom API uses JSON Web Tokens (JWT) to authenticate account-level access. To get them, create a JWT App or a Server-to-Sever OAuth app:
    
+
    
+  
    From June 1, 2023, Zoom recommend that you create a Server-to-Server OAuth application to replace the funcionality of
+  a JWT app in your account.
    
+
    
+
      
+
    1. Log into your Zoom profile page
      2. 
+
    2. Click on Advanced / Application Marketplace
      3. 
+
    3. Click on Develop / Build App
      4. 
+
    4. Choose JWT or Server-to-Serve OAuth and then Create
      5. 
+
    5. Information: Fill in fields about your \"App\" (application and company names, contact name and email address)
      6. 
+
    6. Click on Continue
      7. 
+
    7. App Credentials
+
        
+
      1. For a JWT application: Copy your API Key and Secret to the plugin configuration
        2. 
+
      2. For a Server-to-Server OAuth application: Copy your Account ID, Client ID and Client secret to the plugin
+configuration
        3. 
+
      8. 
+
    8. Click on Continue
      9. 
+
    9. Feature: enable Event Subscriptions to add a new one with endpoint URL
+https://your.chamilo.url/plugin/zoom/endpoint.php (validate the endpoint to allow to activate the app) and add
+these event types:
      
+
        
+
      • Start Meeting
        • 
+
      • End Meeting
        • 
+
      • Participant/Host joined meeting
        • 
+
      • Participant/Host left meeting
        • 
+
      • Start Webinar
        • 
+
      • End Webinar
        • 
+
      • Participant/Host joined webinar
        • 
+
      • Participant/Host left webinar
        • 
+
      • All Recordings have completed
        • 
+
      • Recording transcript files have completed
        • 
+
      
+
      Then click on Done then on Save and copy your Verification Token if you have a JWT application or the Secret
+Token if you have an Server-to-Server OAuth application to the plugin configuration
      10. 
+
    10. click on Continue
      11. 
+
    11. Scopes (only for Server-to-Server OAuth application): Click on Add Scopes and select meeting:write:admin,
+webinar:write:admin, recording:write:admin. Then click on Done.
      12. 
+
    
+
    
+Attention:
+
    Zoom is NOT free software and specific rules apply to personal data protection.
+Please check with Zoom and make sure they satisfy you and learning users.";
+
+$strings['enableParticipantRegistration_help'] = "Requires a paying Zoom profile.
+Will not work for a basic profile.";
+
+$strings['enableCloudRecording_help'] = "Requires a paying Zoom profile.
+Will not work for a basic profile.";
+
+// please keep these lines alphabetically sorted
+$strings['AllCourseUsersWereRegistered'] = "All course students were registered";
+$strings['Agenda'] = "Agenda";
+$strings['CannotRegisterWithoutEmailAddress'] = "Cannot register without email address";
+$strings['CopyingJoinURL'] = "Copying join URL";
+$strings['CopyJoinAsURL'] = "Copy 'join as' URL";
+$strings['CopyToCourse'] = "Copy to course";
+$strings['CouldNotCopyJoinURL'] = "Could not copy join URL";
+$strings['Course'] = "Cours";
+$strings['CreatedAt'] = "Created at";
+$strings['CreateLinkInCourse'] = "Create link(s) in course";
+$strings['CreateUserVideoConference'] = "Create user conference";
+$strings['DateMeetingTitle'] = "%s: %s";
+$strings['DeleteMeeting'] = "Delete meeting";
+$strings['DeleteFile'] = "Delete file(s)";
+$strings['Details'] = "Details";
+$strings['DoIt'] = "Do it";
+$strings['Duration'] = "Duration";
+$strings['DurationFormat'] = "%hh%I";
+$strings['DurationInMinutes'] = "Duration (in minutes)";
+$strings['EndDate'] = "End Date";
+$strings['EnterMeeting'] = "Enter meeting";
+$strings['ViewMeeting'] = "View meeting";
+$strings['Files'] = "Files";
+$strings['Finished'] = "finished";
+$strings['FileWasCopiedToCourse'] = "The file was copied to the course";
+$strings['FileWasDeleted'] = "The file was deleted";
+$strings['GlobalMeeting'] = "Global conference";
+$strings['GlobalMeetingPerUser'] = "Global conference per user";
+$strings['GroupUsersWereRegistered'] = "Group members were registered";
+$strings['InstantMeeting'] = "Instant meeting";
+$strings['Join'] = "Join";
+$strings['JoinGlobalVideoConference'] = "Join global conference";
+$strings['JoinURLCopied'] = "Join URL copied";
+$strings['JoinURLToSendToParticipants'] = "Join URL to send to participants";
+$strings['LiveMeetings'] = "Live meetings";
+$strings['LinkToFileWasCreatedInCourse'] = "A link to the file was added to the course";
+$strings['MeetingDeleted'] = "Meeting deleted";
+$strings['MeetingsFound'] = "Meetings found";
+$strings['MeetingUpdated'] = "Meeting updated";
+$strings['NewMeetingCreated'] = "New meeting created";
+$strings['Password'] = "Password";
+$strings['RecurringWithFixedTime'] = "Recurring with fixed time";
+$strings['RecurringWithNoFixedTime'] = "Recurring with no fixed time";
+$strings['RegisterAllCourseUsers'] = "Register all course users";
+$strings['RegisteredUserListWasUpdated'] = "Registered user list updated";
+$strings['RegisteredUsers'] = "Registered users";
+$strings['RegisteredPresenters'] = "Registered presenters";
+$strings['RegisterNoUser'] = "Register no user";
+$strings['RegisterTheseGroupMembers'] = "Register these group members";
+$strings['ScheduleAMeeting'] = "Schedule a meeting";
+$strings['ScheduledMeeting'] = "Scheduled meeting";
+$strings['ScheduledMeetings'] = "Scheduled Meetings";
+$strings['ScheduleAMeeting'] = "Schedule a meeting";
+$strings['SearchMeeting'] = "Search meeting";
+$strings['Session'] = "Session";
+$strings['StartDate'] = "Start Date";
+$strings['Started'] = "started";
+$strings['StartInstantMeeting'] = "Start instant meeting";
+$strings['StartMeeting'] = "Start meeting";
+$strings['StartTime'] = "Start time";
+$strings['Topic'] = "Topic";
+$strings['TopicAndAgenda'] = "Topic and agenda";
+$strings['Type'] = "Type";
+$strings['UpcomingMeetings'] = "Upcoming meetings";
+$strings['UpdateMeeting'] = "Update meeting";
+$strings['UpdateRegisteredUserList'] = "Update registered user list";
+$strings['UserRegistration'] = "User registration";
+$strings['Y-m-d H:i'] = "Y-m-d H:i";
+$strings['Waiting'] = "waiting";
+$strings['XRecordingOfMeetingXFromXDurationXDotX'] = "%s recording of meeting %s from %s (%s).%s";
+$strings['YouAreNotRegisteredToThisMeeting'] = "You are not registered to this meeting";
+$strings['ZoomVideoConferences'] = "Zoom Video Conferences";
+$strings['Recordings'] = "Recordings";
+$strings['CreateGlobalVideoConference'] = "Create global video conference";
+$strings['ConferenceNotStarted'] = "Conference not started";
+$strings['MeetingNotFound'] = "Meeting not found";
+$strings['JoinURLNotAvailable'] = "URL not available";
+$strings['Meetings'] = "Meetings";
+$strings['ConferenceType'] = "Conference type";
+$strings['ForEveryone'] = "Everyone";
+$strings['SomeUsers'] = "Some users (Select later)";
+$strings['Activity'] = "Activity";
+$strings['ConferenceNotAvailable'] = "Conference not available";
+$strings['SignAttendance'] = "Sign attendance";
+$strings['ReasonToSign'] = 'Reason to sign attendance';
+$strings['ConferenceWithAttendance'] = "Conference with attendance sign";
+$strings['Sign'] = "Sign";
+$strings['Signature'] = "Signature";
+$strings['Meeting'] = "Meeting";
+$strings['Webinar'] = "Webinar";
+$strings['AudienceType'] = 'Audience type';
+$strings['AccountEmail'] = 'Account email';
+$strings['NewWebinarCreated'] = "New webinar created";
+$strings['UpdateWebinar'] = 'Update webinar';
+$strings['WebinarUpdated'] = "Webinar updated";
+$strings['DeleteWebinar'] = "Delete webinar";
+$strings['WebinarDeleted'] = "Webinar deleted";
+$strings['UrlForSelfRegistration'] = "URL for self registration";
+$strings['RegisterMeToConference'] = "Register me to conference";
+$strings['UnregisterMeToConference'] = "Unregister me to conference";
+$strings['Presenters'] = "Presenters";
diff --git a/plugin/zoom/lang/french.php b/plugin/zoom/lang/french.php
new file mode 100644
index 000000000..b6a9bb8c5
--- /dev/null
+++ b/plugin/zoom/lang/french.php
@@ -0,0 +1,173 @@
+API Key)";
+$strings['apiSecret'] = "Code secret d'API (API Secret)";
+$strings['enableParticipantRegistration'] = "Activer l'inscription des participants";
+$strings['enableCloudRecording'] = "Type d'enregistrement automatique";
+$strings['enableGlobalConference'] = "Activer les conférences globales";
+$strings['enableGlobalConferencePerUser'] = "Activer les conférences globales par utilisateur";
+$strings['globalConferenceAllowRoles'] = "Visibilité du lien de vidéo conférence global pour les profils suivant";
+$strings['globalConferencePerUserAllowRoles'] = "Visibilité du lien de vidéo conférence global par utilisateur pour les profils suivant";
+$strings['tool_enable_help'] = "Choisissez si vous voulez activer l'outil de conférence vidéo Zoom.
+Une fois activé, il apparaitra dans les pages d'accueil de tous les cours :
+les enseignants pourront démarrer une conférence et les étudiants la rejoindre.
+
    
+Ce plugin requiert un compte Zoom pour gérer les conférences.
+
    L'API de Zoom utilise les JSON Web Tokens (JWT) pour autoriser l'accès à un compte. 
+Pour les obtenir, créez une application JWT ou une application OAuth serveur à serveur :
    
+
    
+  
    À partir du 1er juin 2023, Zoom recommande de créer une application OAuth serveur à serveur 
+pour remplacer la fonctionnalité d'une application JWT dans votre compte.
    
+
    
+
      
+
    1. Connectez-vous à votre page de profil Zoom
      2. 
+
    2. Cliquez sur Avancé / Marketplace d'application
      3. 
+
    3. Cliquez sur Développer / Créer une application
      4. 
+
    4. Choisissez JWT ou OAuth serveur à serveur, puis Créer
      5. 
+
    5. Informations : Remplissez les champs sur votre \"App\" (noms de l'application et de la société, nom et adresse e-mail de contact)
      6. 
+
    6. Cliquez sur Continuer
      7. 
+
    7. Identifiants de l'application
+
        
+
      1. Pour une application JWT : Copiez votre clé API (API Key) et votre code secret (API Secret) dans la configuration du plugin
        2. 
+
      2. Pour une application OAuth serveur à serveur : Copiez votre ID de compte, votre ID de client et votre secret de client dans la configuration du plugin
        3. 
+
      8. 
+
    8. Cliquez sur Continuer
      9. 
+
    9. Fonctionnalité : activez les Abonnements aux événements / Event Subscriptions pour en ajouter un nouveau avec comme endpoint URL
+https://your.chamilo.url/plugin/zoom/endpoint.php (validez le point de terminaison pour permettre l'activation de l'application) et ajoutez
+ces types d'événements :
      
+
        
+
      • Démarrer une réunion / Start Meeting
        • 
+
      • Terminer une réunion / End Meeting
        • 
+
      • Participant/hôte a rejoint la réunion / Participant/Host joined meeting
        • 
+
      • Participant/hôte a quitté la réunion / Participant/Host left meeting
        • 
+
      • Démarrer un webinar / Start Webinar
        • 
+
      • Terminer un webinar / End Webinar
        • 
+
      • Participant/hôte a rejoint le webinar / Participant/Host joined webinar
        • 
+
      • Participant/hôte a quitté le webinar / Participant/Host left webinar
        • 
+
      • Toutes les enregistrements sont terminées / All Recordings have completed
        • 
+
      • Les fichiers de transcription d'enregistrement sont terminés / Recording transcript files have completed
        • 
+
      
+
      Ensuite, cliquez sur Terminé, puis sur Enregistrer et copiez votre Jeton de vérification / Verification Token si vous avez une application JWT ou le Jeton Secret / Secret
+Token si vous avez une application OAuth serveur à serveur dans la configuration du plugin
      10. 
+
    10. cliquez sur Continuer
      11. 
+
    11. Scopes (uniquement pour l'application OAuth serveur à serveur) : cliquez sur Ajouter des scopes / Add Scopes et sélectionnez meeting:write:admin, webinar:write:admin, recording:write:admin. Puis cliquez sur Terminé.
      12. 
+
    
+
    
+Attention :
+
    Zoom n'est PAS un logiciel libre
+et des règles spécifiques de protection des données personnelles s'y appliquent.
+Merci de vérifier auprès de Zoom qu'elles sont satisfaisantes pour vous et les apprenants qui l'utiliseront.";
+
+$strings['enableParticipantRegistration_help'] = "Nécessite un profil Zoom payant.
+Ne fonctionnera pas pour un profil de base.";
+
+$strings['enableCloudRecording_help'] = "Nécessite un profil Zoom payant.
+Ne fonctionnera pas pour un profil de base.";
+
+// please keep these lines alphabetically sorted
+$strings['AllCourseUsersWereRegistered'] = "Tous les étudiants du cours sont inscrits";
+$strings['Agenda'] = "Ordre du jour";
+$strings['CannotRegisterWithoutEmailAddress'] = "Impossible d'inscrire un utilisateur sans adresse de courriel";
+$strings['CopyingJoinURL'] = "Copie de l'URL pour rejoindre en cours";
+$strings['CopyJoinAsURL'] = "Copier l'URL pour 'rejoindre en tant que'";
+$strings['CopyToCourse'] = "Copier dans le cours";
+$strings['CouldNotCopyJoinURL'] = "Échec de la copie de l'URL pour rejoindre";
+$strings['Course'] = "Cours";
+$strings['CreatedAt'] = "Créé à";
+$strings['CreateLinkInCourse'] = "Créer dans le cours un ou des lien(s) vers le(s) fichier(s)";
+$strings['CreateUserVideoConference'] = "Créer des conferences par utilisateur";
+$strings['DateMeetingTitle'] = "%s : %s";
+$strings['DeleteMeeting'] = "Effacer la conférence";
+$strings['DeleteFile'] = "Supprimer ce(s) fichier(s)";
+$strings['Details'] = "Détail";
+$strings['DoIt'] = "Fais-le";
+$strings['Duration'] = "Durée";
+$strings['DurationFormat'] = "%hh%I";
+$strings['DurationInMinutes'] = "Durée (en minutes)";
+$strings['EndDate'] = "Date de fin";
+$strings['EnterMeeting'] = "Entrer dans la conférence";
+$strings['ViewMeeting'] = "Voir la conférence";
+$strings['Files'] = "Fichiers";
+$strings['Finished'] = "terminée";
+$strings['FileWasCopiedToCourse'] = "Le fichier a été copié dans le cours";
+$strings['FileWasDeleted'] = "Le fichier a été effacé";
+$strings['GlobalMeeting'] = "Conférence globale";
+$strings['GroupUsersWereRegistered'] = "Les membres des groupes ont été inscrits";
+$strings['InstantMeeting'] = "Conférence instantanée";
+$strings['Join'] = "Rejoindre";
+$strings['JoinGlobalVideoConference'] = "Rejoindre la conférence globale";
+$strings['JoinURLCopied'] = "URL pour rejoindre copiée";
+$strings['JoinURLToSendToParticipants'] = "URL pour assister à la conférence (à envoyer aux participants)";
+$strings['LiveMeetings'] = "Conférences en cours";
+$strings['LinkToFileWasCreatedInCourse'] = "Un lien vers le fichier a été ajouter au cours";
+$strings['MeetingDeleted'] = "Conférence effacée";
+$strings['MeetingsFound'] = "Conférences trouvées";
+$strings['MeetingUpdated'] = "Conférence mise à jour";
+$strings['NewMeetingCreated'] = "Nouvelle conférence créée";
+$strings['Password'] = "Mot de passe";
+$strings['RecurringWithFixedTime'] = "Recurrent, à heure fixe";
+$strings['RecurringWithNoFixedTime'] = "Recurrent, sans heure fixe";
+$strings['RegisterAllCourseUsers'] = "Inscrire tous les utilisateurs du cours";
+$strings['RegisteredUserListWasUpdated'] = "Liste des utilisateurs inscrits mise à jour";
+$strings['RegisteredUsers'] = "Utilisateurs inscrits";
+$strings['RegisterNoUser'] = "N'inscrire aucun utilisateur";
+$strings['RegisterTheseGroupMembers'] = "Inscrire les membres de ces groupes";
+$strings['ScheduleAMeeting'] = "Programmer une conférence";
+$strings['ScheduledMeeting'] = "Conférence programmée";
+$strings['ScheduledMeetings'] = "Conférences programmées";
+$strings['ScheduleAMeeting'] = "Programmer une conférence";
+$strings['SearchMeeting'] = "Rechercher une conférence";
+$strings['Session'] = "Session";
+$strings['StartDate'] = "Date de début";
+$strings['Started'] = "démarrée";
+$strings['StartInstantMeeting'] = "Démarrer une conférence instantanée";
+$strings['StartMeeting'] = "Démarrer la conférence";
+$strings['StartTime'] = "Heure de début";
+$strings['Topic'] = "Objet";
+$strings['TopicAndAgenda'] = "Objet et ordre du jour";
+$strings['Type'] = "Type";
+$strings['UpcomingMeeting'] = "Conférences à venir";
+$strings['UpdateMeeting'] = "Mettre à jour la conférence";
+$strings['UpdateRegisteredUserList'] = "Mettre à jour la liste des utilisateurs inscrits";
+$strings['UserRegistration'] = "Inscription des utilisateurs";
+$strings['Y-m-d H:i'] = "d/m/Y à H\hi";
+$strings['verificationToken'] = 'Verification Token';
+$strings['Waiting'] = "en attente";
+$strings['XRecordingOfMeetingXFromXDurationXDotX'] = "Enregistrement (%s) de la conférence %s de %s (%s).%s";
+$strings['YouAreNotRegisteredToThisMeeting'] = "Vous n'êtes pas inscrit à cette conférence";
+$strings['ZoomVideoConferences'] = "Conférences vidéo Zoom";
+$strings['Recordings'] = "Enregistrements";
+$strings['CreateGlobalVideoConference'] = "Créer une conférence global";
+$strings['JoinURLNotAvailable'] = "URL pas disponible";
+$strings['Meetings'] = "Conférences";
+$strings['Activity'] = "Activité";
+$strings['ConferenceNotAvailable'] = "Conférence non disponible";
+$strings['SignAttendance'] = "Signer la feuille d'émargement";
+$strings['ReasonToSign'] = "Explication pour signer la feuille d'émargement";
+$strings['ConferenceWithAttendance'] = "Conférence avec signature d'émargement";
+$strings['Sign'] = "Signer";
+$strings['Signature'] = "Signature";
+$strings['Meeting'] = "Meeting";
+$strings['Webinar'] = "Webinar";
+$strings['AudienceType'] = "Type d'audience";
+$strings['AccountEmail'] = "Compte email";
+$strings['NewWebinarCreated'] = "Nouveau webinar créé";
+$strings['UpdateWebinar'] = "Mettre à jour le webinar";
+$strings['WebinarUpdated'] = "Webinar mis à jour";
+$strings['DeleteWebinar'] = "Supprimer le webinar";
+$strings['WebinarDeleted'] = "Webinar supprimé";
+$strings['UrlForSelfRegistration'] = "URL pour l'auto-inscription des participants";
+$strings['RegisterMeToConference'] = "M'inscrire à la visio";
+$strings['UnregisterMeToConference'] = "Me désinscrire de la visio";
+$strings['ForEveryone'] = "Tout le monde";
+$strings['SomeUsers'] = "Utilisateurs inscrits (à inscrire après)";
+$strings['Presenters'] = "Animateurs";
+$strings['RegisteredPresenters'] = "Animateurs enregistrés";
+$strings['enablePresenter_help'] = "Il est nécessaire que l'option Activer l'inscription des participants soit sur Oui.";
+$strings['enablePresenter'] = 'Activer les animateurs';
diff --git a/plugin/zoom/lang/spanish.php b/plugin/zoom/lang/spanish.php
new file mode 100644
index 000000000..c5995e80f
--- /dev/null
+++ b/plugin/zoom/lang/spanish.php
@@ -0,0 +1,174 @@
+API Key)";
+$strings['apiSecret'] = "Código secreto de API (API Secret)";
+$strings['enableParticipantRegistration'] = "Activar la inscripción de participantes";
+$strings['enablePresenter'] = 'Activar presentadores';
+$strings['enablePresenter_help'] = 'Requiere que el parametro Activar la inscripción de participantes este activado.';
+$strings['enableCloudRecording'] = "Tipo de grabación automática";
+$strings['enableGlobalConference'] = "Activar las conferencias globales";
+$strings['enableGlobalConferencePerUser'] = "Activar las conferencias globales por usuario";
+$strings['globalConferenceAllowRoles'] = "Visibilidad del enlace global de videoconferencia para los perfiles siguientes";
+$strings['globalConferencePerUserAllowRoles'] = "Visibilidad del enlace global de videoconferencia por usuario para los perfiles siguientes";
+$strings['accountSelector'] = 'Selector de cuentas';
+$strings['accountSelector_help'] = 'Te permite declarar los correos de las diferentes cuentas con las que quieres abrir los videos de Zoom. Separados por punto y coma (account_one@example.come;account_two@exaple.com).';
+
+$strings['tool_enable_help'] = "Escoja si desea activar la herramienta Zoom.
+Una vez activada, aparecerá en las páginas principales de todos los cursos. Los profesores podrán
+iniciar una conferencia y los alumnos juntarse a ella.
+
    
+Este plugin requiere una cuenta Zoom para gestionar las conferencias.
+
    El API de Zoom utiliza los JSON Web Tokens (JWT) para autorizar el acceso a una cuenta.
+Para obtenerlos, crea una app JWT o una aplicación Server-to-Server OAuth:
    
+
    
+  
    Desde el 1 de junio de 2023, Zoom recomienda que usted cree una aplicación Server-to-Server OAuth para reemplazar
+  la funcionalidad de una aplicación JWT en tu cuenta.
    
+
    
+
      
+
    1. logéase en Su perfil Zoom
      2. 
+
    2. de clic en Avanzado / Marketplace de aplicaciones
      3. 
+
    3. de clic en Develop / build App
      4. 
+
    4. escoja JWT o Sever-to-Server OAuth y luego Create
      5. 
+
    5. Information: ingrese algunas informaciones sobre vuestra \"App\"
+(nombres de la aplicación, de la empresa, nombre y dirección de correo de contacto)
+
    6. de clic en Continue
      7. 
+
    7. App Credentials:
+
        
+
      1. Para una aplicación JWT: copia la clave (API Key) y el código secreto (API Secret) por ingresar aquí.
        2. 
+
      2. Para una aplicación Server-to-Server OAuth: Copia los valores de Account ID, Client ID y Client secret para ingresar aquí
        3. 
+
      
+
    8. de clic en Continue
      9. 
+
    9. Feature : activez Event Subscriptions para agregar uno con su endpoint URL
+https://your.chamilo.url/plugin/zoom/endpoint.php (valida el endpoint para permitir activar la aplicación)
+y agrega este tipo de eventos:
      
+
        
+
      • Start Meeting
        • 
+
      • End Meeting
        • 
+
      • Participant/Host joined meeting
        • 
+
      • Participant/Host left meeting
        • 
+
      • Start Webinar
        • 
+
      • End Webinar
        • 
+
      • Participant/Host joined webinar
        • 
+
      • Participant/Host left webinar
        • 
+
      • All Recordings have completed
        • 
+
      • Recording transcript files have completed
        • 
+
      
+
      Luego de clic en Done y luego en Save y copie su Verification Token si tiene una aplicación JWT o el Secret token si tiene una aplicación Server-to-Server OAuth para ingresar aquí
      10. 
+
    10. de clic en Continue
      11. 
+
    11. Scopes (solo para una aplicación Server-to-Server OAuth): click en Add Scopes y seleccione meeting:write:admin,
+webinar:write:admin, recording:write:admin. Luego, haga click en Done.
      12. 
+
    
+
    
+Atención :
+
    Zoom NO ES un software libre, y reglas específicas de protección de datos se aplican a este.
+Por favor verifique con Zoom que éstas le den satisfacción a Usted y los alumnos que la usarán.";
+
+$strings['enableParticipantRegistration_help'] = "Requiere un perfil Zoom de pago.
+No funcionará para un perfil base/gratuito.";
+
+$strings['enableCloudRecording_help'] = "Requiere un perfil Zoom de pago.
+No funcionará para un perfil base/gratuito.";
+
+// please keep these lines alphabetically sorted
+$strings['AllCourseUsersWereRegistered'] = "Todos los alumnos del curso están inscritos";
+$strings['Agenda'] = "Orden del día";
+$strings['CannotRegisterWithoutEmailAddress'] = "No se puede registrar usuario sin dirección de correo electrónico";
+$strings['CopyingJoinURL'] = "Copia de la URL para ingresar";
+$strings['CopyJoinAsURL'] = "Copiar la URL para 'ingresar como'";
+$strings['CopyToCourse'] = "Copiar en el curso";
+$strings['CouldNotCopyJoinURL'] = "Falló la copia de la URL de ingreso";
+$strings['Course'] = "Curso";
+$strings['CreatedAt'] = "Creado el";
+$strings['CreateLinkInCourse'] = "Crear en el curso uno o más vínculos hacia el/los archivo(s)";
+$strings['CreateUserVideoConference'] = "Crear conferencias de usario";
+$strings['DateMeetingTitle'] = "%s: %s";
+$strings['DeleteMeeting'] = "Borrar la conferencia";
+$strings['DeleteFile'] = "Borrar este/estos archivo(s)";
+$strings['Details'] = "Detalle";
+$strings['DoIt'] = "Hágalo";
+$strings['Duration'] = "Duración";
+$strings['DurationFormat'] = "%hh%I";
+$strings['DurationInMinutes'] = "Duración (en minutos)";
+$strings['EndDate'] = "Fecha de fin";
+$strings['EnterMeeting'] = "Ingresar la conferencia";
+$strings['ViewMeeting'] = "Ver la conferencia";
+$strings['Files'] = "Archivos";
+$strings['Finished'] = "terminada";
+$strings['FileWasCopiedToCourse'] = "El archivo ha sido copiado en el curso";
+$strings['FileWasDeleted'] = "El archivo ha sido borrado";
+$strings['GlobalMeeting'] = "Conferencia global";
+$strings['GroupUsersWereRegistered'] = "Miembros de los grupos han sido registrados";
+$strings['InstantMeeting'] = "Conferencia instantánea";
+$strings['Join'] = "Ingresar";
+$strings['JoinGlobalVideoConference'] = "Ingresar la conrencia global";
+$strings['JoinURLCopied'] = "URL para juntarse copiada";
+$strings['JoinURLToSendToParticipants'] = "URL para asistir a la conferencia (para enviar a los participantes)";
+$strings['LiveMeetings'] = "Conferencias activas";
+$strings['LinkToFileWasCreatedInCourse'] = "Un enlace al archivo ha sido añadido al curso";
+$strings['MeetingDeleted'] = "Conferencia borrada";
+$strings['MeetingsFound'] = "Conferencias encontradas";
+$strings['MeetingUpdated'] = "Conferencias actualizadas";
+$strings['NewMeetingCreated'] = "Nueva conferencia creada";
+$strings['Password'] = "Contraseña";
+$strings['RecurringWithFixedTime'] = "Recurrente, a una hora fija";
+$strings['RecurringWithNoFixedTime'] = "Recurrente, sin hora fija";
+$strings['RegisterAllCourseUsers'] = "Inscribir todos los usuarios del curso";
+$strings['RegisteredUserListWasUpdated'] = "Lista de usuarios inscritos actualizada";
+$strings['RegisteredUsers'] = "Usuarios inscritos";
+$strings['RegisteredPresenters'] = "Presentadores registrados";
+$strings['RegisterNoUser'] = "No inscribir ningún usuario";
+$strings['RegisterTheseGroupMembers'] = "Inscribir los miembros de estos grupos";
+$strings['ScheduleAMeeting'] = "Programar una conferencia";
+$strings['ScheduledMeeting'] = "Conferencia programada";
+$strings['ScheduledMeetings'] = "Conferencias programadas";
+$strings['ScheduleAMeeting'] = "Programar una conferencia";
+$strings['SearchMeeting'] = "Buscar una conferencia";
+$strings['Session'] = "Sesión";
+$strings['StartDate'] = "Fecha de inicio";
+$strings['Started'] = "iniciada";
+$strings['StartInstantMeeting'] = "Iniciar una conferencia instantánea";
+$strings['StartMeeting'] = "Iniciar la conferencia";
+$strings['StartTime'] = "Hora de inicio";
+$strings['Topic'] = "Objeto";
+$strings['TopicAndAgenda'] = "Objeto y orden del día";
+$strings['Type'] = "Tipo";
+$strings['UpcomingMeeting'] = "Próximas conferencias";
+$strings['UpdateMeeting'] = "Actualizar la conferencia";
+$strings['UpdateRegisteredUserList'] = "Actualizar la lista de usuarios inscritos";
+$strings['UserRegistration'] = "Inscripción de los usuarios";
+$strings['Y-m-d H:i'] = "d/m/Y a las H\hi";
+$strings['verificationToken'] = 'Verification Token';
+$strings['Waiting'] = "en espera";
+$strings['XRecordingOfMeetingXFromXDurationXDotX'] = "Grabación (%s) de la conferencia %s de %s (%s).%s";
+$strings['YouAreNotRegisteredToThisMeeting'] = "No estás registrado en esta reunión";
+$strings['ZoomVideoConferences'] = "Videoconferencias Zoom";
+$strings['Recordings'] = "Grabaciones";
+$strings['CreateGlobalVideoConference'] = "Crear una videoconferencia global";
+$strings['JoinURLNotAvailable'] = "URL no disponible";
+$strings['Meetings'] = "Conferencias";
+$strings['Activity'] = "Actividad";
+$strings['ConferenceNotAvailable'] = "Conferencia no disponible";
+$strings['SignAttendance'] = "Firmar asistencia";
+$strings['ReasonToSign'] = 'Razón para firmar asistencia';
+$strings['ConferenceWithAttendance'] = "Conferencia con registro de asistencia";
+$strings['Sign'] = "Firmar";
+$strings['Signature'] = "Firma";
+$strings['Meeting'] = "Conferencia";
+$strings['Webinar'] = "Seminario web";
+$strings['AudienceType'] = 'Tipo de público';
+$strings['AccountEmail'] = 'Correo electrónico de la cuenta';
+$strings['NewWebinarCreated'] = "Nuevo seminario web creado";
+$strings['UpdateWebinar'] = 'Actualizar seminario web';
+$strings['WebinarUpdated'] = "Seminario web actualizado";
+$strings['DeleteWebinar'] = "Borrar seminario web";
+$strings['WebinarDeleted'] = "Seminario web borrado";
+$strings['UrlForSelfRegistration'] = "URL para auto registro";
+$strings['RegisterMeToConference'] = "Registrarme a la conferencia";
+$strings['UnregisterMeToConference'] = "Cancelar registro a la conferencia";
+$strings['Presenters'] = "Presentadores";
diff --git a/plugin/zoom/lib/API/Api2RequestTrait.php b/plugin/zoom/lib/API/Api2RequestTrait.php
new file mode 100644
index 000000000..76dead10a
--- /dev/null
+++ b/plugin/zoom/lib/API/Api2RequestTrait.php
@@ -0,0 +1,67 @@
+ $httpMethod,
+            CURLOPT_ENCODING => '',
+            CURLOPT_HTTPHEADER => [
+                'authorization: Bearer '.$this->token,
+                'content-type: application/json',
+            ],
+            CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
+            CURLOPT_MAXREDIRS => 10,
+            CURLOPT_RETURNTRANSFER => true,
+            CURLOPT_TIMEOUT => 30,
+        ];
+        if (!is_null($requestBody)) {
+            $jsonRequestBody = json_encode($requestBody);
+            if (false === $jsonRequestBody) {
+                throw new Exception('Could not generate JSON request body');
+            }
+            $options[CURLOPT_POSTFIELDS] = $jsonRequestBody;
+        }
+
+        $url = "https://api.zoom.us/v2/$relativePath";
+        if (!empty($parameters)) {
+            $url .= '?'.http_build_query($parameters);
+        }
+        $curl = curl_init($url);
+        if (false === $curl) {
+            throw new Exception("curl_init returned false");
+        }
+        curl_setopt_array($curl, $options);
+        $responseBody = curl_exec($curl);
+        $responseCode = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
+        $curlError = curl_error($curl);
+        curl_close($curl);
+
+        if ($curlError) {
+            throw new Exception("cURL Error: $curlError");
+        }
+
+        if (false === $responseBody || !is_string($responseBody)) {
+            throw new Exception('cURL Error');
+        }
+
+        if (empty($responseCode)
+            || $responseCode < 200
+            || $responseCode >= 300
+        ) {
+            throw new Exception($responseBody, $responseCode);
+        }
+
+        return $responseBody;
+    }
+}
diff --git a/plugin/zoom/lib/API/BaseMeetingTrait.php b/plugin/zoom/lib/API/BaseMeetingTrait.php
new file mode 100644
index 000000000..fe9fe5660
--- /dev/null
+++ b/plugin/zoom/lib/API/BaseMeetingTrait.php
@@ -0,0 +1,41 @@
+token = JWT::encode(
+            [
+                'iss' => $apiKey,
+                'exp' => (time() + 60) * 1000, // will expire in one minute
+            ],
+            $apiSecret
+        );
+        self::register($this);
+    }
+}
diff --git a/plugin/zoom/lib/API/JsonDeserializableTrait.php b/plugin/zoom/lib/API/JsonDeserializableTrait.php
new file mode 100644
index 000000000..f9001104b
--- /dev/null
+++ b/plugin/zoom/lib/API/JsonDeserializableTrait.php
@@ -0,0 +1,122 @@
+ $value) {
+            if (property_exists($destination, $name)) {
+                if (is_object($value)) {
+                    if (is_object($destination->$name)) {
+                        static::recursivelyCopyObjectProperties($value, $destination->$name);
+                    } else {
+                        throw new Exception("Source property $name is an object, which is not expected");
+                    }
+                } elseif (is_array($value)) {
+                    if (is_array($destination->$name)) {
+                        $itemClass = $destination->itemClass($name);
+                        foreach ($value as $sourceItem) {
+                            if ('string' === $itemClass) {
+                                $destination->$name[] = $sourceItem;
+                            } else {
+                                $item = new $itemClass();
+                                static::recursivelyCopyObjectProperties($sourceItem, $item);
+                                $destination->$name[] = $item;
+                            }
+                        }
+                    } else {
+                        throw new Exception("Source property $name is an array, which is not expected");
+                    }
+                } else {
+                    $destination->$name = $value;
+                }
+            } else {
+                error_log("Source object has property $name, which was not expected: ".json_encode($source));
+            }
+        }
+        $destination->initializeExtraProperties();
+    }
+}
diff --git a/plugin/zoom/lib/API/Meeting.php b/plugin/zoom/lib/API/Meeting.php
new file mode 100644
index 000000000..6b9ec94ba
--- /dev/null
+++ b/plugin/zoom/lib/API/Meeting.php
@@ -0,0 +1,88 @@
+tracking_fields = [];
+        $this->settings = new MeetingSettings();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function itemClass($propertyName)
+    {
+        if ('tracking_fields' === $propertyName) {
+            return TrackingField::class;
+        }
+        throw new Exception("no such array property $propertyName");
+    }
+
+    /**
+     * Creates a meeting on the server and returns the resulting MeetingInfoGet.
+     *
+     * @throws Exception describing the error (message and code)
+     *
+     * @return MeetingInfoGet meeting
+     */
+    public function create($userId = null)
+    {
+        $userId = empty($userId) ? 'me' : $userId;
+
+        return MeetingInfoGet::fromJson(
+            Client::getInstance()->send('POST', "users/$userId/meetings", [], $this)
+        );
+    }
+
+    /**
+     * Creates a Meeting instance from a topic.
+     *
+     * @param string $topic
+     * @param int    $type
+     *
+     * @return static
+     */
+    public static function fromTopicAndType($topic, $type = self::TYPE_SCHEDULED)
+    {
+        $instance = new static();
+        $instance->topic = $topic;
+        $instance->type = $type;
+
+        return $instance;
+    }
+}
diff --git a/plugin/zoom/lib/API/MeetingInfo.php b/plugin/zoom/lib/API/MeetingInfo.php
new file mode 100644
index 000000000..832cc33e6
--- /dev/null
+++ b/plugin/zoom/lib/API/MeetingInfo.php
@@ -0,0 +1,34 @@
+send('GET', "meetings/$id"));
+    }
+
+    /**
+     * Updates the meeting on server.
+     *
+     * @throws Exception
+     */
+    public function update(): void
+    {
+        Client::getInstance()->send('PATCH', 'meetings/'.$this->id, [], $this);
+    }
+
+    /**
+     * Ends the meeting on server.
+     *
+     * @throws Exception
+     */
+    public function endNow()
+    {
+        Client::getInstance()->send('PUT', "meetings/$this->id/status", [], (object) ['action' => 'end']);
+    }
+
+    /**
+     * Deletes the meeting on server.
+     *
+     * @throws Exception
+     */
+    public function delete()
+    {
+        Client::getInstance()->send('DELETE', "meetings/$this->id");
+    }
+
+    /**
+     * Adds a registrant to the meeting.
+     *
+     * @param RegistrantSchema $registrant    with at least 'email' and 'first_name'.
+     *                                        'last_name' will also be recorded by Zoom.
+     *                                        Other properties remain ignored, or not returned by Zoom
+     *                                        (at least while using profile "Pro")
+     * @param string           $occurrenceIds separated by comma
+     *
+     * @throws Exception
+     *
+     * @return CreatedRegistration with unique join_url and registrant_id properties
+     */
+    public function addRegistrant(RegistrantSchema $registrant, string $occurrenceIds = ''): CreatedRegistration
+    {
+        return CreatedRegistration::fromJson(
+            Client::getInstance()->send(
+                'POST',
+                "meetings/$this->id/registrants",
+                empty($occurrenceIds) ? [] : ['occurrence_ids' => $occurrenceIds],
+                $registrant
+            )
+        );
+    }
+
+    /**
+     * Removes registrants from the meeting.
+     *
+     * @param MeetingRegistrant[] $registrants   registrants to remove (id and email)
+     * @param string              $occurrenceIds separated by comma
+     *
+     * @throws Exception
+     */
+    public function removeRegistrants($registrants, $occurrenceIds = '')
+    {
+        if (!empty($registrants)) {
+            Client::getInstance()->send(
+                'PUT',
+                "meetings/$this->id/registrants/status",
+                empty($occurrenceIds) ? [] : ['occurrence_ids' => $occurrenceIds],
+                (object) [
+                    'action' => 'cancel',
+                    'registrants' => $registrants,
+                ]
+            );
+        }
+    }
+
+    /**
+     * Retrieves meeting registrants.
+     *
+     * @throws Exception
+     *
+     * @return MeetingRegistrantListItem[] the meeting registrants
+     */
+    public function getRegistrants()
+    {
+        return MeetingRegistrantList::loadMeetingRegistrants($this->id);
+    }
+
+    /**
+     * Retrieves the meeting's instances.
+     *
+     * @throws Exception
+     *
+     * @return MeetingInstance[]
+     */
+    public function getInstances()
+    {
+        return MeetingInstances::fromMeetingId($this->id)->meetings;
+    }
+}
diff --git a/plugin/zoom/lib/API/MeetingInstance.php b/plugin/zoom/lib/API/MeetingInstance.php
new file mode 100644
index 000000000..efb9539d7
--- /dev/null
+++ b/plugin/zoom/lib/API/MeetingInstance.php
@@ -0,0 +1,50 @@
+send('GET', 'meetings/'.htmlentities($this->uuid).'/recordings')
+        );
+    }
+
+    /**
+     * Retrieves the instance's participants.
+     *
+     * @throws Exception
+     *
+     * @return ParticipantListItem[]
+     */
+    public function getParticipants()
+    {
+        return ParticipantList::loadInstanceParticipants($this->uuid);
+    }
+}
diff --git a/plugin/zoom/lib/API/MeetingInstances.php b/plugin/zoom/lib/API/MeetingInstances.php
new file mode 100644
index 000000000..be38bc902
--- /dev/null
+++ b/plugin/zoom/lib/API/MeetingInstances.php
@@ -0,0 +1,53 @@
+meetings = [];
+    }
+
+    /**
+     * Retrieves a meeting's instances.
+     *
+     * @param int $meetingId
+     *
+     * @throws Exception
+     *
+     * @return MeetingInstances the meeting's instances
+     */
+    public static function fromMeetingId($meetingId)
+    {
+        return static::fromJson(Client::getInstance()->send('GET', "past_meetings/$meetingId/instances"));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function itemClass($propertyName)
+    {
+        if ('meetings' === $propertyName) {
+            return MeetingInstance::class;
+        }
+        throw new Exception("No such array property $propertyName");
+    }
+}
diff --git a/plugin/zoom/lib/API/MeetingList.php b/plugin/zoom/lib/API/MeetingList.php
new file mode 100644
index 000000000..cc21004b5
--- /dev/null
+++ b/plugin/zoom/lib/API/MeetingList.php
@@ -0,0 +1,58 @@
+meetings = [];
+    }
+
+    /**
+     * Retrieves all meetings of a type.
+     *
+     * @param int $type TYPE_SCHEDULED, TYPE_LIVE or TYPE_UPCOMING
+     *
+     * @throws Exception
+     *
+     * @return MeetingListItem[] all meetings
+     */
+    public static function loadMeetings($type)
+    {
+        return static::loadItems('meetings', 'users/me/meetings', ['type' => $type]);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function itemClass($propertyName)
+    {
+        if ('meetings' === $propertyName) {
+            return MeetingListItem::class;
+        }
+        throw new Exception("No such array property $propertyName");
+    }
+}
diff --git a/plugin/zoom/lib/API/MeetingListItem.php b/plugin/zoom/lib/API/MeetingListItem.php
new file mode 100644
index 000000000..e2793bed2
--- /dev/null
+++ b/plugin/zoom/lib/API/MeetingListItem.php
@@ -0,0 +1,44 @@
+auto_approve = true;
+    }
+}
diff --git a/plugin/zoom/lib/API/MeetingRegistrantList.php b/plugin/zoom/lib/API/MeetingRegistrantList.php
new file mode 100644
index 000000000..0f8446972
--- /dev/null
+++ b/plugin/zoom/lib/API/MeetingRegistrantList.php
@@ -0,0 +1,53 @@
+registrants = [];
+    }
+
+    /**
+     * Retrieves all registrant for a meeting.
+     *
+     * @param int $meetingId
+     *
+     * @throws Exception
+     *
+     * @return MeetingRegistrantListItem[] all registrants of the meeting
+     */
+    public static function loadMeetingRegistrants($meetingId)
+    {
+        return static::loadItems('registrants', "meetings/$meetingId/registrants");
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function itemClass($propertyName)
+    {
+        if ('registrants' === $propertyName) {
+            return MeetingRegistrantListItem::class;
+        }
+        throw new Exception("no such array property $propertyName");
+    }
+}
diff --git a/plugin/zoom/lib/API/MeetingRegistrantListItem.php b/plugin/zoom/lib/API/MeetingRegistrantListItem.php
new file mode 100644
index 000000000..e00b86a26
--- /dev/null
+++ b/plugin/zoom/lib/API/MeetingRegistrantListItem.php
@@ -0,0 +1,29 @@
+global_dial_in_countries = [];
+        $this->global_dial_in_numbers = [];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function itemClass($propertyName)
+    {
+        if ('global_dial_in_countries' === $propertyName) {
+            return 'string';
+        }
+        if ('global_dial_in_numbers' === $propertyName) {
+            return GlobalDialInNumber::class;
+        }
+        throw new Exception("No such array property $propertyName");
+    }
+}
diff --git a/plugin/zoom/lib/API/Ocurrence.php b/plugin/zoom/lib/API/Ocurrence.php
new file mode 100644
index 000000000..69843c87f
--- /dev/null
+++ b/plugin/zoom/lib/API/Ocurrence.php
@@ -0,0 +1,22 @@
+send(
+                    'GET',
+                    $relativePath,
+                    array_merge(['page_size' => $pageSize, 'page_number' => $pageNumber], $parameters)
+                )
+            );
+            $items = array_merge($items, $response->$arrayPropertyName);
+            if (0 === $totalRecords) {
+                $pageCount = $response->page_count;
+                $pageSize = $response->page_size;
+                $totalRecords = $response->total_records;
+            }
+        }
+        if (count($items) !== $totalRecords) {
+            error_log('Zoom announced '.$totalRecords.' records but returned '.count($items));
+        }
+
+        return $items;
+    }
+}
diff --git a/plugin/zoom/lib/API/PaginationToken.php b/plugin/zoom/lib/API/PaginationToken.php
new file mode 100644
index 000000000..931d370d1
--- /dev/null
+++ b/plugin/zoom/lib/API/PaginationToken.php
@@ -0,0 +1,71 @@
+send(
+                    'GET',
+                    $relativePath,
+                    array_merge(['page_size' => $pageSize, 'next_page_token' => $nextPageToken], $parameters)
+                )
+            );
+            $items = array_merge($items, $response->$arrayPropertyName);
+            $nextPageToken = $response->next_page_token;
+            if (0 === $totalRecords) {
+                $pageSize = $response->page_size;
+                $totalRecords = $response->total_records;
+            }
+        } while (!empty($nextPagetoken));
+        if (count($items) !== $totalRecords) {
+            error_log('Zoom announced '.$totalRecords.' records but returned '.count($items));
+        }
+
+        return $items;
+    }
+}
diff --git a/plugin/zoom/lib/API/ParticipantList.php b/plugin/zoom/lib/API/ParticipantList.php
new file mode 100644
index 000000000..84c4aba7b
--- /dev/null
+++ b/plugin/zoom/lib/API/ParticipantList.php
@@ -0,0 +1,57 @@
+participants = [];
+    }
+
+    /**
+     * Retrieves a meeting instance's participants.
+     *
+     * @param string $instanceUUID
+     *
+     * @throws Exception
+     *
+     * @return ParticipantListItem[] participants
+     */
+    public static function loadInstanceParticipants($instanceUUID)
+    {
+        return static::loadItems(
+            'participants',
+            'past_meetings/'.htmlentities($instanceUUID).'/participants'
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function itemClass($propertyName)
+    {
+        if ('participants' === $propertyName) {
+            return ParticipantListItem::class;
+        }
+        throw new Exception("No such array property $propertyName");
+    }
+}
diff --git a/plugin/zoom/lib/API/ParticipantListItem.php b/plugin/zoom/lib/API/ParticipantListItem.php
new file mode 100644
index 000000000..56e5735b2
--- /dev/null
+++ b/plugin/zoom/lib/API/ParticipantListItem.php
@@ -0,0 +1,22 @@
+send('GET', 'past_meetings/'.htmlentities($uuid)));
+    }
+
+    /**
+     * Retrieves information on participants from a past meeting instance.
+     *
+     * @throws Exception
+     *
+     * @return ParticipantListItem[] participants
+     */
+    public function getParticipants()
+    {
+        return ParticipantList::loadInstanceParticipants($this->uuid);
+    }
+}
diff --git a/plugin/zoom/lib/API/QuestionAndAnswer.php b/plugin/zoom/lib/API/QuestionAndAnswer.php
new file mode 100644
index 000000000..1eccdcb7c
--- /dev/null
+++ b/plugin/zoom/lib/API/QuestionAndAnswer.php
@@ -0,0 +1,23 @@
+
+     *  `MP4`: Video file of the recording.
    
+     *  `M4A` Audio-only file of the recording.
    
+     *  `TIMELINE`: Timestamp file of the recording.
+     * To get a timeline file, the "Add a timestamp to the recording" setting must be enabled in the recording settings
+     * (https://support.zoom.us/hc/en-us/articles/203741855-Cloud-recording#h_3f14c3a4-d16b-4a3c-bbe5-ef7d24500048).
+     * The time will display in the host's timezone, set on their Zoom profile.
+     *  `TRANSCRIPT`: Transcription file of the recording.
+     *  `CHAT`: A TXT file containing in-meeting chat messages that were sent during the meeting.
+     *  `CC`: File containing closed captions of the recording.
+     * A recording file object with file type of either `CC` or `TIMELINE` **does not have** the following properties:
+     * `id`, `status`, `file_size`, `recording_type`, and `play_url`.
+     */
+    public $file_type;
+
+    /** @var int The recording file size. */
+    public $file_size;
+
+    /** @var string The URL using which a recording file can be played. */
+    public $play_url;
+
+    /** @var string The URL using which the recording file can be downloaded.
+     * To access a private or password protected cloud recording, you must use a [Zoom JWT App Type]
+     * (https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app).
+     * Use the generated JWT token as the value of the `access_token` query parameter
+     * and include this query parameter at the end of the URL as shown in the example.
+     * Example: `https://api.zoom.us/recording/download/{{ Download Path }}?access_token={{ JWT Token }}`
+     */
+    public $download_url;
+
+    /** @var string The recording status. "completed". */
+    public $status;
+
+    /** @var string The time at which recording was deleted. Returned in the response only for trash query. */
+    public $deleted_time;
+
+    /** @var string The recording type. The value of this field can be one of the following:
+     * `shared_screen_with_speaker_view(CC)`
+     * `shared_screen_with_speaker_view`
+     * `shared_screen_with_gallery_view`
+     * `speaker_view`
+     * `gallery_view`
+     * `shared_screen`
+     * `audio_only`
+     * `audio_transcript`
+     * `chat_file`
+     * `TIMELINE`
+     */
+    public $recording_type;
+
+    /**
+     * Builds the recording file download URL with the access_token query parameter.
+     *
+     * @see RecordingFile::$download_url
+     *
+     * @param string $token
+     *
+     * @return string full URL
+     */
+    public function getFullDownloadURL($token)
+    {
+        return $this->download_url.'?access_token='.$token;
+    }
+
+    /**
+     * Deletes the file.
+     *
+     * @throws Exception
+     */
+    public function delete()
+    {
+        Client::getInstance()->send(
+            'DELETE',
+            "/meetings/$this->meeting_id/recordings/$this->id",
+            ['action' => 'delete']
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function itemClass($propertyName)
+    {
+        throw new Exception("No such array property $propertyName");
+    }
+}
diff --git a/plugin/zoom/lib/API/RecordingList.php b/plugin/zoom/lib/API/RecordingList.php
new file mode 100644
index 000000000..3cae5dcbb
--- /dev/null
+++ b/plugin/zoom/lib/API/RecordingList.php
@@ -0,0 +1,65 @@
+meetings = [];
+    }
+
+    /**
+     * Retrieves all recordings from a period of time.
+     *
+     * @param DateTime $startDate first day of the period
+     * @param DateTime $endDate   last day of the period
+     *
+     * @throws Exception
+     *
+     * @return RecordingMeeting[] all recordings from that period
+     */
+    public static function loadPeriodRecordings($startDate, $endDate)
+    {
+        return static::loadItems(
+            'meetings',
+            'users/me/recordings',
+            [
+                'from' => $startDate->format('Y-m-d'),
+                'to' => $endDate->format('Y-m-d'),
+            ]
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function itemClass($propertyName)
+    {
+        if ('meetings' === $propertyName) {
+            return RecordingMeeting::class;
+        }
+        throw new Exception("No such array property $propertyName");
+    }
+}
diff --git a/plugin/zoom/lib/API/RecordingMeeting.php b/plugin/zoom/lib/API/RecordingMeeting.php
new file mode 100644
index 000000000..517b532c8
--- /dev/null
+++ b/plugin/zoom/lib/API/RecordingMeeting.php
@@ -0,0 +1,95 @@
+recording_files = [];
+    }
+
+    /**
+     * Deletes the recording on the server.
+     *
+     * @throws Exception
+     */
+    public function delete()
+    {
+        Client::getInstance()->send(
+            'DELETE',
+            'meetings/'.htmlentities($this->uuid).'/recordings',
+            ['action' => 'delete']
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function itemClass($propertyName)
+    {
+        if ('recording_files' === $propertyName) {
+            return RecordingFile::class;
+        }
+        throw new Exception("No such array property $propertyName");
+    }
+}
diff --git a/plugin/zoom/lib/API/RegistrantSchema.php b/plugin/zoom/lib/API/RegistrantSchema.php
new file mode 100644
index 000000000..db24b5732
--- /dev/null
+++ b/plugin/zoom/lib/API/RegistrantSchema.php
@@ -0,0 +1,103 @@
+ value */
+    public $custom_questions;
+
+    /**
+     * @var string
+     */
+    public $language;
+
+    /**
+     * MeetingRegistrant constructor.
+     */
+    public function __construct()
+    {
+        $this->status = 'approved';
+        $this->custom_questions = [];
+    }
+
+    public static function fromEmailAndFirstName(string $email, string $firstName, string $lastName = null): RegistrantSchema
+    {
+        $instance = new static();
+        $instance->first_name = $firstName;
+        $instance->email = $email;
+        if (null !== $lastName) {
+            $instance->last_name = $lastName;
+        }
+
+        return $instance;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function itemClass($propertyName): string
+    {
+        if ('custom_questions' === $propertyName) {
+            return CustomQuestion::class;
+        }
+        throw new Exception("no such array property $propertyName");
+    }
+}
diff --git a/plugin/zoom/lib/API/ServerToServerOAuthClient.php b/plugin/zoom/lib/API/ServerToServerOAuthClient.php
new file mode 100644
index 000000000..332ce9a7c
--- /dev/null
+++ b/plugin/zoom/lib/API/ServerToServerOAuthClient.php
@@ -0,0 +1,84 @@
+token = $this->requireAccessToken($accountId, $clientId, $clientSecret);
+        } catch (Exception $e) {
+            error_log('Zoom: Can\'t require access token: '.$e->getMessage());
+        }
+
+        self::register($this);
+    }
+
+    private function requireAccessToken(string $accountId, string $clientId, string $clientSecret)
+    {
+        $options = [
+            CURLOPT_CUSTOMREQUEST => 'POST',
+            CURLOPT_ENCODING => '',
+            CURLOPT_HTTPHEADER => [
+                'Authorization: Basic '.base64_encode("$clientId:$clientSecret"),
+                'Content-Type: application/x-www-form-urlencoded',
+                'Host: zoom.us',
+            ],
+            CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
+            CURLOPT_MAXREDIRS => 10,
+            CURLOPT_RETURNTRANSFER => true,
+            CURLOPT_TIMEOUT => 30,
+            CURLOPT_POST => true,
+            CURLOPT_POSTFIELDS => http_build_query([
+                'grant_type' => 'account_credentials',
+                'account_id' => $accountId,
+            ]),
+        ];
+
+        $url = 'https://zoom.us/oauth/token';
+
+        $curl = curl_init($url);
+
+        if (false === $curl) {
+            throw new Exception("curl_init returned false");
+        }
+
+        curl_setopt_array($curl, $options);
+        $responseBody = curl_exec($curl);
+        $responseCode = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
+        $curlError = curl_error($curl);
+        curl_close($curl);
+
+        if ($curlError) {
+            throw new Exception("cURL Error: $curlError");
+        }
+
+        if (false === $responseBody || !is_string($responseBody)) {
+            throw new Exception('cURL Error');
+        }
+
+        if (empty($responseCode) || $responseCode < 200 || $responseCode >= 300) {
+            throw new Exception($responseBody, $responseCode);
+        }
+
+        $jsonResponseBody = json_decode($responseBody, true);
+
+        if (false === $jsonResponseBody) {
+            throw new Exception('Could not generate JSON responso body');
+        }
+
+        return $jsonResponseBody['access_token'];
+    }
+}
diff --git a/plugin/zoom/lib/API/TrackingField.php b/plugin/zoom/lib/API/TrackingField.php
new file mode 100644
index 000000000..7f089ff9c
--- /dev/null
+++ b/plugin/zoom/lib/API/TrackingField.php
@@ -0,0 +1,29 @@
+
+     */
+    public $tracking_fields;
+    public $recurrence;
+    public $template_id;
+    /**
+     * @var array
+     */
+    public $ocurrences;
+
+    protected function __construct()
+    {
+        $this->tracking_fields = [];
+        $this->settings = new WebinarSettings();
+        $this->ocurrences = [];
+    }
+
+    public function itemClass($propertyName): string
+    {
+        if ('tracking_fields' === $propertyName) {
+            return TrackingField::class;
+        }
+
+        if ('ocurrences' === $propertyName) {
+            return Ocurrence::class;
+        }
+
+        throw new Exception("no such array property $propertyName");
+    }
+
+    public static function fromTopicAndType($topic, $type = self::TYPE_WEBINAR): WebinarSchema
+    {
+        $instance = new static();
+        $instance->topic = $topic;
+        $instance->type = $type;
+
+        return $instance;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function create($userId = null): WebinarSchema
+    {
+        $client = Client::getInstance();
+
+        $userId = empty($userId) ? 'me' : $userId;
+
+        return self::fromJson(
+            $client->send('POST', "users/$userId/webinars", [], $this)
+        );
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function update(): void
+    {
+        Client::getInstance()->send('PATCH', 'webinars/'.$this->id, [], $this);
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function delete()
+    {
+        Client::getInstance()->send('DELETE', "webinars/$this->id");
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function addRegistrant(RegistrantSchema $registrant, string $occurrenceIds = ''): CreatedRegistration
+    {
+        return CreatedRegistration::fromJson(
+            Client::getInstance()->send(
+                'POST',
+                "webinars/$this->id/registrants",
+                empty($occurrenceIds) ? [] : ['occurrence_ids' => $occurrenceIds],
+                $registrant
+            )
+        );
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function removeRegistrants(array $registrants, string $occurrenceIds = '')
+    {
+        if (empty($registrants)) {
+            return;
+        }
+
+        $requestBody = new stdClass();
+        $requestBody->action = 'cancel';
+        $requestBody->registrants = $registrants;
+
+        Client::getInstance()->send(
+            'PUT',
+            "webinars/$this->id/registrants/status",
+            empty($occurrenceIds) ? [] : ['occurrence_ids' => $occurrenceIds],
+            $requestBody
+        );
+    }
+}
diff --git a/plugin/zoom/lib/API/WebinarSettings.php b/plugin/zoom/lib/API/WebinarSettings.php
new file mode 100644
index 000000000..b46671a78
--- /dev/null
+++ b/plugin/zoom/lib/API/WebinarSettings.php
@@ -0,0 +1,201 @@
+
+     */
+    public $global_dial_in_countries;
+    /**
+     * @var array
+     */
+    public $global_dial_in_numbers;
+    /**
+     * @var string
+     */
+    public $contact_name;
+    /**
+     * @var string
+     */
+    public $contact_email;
+    /**
+     * @var int
+     */
+    public $registrants_restrict_number;
+    /**
+     * @var bool
+     */
+    public $registrants_email_notification;
+    /**
+     * @var bool
+     */
+    public $post_webinar_survey;
+    /**
+     * @var bool
+     */
+    public $meeting_authentication;
+    /**
+     * @var QuestionAndAnswer
+     */
+    public $question_and_answer;
+    /**
+     * @var bool
+     */
+    public $hd_video_for_attendees;
+    /**
+     * @var bool
+     */
+    public $send_1080p_video_to_attendees;
+    /**
+     * @var string
+     */
+    public $email_language;
+    /**
+     * @var bool
+     */
+    public $panelists_invitation_email_notification;
+    /**
+     * @var FollowUpUsers
+     */
+    public $attendees_and_panelists_reminder_email_notification;
+    /**
+     * @var FollowUpUsers
+     */
+    public $follow_up_attendees_email_notification;
+    /**
+     * @var FollowUpUsers
+     */
+    public $follow_up_absentees_email_notification;
+
+    /**
+     * @var int
+     */
+    public $registration_type;
+    /**
+     * @var string
+     */
+    public $auto;
+    /**
+     * @var string
+     */
+    public $survey_url;
+    /**
+     * @var string
+     */
+    public $authentication_option;
+    /**
+     * @var string
+     */
+    public $authentication_domains;
+    /**
+     * @var string
+     */
+    public $authentication_name;
+
+    public function __construct()
+    {
+        $this->global_dial_in_countries = [];
+        $this->global_dial_in_numbers = [];
+        $this->question_and_answer = new QuestionAndAnswer();
+        $this->attendees_and_panelists_reminder_email_notification = new FollowUpUsers();
+        $this->follow_up_absentees_email_notification = new FollowUpUsers();
+        $this->follow_up_attendees_email_notification = new FollowUpUsers();
+    }
+
+    public function itemClass($propertyName): string
+    {
+        if ('global_dial_in_countries' === $propertyName) {
+            return 'string';
+        }
+
+        if ('global_dial_in_numbers' === $propertyName) {
+            return GlobalDialInNumber::class;
+        }
+
+        throw new Exception("No such array property $propertyName");
+    }
+}
diff --git a/plugin/zoom/lib/MeetingRepository.php b/plugin/zoom/lib/MeetingRepository.php
new file mode 100644
index 000000000..392b2ae5b
--- /dev/null
+++ b/plugin/zoom/lib/MeetingRepository.php
@@ -0,0 +1,215 @@
+findAll();
+
+        /** @var Meeting $candidate */
+        foreach ($all as $candidate) {
+            if (API\Meeting::TYPE_INSTANT === $candidate->getMeetingInfoGet()->type) {
+                continue;
+            }
+
+            $cantidateEndDate = clone $candidate->startDateTime;
+            $cantidateEndDate->add($candidate->durationInterval);
+
+            if (($candidate->startDateTime >= $startDate && $candidate->startDateTime <= $endDate)
+                || ($candidate->startDateTime <= $startDate && $cantidateEndDate >= $startDate)
+            ) {
+                $matching[] = $candidate;
+            }
+        }
+
+        return $matching;
+    }
+
+    /**
+     * @return ArrayCollection|Collection|Meeting[]
+     */
+    public function globalMeetings()
+    {
+        return $this->matching(
+            Criteria::create()->where(
+                Criteria::expr()->andX(
+                    Criteria::expr()->eq('course', null),
+                    Criteria::expr()->eq('user', null)
+                )
+            )
+        );
+    }
+
+    /**
+     * @return ArrayCollection|Collection|Meeting[]
+     */
+    public function unfinishedGlobalMeetings()
+    {
+        return $this->globalMeetings()->filter(
+            function ($meeting) {
+                return 'finished' !== $meeting->getMeetingInfoGet()->status;
+            }
+        );
+    }
+
+    /**
+     * Returns either a user's meetings or all user meetings.
+     *
+     * @param User|null $user
+     *
+     * @return QueryBuilder
+     */
+    public function userMeetings($user = null)
+    {
+        $qb = $this->createQueryBuilder('m');
+        $qb
+            ->select('m')
+            ->leftJoin('m.registrants', 'r');
+
+        //$qb->select('m');
+        /*$criteria = Criteria::create()->where(
+            Criteria::expr()->andX(
+                Criteria::expr()->isNull('course'),
+                Criteria::expr()->orX(
+                    Criteria::expr()->isNull('user'),
+                    Criteria::expr()->eq('user', $user)
+                )
+            ));*/
+
+        /*$qb->where(Criteria::expr()->andX(
+            Criteria::expr()->isNull('course'),
+            Criteria::expr()->orX(
+                Criteria::expr()->isNull('user'),
+                Criteria::expr()->eq('user', $user)
+            )
+        ));*/
+
+        $qb
+            ->andWhere('m.course IS NULL')
+            ->andWhere('m.user IS NULL OR m.user = :user OR r.user = :user');
+
+        $qb->setParameters(['user' => $user]);
+
+        return $qb;
+
+        /*return $this->matching(
+            ,
+                Criteria::expr()->andX(
+                    Criteria::expr()->eq('registrants', null),
+                    Criteria::expr()->orX(
+                        Criteria::expr()->eq('user', null),
+                        Criteria::expr()->eq('user', $user)
+                    )
+                )
+            )
+        );*/
+
+        /*return $this->matching(
+            Criteria::create()->where(
+                Criteria::expr()->andX(
+                    Criteria::expr()->eq('course', null),
+                    Criteria::expr()->orX(
+                        Criteria::expr()->eq('user', null),
+                        Criteria::expr()->eq('user', $user)
+                    )
+                )
+            )
+        );*/
+    }
+
+    /**
+     * @param User|null $user
+     *
+     * @return Meeting[]
+     */
+    public function unfinishedUserMeetings($user = null)
+    {
+        /*return $this->userMeetings($user)->filter(
+           function ($meeting) {
+               return 'finished' !== $meeting->getMeetingInfoGet()->status;
+           }
+       );*/
+
+        $results = @$this->userMeetings($user)->getQuery()->getResult();
+        $list = [];
+        foreach ($results as $meeting) {
+            if ('finished' === $meeting->getMeetingInfoGet()->status) {
+                $list[] = $meeting;
+            }
+        }
+
+        return $list;
+    }
+
+    /**
+     * @param DateTime $start
+     * @param DateTime $end
+     * @param User     $user
+     *
+     * @return ArrayCollection|Collection|Meeting[]
+     */
+    public function periodUserMeetings($start, $end, $user = null)
+    {
+        /*return $this->userMeetings($user)->filter(
+            function ($meeting) use ($start, $end) {
+                return $meeting->startDateTime >= $start && $meeting->startDateTime <= $end;
+            }
+        );*/
+
+        $results = @$this->userMeetings($user)->getQuery()->getResult();
+        $list = [];
+        if ($results) {
+            foreach ($results as $meeting) {
+                if ($meeting->startDateTime >= $start && $meeting->startDateTime <= $end) {
+                    $list[] = $meeting;
+                }
+            }
+        }
+
+        return $list;
+    }
+
+    /**
+     * Returns either a course's meetings or all course meetings.
+     *
+     * @return ArrayCollection|Collection|Meeting[]
+     */
+    public function courseMeetings(Course $course, CGroupInfo $group = null, Session $session = null)
+    {
+        return $this->matching(
+            Criteria::create()->where(
+                    Criteria::expr()->andX(
+                 Criteria::expr()->eq('group', $group),
+                    Criteria::expr()->eq('course', $course),
+                    Criteria::expr()->eq('session', $session)
+                )
+            )
+        );
+    }
+}
diff --git a/plugin/zoom/lib/RecordingRepository.php b/plugin/zoom/lib/RecordingRepository.php
new file mode 100644
index 000000000..959a70cbc
--- /dev/null
+++ b/plugin/zoom/lib/RecordingRepository.php
@@ -0,0 +1,65 @@
+findAll();
+        foreach ($all as $candidate) {
+            if ($candidate->startDateTime >= $startDate && $candidate->startDateTime <= $endDate) {
+                $matching[] = $candidate;
+            }
+        }
+
+        return $matching;
+    }
+
+    /**
+     * Returns a user's meeting recordings.
+     *
+     * @param User $user
+     *
+     * @return ArrayCollection|Collection|Recording[]
+     */
+    /*public function userRecordings($user)
+    {
+        return $this->matching(
+            Criteria::create()->where(
+                Criteria::expr()->in(
+                    'meeting',
+                    $this->getEntityManager()->getRepository(Meeting::class)->userMeetings($user)->toArray()
+                )
+            )
+        );
+    }*/
+
+    /**
+     * @param DateTime $start
+     * @param DateTime $end
+     * @param User     $user
+     *
+     * @return ArrayCollection|Recording[]
+     */
+    /*public function getPeriodUserRecordings($start, $end, $user = null)
+    {
+        return $this->userRecordings($user)->filter(
+            function ($meeting) use ($start, $end) {
+                return $meeting->startDateTime >= $start && $meeting->startDateTime <= $end;
+            }
+        );
+    }*/
+}
diff --git a/plugin/zoom/lib/RegistrantRepository.php b/plugin/zoom/lib/RegistrantRepository.php
new file mode 100644
index 000000000..0b1b866b8
--- /dev/null
+++ b/plugin/zoom/lib/RegistrantRepository.php
@@ -0,0 +1,49 @@
+add(new DateInterval('P7D'));
+        $meetings = $this->getEntityManager()->getRepository(Meeting::class)->periodMeetings($start, $end);
+
+        return $this->findBy(['meeting' => $meetings, 'user' => $user]);
+    }
+
+    public function findByMeetingPaginated(Meeting $meeting, int $from, int $limit, string $column, string $direction)
+    {
+        $queryBuilder = $this->createQueryBuilder('r')
+            ->join('r.user', 'u')
+            ->leftJoin('r.signature', 's')
+            ->where('r.meeting = :meeting')
+            ->setFirstResult($from)
+            ->setMaxResults($limit)
+            ->orderBy($column, $direction)
+        ;
+
+        $queryBuilder->setParameter('meeting', $meeting);
+
+        return $queryBuilder->getQuery()->getResult();
+    }
+}
diff --git a/plugin/zoom/lib/ZoomPlugin.php b/plugin/zoom/lib/ZoomPlugin.php
new file mode 100644
index 000000000..15a5266a2
--- /dev/null
+++ b/plugin/zoom/lib/ZoomPlugin.php
@@ -0,0 +1,2000 @@
+ 'boolean',
+                'apiKey' => 'text',
+                'apiSecret' => 'text',
+                'verificationToken' => 'text',
+                self::SETTING_ACCOUNT_ID => 'text',
+                self::SETTING_CLIENT_ID => 'text',
+                self::SETTING_CLIENT_SECRET => 'text',
+                self::SETTING_SECRET_TOKEN => 'text',
+                'enableParticipantRegistration' => 'boolean',
+                'enablePresenter' => 'boolean',
+                'enableCloudRecording' => [
+                    'type' => 'select',
+                    'options' => [
+                        self::RECORDING_TYPE_CLOUD => 'Cloud',
+                        self::RECORDING_TYPE_LOCAL => 'Local',
+                        self::RECORDING_TYPE_NONE => get_lang('None'),
+                    ],
+                ],
+                'enableGlobalConference' => 'boolean',
+                'globalConferenceAllowRoles' => [
+                    'type' => 'select',
+                    'options' => [
+                        PLATFORM_ADMIN => get_lang('Administrator'),
+                        COURSEMANAGER => get_lang('Teacher'),
+                        STUDENT => get_lang('Student'),
+                        STUDENT_BOSS => get_lang('StudentBoss'),
+                        SESSIONADMIN => get_lang('SessionsAdmin'),
+                    ],
+                    'attributes' => ['multiple' => 'multiple'],
+                ],
+                'accountSelector' => 'text',
+            ]
+        );
+
+        $this->isAdminPlugin = true;
+
+        $accountId = $this->get(self::SETTING_ACCOUNT_ID);
+        $clientId = $this->get(self::SETTING_CLIENT_ID);
+        $clientSecret = $this->get(self::SETTING_CLIENT_SECRET);
+
+        if (!empty($accountId) && !empty($clientId) && !empty($clientSecret)) {
+            $this->jwtClient = new ServerToServerOAuthClient($accountId, $clientId, $clientSecret);
+        } else {
+            $this->jwtClient = new JWTClient($this->get('apiKey'), $this->get('apiSecret'));
+        }
+    }
+
+    /**
+     * Caches and returns an instance of this class.
+     *
+     * @return ZoomPlugin the instance to use
+     */
+    public static function create(): ZoomPlugin
+    {
+        static $instance = null;
+
+        return $instance ? $instance : $instance = new self();
+    }
+
+    /**
+     * @return bool
+     */
+    public static function currentUserCanJoinGlobalMeeting()
+    {
+        $user = api_get_user_entity(api_get_user_id());
+
+        if (null === $user) {
+            return false;
+        }
+
+        //return 'true' === api_get_plugin_setting('zoom', 'enableGlobalConference') && api_user_is_login();
+        return
+            'true' === api_get_plugin_setting('zoom', 'enableGlobalConference')
+            && in_array(
+                (api_is_platform_admin() ? PLATFORM_ADMIN : $user->getStatus()),
+                (array) api_get_plugin_setting('zoom', 'globalConferenceAllowRoles')
+            );
+    }
+
+    /**
+     * @return array
+     */
+    public function getProfileBlockItems()
+    {
+        $elements = $this->meetingsToWhichCurrentUserIsRegisteredComingSoon();
+        $addMeetingLink = false;
+        if (self::currentUserCanJoinGlobalMeeting()) {
+            $addMeetingLink = true;
+        }
+
+        if ($addMeetingLink) {
+            $elements[$this->get_lang('Meetings')] = api_get_path(WEB_PLUGIN_PATH).'zoom/meetings.php';
+        }
+
+        $items = [];
+        foreach ($elements as $title => $link) {
+            $items[] = [
+                'class' => 'video-conference',
+                'icon' => Display::return_icon(
+                    'bbb.png',
+                    get_lang('VideoConference')
+                ),
+                'link' => $link,
+                'title' => $title,
+            ];
+        }
+
+        return $items;
+    }
+
+    /**
+     * @return array [ $title => $link ]
+     */
+    public function meetingsToWhichCurrentUserIsRegisteredComingSoon()
+    {
+        $linkTemplate = api_get_path(WEB_PLUGIN_PATH).'zoom/join_meeting.php?meetingId=%s';
+        $user = api_get_user_entity(api_get_user_id());
+        $meetings = self::getRegistrantRepository()->meetingsComingSoonRegistrationsForUser($user);
+        $items = [];
+        foreach ($meetings as $registrant) {
+            $meeting = $registrant->getMeeting();
+
+            $items[sprintf(
+                $this->get_lang('DateMeetingTitle'),
+                $meeting->formattedStartTime,
+                $meeting->getTopic()
+            )] = sprintf($linkTemplate, $meeting->getMeetingId());
+        }
+
+        return $items;
+    }
+
+    /**
+     * @return RegistrantRepository|EntityRepository
+     */
+    public static function getRegistrantRepository()
+    {
+        return Database::getManager()->getRepository(Registrant::class);
+    }
+
+    /**
+     * Creates this plugin's related tables in the internal database.
+     * Installs course fields in all courses.
+     *
+     * @throws ToolsException
+     */
+    public function install()
+    {
+        $schemaManager = Database::getManager()->getConnection()->getSchemaManager();
+
+        $tablesExists = $schemaManager->tablesExist(
+            [
+                'plugin_zoom_meeting',
+                'plugin_zoom_meeting_activity',
+                'plugin_zoom_recording',
+                'plugin_zoom_registrant',
+                'plugin_zoom_signature',
+            ]
+        );
+
+        if ($tablesExists) {
+            return;
+        }
+
+        $em = Database::getManager();
+
+        (new SchemaTool($em))->createSchema(
+            [
+                $em->getClassMetadata(Meeting::class),
+                $em->getClassMetadata(Webinar::class),
+                $em->getClassMetadata(MeetingActivity::class),
+                $em->getClassMetadata(Recording::class),
+                $em->getClassMetadata(Registrant::class),
+                $em->getClassMetadata(Signature::class),
+            ]
+        );
+
+        // Copy icons into the main/img/icons folder
+        $iconName = 'zoom_meet';
+        $iconsList = [
+            '64/'.$iconName.'.png',
+            '64/'.$iconName.'_na.png',
+            '32/'.$iconName.'.png',
+            '32/'.$iconName.'_na.png',
+            '22/'.$iconName.'.png',
+            '22/'.$iconName.'_na.png',
+        ];
+        $sourceDir = api_get_path(SYS_PLUGIN_PATH).'zoom/resources/img/';
+        $destinationDir = api_get_path(SYS_CODE_PATH).'img/icons/';
+        foreach ($iconsList as $icon) {
+            $src = $sourceDir.$icon;
+            $dest = $destinationDir.$icon;
+            copy($src, $dest);
+        }
+
+        $this->install_course_fields_in_all_courses(true, 'zoom_meet.png');
+    }
+
+    /**
+     * Drops this plugins' related tables from the internal database.
+     * Uninstalls course fields in all courses().
+     */
+    public function uninstall()
+    {
+        $em = Database::getManager();
+
+        (new SchemaTool($em))->dropSchema(
+            [
+                $em->getClassMetadata(Meeting::class),
+                $em->getClassMetadata(Webinar::class),
+                $em->getClassMetadata(MeetingActivity::class),
+                $em->getClassMetadata(Recording::class),
+                $em->getClassMetadata(Registrant::class),
+                $em->getClassMetadata(Signature::class),
+            ]
+        );
+        $this->uninstall_course_fields_in_all_courses();
+
+        // Remove icons from the main/img/icons folder
+        $iconName = 'zoom_meet';
+        $iconsList = [
+            '64/'.$iconName.'.png',
+            '64/'.$iconName.'_na.png',
+            '32/'.$iconName.'.png',
+            '32/'.$iconName.'_na.png',
+            '22/'.$iconName.'.png',
+            '22/'.$iconName.'_na.png',
+        ];
+        $destinationDir = api_get_path(SYS_CODE_PATH).'img/icons/';
+        foreach ($iconsList as $icon) {
+            $dest = $destinationDir.$icon;
+            if (is_file($dest)) {
+                @unlink($dest);
+            }
+        }
+    }
+
+    /**
+     * Generates the search form to include in the meeting list administration page.
+     * The form has DatePickers 'start' and 'end' and Checkbox 'reloadRecordingLists'.
+     *
+     * @return FormValidator the form
+     */
+    public function getAdminSearchForm()
+    {
+        $form = new FormValidator('search');
+        $form->addHeader($this->get_lang('SearchMeeting'));
+        $form->addDatePicker('start', get_lang('StartDate'));
+        $form->addDatePicker('end', get_lang('EndDate'));
+        $form->addButtonSearch(get_lang('Search'));
+        $oneMonth = new DateInterval('P1M');
+        if ($form->validate()) {
+            try {
+                $start = new DateTime($form->getSubmitValue('start'));
+            } catch (Exception $exception) {
+                $start = new DateTime();
+                $start->sub($oneMonth);
+            }
+            try {
+                $end = new DateTime($form->getSubmitValue('end'));
+            } catch (Exception $exception) {
+                $end = new DateTime();
+                $end->add($oneMonth);
+            }
+        } else {
+            $start = new DateTime();
+            $start->sub($oneMonth);
+            $end = new DateTime();
+            $end->add($oneMonth);
+        }
+        try {
+            $form->setDefaults(
+                [
+                    'start' => $start->format('Y-m-d'),
+                    'end' => $end->format('Y-m-d'),
+                ]
+            );
+        } catch (Exception $exception) {
+            error_log(join(':', [__FILE__, __LINE__, $exception]));
+        }
+
+        return $form;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function getEditConferenceForm(Meeting $conference): FormValidator
+    {
+        $isWebinar = $conference instanceof Webinar;
+        $requiresDateAndDuration = $conference->requiresDateAndDuration();
+
+        /** @var BaseMeetingTrait $schema */
+        $schema = $isWebinar ? $conference->getWebinarSchema() : $conference->getMeetingInfoGet();
+
+        $form = new FormValidator('edit', 'post', $_SERVER['REQUEST_URI']);
+        $form->addHeader(
+            $isWebinar ? $this->get_lang('UpdateWebinar') : $this->get_lang('UpdateMeeting')
+        );
+        $form->addLabel(get_lang('Type'), $conference->typeName);
+        if ($conference->getAccountEmail()) {
+            $form->addLabel(
+                $this->get_lang('AccountEmail'),
+                $conference->getAccountEmail()
+            );
+        }
+        $form->addText('topic', $this->get_lang('Topic'));
+
+        if ($requiresDateAndDuration) {
+            $startTimeDatePicker = $form->addDateTimePicker('startTime', get_lang('StartTime'));
+            $durationNumeric = $form->addNumeric('duration', $this->get_lang('DurationInMinutes'));
+
+            $form->setRequired($startTimeDatePicker);
+            $form->setRequired($durationNumeric);
+        }
+
+        $form->addTextarea('agenda', get_lang('Agenda'), ['maxlength' => 2000]);
+        $form->addCheckBox('sign_attendance', $this->get_lang('SignAttendance'), get_lang('Yes'));
+        $form->addTextarea('reason_to_sign', $this->get_lang('ReasonToSign'), ['rows' => 5]);
+        $form->addButtonUpdate(get_lang('Update'));
+
+        if ($form->validate()) {
+            $formValues = $form->exportValues();
+
+            $em = Database::getManager();
+
+            if ($requiresDateAndDuration) {
+                $schema->start_time = (new DateTime($formValues['startTime']))->format(DATE_ATOM);
+                $schema->timezone = date_default_timezone_get();
+                $schema->duration = (int) $formValues['duration'];
+            }
+
+            $schema->topic = $formValues['topic'];
+            $schema->agenda = $formValues['agenda'];
+
+            $conference
+                ->setSignAttendance(isset($formValues['sign_attendance']))
+                ->setReasonToSignAttendance($formValues['reason_to_sign']);
+
+            try {
+                $schema->update();
+
+                if ($isWebinar) {
+                    $conference->setWebinarSchema($schema);
+                } else {
+                    $conference->setMeetingInfoGet($schema);
+                }
+
+                $em->persist($conference);
+                $em->flush();
+
+                Display::addFlash(
+                    Display::return_message(
+                        $isWebinar ? $this->get_lang('WebinarUpdated') : $this->get_lang('MeetingUpdated'),
+                        'confirm'
+                    )
+                );
+            } catch (Exception $exception) {
+                Display::addFlash(
+                    Display::return_message($exception->getMessage(), 'error')
+                );
+            }
+        }
+
+        $defaults = [
+            'topic' => $schema->topic,
+            'agenda' => $schema->agenda,
+        ];
+
+        if ($requiresDateAndDuration) {
+            $defaults['startTime'] = $conference->startDateTime->format('Y-m-d H:i');
+            $defaults['duration'] = $schema->duration;
+        }
+
+        $defaults['sign_attendance'] = $conference->isSignAttendance();
+        $defaults['reason_to_sign'] = $conference->getReasonToSignAttendance();
+
+        $form->setDefaults($defaults);
+
+        return $form;
+    }
+
+    /**
+     * Generates a meeting delete form and deletes the meeting on validation.
+     *
+     * @param Meeting $meeting
+     * @param string  $returnURL where to redirect to on successful deletion
+     *
+     * @throws Exception
+     *
+     * @return FormValidator
+     */
+    public function getDeleteMeetingForm($meeting, $returnURL)
+    {
+        $id = $meeting->getMeetingId();
+        $form = new FormValidator('delete', 'post', api_get_self().'?meetingId='.$id);
+        $form->addButtonDelete($this->get_lang('DeleteMeeting'));
+        if ($form->validate()) {
+            $this->deleteMeeting($meeting, $returnURL);
+        }
+
+        return $form;
+    }
+
+    public function getDeleteWebinarForm(Webinar $webinar, string $returnURL): FormValidator
+    {
+        $id = $webinar->getMeetingId();
+        $form = new FormValidator('delete', 'post', api_get_self()."?meetingId=$id");
+        $form->addButtonDelete($this->get_lang('DeleteWebinar'));
+
+        if ($form->validate()) {
+            $this->deleteWebinar($webinar, $returnURL);
+        }
+
+        return $form;
+    }
+
+    /**
+     * @param Meeting $meeting
+     * @param string  $returnURL
+     */
+    public function deleteMeeting($meeting, $returnURL): bool
+    {
+        if (null === $meeting) {
+            return false;
+        }
+
+        // No need to delete a instant meeting.
+        if (\Chamilo\PluginBundle\Zoom\API\Meeting::TYPE_INSTANT == $meeting->getMeetingInfoGet()->type) {
+            return false;
+        }
+
+        try {
+            $meeting->getMeetingInfoGet()->delete();
+        } catch (Exception $exception) {
+            $this->handleException($exception);
+        }
+
+        $em = Database::getManager();
+        $em->remove($meeting);
+        $em->flush();
+
+        Display::addFlash(
+            Display::return_message($this->get_lang('MeetingDeleted'), 'confirm')
+        );
+        api_location($returnURL);
+
+        return true;
+    }
+
+    public function deleteWebinar(Webinar $webinar, string $returnURL)
+    {
+        try {
+            $webinar->getWebinarSchema()->delete();
+        } catch (Exception $exception) {
+            $this->handleException($exception);
+        }
+
+        $em = Database::getManager();
+        $em->remove($webinar);
+        $em->flush();
+
+        Display::addFlash(
+            Display::return_message($this->get_lang('WebinarDeleted'), 'success')
+        );
+
+        api_location($returnURL);
+    }
+
+    /**
+     * @param Exception $exception
+     */
+    public function handleException($exception)
+    {
+        if ($exception instanceof Exception) {
+            $error = json_decode($exception->getMessage());
+            $message = $exception->getMessage();
+            if ($error->message) {
+                $message = $error->message;
+            }
+            Display::addFlash(
+                Display::return_message($message, 'error')
+            );
+        }
+    }
+
+    /**
+     * Generates a registrant list update form listing course and session users.
+     * Updates the list on validation.
+     *
+     * @param Meeting $meeting
+     *
+     * @throws Exception
+     *
+     * @return FormValidator
+     */
+    public function getRegisterParticipantForm($meeting)
+    {
+        $form = new FormValidator('register', 'post', $_SERVER['REQUEST_URI']);
+        $userIdSelect = $form->addSelect('userIds', $this->get_lang('RegisteredUsers'));
+        $userIdSelect->setMultiple(true);
+        $form->addButtonSend($this->get_lang('UpdateRegisteredUserList'));
+
+        $selfRegistrationUrl = api_get_path(WEB_PLUGIN_PATH)
+            .'zoom/subscription.php?meetingId='.$meeting->getMeetingId();
+
+        $form->addHtml(
+            '
    
+                
    
+                
+                
    
+                    
+                    
+                        
+                    
+                
    
+            
    '
+        );
+
+        $users = $meeting->getRegistrableUsers();
+        foreach ($users as $user) {
+            $userIdSelect->addOption(
+                api_get_person_name($user->getFirstname(), $user->getLastname()),
+                $user->getId()
+            );
+        }
+
+        if ($form->validate()) {
+            $selectedUserIds = $form->getSubmitValue('userIds');
+            $selectedUsers = [];
+            if (!empty($selectedUserIds)) {
+                foreach ($users as $user) {
+                    if (in_array($user->getId(), $selectedUserIds)) {
+                        $selectedUsers[] = $user;
+                    }
+                }
+            }
+
+            try {
+                $this->updateRegistrantList($meeting, $selectedUsers);
+                Display::addFlash(
+                    Display::return_message($this->get_lang('RegisteredUserListWasUpdated'), 'confirm')
+                );
+            } catch (Exception $exception) {
+                Display::addFlash(
+                    Display::return_message($exception->getMessage(), 'error')
+                );
+            }
+        }
+        $registeredUserIds = [];
+        foreach ($meeting->getRegistrants() as $registrant) {
+            $registeredUserIds[] = $registrant->getUser()->getId();
+        }
+        $userIdSelect->setSelected($registeredUserIds);
+
+        return $form;
+    }
+
+    public function getRegisterPresenterForm(Meeting $meeting): FormValidator
+    {
+        $form = new FormValidator('register_presenter', 'post', $_SERVER['REQUEST_URI']);
+
+        $presenterIdSelect = $form->addSelect('presenterIds', $this->get_lang('RegisteredPresenters'));
+        $presenterIdSelect->setMultiple(true);
+
+        $form->addButtonSend($this->get_lang('UpdateRegisteredUserList'));
+
+        $users = $meeting->getRegistrableUsers();
+
+        foreach ($users as $user) {
+            $presenterIdSelect->addOption(
+                api_get_person_name($user->getFirstname(), $user->getLastname()),
+                $user->getId()
+            );
+        }
+
+        if ($form->validate()) {
+            $selectedPresenterIds = $form->getSubmitValue('presenterIds') ?: [];
+            $selectedPresenters = [];
+
+            foreach ($users as $user) {
+                if (in_array($user->getId(), $selectedPresenterIds)) {
+                    $selectedPresenters[] = $user;
+                }
+            }
+
+            try {
+                $this->updatePresenterList($meeting, $selectedPresenters);
+
+                Display::addFlash(
+                    Display::return_message($this->get_lang('RegisteredUserListWasUpdated'), 'confirm')
+                );
+            } catch (Exception $exception) {
+                Display::addFlash(
+                    Display::return_message($exception->getMessage(), 'error')
+                );
+            }
+        }
+
+        $registeredPresenterIds = [];
+
+        foreach ($meeting->getPresenters() as $registrant) {
+            if ($registrant instanceof Presenter) {
+                $registeredPresenterIds[] = $registrant->getUser()->getId();
+            }
+        }
+
+        $presenterIdSelect->setSelected($registeredPresenterIds);
+
+        return $form;
+    }
+
+    /**
+     * Generates a meeting recording files management form.
+     * Takes action on validation.
+     *
+     * @param Meeting $meeting
+     *
+     * @throws Exception
+     *
+     * @return FormValidator
+     */
+    public function getFileForm($meeting, $returnURL)
+    {
+        $form = new FormValidator('fileForm', 'post', $_SERVER['REQUEST_URI']);
+        if (!$meeting->getRecordings()->isEmpty()) {
+            $fileIdSelect = $form->addSelect('fileIds', get_lang('Files'));
+            $fileIdSelect->setMultiple(true);
+            $recordingList = $meeting->getRecordings();
+            foreach ($recordingList as &$recording) {
+                // $recording->instanceDetails = $plugin->getPastMeetingInstanceDetails($instance->uuid);
+                $options = [];
+                $recordings = $recording->getRecordingMeeting()->recording_files;
+                foreach ($recordings as $file) {
+                    $options[] = [
+                        'text' => sprintf(
+                            '%s.%s (%s)',
+                            $file->recording_type,
+                            $file->file_type,
+                            $file->file_size
+                        ),
+                        'value' => $file->id,
+                    ];
+                }
+                $fileIdSelect->addOptGroup(
+                    $options,
+                    sprintf("%s (%s)", $recording->formattedStartTime, $recording->formattedDuration)
+                );
+            }
+            $actions = [];
+            if ($meeting->isCourseMeeting()) {
+                $actions['CreateLinkInCourse'] = $this->get_lang('CreateLinkInCourse');
+                $actions['CopyToCourse'] = $this->get_lang('CopyToCourse');
+            }
+            $actions['DeleteFile'] = $this->get_lang('DeleteFile');
+            $form->addRadio(
+                'action',
+                get_lang('Action'),
+                $actions
+            );
+            $form->addButtonUpdate($this->get_lang('DoIt'));
+            if ($form->validate()) {
+                $action = $form->getSubmitValue('action');
+                $idList = $form->getSubmitValue('fileIds');
+
+                foreach ($recordingList as $recording) {
+                    $recordings = $recording->getRecordingMeeting()->recording_files;
+
+                    foreach ($recordings as $file) {
+                        if (in_array($file->id, $idList)) {
+                            $name = sprintf(
+                                $this->get_lang('XRecordingOfMeetingXFromXDurationXDotX'),
+                                $file->recording_type,
+                                $meeting->getId(),
+                                $recording->formattedStartTime,
+                                $recording->formattedDuration,
+                                $file->file_type
+                            );
+                            if ('CreateLinkInCourse' === $action && $meeting->isCourseMeeting()) {
+                                try {
+                                    $this->createLinkToFileInCourse($meeting, $file, $name);
+                                    Display::addFlash(
+                                        Display::return_message(
+                                            $this->get_lang('LinkToFileWasCreatedInCourse'),
+                                            'success'
+                                        )
+                                    );
+                                } catch (Exception $exception) {
+                                    Display::addFlash(
+                                        Display::return_message($exception->getMessage(), 'error')
+                                    );
+                                }
+                            } elseif ('CopyToCourse' === $action && $meeting->isCourseMeeting()) {
+                                try {
+                                    $this->copyFileToCourse($meeting, $file, $name);
+                                    Display::addFlash(
+                                        Display::return_message($this->get_lang('FileWasCopiedToCourse'), 'confirm')
+                                    );
+                                } catch (Exception $exception) {
+                                    Display::addFlash(
+                                        Display::return_message($exception->getMessage(), 'error')
+                                    );
+                                }
+                            } elseif ('DeleteFile' === $action) {
+                                try {
+                                    $name = $file->recording_type;
+                                    $file->delete();
+                                    Display::addFlash(
+                                        Display::return_message($this->get_lang('FileWasDeleted').': '.$name, 'confirm')
+                                    );
+                                } catch (Exception $exception) {
+                                    Display::addFlash(
+                                        Display::return_message($exception->getMessage(), 'error')
+                                    );
+                                }
+                            }
+                        }
+                    }
+                }
+                api_location($returnURL);
+            }
+        }
+
+        return $form;
+    }
+
+    /**
+     * Adds to the meeting course documents a link to a meeting instance recording file.
+     *
+     * @param Meeting       $meeting
+     * @param RecordingFile $file
+     * @param string        $name
+     *
+     * @throws Exception
+     */
+    public function createLinkToFileInCourse($meeting, $file, $name)
+    {
+        $course = $meeting->getCourse();
+        if (null === $course) {
+            throw new Exception('This meeting is not linked to a course');
+        }
+        $courseInfo = api_get_course_info_by_id($course->getId());
+        if (empty($courseInfo)) {
+            throw new Exception('This meeting is not linked to a valid course');
+        }
+        $path = '/zoom_meeting_recording_file_'.$file->id.'.'.$file->file_type;
+        $docId = DocumentManager::addCloudLink($courseInfo, $path, $file->play_url, $name);
+        if (!$docId) {
+            throw new Exception(get_lang(DocumentManager::cloudLinkExists($courseInfo, $path, $file->play_url) ? 'UrlAlreadyExists' : 'ErrorAddCloudLink'));
+        }
+    }
+
+    /**
+     * Copies a recording file to a meeting's course.
+     *
+     * @param Meeting       $meeting
+     * @param RecordingFile $file
+     * @param string        $name
+     *
+     * @throws Exception
+     */
+    public function copyFileToCourse($meeting, $file, $name)
+    {
+        $course = $meeting->getCourse();
+        if (null === $course) {
+            throw new Exception('This meeting is not linked to a course');
+        }
+        $courseInfo = api_get_course_info_by_id($course->getId());
+        if (empty($courseInfo)) {
+            throw new Exception('This meeting is not linked to a valid course');
+        }
+        $tmpFile = tmpfile();
+        if (false === $tmpFile) {
+            throw new Exception('tmpfile() returned false');
+        }
+        $curl = curl_init($file->getFullDownloadURL($this->jwtClient->token));
+        if (false === $curl) {
+            throw new Exception('Could not init curl: '.curl_error($curl));
+        }
+        if (!curl_setopt_array(
+            $curl,
+            [
+                CURLOPT_FILE => $tmpFile,
+                CURLOPT_FOLLOWLOCATION => true,
+                CURLOPT_MAXREDIRS => 10,
+                CURLOPT_TIMEOUT => 120,
+            ]
+        )) {
+            throw new Exception("Could not set curl options: ".curl_error($curl));
+        }
+        if (false === curl_exec($curl)) {
+            throw new Exception("curl_exec failed: ".curl_error($curl));
+        }
+
+        $sessionId = 0;
+        $session = $meeting->getSession();
+        if (null !== $session) {
+            $sessionId = $session->getId();
+        }
+
+        $groupId = 0;
+        $group = $meeting->getGroup();
+        if (null !== $group) {
+            $groupId = $group->getIid();
+        }
+
+        $newPath = handle_uploaded_document(
+            $courseInfo,
+            [
+                'name' => $name,
+                'tmp_name' => stream_get_meta_data($tmpFile)['uri'],
+                'size' => filesize(stream_get_meta_data($tmpFile)['uri']),
+                'from_file' => true,
+                'move_file' => true,
+                'type' => $file->file_type,
+            ],
+            api_get_path(SYS_COURSE_PATH).$courseInfo['path'].'/document',
+            '/',
+            api_get_user_id(),
+            $groupId,
+            null,
+            0,
+            'overwrite',
+            true,
+            false,
+            null,
+            $sessionId,
+            true
+        );
+
+        fclose($tmpFile);
+        if (false === $newPath) {
+            throw new Exception('Could not handle uploaded document');
+        }
+    }
+
+    /**
+     * Generates a form to fast and easily create and start an instant meeting.
+     * On validation, create it then redirect to it and exit.
+     *
+     * @return FormValidator
+     */
+    public function getCreateInstantMeetingForm(
+        User $user,
+        Course $course,
+        CGroupInfo $group = null,
+        Session $session = null
+    ) {
+        $extraUrl = '';
+        if (!empty($course)) {
+            $extraUrl = api_get_cidreq();
+        }
+        $form = new FormValidator('createInstantMeetingForm', 'post', api_get_self().'?'.$extraUrl, '_blank');
+        $form->addButton('startButton', $this->get_lang('StartInstantMeeting'), 'video-camera', 'primary');
+        if ($form->validate()) {
+            try {
+                $this->startInstantMeeting($this->get_lang('InstantMeeting'), $user, $course, $group, $session);
+            } catch (Exception $exception) {
+                Display::addFlash(
+                    Display::return_message($exception->getMessage(), 'error')
+                );
+            }
+        }
+
+        return $form;
+    }
+
+    /**
+     * Generates a form to schedule a meeting.
+     * On validation, creates it and redirects to its page.
+     *
+     * @throws Exception
+     *
+     * @return FormValidator
+     */
+    public function getScheduleMeetingForm(User $user, Course $course = null, CGroupInfo $group = null, Session $session = null)
+    {
+        $extraUrl = '';
+        if (!empty($course)) {
+            $extraUrl = api_get_cidreq();
+        }
+        $form = new FormValidator('scheduleMeetingForm', 'post', api_get_self().'?'.$extraUrl);
+        $form->addHeader($this->get_lang('ScheduleAMeeting'));
+
+        $form->addSelect(
+            'conference_type',
+            $this->get_lang('ConferenceType'),
+            [
+                'meeting' => $this->get_lang('Meeting'),
+                'webinar' => $this->get_lang('Webinar'),
+            ]
+        );
+        $form->addRule('conference_type', get_lang('ThisFieldIsRequired'), 'required');
+
+        $startTimeDatePicker = $form->addDateTimePicker('startTime', get_lang('StartTime'));
+        $form->setRequired($startTimeDatePicker);
+
+        $form->addText('topic', $this->get_lang('Topic'), true);
+        $form->addTextarea('agenda', get_lang('Agenda'), ['maxlength' => 2000]);
+
+        $durationNumeric = $form->addNumeric('duration', $this->get_lang('DurationInMinutes'));
+        $form->setRequired($durationNumeric);
+
+        if (null === $course && 'true' === $this->get('enableGlobalConference')) {
+            $options = [];
+            $options['everyone'] = $this->get_lang('ForEveryone');
+            $options['registered_users'] = $this->get_lang('SomeUsers');
+            if (!empty($options)) {
+                if (1 === count($options)) {
+                    $form->addHidden('type', key($options));
+                } else {
+                    $form->addSelect('type', $this->get_lang('AudienceType'), $options);
+                }
+            }
+        } else {
+            // To course
+            $form->addHidden('type', 'course');
+        }
+
+        /*
+       // $passwordText = $form->addText('password', get_lang('Password'), false, ['maxlength' => '10']);
+       if (null !== $course) {
+           $registrationOptions = [
+               'RegisterAllCourseUsers' => $this->get_lang('RegisterAllCourseUsers'),
+           ];
+           $groups = GroupManager::get_groups();
+           if (!empty($groups)) {
+               $registrationOptions['RegisterTheseGroupMembers'] = get_lang('RegisterTheseGroupMembers');
+           }
+           $registrationOptions['RegisterNoUser'] = $this->get_lang('RegisterNoUser');
+           $userRegistrationRadio = $form->addRadio(
+               'userRegistration',
+               $this->get_lang('UserRegistration'),
+               $registrationOptions
+           );
+           $groupOptions = [];
+           foreach ($groups as $group) {
+               $groupOptions[$group['id']] = $group['name'];
+           }
+           $groupIdsSelect = $form->addSelect(
+               'groupIds',
+               $this->get_lang('RegisterTheseGroupMembers'),
+               $groupOptions
+           );
+           $groupIdsSelect->setMultiple(true);
+           if (!empty($groups)) {
+               $jsCode = sprintf(
+                   "getElementById('%s').parentNode.parentNode.parentNode.style.display = getElementById('%s').checked ? 'block' : 'none'",
+                   $groupIdsSelect->getAttribute('id'),
+                   $userRegistrationRadio->getelements()[1]->getAttribute('id')
+               );
+
+               $form->setAttribute('onchange', $jsCode);
+           }
+       }*/
+
+        $form->addCheckBox('sign_attendance', $this->get_lang('SignAttendance'), get_lang('Yes'));
+        $form->addTextarea('reason_to_sign', $this->get_lang('ReasonToSign'), ['rows' => 5]);
+
+        $accountEmails = $this->getAccountEmails();
+
+        if (!empty($accountEmails)) {
+            $form->addSelect('account_email', $this->get_lang('AccountEmail'), $accountEmails);
+        }
+
+        $form->addButtonCreate(get_lang('Save'));
+
+        if ($form->validate()) {
+            $formValues = $form->exportValues();
+            $conferenceType = $formValues['conference_type'];
+            $password = substr(uniqid('z', true), 0, 10);
+
+            switch ($formValues['type']) {
+                case 'everyone':
+                    $user = null;
+                    $group = null;
+                    $course = null;
+                    $session = null;
+
+                    break;
+                case 'registered_users':
+                    //$user = null;
+                    $course = null;
+                    $session = null;
+
+                    break;
+                case 'course':
+                    $user = null;
+                    //$course = null;
+                    //$session = null;
+
+                    break;
+            }
+
+            $accountEmail = $formValues['account_email'] ?? null;
+            $accountEmail = $accountEmail && in_array($accountEmail, $accountEmails) ? $accountEmail : null;
+
+            try {
+                $startTime = new DateTime($formValues['startTime']);
+
+                if ('meeting' === $conferenceType) {
+                    $newMeeting = $this->createScheduleMeeting(
+                        $user,
+                        $course,
+                        $group,
+                        $session,
+                        $startTime,
+                        $formValues['duration'],
+                        $formValues['topic'],
+                        $formValues['agenda'],
+                        $password,
+                        isset($formValues['sign_attendance']),
+                        $formValues['reason_to_sign'],
+                        $accountEmail
+                    );
+
+                    Display::addFlash(
+                        Display::return_message($this->get_lang('NewMeetingCreated'))
+                    );
+                } elseif ('webinar' === $conferenceType) {
+                    $newMeeting = $this->createScheduleWebinar(
+                        $user,
+                        $course,
+                        $group,
+                        $session,
+                        $startTime,
+                        $formValues['duration'],
+                        $formValues['topic'],
+                        $formValues['agenda'],
+                        $password,
+                        isset($formValues['sign_attendance']),
+                        $formValues['reason_to_sign'],
+                        $accountEmail
+                    );
+
+                    Display::addFlash(
+                        Display::return_message($this->get_lang('NewWebinarCreated'))
+                    );
+                } else {
+                    throw new Exception('Invalid conference type');
+                }
+
+                if ($newMeeting->isCourseMeeting()) {
+                    if ('RegisterAllCourseUsers' === $form->getSubmitValue('userRegistration')) {
+                        $this->registerAllCourseUsers($newMeeting);
+                        Display::addFlash(
+                            Display::return_message($this->get_lang('AllCourseUsersWereRegistered'))
+                        );
+                    } elseif ('RegisterTheseGroupMembers' === $form->getSubmitValue('userRegistration')) {
+                        $userIds = [];
+                        foreach ($form->getSubmitValue('groupIds') as $groupId) {
+                            $userIds = array_unique(array_merge($userIds, GroupManager::get_users($groupId)));
+                        }
+                        $users = Database::getManager()->getRepository('ChamiloUserBundle:User')->findBy(
+                            ['id' => $userIds]
+                        );
+                        $this->registerUsers($newMeeting, $users);
+                        Display::addFlash(
+                            Display::return_message($this->get_lang('GroupUsersWereRegistered'))
+                        );
+                    }
+                }
+                api_location('meeting.php?meetingId='.$newMeeting->getMeetingId().'&'.$extraUrl);
+            } catch (Exception $exception) {
+                Display::addFlash(
+                    Display::return_message($exception->getMessage(), 'error')
+                );
+            }
+        } else {
+            $form->setDefaults(
+                [
+                    'duration' => 60,
+                    'userRegistration' => 'RegisterAllCourseUsers',
+                ]
+            );
+        }
+
+        return $form;
+    }
+
+    /**
+     * Return the current global meeting (create it if needed).
+     *
+     * @throws Exception
+     *
+     * @return string
+     */
+    public function getGlobalMeeting()
+    {
+        foreach ($this->getMeetingRepository()->unfinishedGlobalMeetings() as $meeting) {
+            return $meeting;
+        }
+
+        return $this->createGlobalMeeting();
+    }
+
+    /**
+     * @return MeetingRepository|EntityRepository
+     */
+    public static function getMeetingRepository()
+    {
+        return Database::getManager()->getRepository(Meeting::class);
+    }
+
+    /**
+     * Returns the URL to enter (start or join) a meeting or null if not possible to enter the meeting,
+     * The returned URL depends on the meeting current status (waiting, started or finished) and the current user.
+     *
+     * @throws OptimisticLockException
+     * @throws Exception
+     *
+     * @return string|null
+     */
+    public function getStartOrJoinMeetingURL(Meeting $meeting)
+    {
+        if ($meeting instanceof Webinar) {
+            $status = 'started';
+        } else {
+            $status = $meeting->getMeetingInfoGet()->status;
+        }
+
+        $userId = api_get_user_id();
+        $currentUser = api_get_user_entity($userId);
+        $isGlobal = 'true' === $this->get('enableGlobalConference') && $meeting->isGlobalMeeting();
+
+        switch ($status) {
+            case 'ended':
+                if ($this->userIsConferenceManager($meeting)) {
+                    return $meeting->getMeetingInfoGet()->start_url;
+                }
+                break;
+            case 'waiting':
+                // Zoom does not allow for a new meeting to be started on first participant join.
+                // It requires the host to start the meeting first.
+                // Therefore for global meetings we must make the first participant the host
+                // that is use start_url rather than join_url.
+                // the participant will not be registered and will appear as the Zoom user account owner.
+                // For course and user meetings, only the host can start the meeting.
+                if ($this->userIsConferenceManager($meeting)) {
+                    return $meeting->getMeetingInfoGet()->start_url;
+                }
+
+                break;
+            case 'started':
+                // User per conference.
+                if ($currentUser === $meeting->getUser()) {
+                    return $meeting instanceof Webinar
+                        ? $meeting->getWebinarSchema()->start_url
+                        : $meeting->getMeetingInfoGet()->join_url;
+                }
+
+                // The participant is not registered, he can join only the global meeting (automatic registration).
+                if ($isGlobal) {
+                    return $this->registerUser($meeting, $currentUser)->getCreatedRegistration()->join_url;
+                }
+
+                if ($meeting->isCourseMeeting()) {
+                    if ($this->userIsCourseConferenceManager()) {
+                        return $meeting instanceof Webinar
+                            ? $meeting->getWebinarSchema()->start_url
+                            : $meeting->getMeetingInfoGet()->start_url;
+                    }
+
+                    $sessionId = api_get_session_id();
+                    $courseCode = api_get_course_id();
+
+                    if (empty($sessionId)) {
+                        $isSubscribed = CourseManager::is_user_subscribed_in_course(
+                            $userId,
+                            $courseCode,
+                            false
+                        );
+                    } else {
+                        $isSubscribed = CourseManager::is_user_subscribed_in_course(
+                            $userId,
+                            $courseCode,
+                            true,
+                            $sessionId
+                        );
+                    }
+
+                    if ($isSubscribed) {
+                        if ($meeting->isCourseGroupMeeting()) {
+                            $groupInfo = GroupManager::get_group_properties($meeting->getGroup()->getIid(), true);
+                            $isInGroup = GroupManager::is_user_in_group($userId, $groupInfo);
+                            if (false === $isInGroup) {
+                                throw new Exception($this->get_lang('YouAreNotRegisteredToThisMeeting'));
+                            }
+                        }
+
+                        if (!$meeting instanceof Webinar
+                            && \Chamilo\PluginBundle\Zoom\API\Meeting::TYPE_INSTANT == $meeting->getMeetingInfoGet()->type
+                        ) {
+                            return $meeting->getMeetingInfoGet()->join_url;
+                        }
+
+                        return $this->registerUser($meeting, $currentUser)->getCreatedRegistration()->join_url;
+                    }
+
+                    throw new Exception($this->get_lang('YouAreNotRegisteredToThisMeeting'));
+                }
+
+                //if ('true' === $this->get('enableParticipantRegistration')) {
+                    //if ('true' === $this->get('enableParticipantRegistration') && $meeting->requiresRegistration()) {
+                    // the participant must be registered
+                    $registrant = $meeting->getRegistrantByUser($currentUser);
+                    if (null == $registrant) {
+                        throw new Exception($this->get_lang('YouAreNotRegisteredToThisMeeting'));
+                    }
+
+                    // the participant is registered
+                    return $registrant->getCreatedRegistration()->join_url;
+                //}
+                break;
+        }
+
+        return null;
+    }
+
+    /**
+     * @param Meeting $meeting
+     *
+     * @return bool whether the logged-in user can manage conferences in this context, that is either
+     *              the current course or session coach, the platform admin or the current course admin
+     */
+    public function userIsConferenceManager($meeting)
+    {
+        if (null === $meeting) {
+            return false;
+        }
+
+        if (api_is_coach() || api_is_platform_admin()) {
+            return true;
+        }
+
+        if ($meeting->isCourseMeeting() && api_get_course_id() && api_is_course_admin()) {
+            return true;
+        }
+
+        $currentUser = api_get_user_entity(api_get_user_id());
+
+        if ('true' === $this->get('enableParticipantRegistration')
+            && 'true' === $this->get('enablePresenter')
+            && $currentUser
+            && $meeting->hasUserAsPresenter($currentUser)
+        ) {
+            return true;
+        }
+
+        return $meeting->isUserMeeting() && $meeting->getUser()->getId() == api_get_user_id();
+    }
+
+    /**
+     * @return bool whether the logged-in user can manage conferences in this context, that is either
+     *              the current course or session coach, the platform admin or the current course admin
+     */
+    public function userIsCourseConferenceManager()
+    {
+        if (api_is_coach() || api_is_platform_admin()) {
+            return true;
+        }
+
+        if (api_get_course_id() && api_is_course_admin()) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Update local recording list from remote Zoom server's version.
+     * Kept to implement a future administration button ("import existing data from zoom server").
+     *
+     * @param DateTime $startDate
+     * @param DateTime $endDate
+     *
+     * @throws OptimisticLockException
+     * @throws Exception
+     */
+    public function reloadPeriodRecordings($startDate, $endDate)
+    {
+        $em = Database::getManager();
+        $recordingRepo = $this->getRecordingRepository();
+        $meetingRepo = $this->getMeetingRepository();
+        $recordings = RecordingList::loadPeriodRecordings($startDate, $endDate);
+
+        foreach ($recordings as $recordingMeeting) {
+            $recordingEntity = $recordingRepo->findOneBy(['uuid' => $recordingMeeting->uuid]);
+            if (null === $recordingEntity) {
+                $recordingEntity = new Recording();
+                $meeting = $meetingRepo->findOneBy(['meetingId' => $recordingMeeting->id]);
+                if (null === $meeting) {
+                    try {
+                        $meetingInfoGet = MeetingInfoGet::fromId($recordingMeeting->id);
+                    } catch (Exception $exception) {
+                        $meetingInfoGet = null; // deleted meeting with recordings
+                    }
+                    if (null !== $meetingInfoGet) {
+                        $meeting = $this->createMeetingFromMeeting(
+                            (new Meeting())->setMeetingInfoGet($meetingInfoGet)
+                        );
+                        $em->persist($meeting);
+                    }
+                }
+                if (null !== $meeting) {
+                    $recordingEntity->setMeeting($meeting);
+                }
+            }
+            $recordingEntity->setRecordingMeeting($recordingMeeting);
+            $em->persist($recordingEntity);
+        }
+        $em->flush();
+    }
+
+    /**
+     * @return RecordingRepository|EntityRepository
+     */
+    public static function getRecordingRepository()
+    {
+        return Database::getManager()->getRepository(Recording::class);
+    }
+
+    public function getToolbar(string $returnUrl = ''): string
+    {
+        $isPlatformOrSessionAdmin = api_is_platform_admin(true);
+        $isSessionAdmin = api_is_session_admin();
+
+        if (!$isPlatformOrSessionAdmin) {
+            return '';
+        }
+
+        $actionsLeft = '';
+        $back = '';
+        $courseId = api_get_course_id();
+        if (empty($courseId)) {
+            $actionsLeft .=
+                Display::url(
+                    Display::return_icon('bbb.png', $this->get_lang('Meetings'), null, ICON_SIZE_MEDIUM),
+                    api_get_path(WEB_PLUGIN_PATH).'zoom/meetings.php'
+                );
+        } else {
+            $actionsLeft .=
+                Display::url(
+                    Display::return_icon('bbb.png', $this->get_lang('Meetings'), null, ICON_SIZE_MEDIUM),
+                    api_get_path(WEB_PLUGIN_PATH).'zoom/start.php?'.api_get_cidreq()
+                );
+        }
+
+        if (!empty($returnUrl)) {
+            $back = Display::url(
+                Display::return_icon('back.png', get_lang('Back'), null, ICON_SIZE_MEDIUM),
+                $returnUrl
+            );
+        }
+
+        if (!$isSessionAdmin) {
+            $actionsLeft .= Display::url(
+                Display::return_icon('agenda.png', get_lang('Calendar'), [], ICON_SIZE_MEDIUM),
+                'calendar.php'
+            );
+
+            $actionsLeft .= Display::url(
+                Display::return_icon('settings.png', get_lang('Settings'), null, ICON_SIZE_MEDIUM),
+                api_get_path(WEB_CODE_PATH).'admin/configure_plugin.php?name=zoom'
+            );
+        }
+
+        return Display::toolbarAction('toolbar', [$back.PHP_EOL.$actionsLeft]);
+    }
+
+    public function getRecordingSetting()
+    {
+        $recording = (string) $this->get('enableCloudRecording');
+
+        if (in_array($recording, [self::RECORDING_TYPE_LOCAL, self::RECORDING_TYPE_CLOUD], true)) {
+            return $recording;
+        }
+
+        return self::RECORDING_TYPE_NONE;
+    }
+
+    public function hasRecordingAvailable()
+    {
+        $recording = $this->getRecordingSetting();
+
+        return self::RECORDING_TYPE_NONE !== $recording;
+    }
+
+    /**
+     * @throws OptimisticLockException
+     * @throws \Doctrine\ORM\ORMException
+     */
+    public function saveSignature(Registrant $registrant, string $file): bool
+    {
+        if (empty($file)) {
+            return false;
+        }
+
+        $signature = $registrant->getSignature();
+
+        if (null !== $signature) {
+            return false;
+        }
+
+        $signature = new Signature();
+        $signature
+            ->setFile($file)
+            ->setRegisteredAt(api_get_utc_datetime(null, false, true))
+        ;
+
+        $registrant->setSignature($signature);
+
+        $em = Database::getManager();
+        $em->persist($signature);
+        $em->flush();
+
+        return true;
+    }
+
+    public function getSignature(int $userId, Meeting $meeting): ?Signature
+    {
+        $signatureRepo = Database::getManager()
+            ->getRepository(Signature::class)
+        ;
+
+        return $signatureRepo->findOneBy(['user' => $userId, 'meeting' => $meeting]);
+    }
+
+    public function exportSignatures(Meeting $meeting, $formatToExport)
+    {
+        $signatures = array_map(
+            function (Registrant $registrant) use ($formatToExport) {
+                $signature = $registrant->getSignature();
+
+                $item = [
+                    $registrant->getUser()->getLastname(),
+                    $registrant->getUser()->getFirstname(),
+                    $signature
+                        ? api_convert_and_format_date($signature->getRegisteredAt(), DATE_TIME_FORMAT_LONG)
+                        : '-',
+                ];
+
+                if ('pdf' === $formatToExport) {
+                    $item[] = $signature
+                        ? Display::img($signature->getFile(), '', ['style' => 'width: 150px;'], false)
+                        : '-';
+                }
+
+                return $item;
+            },
+            $meeting->getRegistrants()->toArray()
+        );
+
+        $data = array_merge(
+            [
+                [
+                    get_lang('LastName'),
+                    get_lang('FirstName'),
+                    get_lang('DateTime'),
+                    'pdf' === $formatToExport ? get_lang('File') : null,
+                ],
+            ],
+            $signatures
+        );
+
+        if ('pdf' === $formatToExport) {
+            $params = [
+                'filename' => get_lang('Attendance'),
+                'pdf_title' => get_lang('Attendance'),
+                'pdf_description' => $meeting->getIntroduction(),
+                'show_teacher_as_myself' => false,
+            ];
+
+            Export::export_table_pdf($data, $params);
+        }
+
+        if ('xls' === $formatToExport) {
+            $introduction = array_map(
+                function ($line) {
+                    return [
+                        strip_tags(trim($line)),
+                    ];
+                },
+                explode(PHP_EOL, $meeting->getIntroduction())
+            );
+
+            Export::arrayToXls(
+                array_merge($introduction, $data),
+                get_lang('Attendance')
+            );
+        }
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function createWebinarFromSchema(Webinar $webinar, WebinarSchema $schema): Webinar
+    {
+        $currentUser = api_get_user_entity(api_get_user_id());
+
+        $schema->settings->contact_email = $currentUser->getEmail();
+        $schema->settings->contact_name = $currentUser->getFullname();
+        $schema->settings->auto_recording = $this->getRecordingSetting();
+        $schema->settings->registrants_email_notification = false;
+        $schema->settings->attendees_and_panelists_reminder_email_notification->enable = false;
+        $schema->settings->follow_up_attendees_email_notification->enable = false;
+        $schema->settings->follow_up_absentees_email_notification->enable = false;
+
+        $schema = $schema->create($webinar->getAccountEmail());
+
+        $webinar->setWebinarSchema($schema);
+
+        $em = Database::getManager();
+        $em->persist($webinar);
+        $em->flush();
+
+        return $webinar;
+    }
+
+    public function getAccountEmails(): array
+    {
+        $currentValue = $this->get('accountSelector');
+
+        if (empty($currentValue)) {
+            return [];
+        }
+
+        $emails = explode(';', $currentValue);
+        $trimmed = array_map('trim', $emails);
+        $filtered = array_filter($trimmed);
+
+        return array_combine($filtered, $filtered);
+    }
+
+    /**
+     * Register users to a meeting.
+     *
+     * @param User[] $users
+     *
+     * @throws OptimisticLockException
+     *
+     * @return User[] failed registrations [ user id => errorMessage ]
+     */
+    public function registerUsers(Meeting $meeting, array $users)
+    {
+        $failedUsers = [];
+        foreach ($users as $user) {
+            try {
+                $this->registerUser($meeting, $user, false);
+            } catch (Exception $exception) {
+                $failedUsers[$user->getId()] = $exception->getMessage();
+            }
+        }
+        Database::getManager()->flush();
+
+        return $failedUsers;
+    }
+
+    /**
+     * @param array $users
+     *
+     * @throws OptimisticLockException
+     * @throws \Doctrine\ORM\ORMException
+     */
+    public function registerPresenters(Meeting $meeting, array $users): array
+    {
+        $failedUsers = [];
+
+        foreach ($users as $user) {
+            try {
+                $this->registerUser($meeting, $user, false, true);
+            } catch (Exception $exception) {
+                $failedUsers[$user->getId()] = $exception->getMessage();
+            }
+        }
+
+        Database::getManager()->flush();
+
+        return $failedUsers;
+    }
+
+    /**
+     * Removes registrants from a meeting.
+     *
+     * @param Registrant[] $registrants
+     *
+     * @throws Exception
+     */
+    public function unregister(Meeting $meeting, array $registrants)
+    {
+        $meetingRegistrants = [];
+        foreach ($registrants as $registrant) {
+            $meetingRegistrants[] = $registrant->getMeetingRegistrant();
+        }
+
+        if ($meeting instanceof Webinar) {
+            $meeting->getWebinarSchema()->removeRegistrants($meetingRegistrants);
+        } else {
+            $meeting->getMeetingInfoGet()->removeRegistrants($meetingRegistrants);
+        }
+
+        $em = Database::getManager();
+        foreach ($registrants as $registrant) {
+            $em->remove($registrant);
+        }
+        $em->flush();
+    }
+
+    /**
+     * Updates meeting registrants list. Adds the missing registrants and removes the extra.
+     *
+     * @param Meeting $meeting
+     * @param User[]  $users   list of users to be registered
+     *
+     * @throws Exception
+     */
+    private function updateRegistrantList($meeting, $users)
+    {
+        $usersToAdd = [];
+        foreach ($users as $user) {
+            $found = false;
+            foreach ($meeting->getRegistrants() as $registrant) {
+                if ($registrant->getUser() === $user) {
+                    $found = true;
+                    break;
+                }
+            }
+            if (!$found) {
+                $usersToAdd[] = $user;
+            }
+        }
+        $registrantsToRemove = [];
+        foreach ($meeting->getRegistrants() as $registrant) {
+            $found = false;
+            foreach ($users as $user) {
+                if ($registrant->getUser() === $user) {
+                    $found = true;
+                    break;
+                }
+            }
+            if (!$found) {
+                $registrantsToRemove[] = $registrant;
+            }
+        }
+        $this->registerUsers($meeting, $usersToAdd);
+        $this->unregister($meeting, $registrantsToRemove);
+    }
+
+    private function updatePresenterList($meeting, $users)
+    {
+        /** @var array $presenters */
+        $presenters = $meeting->getPresenters();
+
+        $presenterToAdd = [];
+
+        foreach ($users as $user) {
+            $foundPresenter = false;
+
+            foreach ($presenters as $presenter) {
+                if ($presenter->getUser() === $user) {
+                    $foundPresenter = true;
+
+                    break;
+                }
+            }
+
+            if (!$foundPresenter) {
+                $presenterToAdd[] = $user;
+            }
+        }
+
+        $registrantsToRemove = [];
+
+        foreach ($presenters as $registrant) {
+            $found = false;
+            foreach ($users as $user) {
+                if ($registrant->getUser() === $user) {
+                    $found = true;
+                    break;
+                }
+            }
+            if (!$found) {
+                $registrantsToRemove[] = $registrant;
+            }
+        }
+
+        $this->registerPresenters($meeting, $presenterToAdd);
+        $this->unregister($meeting, $registrantsToRemove);
+    }
+
+    /**
+     * @throws Exception
+     * @throws OptimisticLockException
+     *
+     * @return Registrant
+     */
+    private function registerUser(Meeting $meeting, User $user, $andFlush = true, bool $isPresenter = false)
+    {
+        if (empty($user->getEmail())) {
+            throw new Exception($this->get_lang('CannotRegisterWithoutEmailAddress'));
+        }
+
+        if ($meeting instanceof Webinar) {
+            $meetingRegistrant = WebinarRegistrantSchema::fromEmailAndFirstName(
+                $user->getEmail(),
+                $user->getFirstname(),
+                $user->getLastname()
+            );
+        } else {
+            $meetingRegistrant = MeetingRegistrant::fromEmailAndFirstName(
+                $user->getEmail(),
+                $user->getFirstname(),
+                $user->getLastname()
+            );
+        }
+
+        $registrantEntity = new Registrant();
+
+        if ($isPresenter) {
+            $registrantEntity = new Presenter();
+        }
+
+        $registrantEntity
+            ->setMeeting($meeting)
+            ->setUser($user)
+            ->setMeetingRegistrant($meetingRegistrant)
+        ;
+
+        if ($meeting instanceof Webinar) {
+            $registrantEntity->setCreatedRegistration($meeting->getWebinarSchema()->addRegistrant($meetingRegistrant));
+        } else {
+            $registrantEntity->setCreatedRegistration($meeting->getMeetingInfoGet()->addRegistrant($meetingRegistrant));
+        }
+
+        Database::getManager()->persist($registrantEntity);
+
+        if ($andFlush) {
+            Database::getManager()->flush($registrantEntity);
+        }
+
+        return $registrantEntity;
+    }
+
+    /**
+     * Starts a new instant meeting and redirects to its start url.
+     *
+     * @param string          $topic
+     * @param User|null       $user
+     * @param Course|null     $course
+     * @param CGroupInfo|null $group
+     * @param Session|null    $session
+     *
+     * @throws Exception
+     */
+    private function startInstantMeeting($topic, $user = null, $course = null, $group = null, $session = null)
+    {
+        $meetingInfoGet = MeetingInfoGet::fromTopicAndType($topic, MeetingInfoGet::TYPE_INSTANT);
+        //$meetingInfoGet->settings->approval_type = MeetingSettings::APPROVAL_TYPE_AUTOMATICALLY_APPROVE;
+        $meeting = $this->createMeetingFromMeeting(
+            (new Meeting())
+                ->setMeetingInfoGet($meetingInfoGet)
+                ->setUser($user)
+                ->setGroup($group)
+                ->setCourse($course)
+                ->setSession($session)
+        );
+        api_location($meeting->getMeetingInfoGet()->start_url);
+    }
+
+    /**
+     * Creates a meeting on Zoom servers and stores it in the local database.
+     *
+     * @param Meeting $meeting a new, unsaved meeting with at least a type and a topic
+     *
+     * @throws Exception
+     *
+     * @return Meeting
+     */
+    private function createMeetingFromMeeting($meeting)
+    {
+        $currentUser = api_get_user_entity(api_get_user_id());
+
+        $meeting->getMeetingInfoGet()->settings->contact_email = $currentUser->getEmail();
+        $meeting->getMeetingInfoGet()->settings->contact_name = $currentUser->getFullname();
+        $meeting->getMeetingInfoGet()->settings->auto_recording = $this->getRecordingSetting();
+        $meeting->getMeetingInfoGet()->settings->registrants_email_notification = false;
+
+        //$meeting->getMeetingInfoGet()->host_email = $currentUser->getEmail();
+        //$meeting->getMeetingInfoGet()->settings->alternative_hosts = $currentUser->getEmail();
+
+        // Send create to Zoom.
+        $meeting->setMeetingInfoGet(
+            $meeting->getMeetingInfoGet()->create(
+                $meeting->getAccountEmail()
+            )
+        );
+
+        Database::getManager()->persist($meeting);
+        Database::getManager()->flush();
+
+        return $meeting;
+    }
+
+    /**
+     * @throws Exception
+     *
+     * @return Meeting
+     */
+    private function createGlobalMeeting()
+    {
+        $meetingInfoGet = MeetingInfoGet::fromTopicAndType(
+            $this->get_lang('GlobalMeeting'),
+            MeetingInfoGet::TYPE_SCHEDULED
+        );
+        $meetingInfoGet->start_time = (new DateTime())->format(DATE_ATOM);
+        $meetingInfoGet->duration = 60;
+        $meetingInfoGet->settings->approval_type =
+            ('true' === $this->get('enableParticipantRegistration'))
+                ? MeetingSettings::APPROVAL_TYPE_AUTOMATICALLY_APPROVE
+                : MeetingSettings::APPROVAL_TYPE_NO_REGISTRATION_REQUIRED;
+        // $meetingInfoGet->settings->host_video = true;
+        $meetingInfoGet->settings->participant_video = true;
+        $meetingInfoGet->settings->join_before_host = true;
+        $meetingInfoGet->settings->registrants_email_notification = false;
+
+        return $this->createMeetingFromMeeting((new Meeting())->setMeetingInfoGet($meetingInfoGet));
+    }
+
+    /**
+     * Schedules a meeting and returns it.
+     * set $course, $session and $user to null in order to create a global meeting.
+     *
+     * @param DateTime $startTime meeting local start date-time (configure local timezone on your Zoom account)
+     * @param int      $duration  in minutes
+     * @param string   $topic     short title of the meeting, required
+     * @param string   $agenda    ordre du jour
+     * @param string   $password  meeting password
+     *
+     * @throws Exception
+     *
+     * @return Meeting meeting
+     */
+    private function createScheduleMeeting(
+        User $user = null,
+        Course $course = null,
+        CGroupInfo $group = null,
+        Session $session = null,
+        $startTime,
+        $duration,
+        $topic,
+        $agenda,
+        $password,
+        bool $signAttendance = false,
+        string $reasonToSignAttendance = '',
+        string $accountEmail = null
+    ) {
+        $meetingInfoGet = MeetingInfoGet::fromTopicAndType($topic, MeetingInfoGet::TYPE_SCHEDULED);
+        $meetingInfoGet->duration = $duration;
+        $meetingInfoGet->start_time = $startTime->format(DATE_ATOM);
+        $meetingInfoGet->agenda = $agenda;
+        $meetingInfoGet->password = $password;
+        $meetingInfoGet->settings->approval_type = MeetingSettings::APPROVAL_TYPE_NO_REGISTRATION_REQUIRED;
+        if ('true' === $this->get('enableParticipantRegistration')) {
+            $meetingInfoGet->settings->approval_type = MeetingSettings::APPROVAL_TYPE_AUTOMATICALLY_APPROVE;
+        }
+
+        return $this->createMeetingFromMeeting(
+            (new Meeting())
+                ->setMeetingInfoGet($meetingInfoGet)
+                ->setUser($user)
+                ->setCourse($course)
+                ->setGroup($group)
+                ->setSession($session)
+                ->setSignAttendance($signAttendance)
+                ->setReasonToSignAttendance($reasonToSignAttendance)
+                ->setAccountEmail($accountEmail)
+        );
+    }
+
+    /**
+     * @throws Exception
+     */
+    private function createScheduleWebinar(
+        ?User $user,
+        ?Course $course,
+        ?CGroupInfo $group,
+        ?Session $session,
+        DateTime $startTime,
+        $duration,
+        $topic,
+        $agenda,
+        $password,
+        bool $signAttendance = false,
+        string $reasonToSignAttendance = '',
+        string $accountEmail = null
+    ): Webinar {
+        $webinarSchema = WebinarSchema::fromTopicAndType($topic);
+        $webinarSchema->duration = $duration;
+        $webinarSchema->start_time = $startTime->format(DATE_ATOM);
+        $webinarSchema->agenda = $agenda;
+        $webinarSchema->password = $password;
+
+        if ('true' === $this->get('enableParticipantRegistration')) {
+            $webinarSchema->settings->approval_type = WebinarSettings::APPROVAL_TYPE_AUTOMATICALLY_APPROVE;
+        }
+
+        $webinar = (new Webinar())
+            ->setUser($user)
+            ->setCourse($course)
+            ->setGroup($group)
+            ->setSession($session)
+            ->setSignAttendance($signAttendance)
+            ->setReasonToSignAttendance($reasonToSignAttendance)
+            ->setAccountEmail($accountEmail)
+        ;
+
+        return $this->createWebinarFromSchema($webinar, $webinarSchema);
+    }
+
+    /**
+     * Registers all the course users to a course meeting.
+     *
+     * @param Meeting $meeting
+     *
+     * @throws OptimisticLockException
+     */
+    private function registerAllCourseUsers($meeting)
+    {
+        $this->registerUsers($meeting, $meeting->getRegistrableUsers());
+    }
+}
diff --git a/plugin/zoom/meeting.ajax.php b/plugin/zoom/meeting.ajax.php
new file mode 100644
index 000000000..a3aa888a5
--- /dev/null
+++ b/plugin/zoom/meeting.ajax.php
@@ -0,0 +1,50 @@
+get('meetingId', 0);
+
+if (empty($meetingId)) {
+    api_not_allowed();
+}
+
+$plugin = ZoomPlugin::create();
+/** @var Meeting $meeting */
+$meeting = $plugin->getMeetingRepository()->findOneBy(['meetingId' => $meetingId]);
+$currentUserId = api_get_user_id();
+$currentUser = api_get_user_entity($currentUserId);
+
+if (null === $meeting) {
+    api_not_allowed(false, $plugin->get_lang('MeetingNotFound'));
+}
+
+switch ($httpRequest->get('a')) {
+    case 'sign_attempt':
+        $registrant = $meeting->getRegistrantByUser($currentUser);
+
+        if (!$meeting->isSignAttendance() ||
+            null === $registrant
+        ) {
+            api_not_allowed();
+        }
+
+        $file = $httpRequest->request->get('file', '');
+
+        $secToken = Security::get_token('zoom_signature');
+
+        if (!Security::check_token($secToken, null, 'zoom_signature')) {
+            api_not_allowed();
+        }
+
+        echo (int) $plugin->saveSignature($registrant, $file);
+        exit;
+}
diff --git a/plugin/zoom/meeting.php b/plugin/zoom/meeting.php
new file mode 100644
index 000000000..185932b72
--- /dev/null
+++ b/plugin/zoom/meeting.php
@@ -0,0 +1,110 @@
+getMeetingRepository()->findOneBy(['meetingId' => $meetingId]);
+
+if (null === $meeting) {
+    api_not_allowed(true, $plugin->get_lang('MeetingNotFound'));
+}
+
+$course_plugin = 'zoom'; // needed in order to load the plugin lang variables
+$returnURL = 'meetings.php';
+$urlExtra = '';
+if ($meeting->isCourseMeeting()) {
+    api_protect_course_script(true);
+    $this_section = SECTION_COURSES;
+    $urlExtra = api_get_cidreq();
+    $returnURL = 'start.php?'.$urlExtra;
+
+    if (api_is_in_group()) {
+        $interbreadcrumb[] = [
+            'url' => api_get_path(WEB_CODE_PATH).'group/group.php?'.$urlExtra,
+            'name' => get_lang('Groups'),
+        ];
+        $interbreadcrumb[] = [
+            'url' => api_get_path(WEB_CODE_PATH).'group/group_space.php?'.$urlExtra,
+            'name' => get_lang('GroupSpace').' '.$meeting->getGroup()->getName(),
+        ];
+    }
+}
+
+$logInfo = [
+    'tool' => 'Videoconference Zoom',
+];
+Event::registerLog($logInfo);
+
+$interbreadcrumb[] = [
+    'url' => $returnURL,
+    'name' => $plugin->get_lang('ZoomVideoConferences'),
+];
+
+$tpl = new Template($meeting->getMeetingId());
+
+if ($plugin->userIsConferenceManager($meeting)) {
+    // user can edit, start and delete meeting
+    $tpl->assign('isConferenceManager', true);
+
+    $tpl->assign('editMeetingForm', $plugin->getEditConferenceForm($meeting)->returnForm());
+
+    if ($meeting instanceof Webinar) {
+        $tpl->assign('deleteMeetingForm', $plugin->getDeleteWebinarForm($meeting, $returnURL)->returnForm());
+    } elseif ($meeting instanceof Meeting) {
+        $tpl->assign('deleteMeetingForm', $plugin->getDeleteMeetingForm($meeting, $returnURL)->returnForm());
+    }
+
+    $pluginEnableParticipantRegistration = 'true' === $plugin->get('enableParticipantRegistration');
+
+    if ($pluginEnableParticipantRegistration && $meeting->requiresRegistration()) {
+        if (false === $meeting->isGlobalMeeting()
+            && false == $meeting->isCourseMeeting()
+        ) {
+            $tpl->assign('registerParticipantForm', $plugin->getRegisterParticipantForm($meeting)->returnForm());
+            $tpl->assign('registrants', $meeting->getRegistrants());
+        }
+
+        if ('true' === $plugin->get('enablePresenter') && !$meeting->isCourseMeeting()) {
+            $tpl->assign('registerPresenterForm', $plugin->getRegisterPresenterForm($meeting)->returnForm());
+            $tpl->assign('presenters', $meeting->getPresenters());
+        }
+    }
+
+    if (ZoomPlugin::RECORDING_TYPE_NONE !== $plugin->getRecordingSetting() &&
+        $meeting->hasCloudAutoRecordingEnabled()
+    ) {
+        $tpl->assign('fileForm', $plugin->getFileForm($meeting, $returnURL)->returnForm());
+        $tpl->assign('recordings', $meeting->getRecordings());
+    }
+} elseif ($meeting->requiresRegistration()) {
+    $userId = api_get_user_id();
+    try {
+        foreach ($meeting->getRegistrants() as $registrant) {
+            if ($registrant->getUser()->getId() == $userId) {
+                $tpl->assign('currentUserJoinURL', $registrant->getJoinUrl());
+                break;
+            }
+        }
+    } catch (Exception $exception) {
+        Display::addFlash(
+            Display::return_message($exception->getMessage(), 'error')
+        );
+    }
+}
+
+$tpl->assign('actions', $plugin->getToolbar());
+$tpl->assign('meeting', $meeting);
+$tpl->assign('url_extra', $urlExtra);
+$tpl->assign('content', $tpl->fetch('zoom/view/meeting.tpl'));
+$tpl->display_one_col_template();
diff --git a/plugin/zoom/meetings.php b/plugin/zoom/meetings.php
new file mode 100644
index 000000000..fb2b6e760
--- /dev/null
+++ b/plugin/zoom/meetings.php
@@ -0,0 +1,28 @@
+getAdminSearchForm();
+$startDate = new DateTime($form->getElement('start')->getValue());
+$endDate = new DateTime($form->getElement('end')->getValue());
+$scheduleForm = $plugin->getScheduleMeetingForm($user);
+$tpl = new Template();
+$tpl->assign('meetings', $plugin->getMeetingRepository()->periodUserMeetings($startDate, $endDate, $user));
+$tpl->assign('allow_recording', $plugin->hasRecordingAvailable());
+$tpl->assign('actions', $plugin->getToolbar());
+$tpl->assign('search_form', $form->returnForm());
+$tpl->assign('schedule_form', $scheduleForm->returnForm());
+$tpl->assign('content', $tpl->fetch('zoom/view/meetings.tpl'));
+$tpl->display_one_col_template();
diff --git a/plugin/zoom/plugin.php b/plugin/zoom/plugin.php
new file mode 100644
index 000000000..8db7cffa8
--- /dev/null
+++ b/plugin/zoom/plugin.php
@@ -0,0 +1,4 @@
+get_info();
diff --git a/plugin/zoom/resources/img/22/zoom_meet.png b/plugin/zoom/resources/img/22/zoom_meet.png
new file mode 100644
index 000000000..8d3ba9a97
Binary files /dev/null and b/plugin/zoom/resources/img/22/zoom_meet.png differ
diff --git a/plugin/zoom/resources/img/22/zoom_meet_na.png b/plugin/zoom/resources/img/22/zoom_meet_na.png
new file mode 100644
index 000000000..fa984bf57
Binary files /dev/null and b/plugin/zoom/resources/img/22/zoom_meet_na.png differ
diff --git a/plugin/zoom/resources/img/32/zoom_meet.png b/plugin/zoom/resources/img/32/zoom_meet.png
new file mode 100644
index 000000000..6bc147aa4
Binary files /dev/null and b/plugin/zoom/resources/img/32/zoom_meet.png differ
diff --git a/plugin/zoom/resources/img/32/zoom_meet_na.png b/plugin/zoom/resources/img/32/zoom_meet_na.png
new file mode 100644
index 000000000..28b3a7ce0
Binary files /dev/null and b/plugin/zoom/resources/img/32/zoom_meet_na.png differ
diff --git a/plugin/zoom/resources/img/64/zoom_meet.png b/plugin/zoom/resources/img/64/zoom_meet.png
new file mode 100644
index 000000000..798ecbe65
Binary files /dev/null and b/plugin/zoom/resources/img/64/zoom_meet.png differ
diff --git a/plugin/zoom/resources/img/64/zoom_meet_na.png b/plugin/zoom/resources/img/64/zoom_meet_na.png
new file mode 100644
index 000000000..e313c79a1
Binary files /dev/null and b/plugin/zoom/resources/img/64/zoom_meet_na.png differ
diff --git a/plugin/zoom/resources/img/svg/zoommeet.svg b/plugin/zoom/resources/img/svg/zoommeet.svg
new file mode 100644
index 000000000..6801d0b09
--- /dev/null
+++ b/plugin/zoom/resources/img/svg/zoommeet.svg
@@ -0,0 +1,291 @@
+
+
+  
+    
+      
+        image/svg+xml
+        
+        
+      
+    
+  
+  
+  
+    
+      
+      
+    
+    
+      
+      
+      
+    
+    
+    
+      
+      
+      
+    
+    
+    
+      
+      
+      
+    
+    
+    
+      
+      
+    
+    
+    
+      
+      
+    
+    
+      
+    
+    
+  
+  
+    
+    
+      
+        
+      
+      
+      
+        
+          
+        
+        
+        
+        
+      
+    
+  
+
diff --git a/plugin/zoom/start.php b/plugin/zoom/start.php
new file mode 100644
index 000000000..7b6bad7d6
--- /dev/null
+++ b/plugin/zoom/start.php
@@ -0,0 +1,118 @@
+ 'Videoconference Zoom',
+];
+Event::registerLog($logInfo);
+
+$course = api_get_course_entity();
+if (null === $course) {
+    api_not_allowed(true);
+}
+
+$group = api_get_group_entity();
+$session = api_get_session_entity();
+$plugin = ZoomPlugin::create();
+
+if (null !== $group) {
+    $interbreadcrumb[] = [
+        'url' => api_get_path(WEB_CODE_PATH).'group/group.php?'.api_get_cidreq(),
+        'name' => get_lang('Groups'),
+    ];
+    $interbreadcrumb[] = [
+        'url' => api_get_path(WEB_CODE_PATH).'group/group_space.php?'.api_get_cidreq(),
+        'name' => get_lang('GroupSpace').' '.$group->getName(),
+    ];
+}
+
+$url = api_get_self().'?'.api_get_cidreq(true, false).'&gidReq=';
+$htmlHeadXtra[] = '';
+
+$tool_name = $plugin->get_lang('ZoomVideoConferences');
+$tpl = new Template($tool_name);
+
+$action = isset($_REQUEST['action']) ? $_REQUEST['action'] : '';
+
+$isManager = $plugin->userIsCourseConferenceManager();
+if ($isManager) {
+    $groupId = api_get_group_id();
+    $groups = GroupManager::get_groups();
+    if (!empty($groups)) {
+        $form = new FormValidator('group_filter');
+        $groupList[0] = get_lang('Select');
+        foreach ($groups as $groupData) {
+            $itemGroupId = $groupData['iid'];
+            /*if (isset($meetingsGroup[$itemGroupId]) && $meetingsGroup[$itemGroupId] == 1) {
+                $groupData['name'] .= ' ('.get_lang('Active').')';
+            }*/
+            $groupList[$itemGroupId] = $groupData['name'];
+        }
+        $form->addSelect('group_id', get_lang('Groups'), $groupList, ['id' => 'group_select']);
+        $form->setDefaults(['group_id' => $groupId]);
+        $formToString = $form->returnForm();
+
+        $tpl->assign('group_form', $formToString);
+    }
+
+    switch ($action) {
+        case 'delete':
+            $meeting = $plugin->getMeetingRepository()->findOneBy(['meetingId' => $_REQUEST['meetingId']]);
+            if ($meeting && $meeting->isCourseMeeting()) {
+                $plugin->deleteMeeting($meeting, api_get_self().'?'.api_get_cidreq());
+            }
+            break;
+    }
+
+    $user = api_get_user_entity(api_get_user_id());
+
+    $tpl->assign(
+        'instant_meeting_form',
+        $plugin->getCreateInstantMeetingForm(
+            $user,
+            $course,
+            $group,
+            $session
+        )->returnForm()
+    );
+    $tpl->assign(
+        'schedule_meeting_form',
+        $plugin->getScheduleMeetingForm(
+            $user,
+            $course,
+            $group,
+            $session
+        )->returnForm()
+    );
+}
+
+try {
+    $tpl->assign(
+        'meetings',
+        $plugin->getMeetingRepository()->courseMeetings($course, $group, $session)
+    );
+} catch (Exception $exception) {
+    Display::addFlash(
+        Display::return_message('Could not retrieve scheduled meeting list: '.$exception->getMessage(), 'error')
+    );
+}
+
+$tpl->assign('is_manager', $isManager);
+$tpl->assign('content', $tpl->fetch('zoom/view/start.tpl'));
+$tpl->display_one_col_template();
diff --git a/plugin/zoom/subscription.php b/plugin/zoom/subscription.php
new file mode 100644
index 000000000..0470eca4f
--- /dev/null
+++ b/plugin/zoom/subscription.php
@@ -0,0 +1,117 @@
+getMeetingRepository()->findOneBy(['meetingId' => $_REQUEST['meetingId']]);
+
+if (null === $meeting) {
+    api_not_allowed(true, $plugin->get_lang('MeetingNotFound'));
+}
+
+if (false !== $meeting->isGlobalMeeting()
+    || false != $meeting->isCourseMeeting()
+    || 'true' !== $plugin->get('enableParticipantRegistration')
+    || !$meeting->requiresRegistration()
+) {
+    api_not_allowed(true);
+}
+
+$currentUser = api_get_user_entity(api_get_user_id());
+$userRegistrant = $meeting->getRegistrantByUser($currentUser);
+
+if ($meeting->isCourseMeeting()) {
+    api_protect_course_script(true);
+
+    if (api_is_in_group()) {
+        $interbreadcrumb[] = [
+            'url' => api_get_path(WEB_CODE_PATH).'group/group.php?'.api_get_cidreq(),
+            'name' => get_lang('Groups'),
+        ];
+        $interbreadcrumb[] = [
+            'url' => api_get_path(WEB_CODE_PATH).'group/group_space.php?'.api_get_cidreq(),
+            'name' => get_lang('GroupSpace').' '.$meeting->getGroup()->getName(),
+        ];
+    }
+}
+
+$form = new FormValidator('subscription');
+$form->addHidden('meetingId', $meeting->getMeetingId());
+
+if (!empty($userRegistrant)) {
+    $form->addButton(
+        'unregister',
+        $plugin->get_lang('UnregisterMeToConference'),
+        'user-times',
+        'warning'
+    );
+
+    $form->addHtml(
+        '
    '
+        .Display::url(
+            $plugin->get_lang('ViewMeeting'),
+            api_get_path(WEB_PLUGIN_PATH).'zoom/join_meeting.php?meetingId='.$meeting->getMeetingId(),
+            ['class' => 'btn btn-primary']
+        )
+        .'
    '
+    );
+} else {
+    $filtered = array_filter(
+        $meeting->getRegistrableUsers(),
+        function (User $registableUser) use ($currentUser) {
+            return $registableUser->getId() === $currentUser->getId();
+        }
+    );
+
+    if (empty($filtered)) {
+        api_not_allowed(true);
+    }
+
+    $form->addButton(
+        'register',
+        $plugin->get_lang('RegisterMeToConference'),
+        'user-plus',
+        'success'
+    );
+}
+
+if ($form->validate()) {
+    $values = $form->exportValues();
+
+    if (isset($values['unregister'])) {
+        $plugin->unregister($meeting, [$userRegistrant]);
+    } else {
+        $plugin->registerUsers($meeting, [$currentUser]);
+    }
+
+    Display::addFlash(
+        Display::return_message($plugin->get_lang('RegisteredUserListWasUpdated'), 'success')
+    );
+
+    api_location('?meetingId='.$meeting->getMeetingId());
+} else {
+    $form->protect();
+}
+
+$view = new Template('');
+$view->assign('meeting', $meeting);
+$view->assign('frm_register_unregister', $form->returnForm());
+$content = $view->fetch('zoom/view/subscription.tpl');
+
+$view->assign('content', $content);
+$view->display_one_col_template();
diff --git a/plugin/zoom/uninstall.php b/plugin/zoom/uninstall.php
new file mode 100644
index 000000000..07d187f73
--- /dev/null
+++ b/plugin/zoom/uninstall.php
@@ -0,0 +1,8 @@
+uninstall();
diff --git a/plugin/zoom/view/activity.tpl b/plugin/zoom/view/activity.tpl
new file mode 100644
index 000000000..494f2e25a
--- /dev/null
+++ b/plugin/zoom/view/activity.tpl
@@ -0,0 +1,57 @@
+
    
+    {{ meeting.typeName }} {{ meeting.meetingId }}
+
    
+
+
+    {{ 'Edit'|get_lang }}
+
+
+
+    
+        
+            
+            
+{#            #}
+            
+            
+        
+    
+    
+    {% for activity in meeting.activities %}
+        
+            
+            
+            
+{#            #}
+            
+        
+    {% endfor %}
+    
+
    {{ 'Type'|get_lang }}{{ 'Action'|get_plugin_lang('ZoomPlugin') }}{{ 'User'|get_lang }}{{ 'Date'|get_lang }}{{ 'Details'|get_lang }} 
    
+                {{ activity.type }}
+            
+                {{ activity.name }}
+            
+                {{ activity.createdAt | api_convert_and_format_date(3)}}
+            #}
+{#                {% if _u.is_admin %}#}
+{#                    #}
+{#                        {{ activity.user.firstname }} {{ activity.user.lastname }} ({{ activity.user.username }})#}
+{#                    #}
+{#                {% else %}#}
+{#                    {{ activity.user.firstname }} {{ activity.user.lastname }} ({{ activity.user.username }})#}
+{#                {% endif %}#}
+{#            
+                {% if activity.eventDecoded.registrant %}
+                    {{ 'User' | get_lang }} :
+                    {{ activity.eventDecoded.registrant.first_name }} -
+                    {{ activity.eventDecoded.registrant.last_name }} -
+                    {{ activity.eventDecoded.registrant.email }} -
+                    {{ activity.eventDecoded.registrant.status }}
+                {% endif %}
+
+                {% if activity.eventDecoded.participant %}
+                    {{ 'User' | get_lang }} :
+                    {{ activity.eventDecoded.participant.user_name }}
+                {% endif %}
+            
    
\ No newline at end of file
diff --git a/plugin/zoom/view/calendar.tpl b/plugin/zoom/view/calendar.tpl
new file mode 100644
index 000000000..122a936be
--- /dev/null
+++ b/plugin/zoom/view/calendar.tpl
@@ -0,0 +1,324 @@
+
+
+
    
+
+
+
+
diff --git a/plugin/zoom/view/join.tpl b/plugin/zoom/view/join.tpl
new file mode 100644
index 000000000..368ae0720
--- /dev/null
+++ b/plugin/zoom/view/join.tpl
@@ -0,0 +1,196 @@
+{% include 'zoom/view/meeting_details.tpl' %}
+
+{% if is_conference_manager and meeting.isSignAttendance %}
+    
    
+        
+        {{ 'ConferenceWithAttendance'|get_plugin_lang('ZoomPlugin') }}
+    
    
+{% endif %}
+
+
    
+
+{% set btn_start = '' %}
+
+{% if start_url %}
+    {% set btn_start %}
+        
+            {{ 'EnterMeeting'|get_plugin_lang('ZoomPlugin') }}
+        
+    {% endset %}
+{% endif %}
+
+{% if not is_conference_manager %}
+    {% if meeting.isSignAttendance %}
+        
    
+            
    
+                
    
+                    
    
+                        
    
+                            
+                            {{ 'Attendance'|get_lang }}
+                        
    
+                    
    
+                    
    
+                        
    {{ meeting.reasonToSignAttendance }}
    
+
+                        {% if signature %}
+                            
    
+                                {{ 'SignatureDone'|get_plugin_lang('ZoomPlugin') }}
+                                
    
+                                    {{ signature.registeredAt|api_convert_and_format_date(constant('DATE_TIME_FORMAT_LONG')) }}
+                                
    
+                            
    
+                        {% else %}
+                            {% set btn_start = '' %}
+
+                            {% if 'started' == meeting.meetingInfoGet.status %}
+                                
+
+                                
+
+                                
+                            {% endif %}
+                        {% endif %}
+                    
    
+                
    
+            
    
+        
    
+    {% endif %}
+{% endif %}
+
+{{ btn_start }}
+
+{% if details_url %}
+    
+        {{ 'Details'|get_lang }}
+    
+{% endif %}
+
+{% if btn_announcement %}
+    {{ btn_announcement }}
+{% endif %}
diff --git a/plugin/zoom/view/meeting.tpl b/plugin/zoom/view/meeting.tpl
new file mode 100644
index 000000000..b43c52f0f
--- /dev/null
+++ b/plugin/zoom/view/meeting.tpl
@@ -0,0 +1,136 @@
+
    
+    {{ meeting.typeName }} {{ meeting.meetingId }}
+    {% if meeting.meetingInfoGet.status %}
+        ({{ meeting.meetingInfoGet.status }})
+    {% endif %}
+
    
+
+
    
+
+{% if meeting.meetingInfoGet.status != 'finished' %}
+    
+        {{ 'ViewMeeting'|get_plugin_lang('ZoomPlugin') }}
+    
+{% endif %}
+
+{% if isConferenceManager %}
+    {% if meeting.status == 'waiting' %}
+        
+            {{ 'StartMeeting'|get_plugin_lang('ZoomPlugin') }}
+        
+    {% endif %}
+
+    
+        {{ 'Activity'|get_plugin_lang('ZoomPlugin') }}
+    
+
+    
+        {{ 'Attendance'|get_lang }}
+    
+{% endif %}
+
    
+
+{% if isConferenceManager %}
+    
    
+    
    
+    
    
+        
    
+            
+            
    
+                
    
+                    
+                    
+                
    
+            
    
+        
    
+    
    
+{% endif %}
+
+{% if currentUserJoinURL %}
+{#
    #}
+{#    #}
+{#        {{ 'JoinMeeting'|get_plugin_lang('ZoomPlugin') }}#}
+{#    #}
+{#
    #}
+{% endif %}
+
+{% if isConferenceManager %}
+    {{ editMeetingForm }}
+    {{ deleteMeetingForm }}
+    {% if registerParticipantForm %}
+        
    
+        {{ registerParticipantForm }}
+    {% endif %}
+
+    {% if registerPresenterForm %}
+        {{ registerPresenterForm }}
+    {% endif %}
+
+    {{ fileForm }}
+
+    
    
+        
    
+            {% if presenters %}
+                
    {{ 'Presenters'|get_plugin_lang('ZoomPlugin') }}
    
+                
+                    {% for presenter in presenters %}
+                        
+                            
+                        
+                    {% endfor %}
+                
    
+                                {{ presenter.fullName }}
+                            
    
+            {% endif %}
+        
    
+        
    
+            {#    {% if registrants and meeting.meetingInfoGet.settings.approval_type != 2 %}#}
+            {% if registrants.count > 0 %}
+                
+                
    {{ 'Users' | get_lang }}
    
+                
    
+                
+                    {% for registrant in registrants %}
+                        
+                            
+                            
+                        
+                    {% endfor %}
+                
    
+                                {{ registrant.fullName }}
+                            
+                                {#               {% if registrant.joinUrl %}#}
+                                {#                #}
+                                {#                    {{ 'CopyJoinAsURL'|get_plugin_lang('ZoomPlugin') }}#}
+                                {#                #}
+                                {#               {% else %}#}
+                                {#                   #}
+                                {#                       {{ 'JoinURLNotAvailable'|get_plugin_lang('ZoomPlugin') }}#}
+                                {#                   #}
+                                {#               {% endif %}#}
+                            
    
+            {% endif %}
+        
    
+    
    
+{% else %}
+    {% include 'zoom/view/meeting_details.tpl' %}
+{% endif %}
diff --git a/plugin/zoom/view/meeting_details.tpl b/plugin/zoom/view/meeting_details.tpl
new file mode 100644
index 000000000..0b6c00efe
--- /dev/null
+++ b/plugin/zoom/view/meeting_details.tpl
@@ -0,0 +1,23 @@
+
    
+    {{ meeting.topic}}
+    {{ meeting.typeName }}
+
    
+
+
    
+    {% if meeting.requiresDateAndDuration %}
+        
    {{ 'StartTime'|get_lang }}
    
+        
    {{ meeting.formattedStartTime }}
    
+
+        
    {{ 'Duration'|get_lang }}
    
+        
    {{ meeting.formattedDuration }}
    
+    {% endif %}
+
+    {% if meeting.accountEmail %}
+        
    {{ 'AccountEmail'|get_lang }}
    
+        
    {{ meeting.accountEmail }}
    
+    {% endif %}
+
    
+
+{% if meeting.agenda %}
+    
    {{ meeting.agenda|nl2br }}
    
+{% endif %}
diff --git a/plugin/zoom/view/meetings.tpl b/plugin/zoom/view/meetings.tpl
new file mode 100644
index 000000000..0d7b39e1f
--- /dev/null
+++ b/plugin/zoom/view/meetings.tpl
@@ -0,0 +1,64 @@
+{% import "default/document/recycle.tpl" as macro %}
+
+{{ schedule_form }}
+{{ search_form }}
+
+{% if meetings %}
+    
    {{ 'MeetingsFound'|get_plugin_lang('ZoomPlugin') }}: 
    
+    
+        
+            
+                
+                
+                
+                
+{#                #}
+{#                #}
+                {% if allow_recording %}
+                    
+                {% endif %}
+                
+            
+        
+        
+        {% for meeting in meetings %}
+            
+                
+                
+                
+                
+{#                    #}
+{#                    #}
+                
+                
+            
+        {% endfor %}
+        
+    
    {{ 'Type'|get_lang }}{{ 'Topic'|get_plugin_lang('ZoomPlugin') }}{{ 'StartTime'|get_lang }}{{ 'ForEveryone'|get_plugin_lang('ZoomPlugin') }}{{ 'Course'|get_lang }}{{ 'Session'|get_lang }}{{ 'Recordings'|get_plugin_lang('ZoomPlugin') }}
    {{ meeting.typeName }}{{ meeting.topic }}{{ meeting.formattedStartTime }}{{ meeting.user ? 'No'|get_lang : 'Yes'|get_lang }}{{ meeting.course ? meeting.course : '-' }}{{ meeting.session ? meeting.session : '-' }}
+                {% if allow_recording and meeting.recordings.count > 0 %}
+                    {% for recording in meeting.recordings %}
+                        
    
+                            
    
+                                {{ recording.formattedStartTime }} ({{ recording.formattedDuration }}) {{ 'Password' | get_lang }}: {{ recording.recordingMeeting.password }}
+                            
    
+                            
    
+                                
+                            
    
+                        
    
+                    {% endfor %}
+                {% endif %}
+                    		
+                    
+                        {{ 'Details'|get_lang }}
+                    
+                
    
+{% endif %}
\ No newline at end of file
diff --git a/plugin/zoom/view/start.tpl b/plugin/zoom/view/start.tpl
new file mode 100644
index 000000000..52bfb4835
--- /dev/null
+++ b/plugin/zoom/view/start.tpl
@@ -0,0 +1,60 @@
+{% if instant_meeting_form %}
+    {{ instant_meeting_form }}
+{% endif %}
+
+{% if group_form %}
+    {{ group_form }}
+{% endif %}
+
+{% if meetings.count %}
+    
    
+        
    {{ 'ScheduledMeetings'|get_lang }}
    
+    
    
+    
+        
+            
+            
+            
+            
+            
+            
+        
+        {% for meeting in meetings %}
+        
+            
+            
+            
+            
+            
+            
+        
+        {% endfor %}
+    
    {{ 'Type'|get_lang }}{{ 'Topic'|get_plugin_lang('ZoomPlugin') }}{{ 'Agenda'|get_plugin_lang('ZoomPlugin') }}{{ 'StartTime'|get_lang }}{{ 'Duration'|get_lang }}{{ 'Actions'|get_lang }}
    {{ meeting.typeName }}
+                {{ meeting.meetingInfoGet.topic }}
+                {{ meeting.webinarSchema.topic }}
+            
+                {{ meeting.meetingInfoGet.agenda|nl2br }}
+                {{ meeting.webinarSchema.agenda|nl2br }}
+            {{ meeting.formattedStartTime }}{{ meeting.formattedDuration }}
+                
+                    {{ 'Join'|get_plugin_lang('ZoomPlugin') }}
+                
+
+                {% if is_manager %}
+                    
+                        {{ 'Details'|get_plugin_lang('ZoomPlugin') }}
+                    
+
+                    
+                        {{ 'Delete'|get_lang }}
+                    
+                {% endif %}
+            
    
+{% endif %}
+
+{% if schedule_meeting_form %}
+    {{ schedule_meeting_form }}
+{% endif %}
\ No newline at end of file
diff --git a/plugin/zoom/view/subscription.tpl b/plugin/zoom/view/subscription.tpl
new file mode 100644
index 000000000..e8799fe9b
--- /dev/null
+++ b/plugin/zoom/view/subscription.tpl
@@ -0,0 +1,3 @@
+{% include 'zoom/view/meeting_details.tpl' %}
+
+{{ frm_register_unregister }}