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_report.c

1011 lines
35 KiB
C
Raw Blame History

// swad_report.c: report on my use of the platform
/*
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-2016 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 <http://www.gnu.org/licenses/>.
*/
/*****************************************************************************/
/*********************************** Headers *********************************/
/*****************************************************************************/
// #include <stdbool.h> // For boolean type
// #include <stdio.h> // For sprintf
// #include <string.h> // For string functions
#include <unistd.h> // For unlink
#include "swad_database.h"
#include "swad_global.h"
#include "swad_ID.h"
#include "swad_profile.h"
/*****************************************************************************/
/****************************** Public constants *****************************/
/*****************************************************************************/
/*****************************************************************************/
/***************************** Private constants *****************************/
/*****************************************************************************/
#define Rep_MIN_CLICKS_CRS 100 // Minimum number of clicks to show a course in historic log
#define Rep_MAX_BAR_WIDTH 80 // Maximum width of graphic bar
// #define Rep_BLOCK "&boxH;" // HTML code for a block in graphic bar
// #define Rep_BLOCK "&blk12;" // HTML code for a block in graphic bar
// #define Rep_BLOCK "&block;" // HTML code for a block in graphic bar
// #define Rep_BLOCK "&equiv;" // HTML code for a block in graphic bar
// #define Rep_BLOCK "&bull;" // HTML code for a block in graphic bar
#define Rep_BLOCK "&squf;" // HTML code for a block in graphic bar
/*****************************************************************************/
/****************************** Internal types *******************************/
/*****************************************************************************/
typedef enum
{
Rep_SEE,
Rep_PRINT,
} Rep_SeeOrPrint_t;
/*****************************************************************************/
/************** External global variables from others modules ****************/
/*****************************************************************************/
extern struct Globals Gbl;
/*****************************************************************************/
/************************* Internal global variables *************************/
/*****************************************************************************/
/*****************************************************************************/
/***************************** Private prototypes ****************************/
/*****************************************************************************/
static void Rep_ShowOrPrintMyUsageReport (Rep_SeeOrPrint_t SeeOrPrint);
static void Rep_PutIconToPrintMyUsageReport (void);
static void Rep_WriteHeader (FILE *FileDst,const char *StrCurrentDateUTC);
static void Rep_WriteSectionPlatform (void);
static void Rep_WriteSectionUsrInfo (void);
static void Rep_WriteSectionUsrFigures (struct UsrFigures *UsrFigures,
struct tm *tm_FirstClickTime,
const char *StrCurrentDateUTC,
const char *StrCurrentTimeUTC);
static void Rep_WriteSectionGlobalHits (struct UsrFigures *UsrFigures,
struct tm *tm_FirstClickTime);
static void Rep_WriteSectionCurrentCourses (struct UsrFigures *UsrFigures,
struct tm *tm_FirstClickTime,
const char *StrCurrentDateUTC,
unsigned long MaxHitsPerYear);
static void Rep_WriteSectionHistoricCourses (struct UsrFigures *UsrFigures,
struct tm *tm_FirstClickTime,
unsigned long MaxHitsPerYear);
static unsigned long Rep_GetMaxHitsPerYear (time_t FirstClickTimeUTC);
static void Rep_GetAndWriteCurrentCrssOfAUsr (const struct UsrData *UsrDat,Rol_Role_t Role,
time_t FirstClickTimeUTC,
struct tm *tm_FirstClickTime,
unsigned long MaxHitsPerYear);
static void Rep_GetAndWriteHistoricCrssOfAUsr (const struct UsrData *UsrDat,Rol_Role_t Role,
time_t FirstClickTimeUTC,
struct tm *tm_FirstClickTime,
unsigned long MaxHitsPerYear);
static void Rep_WriteRowCrsData (long CrsCod,Rol_Role_t Role,
time_t FirstClickTimeUTC,
struct tm *tm_FirstClickTime,
unsigned long MaxHitsPerYear);
static void Rep_ShowMyHitsPerYear (bool AnyCourse,long CrsCod,Rol_Role_t Role,
time_t FirstClickTimeUTC,
struct tm *tm_FirstClickTime,
unsigned long MaxHitsPerYear);
static void Rep_DrawBarNumHits (float HitsNum,float HitsMax,
unsigned MaxBarWidth);
/*****************************************************************************/
/********* Show my usage report (report on my use of the platform) ***********/
/*****************************************************************************/
void Rep_ReqMyUsageReport (void)
{
extern const char *Txt_Report_of_use_of_PLATFORM;
extern const char *Txt_Generate_report;
char StrCurrentDateUTC[10+1]; // Example: 2016-10-02
// 1234567890
char StrCurrentTimeUTC[8+1]; // Example: 19:03:49
// 12345678
/***** Get current date-time *****/
Dat_GetCurrentDateTimeUTC (StrCurrentDateUTC,StrCurrentTimeUTC);
/***** Form to show my usage report *****/
Act_FormStart (ActSeeMyUsgRep);
/***** Start frame *****/
sprintf (Gbl.Title,Txt_Report_of_use_of_PLATFORM,Cfg_PLATFORM_SHORT_NAME);
Lay_StartRoundFrame (NULL,Gbl.Title,NULL);
/***** Header *****/
fprintf (Gbl.F.Out,"<div class=\"DAT_N\">%s",Gbl.Usrs.Me.UsrDat.FullName);
if (StrCurrentDateUTC[0])
fprintf (Gbl.F.Out,"<br />%s",StrCurrentDateUTC);
fprintf (Gbl.F.Out,"</div>");
/***** Send button and end frame *****/
Lay_EndRoundFrameWithButton (Lay_CONFIRM_BUTTON,Txt_Generate_report);
/***** End of form *****/
Act_FormEnd ();
}
void Rep_ShowMyUsageReport (void)
{
Rep_ShowOrPrintMyUsageReport (false);
}
void Rep_PrintMyUsageReport (void)
{
Rep_ShowOrPrintMyUsageReport (true);
}
static void Rep_ShowOrPrintMyUsageReport (Rep_SeeOrPrint_t SeeOrPrint)
{
extern const char *Txt_Report;
struct UsrFigures UsrFigures;
char PathReports[PATH_MAX+1];
char PathFileReport[PATH_MAX+1];
struct tm tm_FirstClickTime;
char StrCurrentDateUTC[10+1]; // Example: 2016-10-02
// 1234567890
char StrCurrentTimeUTC[8+1]; // Example: 19:03:49
// 12345678
bool GetUsrFiguresAgain;
unsigned long MaxHitsPerYear;
/***** Get current date-time *****/
Dat_GetCurrentDateTimeUTC (StrCurrentDateUTC,StrCurrentTimeUTC);
/***** Start frame *****/
if (SeeOrPrint == Rep_SEE)
Lay_StartRoundFrame (NULL,Txt_Report,
Rep_PutIconToPrintMyUsageReport);
/***** Path for reports *****/
sprintf (PathReports,"%s/%s",Cfg_PATH_SWAD_PRIVATE,Cfg_FOLDER_REP);
Fil_CreateDirIfNotExists (PathReports);
/***** Create a new empty syllabus *****/
/* Path of the private directory for the file with the report */
sprintf (PathFileReport,"%s/%s.html",
PathReports,Gbl.UniqueNameEncrypted);
if ((Gbl.F.Rep = fopen (PathFileReport,"wb")) == NULL)
Lay_ShowErrorAndExit ("Can not create report file.");
/***** Start file *****/
fprintf (Gbl.F.Rep,"<div style=\"margin:2em; text-align:left;\">\n");
/***** Header *****/
Rep_WriteHeader (Gbl.F.Rep,StrCurrentDateUTC);
/***** Platform *****/
Rep_WriteSectionPlatform ();
/***** Personal information *****/
Rep_WriteSectionUsrInfo ();
/***** Figures *****/
Prf_GetUsrFigures (Gbl.Usrs.Me.UsrDat.UsrCod,&UsrFigures);
GetUsrFiguresAgain = Prf_GetAndStoreAllUsrFigures (Gbl.Usrs.Me.UsrDat.UsrCod,&UsrFigures);
if (GetUsrFiguresAgain)
Prf_GetUsrFigures (Gbl.Usrs.Me.UsrDat.UsrCod,&UsrFigures);
if (UsrFigures.FirstClickTimeUTC)
gmtime_r (&UsrFigures.FirstClickTimeUTC,&tm_FirstClickTime);
Rep_WriteSectionUsrFigures (&UsrFigures,&tm_FirstClickTime,
StrCurrentDateUTC,StrCurrentTimeUTC);
/***** Global hits *****/
Rep_WriteSectionGlobalHits (&UsrFigures,&tm_FirstClickTime);
/***** Current courses *****/
MaxHitsPerYear = Rep_GetMaxHitsPerYear (UsrFigures.FirstClickTimeUTC);
Rep_WriteSectionCurrentCourses (&UsrFigures,&tm_FirstClickTime,
StrCurrentDateUTC,MaxHitsPerYear);
/***** Historic courses *****/
Rep_WriteSectionHistoricCourses (&UsrFigures,&tm_FirstClickTime,
MaxHitsPerYear);
/***** End file *****/
fprintf (Gbl.F.Rep,"</div>\n");
/***** Open report file for reading *****/
if ((Gbl.F.Rep = fopen (PathFileReport,"rb")) == NULL)
Lay_ShowErrorAndExit ("Can not open report file.");
/***** Copy from report file to output file *****/
Fil_FastCopyOfOpenFiles (Gbl.F.Rep,Gbl.F.Out);
/***** Close and remove report file *****/
Fil_CloseReportFile ();
unlink (PathFileReport);
/***** End frame *****/
if (SeeOrPrint == Rep_SEE)
Lay_EndRoundFrame ();
}
/*****************************************************************************/
/********************* Put icon to print my usage report *********************/
/*****************************************************************************/
static void Rep_PutIconToPrintMyUsageReport (void)
{
extern const char *Txt_Print;
Lay_PutContextualLink (ActPrnMyUsgRep,NULL,
"print64x64.png",
Txt_Print,NULL,
NULL);
}
/*****************************************************************************/
/******************** Write header of user's usage report ********************/
/*****************************************************************************/
static void Rep_WriteHeader (FILE *FileDst,const char *StrCurrentDateUTC)
{
extern const char *Txt_Report_of_use_of_PLATFORM;
/***** Start of header *****/
fprintf (FileDst,"<header style=\"margin:2em; text-align:center;\">");
/***** Main title *****/
sprintf (Gbl.Title,Txt_Report_of_use_of_PLATFORM,Cfg_PLATFORM_SHORT_NAME);
fprintf (FileDst,"<h1>%s</h1>",Gbl.Title);
/***** Subtitle *****/
fprintf (FileDst,"<h2>%s",Gbl.Usrs.Me.UsrDat.FullName);
if (StrCurrentDateUTC[0])
fprintf (FileDst,", %s",StrCurrentDateUTC);
fprintf (FileDst,"</h2>");
/***** End of header *****/
fprintf (FileDst,"</header>\n");
}
/*****************************************************************************/
/************* Write section for platform in user's usage report *************/
/*****************************************************************************/
static void Rep_WriteSectionPlatform (void)
{
extern const char *Txt_Teaching_platform;
extern const char *Txt_Name;
extern const char *Txt_TAGLINE;
extern const char *Txt_URL;
/***** Start of section *****/
fprintf (Gbl.F.Rep,"<section>"
"<h3>%s</h3>"
"<ul>",
Txt_Teaching_platform);
/***** Platform name *****/
fprintf (Gbl.F.Rep,"<li>%s: %s, %s</li>",
Txt_Name,
Cfg_PLATFORM_FULL_NAME,Txt_TAGLINE);
/***** Server URL *****/
fprintf (Gbl.F.Rep,"<li>%s: <a href=\"%s\">%s</a></li>",
Txt_URL,Cfg_URL_SWAD_SERVER,Cfg_URL_SWAD_SERVER);
/***** End of section *****/
fprintf (Gbl.F.Rep,"</ul>"
"</section>\n");
}
/*****************************************************************************/
/*********** Write section for user's info in user's usage report ************/
/*****************************************************************************/
static void Rep_WriteSectionUsrInfo (void)
{
extern const char *Txt_Personal_information;
extern const char *Txt_Name;
extern const char *Txt_Email;
extern const char *Txt_Country;
extern const char *Txt_Institution;
char CtyName[Cty_MAX_BYTES_COUNTRY_NAME+1];
struct Institution Ins;
/***** Start of section *****/
fprintf (Gbl.F.Rep,"<section>"
"<h3>%s</h3>"
"<ul>",
Txt_Personal_information);
/***** User's name *****/
fprintf (Gbl.F.Rep,"<li>%s: <strong>%s</strong></li>",
Txt_Name,
Gbl.Usrs.Me.UsrDat.FullName);
/***** User's e-mail *****/
fprintf (Gbl.F.Rep,"<li>%s: %s</li>",
Txt_Email,
Gbl.Usrs.Me.UsrDat.Email);
/***** User's country *****/
Cty_GetCountryName (Gbl.Usrs.Me.UsrDat.CtyCod,CtyName);
fprintf (Gbl.F.Rep,"<li>%s: %s</li>",
Txt_Country,
CtyName);
/***** User's institution *****/
Ins.InsCod = Gbl.Usrs.Me.UsrDat.InsCod;
Ins_GetDataOfInstitutionByCod (&Ins,Ins_GET_BASIC_DATA);
fprintf (Gbl.F.Rep,"<li>%s: %s</li>",
Txt_Institution,
Ins.FullName);
/***** End of section *****/
fprintf (Gbl.F.Rep,"</ul>"
"</section>\n");
}
/*****************************************************************************/
/********* Write section for user's figures in user's usage report ***********/
/*****************************************************************************/
static void Rep_WriteSectionUsrFigures (struct UsrFigures *UsrFigures,
struct tm *tm_FirstClickTime,
const char *StrCurrentDateUTC,
const char *StrCurrentTimeUTC)
{
extern const char *Txt_Figures;
extern const char *Txt_TIME_Since;
extern const char *Txt_TIME_until;
extern const char *Txt_day;
extern const char *Txt_days;
extern const char *Txt_Clicks;
extern const char *Txt_Files_uploaded;
extern const char *Txt_file;
extern const char *Txt_files;
extern const char *Txt_public_FILES;
extern const char *Txt_Downloads;
extern const char *Txt_download;
extern const char *Txt_downloads;
extern const char *Txt_Forum_posts;
extern const char *Txt_post;
extern const char *Txt_posts;
extern const char *Txt_Messages_sent;
extern const char *Txt_message;
extern const char *Txt_messages;
unsigned NumFiles;
unsigned NumPublicFiles;
/***** Start of section *****/
fprintf (Gbl.F.Rep,"<section>"
"<h3>%s</h3>"
"<ul>",
Txt_Figures);
/***** Time since first click until now *****/
fprintf (Gbl.F.Rep,"<li>%s ",Txt_TIME_Since);
if (UsrFigures->FirstClickTimeUTC)
{
if (tm_FirstClickTime != NULL)
{
fprintf (Gbl.F.Rep,"%04d-%02d-%02d %02d:%02d:%02d UTC",
1900 + tm_FirstClickTime->tm_year, // year
1 + tm_FirstClickTime->tm_mon, // month
tm_FirstClickTime->tm_mday, // day of the month
tm_FirstClickTime->tm_hour, // hours
tm_FirstClickTime->tm_min, // minutes
tm_FirstClickTime->tm_sec); // seconds
if (StrCurrentDateUTC[0])
fprintf (Gbl.F.Rep," %s %s %s UTC",
Txt_TIME_until,StrCurrentDateUTC,StrCurrentTimeUTC);
if (UsrFigures->NumDays > 0)
fprintf (Gbl.F.Rep," (%d %s)",
UsrFigures->NumDays,
(UsrFigures->NumDays == 1) ? Txt_day :
Txt_days);
}
}
else // Time of first click is unknown
{
fprintf (Gbl.F.Rep,"?");
if (StrCurrentDateUTC[0])
fprintf (Gbl.F.Rep," - %s %s UTC",StrCurrentDateUTC,StrCurrentTimeUTC);
}
fprintf (Gbl.F.Rep,"</li>");
/***** Number of clicks *****/
fprintf (Gbl.F.Rep,"<li>%s: ",Txt_Clicks);
if (UsrFigures->NumClicks >= 0)
{
fprintf (Gbl.F.Rep,"%ld",UsrFigures->NumClicks);
if (UsrFigures->NumDays > 0)
{
fprintf (Gbl.F.Rep," (");
Str_WriteFloatNum (Gbl.F.Rep,
(float) UsrFigures->NumClicks /
(float) UsrFigures->NumDays);
fprintf (Gbl.F.Rep," / %s)",Txt_day);
}
}
else // Number of clicks is unknown
fprintf (Gbl.F.Rep,"?");
fprintf (Gbl.F.Rep,"</li>");
/***** Number of files currently published *****/
if ((NumFiles = Brw_GetNumFilesUsr (Gbl.Usrs.Me.UsrDat.UsrCod)))
NumPublicFiles = Brw_GetNumPublicFilesUsr (Gbl.Usrs.Me.UsrDat.UsrCod);
else
NumPublicFiles = 0;
fprintf (Gbl.F.Rep,"<li>"
"%s: %u %s (%u %s)"
"</li>",
Txt_Files_uploaded,
NumFiles,
(NumFiles == 1) ? Txt_file :
Txt_files,
NumPublicFiles,Txt_public_FILES);
/***** Number of file views *****/
fprintf (Gbl.F.Rep,"<li>%s: ",Txt_Downloads);
if (UsrFigures->NumFileViews >= 0)
{
fprintf (Gbl.F.Rep,"%ld %s",
UsrFigures->NumFileViews,
(UsrFigures->NumFileViews == 1) ? Txt_download :
Txt_downloads);
if (UsrFigures->NumDays > 0)
{
fprintf (Gbl.F.Rep," (");
Str_WriteFloatNum (Gbl.F.Rep,
(float) UsrFigures->NumFileViews /
(float) UsrFigures->NumDays);
fprintf (Gbl.F.Rep," / %s)",Txt_day);
}
}
else // Number of file views is unknown
fprintf (Gbl.F.Rep,"?");
fprintf (Gbl.F.Rep,"</li>");
/***** Number of posts in forums *****/
fprintf (Gbl.F.Rep,"<li>%s: ",Txt_Forum_posts);
if (UsrFigures->NumForPst >= 0)
{
fprintf (Gbl.F.Rep,"%ld %s",
UsrFigures->NumForPst,
(UsrFigures->NumForPst == 1) ? Txt_post :
Txt_posts);
if (UsrFigures->NumDays > 0)
{
fprintf (Gbl.F.Rep," (");
Str_WriteFloatNum (Gbl.F.Rep,
(float) UsrFigures->NumForPst /
(float) UsrFigures->NumDays);
fprintf (Gbl.F.Rep," / %s)",Txt_day);
}
}
else // Number of forum posts is unknown
fprintf (Gbl.F.Rep,"?");
fprintf (Gbl.F.Rep,"</li>");
/***** Number of messages sent *****/
fprintf (Gbl.F.Rep,"<li>%s: ",Txt_Messages_sent);
if (UsrFigures->NumMsgSnt >= 0)
{
fprintf (Gbl.F.Rep,"%ld %s",
UsrFigures->NumMsgSnt,
(UsrFigures->NumMsgSnt == 1) ? Txt_message :
Txt_messages);
if (UsrFigures->NumDays > 0)
{
fprintf (Gbl.F.Rep," (");
Str_WriteFloatNum (Gbl.F.Rep,
(float) UsrFigures->NumMsgSnt /
(float) UsrFigures->NumDays);
fprintf (Gbl.F.Rep," / %s)",Txt_day);
}
}
else // Number of messages sent is unknown
fprintf (Gbl.F.Rep,"?");
fprintf (Gbl.F.Rep,"</li>");
/***** End of section *****/
fprintf (Gbl.F.Rep,"</ul>"
"</section>\n");
}
/*****************************************************************************/
/******** Write section for user's global hits in user's usage report ********/
/*****************************************************************************/
static void Rep_WriteSectionGlobalHits (struct UsrFigures *UsrFigures,
struct tm *tm_FirstClickTime)
{
extern const char *Txt_Hits;
/***** Start of section *****/
fprintf (Gbl.F.Rep,"<section>"
"<h3>%s</h3>",
Txt_Hits);
/***** Global (in any course) hits per year *****/
Rep_ShowMyHitsPerYear (true,-1L, // Any course
Rol_UNKNOWN, // Any role
UsrFigures->FirstClickTimeUTC,
tm_FirstClickTime,
0); // MaxHitsPerYear not passed as an argument but computed inside the function
/***** End of section *****/
fprintf (Gbl.F.Rep,"</section>\n");
}
/*****************************************************************************/
/****** Write section for user's current courses in user's usage report ******/
/*****************************************************************************/
static void Rep_WriteSectionCurrentCourses (struct UsrFigures *UsrFigures,
struct tm *tm_FirstClickTime,
const char *StrCurrentDateUTC,
unsigned long MaxHitsPerYear)
{
extern const char *Txt_Courses;
Rol_Role_t Role;
/***** Start of section *****/
fprintf (Gbl.F.Rep,"<section>"
"<h3>%s",
Txt_Courses);
if (StrCurrentDateUTC[0])
fprintf (Gbl.F.Rep," (%s)",StrCurrentDateUTC);
fprintf (Gbl.F.Rep,"</h3>"
"<ul>");
/***** Number of courses in which the user is student/teacher *****/
for (Role = Rol_STUDENT;
Role <= Rol_TEACHER;
Role++)
/* List my courses with this role */
Rep_GetAndWriteCurrentCrssOfAUsr (&Gbl.Usrs.Me.UsrDat,Role,
UsrFigures->FirstClickTimeUTC,tm_FirstClickTime,
MaxHitsPerYear);
/***** End of section *****/
fprintf (Gbl.F.Rep,"</ul>"
"</section>\n");
}
/*****************************************************************************/
/***** Write section for user's historic courses in user's usage report ******/
/*****************************************************************************/
static void Rep_WriteSectionHistoricCourses (struct UsrFigures *UsrFigures,
struct tm *tm_FirstClickTime,
unsigned long MaxHitsPerYear)
{
extern const char *Txt_Courses;
extern const char *Txt_historical_log;
extern const char *Txt_Only_courses_with_more_than_X_clicks_are_shown;
Rol_Role_t Role;
/***** Start of section *****/
fprintf (Gbl.F.Rep,"<section>"
"<h3>%s (%s)</h3>",
Txt_Courses,Txt_historical_log);
fprintf (Gbl.F.Rep,Txt_Only_courses_with_more_than_X_clicks_are_shown,
Rep_MIN_CLICKS_CRS);
fprintf (Gbl.F.Rep,"<ul>");
/***** Number of courses in which the user clicked as student/teacher *****/
for (Role = Rol_STUDENT;
Role <= Rol_TEACHER;
Role++)
/* List my courses with this role */
Rep_GetAndWriteHistoricCrssOfAUsr (&Gbl.Usrs.Me.UsrDat,Role,
UsrFigures->FirstClickTimeUTC,tm_FirstClickTime,
MaxHitsPerYear);
/***** End of section *****/
fprintf (Gbl.F.Rep,"</ul>"
"</section>\n");
}
/*****************************************************************************/
/************ Get the maximum number of hits per course-year-role ************/
/*****************************************************************************/
// Return the maximum number of hits per year
static unsigned long Rep_GetMaxHitsPerYear (time_t FirstClickTimeUTC)
{
char Query[512];
MYSQL_RES *mysql_res;
MYSQL_ROW row;
unsigned long MaxHitsPerYear = 0;
sprintf (Query,"SELECT MAX(N) FROM (SELECT "
"CrsCod,"
"YEAR(CONVERT_TZ(ClickTime,@@session.time_zone,'UTC')) AS Year,"
"Role,"
"COUNT(*) AS N"
" FROM log_full"
" WHERE ClickTime>=FROM_UNIXTIME('%ld')"
" AND UsrCod='%ld' AND Role>='%u' AND Role<='%u'"
" GROUP BY CrsCod,Year,Role)"
" AS hits_per_crs_year",
(long) FirstClickTimeUTC,
Gbl.Usrs.Me.UsrDat.UsrCod,
(unsigned) Rol_STUDENT,
(unsigned) Rol_TEACHER);
DB_QuerySELECT (Query,&mysql_res,"can not get last question index");
/***** Get number of users *****/
row = mysql_fetch_row (mysql_res);
if (row[0]) // There are questions
if (sscanf (row[0],"%lu",&MaxHitsPerYear) != 1)
Lay_ShowErrorAndExit ("Error when getting maximum hits.");
return MaxHitsPerYear;
}
/*****************************************************************************/
/************************** Write courses of a user **************************/
/*****************************************************************************/
static void Rep_GetAndWriteCurrentCrssOfAUsr (const struct UsrData *UsrDat,Rol_Role_t Role,
time_t FirstClickTimeUTC,
struct tm *tm_FirstClickTime,
unsigned long MaxHitsPerYear)
{
extern const char *Txt_USER_in_COURSE;
extern const char *Txt_ROLES_SINGUL_Abc[Rol_NUM_ROLES][Usr_NUM_SEXS];
extern const char *Txt_course;
extern const char *Txt_courses;
extern const char *Txt_teachers_ABBREVIATION;
extern const char *Txt_students_ABBREVIATION;
char Query[512];
MYSQL_RES *mysql_res;
MYSQL_ROW row;
unsigned NumCrss;
unsigned NumCrs;
long CrsCod;
NumCrss = Usr_GetNumCrssOfUsrWithARole (UsrDat->UsrCod,Role);
sprintf (Gbl.Title,Txt_USER_in_COURSE,Txt_ROLES_SINGUL_Abc[Role][Gbl.Usrs.Me.UsrDat.Sex]);
fprintf (Gbl.F.Rep,"<li>%s %u %s",
Gbl.Title,
NumCrss,
NumCrss == 1 ? Txt_course :
Txt_courses);
if (NumCrss)
{
fprintf (Gbl.F.Rep," (%u %s / %u %s)",
Usr_GetNumUsrsInCrssOfAUsr (Gbl.Usrs.Me.UsrDat.UsrCod,Role,Rol_TEACHER),
Txt_teachers_ABBREVIATION,
Usr_GetNumUsrsInCrssOfAUsr (Gbl.Usrs.Me.UsrDat.UsrCod,Role,Rol_STUDENT),
Txt_students_ABBREVIATION);
/***** Get courses of a user from database *****/
sprintf (Query,"SELECT courses.CrsCod,degrees.FullName,courses.Year,courses.FullName"
" FROM crs_usr,courses,degrees"
" WHERE crs_usr.UsrCod='%ld'"
" AND crs_usr.Role='%u'"
" AND crs_usr.CrsCod=courses.CrsCod"
" AND courses.DegCod=degrees.DegCod"
" ORDER BY degrees.FullName,courses.Year,courses.FullName",
UsrDat->UsrCod,(unsigned) Role);
/***** List the courses (one row per course) *****/
if ((NumCrss = (unsigned) DB_QuerySELECT (Query,&mysql_res,"can not get courses of a user")))
{
/* Heading row */
fprintf (Gbl.F.Rep,"<ol>");
/* Write courses */
for (NumCrs = 1;
NumCrs <= NumCrss;
NumCrs++)
{
/* Get next course */
row = mysql_fetch_row (mysql_res);
/* Get course code (row[0]) */
CrsCod = Str_ConvertStrCodToLongCod (row[0]);
/* Write data of this course */
Rep_WriteRowCrsData (CrsCod,Role,
FirstClickTimeUTC,tm_FirstClickTime,
MaxHitsPerYear);
}
/* End table */
fprintf (Gbl.F.Rep,"</ol>");
}
/***** Free structure that stores the query result *****/
DB_FreeMySQLResult (&mysql_res);
}
fprintf (Gbl.F.Rep,"</li>");
}
/*****************************************************************************/
/************************** Write courses of a user **************************/
/*****************************************************************************/
static void Rep_GetAndWriteHistoricCrssOfAUsr (const struct UsrData *UsrDat,Rol_Role_t Role,
time_t FirstClickTimeUTC,
struct tm *tm_FirstClickTime,
unsigned long MaxHitsPerYear)
{
extern const char *Txt_Hits_as_a_USER;
extern const char *Txt_ROLES_SINGUL_abc[Rol_NUM_ROLES][Usr_NUM_SEXS];
char Query[256];
MYSQL_RES *mysql_res;
MYSQL_ROW row;
unsigned NumCrss;
unsigned NumCrs;
long CrsCod;
/***** Get courses of a user from database *****/
sprintf (Query,"SELECT CrsCod,COUNT(*) AS N"
" FROM log_full"
" WHERE UsrCod='%ld' AND Role='%u'"
" GROUP BY CrsCod"
" HAVING N>'%u'"
" ORDER BY N DESC",
UsrDat->UsrCod,(unsigned) Role,
Rep_MIN_CLICKS_CRS);
/***** List the courses (one row per course) *****/
if ((NumCrss = (unsigned) DB_QuerySELECT (Query,&mysql_res,"can not get courses of a user")))
{
/* Heading row */
sprintf (Gbl.Title,Txt_Hits_as_a_USER,
Txt_ROLES_SINGUL_abc[Role][Gbl.Usrs.Me.UsrDat.Sex]);
fprintf (Gbl.F.Rep,"<li>%s:"
"<ol>",
Gbl.Title);
/* Write courses */
for (NumCrs = 1;
NumCrs <= NumCrss;
NumCrs++)
{
/* Get next course */
row = mysql_fetch_row (mysql_res);
/* Get course code (row[0]) */
CrsCod = Str_ConvertStrCodToLongCod (row[0]);
/* Write data of this course */
Rep_WriteRowCrsData (CrsCod,Role,
FirstClickTimeUTC,tm_FirstClickTime,
MaxHitsPerYear);
}
/* End of list */
fprintf (Gbl.F.Rep,"</ol>"
"</li>");
}
/***** Free structure that stores the query result *****/
DB_FreeMySQLResult (&mysql_res);
}
/*****************************************************************************/
/************** Write the data of a course (result of a query) ***************/
/*****************************************************************************/
static void Rep_WriteRowCrsData (long CrsCod,Rol_Role_t Role,
time_t FirstClickTimeUTC,
struct tm *tm_FirstClickTime,
unsigned long MaxHitsPerYear)
{
extern const char *Txt_YEAR_OF_DEGREE[1+Deg_MAX_YEARS_PER_DEGREE];
extern const char *Txt_teachers_ABBREVIATION;
extern const char *Txt_students_ABBREVIATION;
extern const char *Txt_unknown_removed_course;
extern const char *Txt_no_course_selected;
struct Course Crs;
struct Degree Deg;
/***** Get course data *****/
Crs.CrsCod = CrsCod;
Crs_GetDataOfCourseByCod (&Crs);
/***** Get degree data *****/
Deg.DegCod = Crs.DegCod;
Deg_GetDataOfDegreeByCod (&Deg);
/***** Start row *****/
fprintf (Gbl.F.Rep,"<li>");
if (CrsCod > 0) // CrsCod > 0 in log ==> course selected
{
if (Crs.CrsCod > 0) // Course exists
{
/***** Write course full name *****/
fprintf (Gbl.F.Rep,"<strong>%s</strong> -",Crs.FullName);
/***** Write year *****/
if (Crs.Year)
fprintf (Gbl.F.Rep," %s",Txt_YEAR_OF_DEGREE[Crs.Year]);
/***** Write degree full name *****/
fprintf (Gbl.F.Rep," %s",Deg.FullName);
/***** Write number of teachers / students in course *****/
fprintf (Gbl.F.Rep," (%u %s / %u %s)",
Usr_GetNumUsrsInCrs (Rol_TEACHER,Crs.CrsCod),Txt_teachers_ABBREVIATION,
Usr_GetNumUsrsInCrs (Rol_STUDENT,Crs.CrsCod),Txt_students_ABBREVIATION);
}
else
fprintf (Gbl.F.Rep,"(%s)",Txt_unknown_removed_course);
}
else // CrsCod <= 0 in log ==> no course selected
fprintf (Gbl.F.Rep,"(%s)",Txt_no_course_selected);
/***** Write hits per year for this course *****/
fprintf (Gbl.F.Rep,"<br />");
Rep_ShowMyHitsPerYear (false,CrsCod,Role,
FirstClickTimeUTC,tm_FirstClickTime,
MaxHitsPerYear);
fprintf (Gbl.F.Rep,"</li>");
}
/*****************************************************************************/
/********************** Write my hits grouped by years ***********************/
/*****************************************************************************/
static void Rep_ShowMyHitsPerYear (bool AnyCourse,long CrsCod,Rol_Role_t Role,
time_t FirstClickTimeUTC,
struct tm *tm_FirstClickTime,
unsigned long MaxHitsPerYear)
{
char Query[512];
char SubQueryCrs[128];
char SubQueryRol[128];
MYSQL_RES *mysql_res;
MYSQL_ROW row;
unsigned long NumRows;
unsigned long NumRow;
unsigned ReadYear;
unsigned LastYear;
unsigned Year;
struct Sta_Hits Hits;
/***** Make the query *****/
if (AnyCourse)
SubQueryCrs[0] = '\0';
else
sprintf (SubQueryCrs," AND CrsCod='%ld'",CrsCod);
if (Role == Rol_UNKNOWN) // Here Rol_UNKNOWN means any role
SubQueryRol[0] = '\0';
else
sprintf (SubQueryRol," AND Role='%u'",(unsigned) Role);
sprintf (Query,"SELECT SQL_NO_CACHE "
"YEAR(CONVERT_TZ(ClickTime,@@session.time_zone,'UTC')) AS Year,"
"COUNT(*) FROM log_full"
" WHERE ClickTime>=FROM_UNIXTIME('%ld')"
" AND UsrCod='%ld'%s%s"
" GROUP BY Year DESC",
(long) FirstClickTimeUTC,
Gbl.Usrs.Me.UsrDat.UsrCod,
SubQueryCrs,
SubQueryRol);
NumRows = DB_QuerySELECT (Query,&mysql_res,"can not get clicks");
/***** Initialize first year *****/
Gbl.DateRange.DateIni.Date.Year = 1900 + tm_FirstClickTime->tm_year;
/***** Initialize LastYear *****/
LastYear = Gbl.Now.Date.Year;
/***** Set maximum number of hits per year *****/
if (MaxHitsPerYear)
/* Set maximum number of hits per year from parameter */
Hits.Max = (float) MaxHitsPerYear;
else
{
/* Compute maximum number of hits per year */
Sta_ComputeMaxAndTotalHits (&Hits,NumRows,mysql_res,1,1);
mysql_data_seek (mysql_res,0);
}
/***** Write rows *****/
for (NumRow = 1;
NumRow <= NumRows;
NumRow++)
{
row = mysql_fetch_row (mysql_res);
/* Get the year (in row[0] is the date in YYYY format) */
if (sscanf (row[0],"%04u",&ReadYear) != 1)
Lay_ShowErrorAndExit ("Wrong date.");
/* Get number hits (in row[1]) */
Hits.Num = Str_GetFloatNumFromStr (row[1]);
for (Year = LastYear;
Year >= ReadYear;
Year--)
{
/* Write the year */
fprintf (Gbl.F.Rep,"%04u ",Year);
/* Draw bar proportional to number of hits */
Rep_DrawBarNumHits (Year == LastYear ? Hits.Num :
0.0,
Hits.Max,Rep_MAX_BAR_WIDTH);
}
LastYear = Year;
}
/***** Finally, show the oldest years without clicks *****/
for (Year = LastYear;
Year >= Gbl.DateRange.DateIni.Date.Year;
Year--)
{
/* Write the year */
fprintf (Gbl.F.Rep,"%04u ",Year);
/* Draw bar proportional to number of hits */
Rep_DrawBarNumHits (0.0,Hits.Max,Rep_MAX_BAR_WIDTH);
}
}
/*****************************************************************************/
/********************* Draw a bar with the number of hits ********************/
/*****************************************************************************/
static void Rep_DrawBarNumHits (float HitsNum,float HitsMax,
unsigned MaxBarWidth)
{
unsigned BarWidth;
unsigned i;
if (HitsNum != 0.0)
{
/***** Draw bar with a with proportional to the number of hits *****/
BarWidth = (unsigned) (((HitsNum * (float) MaxBarWidth) / HitsMax) + 0.5);
for (i = 0;
i < BarWidth;
i++)
fprintf (Gbl.F.Rep,Rep_BLOCK);
/***** Write the number of hits *****/
fprintf (Gbl.F.Rep," ");
Str_WriteFloatNum (Gbl.F.Rep,HitsNum);
}
else
/***** Write the number of clicks *****/
fprintf (Gbl.F.Rep,"0");
fprintf (Gbl.F.Rep,"<br />");
}
Reference in New Issue View Git Blame Copy Permalink