Marown/swad-core
Marown
/
swad-core
mirror of https://github.com/acanas/swad-core.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
swad-core/swad_session_database.c

344 lines
13 KiB
C
Raw Permalink Blame History

// swad_session_database.c: sessions operations with database
/*
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-2024 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 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 "swad_config.h"
#include "swad_database.h"
#include "swad_global.h"
#include "swad_pagination.h"
/*****************************************************************************/
/************** External global variables from others modules ****************/
/*****************************************************************************/
extern struct Globals Gbl;
/*****************************************************************************/
/******************** Insert new session in the database *********************/
/*****************************************************************************/
void Ses_DB_InsertSession (Sch_WhatToSearch_t WhatToSearch)
{
DB_QueryINSERT ("can not create session",
"INSERT INTO ses_sessions"
" (SessionId,UsrCod,Password,Role,"
"CtyCod,InsCod,CtrCod,DegCod,CrsCod,LastTime,LastRefresh,WhatToSearch)"
" VALUES"
" ('%s',%ld,'%s',%u,"
"%ld,%ld,%ld,%ld,%ld,NOW(),NOW(),%u)",
Gbl.Session.Id,
Gbl.Usrs.Me.UsrDat.UsrCod,
Gbl.Usrs.Me.UsrDat.Password,
(unsigned) Gbl.Usrs.Me.Role.Logged,
Gbl.Hierarchy.Node[Hie_CTY].HieCod,
Gbl.Hierarchy.Node[Hie_INS].HieCod,
Gbl.Hierarchy.Node[Hie_CTR].HieCod,
Gbl.Hierarchy.Node[Hie_DEG].HieCod,
Gbl.Hierarchy.Node[Hie_CRS].HieCod,
WhatToSearch);
}
/*****************************************************************************/
/***************** Modify data of session in the database ********************/
/*****************************************************************************/
void Ses_DB_UpdateSession (void)
{
DB_QueryUPDATE ("can not update session",
"UPDATE ses_sessions"
" SET UsrCod=%ld,"
"Password='%s',"
"Role=%u,"
"CtyCod=%ld,"
"InsCod=%ld,"
"CtrCod=%ld,"
"DegCod=%ld,"
"CrsCod=%ld,"
"LastTime=NOW(),"
"LastRefresh=NOW()"
" WHERE SessionId='%s'",
Gbl.Usrs.Me.UsrDat.UsrCod,
Gbl.Usrs.Me.UsrDat.Password,
(unsigned) Gbl.Usrs.Me.Role.Logged,
Gbl.Hierarchy.Node[Hie_CTY].HieCod,
Gbl.Hierarchy.Node[Hie_INS].HieCod,
Gbl.Hierarchy.Node[Hie_CTR].HieCod,
Gbl.Hierarchy.Node[Hie_DEG].HieCod,
Gbl.Hierarchy.Node[Hie_CRS].HieCod,
Gbl.Session.Id);
}
/*****************************************************************************/
/********************** Save last search into session ************************/
/*****************************************************************************/
void Ses_DB_SaveLastSearchIntoSession (const struct Sch_Search *Search)
{
DB_QueryUPDATE ("can not update last search in session",
"UPDATE ses_sessions"
" SET WhatToSearch=%u,"
"SearchStr='%s'"
" WHERE SessionId='%s'",
(unsigned) Search->WhatToSearch,
Search->Str,
Gbl.Session.Id);
}
/*****************************************************************************/
/********* Save last page of received/sent messages into session *************/
/*****************************************************************************/
void Ses_DB_SaveLastPageMsgIntoSession (Pag_WhatPaginate_t WhatPaginate,unsigned NumPage)
{
/***** Save last page of received/sent messages *****/
DB_QueryUPDATE ("can not update last page of messages",
"UPDATE ses_sessions"
" SET %s=%u"
" WHERE SessionId='%s'",
WhatPaginate == Pag_MESSAGES_RECEIVED ? "LastPageMsgRcv" :
"LastPageMsgSnt",
NumPage,Gbl.Session.Id);
}
/*****************************************************************************/
/******************** Update session last refresh in database ****************/
/*****************************************************************************/
void Ses_DB_UpdateSessionLastRefresh (void)
{
DB_QueryUPDATE ("can not update session",
"UPDATE ses_sessions"
" SET LastRefresh=NOW()"
" WHERE SessionId='%s'",
Gbl.Session.Id);
}
/*****************************************************************************/
/*********** Check if the session already exists in the database *************/
/*****************************************************************************/
// Return true if session exists
// Return false if session does not exist or error
bool Ses_DB_CheckIfSessionExists (const char *IdSes)
{
return
DB_QueryEXISTS ("can not check if a session already existed",
"SELECT EXISTS"
"(SELECT *"
" FROM ses_sessions"
" WHERE SessionId='%s')",
IdSes);
}
/*****************************************************************************/
/******* Get the data (user code and password) of an initiated session *******/
/*****************************************************************************/
unsigned Ses_DB_GetSessionData (MYSQL_RES **mysql_res)
{
return (unsigned)
DB_QuerySELECT (mysql_res,"can not get session data",
"SELECT UsrCod," // row[0]
"Password," // row[1]
"Role," // row[2]
"CtyCod," // row[3]
"InsCod," // row[4]
"CtrCod," // row[5]
"DegCod," // row[6]
"CrsCod," // row[7]
"WhatToSearch," // row[8]
"SearchStr" // row[9]
" FROM ses_sessions"
" WHERE SessionId='%s'",
Gbl.Session.Id);
}
/*****************************************************************************/
/************************* Get some data of a session ************************/
/*****************************************************************************/
unsigned Ses_DB_GetSomeSessionData (MYSQL_RES **mysql_res,const char *SessionId)
{
return (unsigned)
DB_QuerySELECT (mysql_res,"can not get session data",
"SELECT UsrCod," // row[0]
"DegCod," // row[1]
"CrsCod" // row[2]
" FROM ses_sessions"
" WHERE SessionId='%s'",
SessionId);
}
/*****************************************************************************/
/********* Get last page of received/sent messages stored in session *********/
/*****************************************************************************/
unsigned Ses_DB_GetLastPageMsgFromSession (Pag_WhatPaginate_t WhatPaginate)
{
static const char *Field[Pag_NUM_WHAT_PAGINATE] =
{
[Pag_MESSAGES_RECEIVED] = "LastPageMsgRcv",
[Pag_MESSAGES_SENT ] = "LastPageMsgSnt",
};
return DB_QuerySELECTUnsigned ("can not get last page of messages",
"SELECT %s"
" FROM ses_sessions"
" WHERE SessionId='%s'",
Field[WhatPaginate],
Gbl.Session.Id);
}
/*****************************************************************************/
/*************************** Remove expired sessions *************************/
/*****************************************************************************/
void Ses_DB_RemoveExpiredSessions (void)
{
/***** Remove expired sessions *****/
/* A session expire
when last click (LastTime) is too old,
or (when there was at least one refresh (navigator supports AJAX)
and last refresh is too old (browser probably was closed)) */
DB_QueryDELETE ("can not remove expired sessions",
"DELETE LOW_PRIORITY FROM ses_sessions"
" WHERE LastTime<FROM_UNIXTIME(UNIX_TIMESTAMP()-%lu)"
" OR "
"(LastRefresh>LastTime+INTERVAL 1 SECOND"
" AND"
" LastRefresh<FROM_UNIXTIME(UNIX_TIMESTAMP()-%lu))",
Cfg_TIME_TO_CLOSE_SESSION_FROM_LAST_CLICK,
Cfg_TIME_TO_CLOSE_SESSION_FROM_LAST_REFRESH);
}
/*****************************************************************************/
/******************* Remove all sessions of a given user *********************/
/*****************************************************************************/
void Ses_DB_RemoveUsrSessions (long UsrCod)
{
DB_QueryDELETE ("can not remove sessions of a user",
"DELETE FROM ses_sessions"
" WHERE UsrCod=%ld",
UsrCod);
}
/*****************************************************************************/
/************************** Remove current session ***************************/
/*****************************************************************************/
void Ses_SB_RemoveCurrentSession (void)
{
/***** Remove current session *****/
DB_QueryDELETE ("can not remove a session",
"DELETE FROM ses_sessions"
" WHERE SessionId='%s'",
Gbl.Session.Id);
}
/*****************************************************************************/
/******************* Insert session parameter in the database ****************/
/*****************************************************************************/
void Ses_DB_InsertPar (const char *ParName,const char *ParValue)
{
DB_QueryINSERT ("can not create session parameter",
"INSERT INTO ses_params"
" (SessionId,ParamName,ParamValue)"
" VALUES"
" ('%s','%s','%s')",
Gbl.Session.Id,
ParName,
ParValue ? ParValue :
"");
}
/*****************************************************************************/
/************** Check if a session parameter existed in database *************/
/*****************************************************************************/
// Return true if the parameter already existed in database
bool Ses_DB_CheckIfParIsAlreadyStored (const char *ParName)
{
return
DB_QueryEXISTS ("can not check if a session parameter is already in database",
"SELECT EXISTS"
"(SELECT *"
" FROM ses_params"
" WHERE SessionId='%s'"
" AND ParamName='%s')",
Gbl.Session.Id,
ParName);
}
/*****************************************************************************/
/***************** Get session parameter from the database *******************/
/*****************************************************************************/
// StrSize is the size of the parameter value, not including the ending '\0'
void Ses_DB_GetPar (const char *ParName,char *ParValue,size_t StrSize)
{
ParValue[0] = '\0';
if (Gbl.Session.IsOpen) // If the session is open, get parameter from DB
/***** Get a session parameter from database *****/
DB_QuerySELECTString (ParValue,StrSize,"can not get a session parameter",
"SELECT ParamValue" // row[0]
" FROM ses_params"
" WHERE SessionId='%s'"
" AND ParamName='%s'",
Gbl.Session.Id,
ParName);
}
/*****************************************************************************/
/************ Remove session parameters of a session from database ***********/
/*****************************************************************************/
void Ses_DB_RemovePar (void)
{
if (Gbl.Session.IsOpen && // There is an open session
!Gbl.Session.ParsInsertedIntoDB) // No params just inserted
/***** Remove session parameters of this session *****/
DB_QueryDELETE ("can not remove session parameters of current session",
"DELETE FROM ses_params"
" WHERE SessionId='%s'",
Gbl.Session.Id);
}
/*****************************************************************************/
/********* Remove expired hidden parameters (from expired sessions) **********/
/*****************************************************************************/
void Ses_DB_RemoveParsFromExpiredSessions (void)
{
/***** Remove session parameters from expired sessions *****/
DB_QueryDELETE ("can not remove session parameters of expired sessions",
"DELETE FROM ses_params"
" WHERE SessionId NOT IN"
" (SELECT SessionId"
" FROM ses_sessions)");
}
Reference in New Issue View Git Blame Copy Permalink