swad-core/swad_config_course.c

// swad_config_course.c: configuration of current course

/*
    SWAD (Shared Workspace At a Distance),
    is a web platform developed at the University of Granada (Spain),
    and used to support university teaching.

    This file is part of SWAD core.
    Copyright (C) 1999-2019 Antonio Ca<EFBFBD>as Vargas

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
/*****************************************************************************/
/********************************* Headers ***********************************/
/*****************************************************************************/

#include <stdbool.h>		// For boolean type
#include <stddef.h>		// For NULL

#include "swad_form.h"
#include "swad_global.h"
#include "swad_HTML.h"
#include "swad_logo.h"
#include "swad_role.h"

/*****************************************************************************/
/************** External global variables from others modules ****************/
/*****************************************************************************/

extern struct Globals Gbl;

/*****************************************************************************/
/*************************** Public constants ********************************/
/*****************************************************************************/

/*****************************************************************************/
/***************************** Private types *********************************/
/*****************************************************************************/

/*****************************************************************************/
/**************************** Private variables ******************************/
/*****************************************************************************/

/*****************************************************************************/
/**************************** Private prototypes *****************************/
/*****************************************************************************/

static void CfgCrs_PutIconToPrint (void);
static void CfgCrs_Title (bool PutLink);
static void CfgCrs_Degree (bool PrintView,bool PutForm);
static void CfgCrs_FullName (bool PutForm);
static void CfgCrs_ShrtName (bool PutForm);
static void CfgCrs_Year (bool PutForm);
static void CfgCrs_InstitutionalCode (bool PutForm);
static void CfgCrs_InternalCode (void);
static void CfgCrs_Shortcut (bool PrintView);
static void CfgCrs_QR (void);
static void CfgCrs_NumUsrsInCrs (Rol_Role_t Role);
static void CfgCrs_Indicators (void);

/*****************************************************************************/
/***************** Configuration of the current course ***********************/
/*****************************************************************************/

void CfgCrs_Configuration (bool PrintView)
  {
   extern const char *Hlp_COURSE_Information;
   bool PutLink;
   bool PutFormDeg;
   bool PutFormName;
   bool PutFormYear;
   bool PutFormInsCod;

   /***** Trivial check *****/
   if (Gbl.Hierarchy.Crs.CrsCod <= 0)	// No course selected
      return;

   /***** Initializations *****/
   PutLink       = !PrintView && Gbl.Hierarchy.Deg.WWW[0];
   PutFormDeg    = !PrintView && Gbl.Usrs.Me.Role.Logged >= Rol_CTR_ADM;
   PutFormName   = !PrintView && Gbl.Usrs.Me.Role.Logged >= Rol_DEG_ADM;
   PutFormYear   =
   PutFormInsCod = !PrintView && Gbl.Usrs.Me.Role.Logged >= Rol_TCH;

   /***** Contextual menu *****/
   if (!PrintView)
      if (Gbl.Usrs.Me.Role.Logged == Rol_GST ||
	  Gbl.Usrs.Me.Role.Logged == Rol_USR)
	{
         Mnu_ContextMenuBegin ();
         Enr_PutLinkToRequestSignUp ();	// Request enrolment in the current course
         Mnu_ContextMenuEnd ();
	}

   /***** Begin box *****/
   if (PrintView)
      Box_BoxBegin (NULL,NULL,NULL,
		    NULL,Box_NOT_CLOSABLE);
   else
      Box_BoxBegin (NULL,NULL,CfgCrs_PutIconToPrint,
		    Hlp_COURSE_Information,Box_NOT_CLOSABLE);

   /***** Title *****/
   CfgCrs_Title (PutLink);

   /**************************** Left part ***********************************/
   HTM_DIV_Begin ("class=\"HIE_CFG_LEFT\"");

   /***** Begin table *****/
   HTM_TABLE_BeginWidePadding (2);

   /***** Degree *****/
   CfgCrs_Degree (PrintView,PutFormDeg);

   /***** Course name *****/
   CfgCrs_FullName (PutFormName);
   CfgCrs_ShrtName (PutFormName);

   /***** Course year *****/
   CfgCrs_Year (PutFormYear);

   if (!PrintView)
     {
      /***** Institutional code of the course *****/
      CfgCrs_InstitutionalCode (PutFormInsCod);

      /***** Internal code of the course *****/
      CfgCrs_InternalCode ();
     }

   /***** Shortcut to the couse *****/
   CfgCrs_Shortcut (PrintView);

   if (PrintView)
      /***** QR code with link to the course *****/
      CfgCrs_QR ();
   else
     {
      /***** Number of users *****/
      CfgCrs_NumUsrsInCrs (Rol_TCH);
      CfgCrs_NumUsrsInCrs (Rol_NET);
      CfgCrs_NumUsrsInCrs (Rol_STD);

      /***** Indicators *****/
      CfgCrs_Indicators ();
     }

   /***** End table *****/
   HTM_TABLE_End ();

   /***** End of left part *****/
   HTM_DIV_End ();

   /***** End box *****/
   Box_BoxEnd ();
  }

/*****************************************************************************/
/************* Put icon to print the configuration of a course ***************/
/*****************************************************************************/

static void CfgCrs_PutIconToPrint (void)
  {
   Ico_PutContextualIconToPrint (ActPrnCrsInf,NULL);
  }

/*****************************************************************************/
/***************** Print configuration of the current course *****************/
/*****************************************************************************/

void CfgCrs_PrintConfiguration (void)
  {
   CfgCrs_Configuration (true);
  }

/*****************************************************************************/
/******************** Show title in course configuration *********************/
/*****************************************************************************/

static void CfgCrs_Title (bool PutLink)
  {
   Hie_ConfigTitle (PutLink,
		    Hie_DEG,				// Logo scope
		    Gbl.Hierarchy.Deg.DegCod,		// Logo code
                    Gbl.Hierarchy.Deg.ShrtName,		// Logo short name
		    Gbl.Hierarchy.Deg.FullName,		// Logo full name
		    Gbl.Hierarchy.Deg.WWW,		// Logo www
		    Gbl.Hierarchy.Crs.FullName);	// Text full name
  }

/*****************************************************************************/
/******************** Show degree in course configuration ********************/
/*****************************************************************************/

static void CfgCrs_Degree (bool PrintView,bool PutForm)
  {
   extern const char *Txt_Degree;
   extern const char *Txt_Go_to_X;
   unsigned NumDeg;

   /***** Degree *****/
   HTM_TR_Begin (NULL);

   /* Label */
   Frm_LabelColumn ("RT",PutForm ? "OthDegCod" :
	                           NULL,
		    Txt_Degree);

   /* Data */
   HTM_TD_Begin ("class=\"DAT LB\"");
   if (PutForm)
     {
      /* Get list of degrees of the current centre */
      Deg_GetListDegsOfCurrentCtr ();

      /* Put form to select degree */
      Frm_StartForm (ActChgCrsDegCfg);
      HTM_SELECT_Begin (true,
			"id=\"OthDegCod\" name=\"OthDegCod\""
			" class=\"INPUT_SHORT_NAME\"");
      for (NumDeg = 0;
	   NumDeg < Gbl.Hierarchy.Ctr.Degs.Num;
	   NumDeg++)
	 HTM_OPTION (HTM_Type_LONG,&Gbl.Hierarchy.Ctr.Degs.Lst[NumDeg].DegCod,
		     Gbl.Hierarchy.Ctr.Degs.Lst[NumDeg].DegCod == Gbl.Hierarchy.Deg.DegCod,false,
		     "%s",Gbl.Hierarchy.Ctr.Degs.Lst[NumDeg].ShrtName);
      HTM_SELECT_End ();
      Frm_EndForm ();

      /* Free list of degrees of the current centre */
      Deg_FreeListDegs (&Gbl.Hierarchy.Ctr.Degs);
     }
   else	// I can not move course to another degree
     {
      if (!PrintView)
	{
         Frm_StartFormGoTo (ActSeeDegInf);
         Deg_PutParamDegCod (Gbl.Hierarchy.Deg.DegCod);
	 snprintf (Gbl.Title,sizeof (Gbl.Title),
		   Txt_Go_to_X,
		   Gbl.Hierarchy.Deg.ShrtName);
	 HTM_BUTTON_SUBMIT_Begin (Gbl.Title,"BT_LINK LT DAT",NULL);
	}
      Lgo_DrawLogo (Hie_DEG,Gbl.Hierarchy.Deg.DegCod,Gbl.Hierarchy.Deg.ShrtName,
		    20,"LM",true);
      HTM_NBSP ();
      HTM_Txt (Gbl.Hierarchy.Deg.FullName);
      if (!PrintView)
	{
	 HTM_BUTTON_End ();
	 Frm_EndForm ();
	}
     }
   HTM_TD_End ();

   HTM_TR_End ();
  }

/*****************************************************************************/
/************** Show course full name in course configuration ****************/
/*****************************************************************************/

static void CfgCrs_FullName (bool PutForm)
  {
   extern const char *Txt_Course;

   Hie_ConfigFullName (PutForm,Txt_Course,ActRenCrsFulCfg,
		       Gbl.Hierarchy.Crs.FullName);
  }

/*****************************************************************************/
/************** Show course short name in course configuration ***************/
/*****************************************************************************/

static void CfgCrs_ShrtName (bool PutForm)
  {
   Hie_ConfigShrtName (PutForm,ActRenCrsShoCfg,Gbl.Hierarchy.Crs.ShrtName);
  }

/*****************************************************************************/
/***************** Show course year in course configuration ******************/
/*****************************************************************************/

static void CfgCrs_Year (bool PutForm)
  {
   extern const char *Txt_Year_OF_A_DEGREE;
   extern const char *Txt_YEAR_OF_DEGREE[1 + Deg_MAX_YEARS_PER_DEGREE];
   extern const char *Txt_Not_applicable;
   unsigned Year;

   /***** Academic year *****/
   HTM_TR_Begin (NULL);

   /* Label */
   Frm_LabelColumn ("RT",PutForm ? "OthCrsYear" :
	                           NULL,
		    Txt_Year_OF_A_DEGREE);

   /* Data */
   HTM_TD_Begin ("class=\"DAT LB\"");
   if (PutForm)
     {
      Frm_StartForm (ActChgCrsYeaCfg);
      HTM_SELECT_Begin (true,
			"id=\"OthCrsYear\" name=\"OthCrsYear\"");
      for (Year = 0;
	   Year <= Deg_MAX_YEARS_PER_DEGREE;
           Year++)
	 HTM_OPTION (HTM_Type_UNSIGNED,&Year,
		     Year == Gbl.Hierarchy.Crs.Year,false,
		     "%s",Txt_YEAR_OF_DEGREE[Year]);
      HTM_SELECT_End ();
      Frm_EndForm ();
     }
   else
      HTM_Txt (Gbl.Hierarchy.Crs.Year ? Txt_YEAR_OF_DEGREE[Gbl.Hierarchy.Crs.Year] :
	                                Txt_Not_applicable);
   HTM_TD_End ();

   HTM_TR_End ();
  }

/*****************************************************************************/
/************* Show institutional code in course configuration ***************/
/*****************************************************************************/

static void CfgCrs_InstitutionalCode (bool PutForm)
  {
   extern const char *Txt_Institutional_code;

   /***** Institutional course code *****/
   HTM_TR_Begin (NULL);

   /* Label */
   Frm_LabelColumn ("RT",PutForm ? "InsCrsCod" :
	                           NULL,
		    Txt_Institutional_code);

   /* Data */
   HTM_TD_Begin ("class=\"DAT LB\"");
   if (PutForm)
     {
      Frm_StartForm (ActChgInsCrsCodCfg);
      HTM_INPUT_TEXT ("InsCrsCod",Crs_MAX_CHARS_INSTITUTIONAL_CRS_COD,
		      Gbl.Hierarchy.Crs.InstitutionalCrsCod,true,
		      "id=\"InsCrsCod\" size=\"%u\" class=\"INPUT_INS_CODE\"",
		      Crs_MAX_CHARS_INSTITUTIONAL_CRS_COD);
      Frm_EndForm ();
     }
   else
      HTM_Txt (Gbl.Hierarchy.Crs.InstitutionalCrsCod);
   HTM_TD_End ();

   HTM_TR_End ();
  }

/*****************************************************************************/
/**************** Show internal code in course configuration *****************/
/*****************************************************************************/

static void CfgCrs_InternalCode (void)
  {
   extern const char *Txt_Internal_code;

   /***** Internal course code *****/
   HTM_TR_Begin (NULL);

   /* Label */
   Frm_LabelColumn ("RT",NULL,Txt_Internal_code);

   /* Data */
   HTM_TD_Begin ("class=\"DAT LB\"");
   HTM_Long (Gbl.Hierarchy.Crs.CrsCod);
   HTM_TD_End ();

   HTM_TR_End ();
  }

/*****************************************************************************/
/*************** Show course shortcut in course configuration ****************/
/*****************************************************************************/

static void CfgCrs_Shortcut (bool PrintView)
  {
   Hie_ConfigShortcut (PrintView,"crs",Gbl.Hierarchy.Crs.CrsCod);
  }

/*****************************************************************************/
/****************** Show course QR in course configuration *******************/
/*****************************************************************************/

static void CfgCrs_QR (void)
  {
   Hie_ConfigQR ("crs",Gbl.Hierarchy.Crs.CrsCod);
  }

/*****************************************************************************/
/*********************** Number of users in this course **********************/
/*****************************************************************************/

static void CfgCrs_NumUsrsInCrs (Rol_Role_t Role)
  {
   extern const char *Txt_ROLES_PLURAL_Abc[Rol_NUM_ROLES][Usr_NUM_SEXS];

   /***** Number of users in course *****/
   HTM_TR_Begin (NULL);

   /* Label */
   Frm_LabelColumn ("RT",NULL,Txt_ROLES_PLURAL_Abc[Role][Usr_SEX_UNKNOWN]);

   /* Data */
   HTM_TD_Begin ("class=\"DAT LB\"");
   HTM_Unsigned (Gbl.Hierarchy.Crs.NumUsrs[Role]);
   HTM_TD_End ();

   HTM_TR_End ();
  }

/*****************************************************************************/
/****************** Show indicators in course configuration ******************/
/*****************************************************************************/

static void CfgCrs_Indicators (void)
  {
   extern const char *Txt_Indicators;
   extern const char *Txt_of_PART_OF_A_TOTAL;
   struct Ind_IndicatorsCrs Indicators;
   int NumIndicatorsFromDB = Ind_GetNumIndicatorsCrsFromDB (Gbl.Hierarchy.Crs.CrsCod);

   /***** Compute indicators ******/
   Ind_ComputeAndStoreIndicatorsCrs (Gbl.Hierarchy.Crs.CrsCod,
				     NumIndicatorsFromDB,&Indicators);

   /***** Number of indicators *****/
   HTM_TR_Begin (NULL);

   /* Label */
   Frm_LabelColumn ("RT",NULL,Txt_Indicators);

   /* Data */
   HTM_TD_Begin ("class=\"LB\"");
   Frm_StartForm (ActReqStaCrs);
   snprintf (Gbl.Title,sizeof (Gbl.Title),
	     "%u %s %u",
	     Indicators.NumIndicators,
	     Txt_of_PART_OF_A_TOTAL,Ind_NUM_INDICATORS);
   HTM_BUTTON_SUBMIT_Begin (Gbl.Title,"BT_LINK DAT",NULL);
   HTM_TxtF ("%s&nbsp;",Gbl.Title);
   Ico_PutIcon ((Indicators.NumIndicators == Ind_NUM_INDICATORS) ? "check-circle.svg" :
								   "exclamation-triangle.svg",
		Gbl.Title,"ICO16x16");
   HTM_BUTTON_End ();
   Frm_EndForm ();
   HTM_TD_End ();

   HTM_TR_End ();
  }