Final touch to BuyCourses plugin before 1.9.8 - refs #5464

Author: ywarnier

plugin/buycourses/config.php

@@ -4,10 +4,10 @@
 define('TABLE_BUY_COURSE', 'plugin_buy_course');
 define('TABLE_BUY_COURSE_COUNTRY', 'plugin_buy_course_country');
 define('TABLE_BUY_COURSE_PAYPAL', 'plugin_buy_course_paypal');
-define('TABLE_BUY_COURSE_TRANSFERENCE', 'plugin_buy_course_transference');
+define('TABLE_BUY_COURSE_TRANSFER', 'plugin_buy_course_transfer');
 define('TABLE_BUY_COURSE_TEMPORAL', 'plugin_buy_course_temporal');
 define('TABLE_BUY_COURSE_SALE', 'plugin_buy_course_sale');
 
 require_once __DIR__ . '/../../main/inc/global.inc.php';
 require_once api_get_path(LIBRARY_PATH) . 'plugin.class.php';
-require_once  api_get_path(PLUGIN_PATH) . 'buy_courses/src/buy_course_plugin.class.php';
+require_once  api_get_path(PLUGIN_PATH) . 'buycourses/src/buy_course_plugin.class.php';

plugin/buycourses/database.php

@@ -1,46 +1,55 @@
 <?php
+/* For license terms, see /license.txt */
 /**
- * Created by PhpStorm.
- * User: fgonzales
- * Date: 21/05/14
- * Time: 12:19 PM
+ * Plugin database installation script. Can only be executed if included
+ * inside another script loading global.inc.php
+ * @package chamilo.plugin.buycourses
  */
-$objPlugin = Buy_CoursesPlugin::create();
+/**
+ * Check if script can be called
+ */
+if (!function_exists('api_get_path')) {
+    die('This script must be loaded through the Chamilo plugin installer sequence');
+}
+/**
+ * Create the script context, then execute database queries to enable
+ */
+$objPlugin = BuyCoursesPlugin::create();
 
 $table = Database::get_main_table(TABLE_BUY_COURSE);
 $sql = "CREATE TABLE IF NOT EXISTS $table (
     id INT unsigned NOT NULL auto_increment PRIMARY KEY,
-    id_course INT unsigned NOT NULL DEFAULT '0',
+    course_id INT unsigned NOT NULL DEFAULT '0',
     code VARCHAR(40),
     title VARCHAR(250),
-    visible int(1),
+    visible int,
     price FLOAT(11,2) NOT NULL DEFAULT '0',
-    sync int(1))";
+    sync int)";
 Database::query($sql);
 $tableCourse = Database::get_main_table(TABLE_MAIN_COURSE);
 $sql = "SELECT id, code, title FROM $tableCourse";
 $res = Database::query($sql);
 while ($row = Database::fetch_assoc($res)) {
-    $presql = "INSERT INTO $table (id_course, code, title, visible) VALUES ('" . $row['id'] . "','" . $row['code'] . "','" . $row['title'] . "','NO')";
+    $presql = "INSERT INTO $table (course_id, code, title, visible) VALUES ('" . $row['id'] . "','" . $row['code'] . "','" . $row['title'] . "','NO')";
     Database::query($presql);
 }
 
 $table = Database::get_main_table(TABLE_BUY_COURSE_COUNTRY);
 $sql = "CREATE TABLE IF NOT EXISTS $table (
-    `id_country` int(5) NOT NULL AUTO_INCREMENT,
-    `country_code` char(2) NOT NULL DEFAULT '',
-    `country_name` varchar(45) NOT NULL DEFAULT '',
-    `currency_code` char(3) DEFAULT NULL,
-    `iso_alpha3` char(3) DEFAULT NULL,
-    `status` int(1) DEFAULT '0',
-    PRIMARY KEY (`id_country`)
+    country_id int NOT NULL AUTO_INCREMENT,
+    country_code char(2) NOT NULL DEFAULT '',
+    country_name varchar(45) NOT NULL DEFAULT '',
+    currency_code char(3) DEFAULT NULL,
+    iso_alpha3 char(3) DEFAULT NULL,
+    status int DEFAULT '0',
+    PRIMARY KEY (country_id)
     ) DEFAULT CHARSET=utf8 AUTO_INCREMENT=0;";
 Database::query($sql);
 
-$sql = "CREATE UNIQUE INDEX index_country ON $table (`country_code`)";
+$sql = "CREATE UNIQUE INDEX index_country ON $table (country_code)";
 Database::query($sql);
 
-$sql = "INSERT INTO $table (`country_code`, `country_name`, `currency_code`, `iso_alpha3`) VALUES
+$sql = "INSERT INTO $table (country_code, country_name, currency_code, iso_alpha3) VALUES
 	('AD', 'Andorra', 'EUR', 'AND'),
 	('AE', 'United Arab Emirates', 'AED', 'ARE'),
 	('AF', 'Afghanistan', 'AFN', 'AFG'),
@@ -304,7 +313,7 @@
 $sql = "INSERT INTO $table (id,username,password,signature) VALUES ('1', 'API_UserName', 'API_Password', 'API_Signature')";
 Database::query($sql);
 
-$table = Database::get_main_table(TABLE_BUY_COURSE_TRANSFERENCE);
+$table = Database::get_main_table(TABLE_BUY_COURSE_TRANSFER);
 $sql = "CREATE TABLE IF NOT EXISTS $table (
     id INT unsigned NOT NULL auto_increment PRIMARY KEY,
     name VARCHAR(100) NOT NULL DEFAULT '',
@@ -336,8 +345,8 @@
 Database::query($sql);
 
 //Menu main tabs
-$rsTab = $objPlugin->addTab('Buy Courses', 'plugin/buy_courses/index.php');
+$rsTab = $objPlugin->addTab('Buy Courses', 'plugin/buycourses/index.php');
 
 if ($rsTab) {
-    echo "<script>location.href = '" . $_SERVER['REQUEST_URI'] . "';</script>";
+    echo "<script>location.href = '" . Security::remove_XSS($_SERVER['REQUEST_URI']) . "';</script>";
 }

plugin/buycourses/index.php

@@ -1,5 +1,5 @@
 <?php
-
+/* For license terms, see /license.txt */
 /**
  * Show form
  */

plugin/buycourses/install.php

@@ -1,12 +1,15 @@
 <?php
+/* For license terms, see /license.txt */
 /**
  * This script is included by main/admin/settings.lib.php and generally
  * includes things to execute in the main database (settings_current table)
- * @package chamilo.plugin.bigbluebutton
+ * @package chamilo.plugin.buycourses
  */
 /**
  * Initialization
  */
-
 require_once dirname(__FILE__) . '/config.php';
-Buy_CoursesPlugin::create()->install();
+if (!api_is_platform_admin()) {
+    die ('You must have admin permissions to install plugins');
+}
+BuyCoursesPlugin::create()->install();

plugin/buycourses/js/buycourses.js

@@ -1,3 +1,8 @@
+/* For licensing terms, see /license.txt */
+/**
+ * JS library for the Chamilo buy-courses plugin
+ * @package chamilo.plugin.buycourses
+ */
 $(document).ready(function () {
     $("input[name='price']").change(function () {
         $(this).parent().next().children().attr("style", "display:none");
@@ -29,16 +34,16 @@ $(document).ready(function () {
     $(".save").click(function () {
         var visible = $(this).parent().parent().prev().prev().children().attr("checked");
         var price = $(this).parent().parent().prev().children().attr("value");
-        var id_course = $(this).attr('id');
-        $.post("function.php", {tab: "save_mod", id_course: id_course, visible: visible, price: price},
+        var course_id = $(this).attr('id');
+        $.post("function.php", {tab: "save_mod", course_id: course_id, visible: visible, price: price},
             function (data) {
                 if (data.status == "false") {
                     alert("Database Error");
                 } else {
-                    $("#course" + data.id_course).children().attr("style", "display:''");
-                    $("#course" + data.id_course).children().next().attr("style", "display:none");
-                    $("#course" + data.id_course).parent().removeClass("fmod")
-                    $("#course" + data.id_course).parent().children().each(function () {
+                    $("#course" + data.course_id).children().attr("style", "display:''");
+                    $("#course" + data.course_id).children().next().attr("style", "display:none");
+                    $("#course" + data.course_id).parent().removeClass("fmod")
+                    $("#course" + data.course_id).parent().children().each(function () {
                         $(this).removeClass("btop");
                     });
                 }
@@ -216,4 +221,4 @@ function acciones_ajax() {
 
 
 }
-		
+		

plugin/buycourses/lang/english.php

@@ -1,52 +1,65 @@
-<?php
-//Needed in order to show the plugin title
-$strings['plugin_title'] = "Comprar cursos";
-$strings['plugin_comment'] = "Configurar precios, tipos de pago, visibilidad de cursos.";
-
-$strings['Visible'] = "Mostrar en el listado";
-$strings['Options'] = "Opciones";
-$strings['Price'] = "Precio";
-$strings['SyncCourseDatabase'] = "Sincronizar cursos de la base de datos";
-
-$strings['Private'] = "Privado - acceso autorizado s&oacute;lo para los miembros del curso";
-$strings['CourseVisibilityClosed'] = "Cerrado - no hay acceso a este curso";
-$strings['OpenToThePlatform'] = "Abierto - acceso autorizado s&oacute;lo para los usuarios registrados en la plataforma";
-$strings['OpenToTheWorld'] = "P&uacute;blico - acceso autorizado a cualquier persona";
-
-$strings['bc_setting_courses_available'] = "Configuraci&oacute;n de cursos disponibles";
-$strings['bc_setting_pay'] = "Configuraci&oacute;n pagos";
-
-$strings['Description'] = "Descripci&oacute;n";
-$strings['Buy'] = "Comprar";
-$strings['Filtro_buscar'] = "Filtro de busqueda";
-$strings['Curso'] = "Curso";
-$strings['Price_Maximum'] = "Precio mayor de";
-$strings['Price_Minimum'] = "Precio menor de";
-$strings['Mostrar_disponibles'] = "Mostrar cursos disponibles";
-$strings['Categorias'] = "Categorias";
-
-$strings['paypal_enable'] = "Habilitar PayPal";
-$strings['tarjet_credit_enable'] = "Habilitar TPV";
-$strings['transference_enable'] = "Habilitar transferencia";
-$strings['unregistered_users_enable'] = "Permitir usuarios sin registro en la plataforma";
-
-$strings['EnrollToCourseXSuccessful'] = "Su inscripci�n en el curso %s se ha completado.";
-$strings['ErrorContactPlatformAdmin'] = "Se ha producido un error desconocido. Por favor, p�ngase en contacto con el administrador de la plataforma.";
-$strings['Cancelacionpedido'] = "El pedido se ha cancelado.";
-$strings['AlreadyBuy'] = "Ya est� matriculado en el curso";
-$strings['Message_conf_transf'] = "Una vez confirmado, recibira un e-mail con los datos bancarios y una referencia del pedido.";
-$strings['bc_subject'] = "Confirmaci�n pedido de cursos";
-$strings['bc_message'] = "Estimado {{name}}. <br />En cuanto recibamos confirmaci&oacute;n de pago procederemos a dar de alta su usuario en el curso <strong>{{curso}}</strong>.<br><br><strong>No olvide indicar en el concepto de la transferencia el n&uacute;mero de referencia del pedido: <div style='display:inline;text-align:center; font-weight:bold; font-size:20px; color:#333'>{{reference}}</div></strong>";
-$strings['bc_registrado'] = 'Ya se encuentra registrado en el curso';
-$strings['bc_tmp_registrado'] = 'Se encuentra a la espera de recibir el pago';
-
-$strings['bc_confi_index'] = 'Configuraci�n cursos y precio';
-$strings['bc_pagos_index'] = 'Configuraci�n pagos';
-$strings['bc_pending'] = 'Pedidos pendientes de pago';
-
-$strings['Ref_pedido'] = 'Referencia del pedido';
-$strings['transferencia_bancaria'] = 'Transferencia Bancaria';
-$strings['paypal'] = 'PayPal';
-$strings['confirmar_compra'] = 'Confirmar compra de curso';
-
-$strings['The_User_Is_Already_Registered'] = 'El usuario ya está registrado';
+<?php
+$strings['plugin_title'] = "Sell courses";
+$strings['plugin_comment'] = "Sell courses directly through your Chamilo portal, using a PayPal account to receive funds. This plugin is in beta version. Neither the Chamilo association nor the developers involved could be considered responsible of any issue you might suffer using this plugin.";
+$strings['Visible'] = "Show list";
+$strings['Options'] = "Options";
+$strings['Price'] = "Price";
+$strings['SyncCourseDatabase'] = "Synchronize courses from database";
+$strings['Private'] = "Private - access authorized only for course members";
+$strings['CourseVisibilityClosed'] = "Closed - no access to this course";
+$strings['OpenToThePlatform'] = "Open - access authorized only for users registered on the platform";
+$strings['OpenToTheWorld'] = "Public - access open to anybody";
+$strings['Description'] = "Description";
+$strings['Buy'] = "Buy";
+$strings['Mostrar_disponibles'] = "Show available courses";
+$strings['paypal_enable'] = "Enable PayPal";
+$strings['transfer_enable'] = "Enable bank transfer";
+$strings['unregistered_users_enable'] = "Allow anonymous users";
+$strings['Cancelacionpedido'] = "The payment has been cancelled.";
+$strings['AlreadyBuy'] = "You are already subscribed to this course.";
+$strings['bc_subject'] = "Confirmation of course order";
+$strings['paypal'] = 'PayPal';
+$strings['confirmar_compra'] = 'Course purchase confirmation';
+$strings['TheUserIsAlreadyRegistered'] = 'The user is already registered';
+$strings['ProblemToSaveTheCurrencyType'] = 'Problem loading the currency type';
+$strings['ProblemToSaveThePaypalParameters'] = 'Problem saving PayPal parameters';
+$strings['ProblemToInsertANewAccount'] = 'Problem inserting the new account';
+$strings['ProblemToDeleteTheAccount'] = 'Problem removing account';
+$strings['ProblemToSaveTheMessage'] = 'Problem saving message';
+$strings['ProblemToSubscribeTheUser'] = 'Problem subscribing the user';
+$strings['TheSubscriptionAndActivationWereDoneSuccessfully'] = 'The subscription and activation were successful';
+$strings['TheUserIsAlreadyRegisteredInTheCourse'] = 'The user is already registered in the course.';
+$strings['CourseListOnSale'] = 'List of courses on sale';
+$strings['BuyCourses'] = 'Buy courses';
+$strings['ConfigurationOfCoursesAndPrices'] = 'Courses and prices configuration';
+$strings['ConfigurationOfPayments'] = 'Payments configuration';
+$strings['OrdersPendingOfPayment'] = 'Orders awaiting payment';
+$strings['AvailableCoursesConfiguration'] = 'Available courses configuration';
+$strings['PaymentsConfiguration'] = 'Payments configuration';
+$strings['bc_message'] = "Dear {{name}}. <br />We are currently waiting for the payment confirmation. Once received, we will enable your user in course <strong>{{curso}}</strong>.<br><br><strong>Please do not forget to mention your order reference number in your transfer: <div style='display:inline;text-align:center; font-weight:bold; font-size:20px; color:#333'>{{reference}}</div></strong>";
+$strings['Categories'] = "Categories";
+$strings['BankTransfer'] = 'Bank transfer';
+$strings['EnrollToCourseXSuccessful'] = "Your subscription to the course is complete";
+$strings['SearchFilter'] = "Search filter";
+$strings['MinimumPrice'] = "Minimum price";
+$strings['MaximumPrice'] = "Maximum price";
+$strings['AvailableCourses'] = "Courses available";
+$strings['PaymentConfiguration'] = "Payment configuration";
+$strings['WaitingToReceiveThePayment'] = "Currently pending payment";
+$strings['CurrencyType'] = "Currency type";
+$strings['SelectACurrency'] = "Choose a currency";
+$strings['Sandbox'] = "Test environment";
+$strings['BankAccount'] = "Bank account";
+$strings['SubscribeUser'] = "Subscribe user";
+$strings['DeleteTheOrder'] = "Delete order";
+$strings['ReferenceOrder'] = 'Order reference';
+$strings['UserInformation'] = "Buyer's details";
+$strings['OnceItIsConfirmed,YouWillReceiveAnEmailWithTheBankInformationAndAnOrderReference'] = "Once confirmed, you will receive an e-mail with the bank details and an order reference.";
+$strings['BankAccountInformation'] = 'Bank account details';
+$strings['ConfirmOrder'] = 'Confirm order';
+$strings['PaymentMethods'] = 'Payment methods';
+$strings['CancelOrder'] = 'Cancel order';
+$strings['ErrorContactPlatformAdmin'] = "Unknown error. Please contact the platform administrator.";
+$strings['PayPalConfig'] = "PayPal configuration:";
+$strings['TransfersConfig'] = "Bank transfers configuration:";
+$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!";