// swad_scope.c: scope (platform, centre, degree, 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ņas Vargas
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General 3 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 .
*/
/*****************************************************************************/
/*********************************** Headers *********************************/
/*****************************************************************************/
#include // For string functions
#include "swad_config.h"
#include "swad_global.h"
#include "swad_parameter.h"
#include "swad_scope.h"
/*****************************************************************************/
/****************************** Public constants *****************************/
/*****************************************************************************/
/*****************************************************************************/
/***************************** Internal constants ****************************/
/*****************************************************************************/
/*****************************************************************************/
/****************************** Internal types *******************************/
/*****************************************************************************/
/*****************************************************************************/
/************** External global variables from others modules ****************/
/*****************************************************************************/
extern struct Globals Gbl;
/*****************************************************************************/
/************************* Internal global variables *************************/
/*****************************************************************************/
/*****************************************************************************/
/***************************** Internal prototypes ***************************/
/*****************************************************************************/
/*****************************************************************************/
/** Put a selector to choice between ranges when getting users for listing ***/
/*****************************************************************************/
void Sco_PutSelectorScope (const char *ParamName,bool SendOnChange)
{
extern const char *Txt_System;
extern const char *Txt_Country;
extern const char *Txt_Institution;
extern const char *Txt_Centre;
extern const char *Txt_Degree;
extern const char *Txt_Course;
Hie_Level_t Scope;
bool WriteScope;
fprintf (Gbl.F.Out,"");
}
/*****************************************************************************/
/********************** Put hidden parameter scope ***************************/
/*****************************************************************************/
void Sco_PutParamCurrentScope (void)
{
Sco_PutParamScope ("ScopeUsr",Gbl.Scope.Current);
}
void Sco_PutParamScope (const char *ParamName,Hie_Level_t Scope)
{
Par_PutHiddenParamUnsigned (ParamName,(unsigned) Scope);
}
/*****************************************************************************/
/*************************** Get parameter scope *****************************/
/*****************************************************************************/
void Sco_GetScope (const char *ParamName)
{
/***** Get parameter with scope *****/
Gbl.Scope.Current = (Hie_Level_t)
Par_GetParToUnsignedLong (ParamName,
0,
Hie_NUM_LEVELS - 1,
(unsigned long) Hie_UNK);
/***** Adjust scope avoiding impossible or forbidden scopes *****/
Sco_AdjustScope ();
}
/*****************************************************************************/
/*********** Adjust scope avoiding impossible or forbidden scopes ************/
/*****************************************************************************/
void Sco_AdjustScope (void)
{
/***** Is scope is unknow, use default scope *****/
if (Gbl.Scope.Current == Hie_UNK)
Gbl.Scope.Current = Gbl.Scope.Default;
/***** Avoid impossible scopes *****/
if (Gbl.Scope.Current == Hie_CRS && Gbl.Hierarchy.Crs.CrsCod <= 0)
Gbl.Scope.Current = Hie_DEG;
if (Gbl.Scope.Current == Hie_DEG && Gbl.Hierarchy.Deg.DegCod <= 0)
Gbl.Scope.Current = Hie_CTR;
if (Gbl.Scope.Current == Hie_CTR && Gbl.Hierarchy.Ctr.CtrCod <= 0)
Gbl.Scope.Current = Hie_INS;
if (Gbl.Scope.Current == Hie_INS && Gbl.Hierarchy.Ins.InsCod <= 0)
Gbl.Scope.Current = Hie_CTY;
if (Gbl.Scope.Current == Hie_CTY && Gbl.Hierarchy.Cty.CtyCod <= 0)
Gbl.Scope.Current = Hie_SYS;
/***** Avoid forbidden scopes *****/
if ((Gbl.Scope.Allowed & (1 << Gbl.Scope.Current)) == 0)
Gbl.Scope.Current = Hie_UNK;
}
/*****************************************************************************/
/****************** Set allowed scopes when listing guests *******************/
/*****************************************************************************/
void Sco_SetScopesForListingGuests (void)
{
switch (Gbl.Usrs.Me.Role.Logged)
{
case Rol_CTR_ADM:
Gbl.Scope.Allowed = 1 << Hie_CTR;
Gbl.Scope.Default = Hie_CTR;
break;
case Rol_INS_ADM:
Gbl.Scope.Allowed = 1 << Hie_INS |
1 << Hie_CTR;
Gbl.Scope.Default = Hie_INS;
break;
case Rol_SYS_ADM:
Gbl.Scope.Allowed = 1 << Hie_SYS |
1 << Hie_CTY |
1 << Hie_INS |
1 << Hie_CTR;
Gbl.Scope.Default = Hie_SYS;
break;
default:
Gbl.Scope.Allowed = 0;
Gbl.Scope.Default = Hie_UNK;
break;
}
}
/*****************************************************************************/
/**************** Set allowed scopes when listing students *******************/
/*****************************************************************************/
void Sco_SetScopesForListingStudents (void)
{
Gbl.Scope.Default = Hie_CRS;
switch (Gbl.Usrs.Me.Role.Logged)
{
case Rol_STD:
case Rol_NET:
case Rol_TCH:
Gbl.Scope.Allowed = 1 << Hie_CRS;
break;
case Rol_DEG_ADM:
Gbl.Scope.Allowed = 1 << Hie_DEG |
1 << Hie_CRS;
break;
case Rol_CTR_ADM:
Gbl.Scope.Allowed = 1 << Hie_CTR |
1 << Hie_DEG |
1 << Hie_CRS;
break;
case Rol_INS_ADM:
Gbl.Scope.Allowed = 1 << Hie_INS |
1 << Hie_CTR |
1 << Hie_DEG |
1 << Hie_CRS;
break;
case Rol_SYS_ADM:
Gbl.Scope.Allowed = 1 << Hie_SYS |
1 << Hie_CTY |
1 << Hie_INS |
1 << Hie_CTR |
1 << Hie_DEG |
1 << Hie_CRS;
break;
default:
Gbl.Scope.Allowed = 0;
Gbl.Scope.Default = Hie_UNK;
break;
}
}
/*****************************************************************************/
/*********************** Get scope from unsigned string **********************/
/*****************************************************************************/
Hie_Level_t Sco_GetScopeFromUnsignedStr (const char *UnsignedStr)
{
unsigned UnsignedNum;
if (sscanf (UnsignedStr,"%u",&UnsignedNum) == 1)
if (UnsignedNum < Hie_NUM_LEVELS)
return (Hie_Level_t) UnsignedNum;
return Hie_UNK;
}
/*****************************************************************************/
/*********************** Get scope from database string **********************/
/*****************************************************************************/
Hie_Level_t Sco_GetScopeFromDBStr (const char *ScopeDBStr)
{
Hie_Level_t Scope;
for (Scope = Hie_UNK;
Scope < Hie_NUM_LEVELS;
Scope++)
if (!strcmp (Sco_GetDBStrFromScope (Scope),ScopeDBStr))
return Scope;
return Hie_UNK;
}
/*****************************************************************************/
/*********************** Get scope from database string **********************/
/*****************************************************************************/
const char *Sco_GetDBStrFromScope (Hie_Level_t Scope)
{
static const char *Sco_ScopeDB[Hie_NUM_LEVELS] =
{
"Unk", // Hie_UNK
"Sys", // Hie_SYS
"Cty", // Hie_CTY
"Ins", // Hie_INS
"Ctr", // Hie_CTR
"Deg", // Hie_DEG
"Crs", // Hie_CRS
};
if (Scope >= Hie_NUM_LEVELS)
Scope = Hie_UNK;
return Sco_ScopeDB[Scope];
}