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

645 lines
22 KiB
C
Raw Blame History

// swad_timeline_favourite.c: social timeline favourites
/*
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-2021 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 "swad_database.h"
#include "swad_global.h"
#include "swad_timeline.h"
#include "swad_timeline_favourite.h"
#include "swad_timeline_publication.h"
/*****************************************************************************/
/****************************** Public constants *****************************/
/*****************************************************************************/
/*****************************************************************************/
/************************* Private constants and types ***********************/
/*****************************************************************************/
#define TL_ICON_FAV "heart.svg"
#define TL_ICON_FAVED "heart-red.svg"
/*****************************************************************************/
/************** External global variables from others modules ****************/
/*****************************************************************************/
extern struct Globals Gbl;
/*****************************************************************************/
/************************* Private global variables **************************/
/*****************************************************************************/
/*****************************************************************************/
/***************************** Private prototypes ****************************/
/*****************************************************************************/
static void TL_Fav_PutDisabledIconFav (unsigned NumFavs);
static void TL_Fav_PutFormToFavNote (long ParamCod);
static void TL_Fav_PutFormToUnfNote (long ParamCod);
static void TL_Fav_PutFormToFavComment (long ParamCod);
static void TL_Fav_PutFormToUnfComment (long ParamCod);
static void TL_Fav_FavNote (struct TL_Not_Note *Not);
static void TL_Fav_UnfNote (struct TL_Not_Note *Not);
static void TL_Fav_FavComment (struct TL_Com_Comment *Com);
static void TL_Fav_UnfComment (struct TL_Com_Comment *Com);
static bool TL_Fav_CheckIfNoteIsFavedByUsr (long NotCod,long UsrCod);
static bool TL_Fav_CheckIfCommIsFavedByUsr (long PubCod,long UsrCod);
static void TL_Fav_ShowUsrsWhoHaveMarkedNoteAsFav (const struct TL_Not_Note *Not,
TL_HowManyUsrs_t HowManyUsrs);
static void TL_Fav_ShowUsrsWhoHaveMarkedCommAsFav (const struct TL_Com_Comment *Com,
TL_HowManyUsrs_t HowManyUsrs);
/*****************************************************************************/
/****************** Put disabled icon to mark as favourite *******************/
/*****************************************************************************/
static void TL_Fav_PutDisabledIconFav (unsigned NumFavs)
{
extern const char *Txt_TIMELINE_NOTE_Favourited_by_X_USERS;
extern const char *Txt_TIMELINE_NOTE_Not_favourited_by_anyone;
/***** Disabled icon to mark as favourite *****/
if (NumFavs)
{
Ico_PutDivIcon ("TL_ICO_DISABLED",TL_ICON_FAV,
Str_BuildStringLong (Txt_TIMELINE_NOTE_Favourited_by_X_USERS,
(long) NumFavs));
Str_FreeString ();
}
else
Ico_PutDivIcon ("TL_ICO_DISABLED",TL_ICON_FAV,
Txt_TIMELINE_NOTE_Not_favourited_by_anyone);
}
/*****************************************************************************/
/************************** Form to fav/unfav note ***************************/
/*****************************************************************************/
static void TL_Fav_PutFormToFavNote (long ParamCod)
{
extern const char *Txt_Mark_as_favourite;
/***** Form and icon to mark note as favourite *****/
TL_FormFavSha (ActFavTL_NotGbl,ActFavTL_NotUsr,
"NotCod=%ld",ParamCod,
TL_ICON_FAV,Txt_Mark_as_favourite);
}
static void TL_Fav_PutFormToUnfNote (long ParamCod)
{
extern const char *Txt_TIMELINE_NOTE_Favourite;
/***** Form and icon to unfav (remove mark as favourite) note *****/
TL_FormFavSha (ActUnfTL_NotGbl,ActUnfTL_NotUsr,
"NotCod=%ld",ParamCod,
TL_ICON_FAVED,Txt_TIMELINE_NOTE_Favourite);
}
/*****************************************************************************/
/************************** Form to fav/unfav comment ************************/
/*****************************************************************************/
static void TL_Fav_PutFormToFavComment (long ParamCod)
{
extern const char *Txt_Mark_as_favourite;
/***** Form and icon to mark comment as favourite *****/
TL_FormFavSha (ActFavTL_ComGbl,ActFavTL_ComUsr,
"PubCod=%ld",ParamCod,
TL_ICON_FAV,Txt_Mark_as_favourite);
}
static void TL_Fav_PutFormToUnfComment (long ParamCod)
{
extern const char *Txt_TIMELINE_NOTE_Favourite;
/***** Form and icon to unfav (remove mark as favourite) comment *****/
TL_FormFavSha (ActUnfTL_ComGbl,ActUnfTL_ComUsr,
"PubCod=%ld",ParamCod,
TL_ICON_FAVED,Txt_TIMELINE_NOTE_Favourite);
}
/*****************************************************************************/
/********************** Mark/unmark a note as favourite **********************/
/*****************************************************************************/
void TL_Fav_ShowAllFaversNoteUsr (void)
{
/***** Get user whom profile is displayed *****/
Usr_GetParamOtherUsrCodEncryptedAndGetUsrData ();
/***** Show all favers *****/
TL_Fav_ShowAllFaversNoteGbl ();
}
void TL_Fav_ShowAllFaversNoteGbl (void)
{
struct TL_Not_Note Not;
/***** Get data of note *****/
Not.NotCod = TL_Not_GetParamNotCod ();
TL_Not_GetDataOfNoteByCod (&Not);
/***** Write HTML inside DIV with form to fav/unfav *****/
TL_Fav_PutFormToFavUnfNote (&Not,TL_SHOW_ALL_USRS);
}
void TL_Fav_FavNoteUsr (void)
{
/***** Get user whom profile is displayed *****/
Usr_GetParamOtherUsrCodEncryptedAndGetUsrData ();
/***** Mark note as favourite *****/
TL_Fav_FavNoteGbl ();
}
void TL_Fav_FavNoteGbl (void)
{
struct TL_Not_Note Not;
/***** Mark note as favourite *****/
TL_Fav_FavNote (&Not);
/***** Write HTML inside DIV with form to unfav *****/
TL_Fav_PutFormToFavUnfNote (&Not,TL_SHOW_FEW_USRS);
}
void TL_Fav_UnfNoteUsr (void)
{
/***** Get user whom profile is displayed *****/
Usr_GetParamOtherUsrCodEncryptedAndGetUsrData ();
/***** Unfav a note previously marked as favourite *****/
TL_Fav_UnfNoteGbl ();
}
void TL_Fav_UnfNoteGbl (void)
{
struct TL_Not_Note Not;
/***** Stop marking as favourite a previously favourited note *****/
TL_Fav_UnfNote (&Not);
/***** Write HTML inside DIV with form to fav *****/
TL_Fav_PutFormToFavUnfNote (&Not,TL_SHOW_FEW_USRS);
}
void TL_Fav_PutFormToFavUnfNote (const struct TL_Not_Note *Not,
TL_HowManyUsrs_t HowManyUsrs)
{
bool IAmTheAuthor;
bool IAmAFaverOfThisNot;
/***** Put form to fav/unfav this note *****/
HTM_DIV_Begin ("class=\"TL_ICO\"");
IAmTheAuthor = Usr_ItsMe (Not->UsrCod);
if (Not->Unavailable || // Unavailable notes can not be favourited
IAmTheAuthor) // I am the author
/* Put disabled icon */
TL_Fav_PutDisabledIconFav (Not->NumFavs);
else // Available and I am not the author
{
/* Put icon to fav/unfav */
IAmAFaverOfThisNot = TL_Fav_CheckIfNoteIsFavedByUsr (Not->NotCod,
Gbl.Usrs.Me.UsrDat.UsrCod);
if (IAmAFaverOfThisNot) // I have favourited this note
TL_Fav_PutFormToUnfNote (Not->NotCod);
else // I am not a faver of this note
TL_Fav_PutFormToFavNote (Not->NotCod);
}
HTM_DIV_End ();
/***** Show who have marked this note as favourite *****/
TL_Fav_ShowUsrsWhoHaveMarkedNoteAsFav (Not,HowManyUsrs);
}
static void TL_Fav_FavNote (struct TL_Not_Note *Not)
{
bool ItsMe;
long OriginalPubCod;
/***** Get data of note *****/
Not->NotCod = TL_Not_GetParamNotCod ();
TL_Not_GetDataOfNoteByCod (Not);
if (Not->NotCod > 0)
{
ItsMe = Usr_ItsMe (Not->UsrCod);
if (Gbl.Usrs.Me.Logged && !ItsMe) // I am not the author
if (!TL_Fav_CheckIfNoteIsFavedByUsr (Not->NotCod,
Gbl.Usrs.Me.UsrDat.UsrCod)) // I have not yet favourited the note
{
/***** Mark as favourite in database *****/
DB_QueryINSERT ("can not favourite note",
"INSERT IGNORE INTO tl_notes_fav"
" (NotCod,UsrCod,TimeFav)"
" VALUES"
" (%ld,%ld,NOW())",
Not->NotCod,
Gbl.Usrs.Me.UsrDat.UsrCod);
/***** Update number of times this note is favourited *****/
TL_Fav_GetNumTimesANoteHasBeenFav (Not);
/***** Create notification about favourite post
for the author of the post *****/
OriginalPubCod = TL_Not_GetPubCodOfOriginalNote (Not->NotCod);
if (OriginalPubCod > 0)
TL_Pub_CreateNotifToAuthor (Not->UsrCod,OriginalPubCod,Ntf_EVENT_TIMELINE_FAV);
}
}
}
static void TL_Fav_UnfNote (struct TL_Not_Note *Not)
{
long OriginalPubCod;
bool ItsMe;
/***** Get data of note *****/
Not->NotCod = TL_Not_GetParamNotCod ();
TL_Not_GetDataOfNoteByCod (Not);
if (Not->NotCod > 0)
{
ItsMe = Usr_ItsMe (Not->UsrCod);
if (Not->NumFavs &&
Gbl.Usrs.Me.Logged && !ItsMe) // I am not the author
if (TL_Fav_CheckIfNoteIsFavedByUsr (Not->NotCod,
Gbl.Usrs.Me.UsrDat.UsrCod)) // I have favourited the note
{
/***** Delete the mark as favourite from database *****/
DB_QueryDELETE ("can not unfavourite note",
"DELETE FROM tl_notes_fav"
" WHERE NotCod=%ld AND UsrCod=%ld",
Not->NotCod,
Gbl.Usrs.Me.UsrDat.UsrCod);
/***** Update number of times this note is favourited *****/
TL_Fav_GetNumTimesANoteHasBeenFav (Not);
/***** Mark possible notifications on this note as removed *****/
OriginalPubCod = TL_Not_GetPubCodOfOriginalNote (Not->NotCod);
if (OriginalPubCod > 0)
Ntf_MarkNotifAsRemoved (Ntf_EVENT_TIMELINE_FAV,OriginalPubCod);
}
}
}
/*****************************************************************************/
/********************* Mark/unmark a comment as favourite ************************/
/*****************************************************************************/
void TL_Fav_ShowAllFaversComUsr (void)
{
/***** Get user whom profile is displayed *****/
Usr_GetParamOtherUsrCodEncryptedAndGetUsrData ();
/***** Show all favers *****/
TL_Fav_ShowAllFaversComGbl ();
}
void TL_Fav_ShowAllFaversComGbl (void)
{
struct TL_Com_Comment Com;
/***** Get data of comment *****/
Med_MediaConstructor (&Com.Content.Media);
Com.PubCod = TL_Pub_GetParamPubCod ();
TL_Com_GetDataOfCommByCod (&Com);
Med_MediaDestructor (&Com.Content.Media);
/***** Write HTML inside DIV with form to fav/unfav *****/
TL_Fav_PutFormToFavUnfComment (&Com,TL_SHOW_ALL_USRS);
}
void TL_Fav_FavCommentUsr (void)
{
/***** Get user whom profile is displayed *****/
Usr_GetParamOtherUsrCodEncryptedAndGetUsrData ();
/***** Mark comment as favourite *****/
TL_Fav_FavCommentGbl ();
}
void TL_Fav_FavCommentGbl (void)
{
struct TL_Com_Comment Com;
/***** Mark comment as favourite *****/
TL_Fav_FavComment (&Com);
/***** Write HTML inside DIV with form to unfav *****/
TL_Fav_PutFormToFavUnfComment (&Com,TL_SHOW_FEW_USRS);
}
void TL_Fav_UnfCommentUsr (void)
{
/***** Get user whom profile is displayed *****/
Usr_GetParamOtherUsrCodEncryptedAndGetUsrData ();
/***** Unfav a comment previously marked as favourite *****/
TL_Fav_UnfCommentGbl ();
}
void TL_Fav_UnfCommentGbl (void)
{
struct TL_Com_Comment Com;
/***** Stop marking as favourite a previously favourited comment *****/
TL_Fav_UnfComment (&Com);
/***** Write HTML inside DIV with form to fav *****/
TL_Fav_PutFormToFavUnfComment (&Com,TL_SHOW_FEW_USRS);
}
void TL_Fav_PutFormToFavUnfComment (const struct TL_Com_Comment *Com,
TL_HowManyUsrs_t HowManyUsrs)
{
bool IAmTheAuthor;
bool IAmAFaverOfThisCom;
/***** Put form to fav/unfav this comment *****/
HTM_DIV_Begin ("class=\"TL_ICO\"");
IAmTheAuthor = Usr_ItsMe (Com->UsrCod);
if (IAmTheAuthor) // I am the author
/* Put disabled icon */
TL_Fav_PutDisabledIconFav (Com->NumFavs);
else // I am not the author
{
/* Put icon to mark this comment as favourite */
IAmAFaverOfThisCom = TL_Fav_CheckIfCommIsFavedByUsr (Com->PubCod,
Gbl.Usrs.Me.UsrDat.UsrCod);
if (IAmAFaverOfThisCom) // I have favourited this comment
/* Put icon to unfav this publication and list of users */
TL_Fav_PutFormToUnfComment (Com->PubCod);
else // I am not a favouriter
/* Put icon to fav this publication and list of users */
TL_Fav_PutFormToFavComment (Com->PubCod);
}
HTM_DIV_End ();
/***** Show who have marked this comment as favourite *****/
TL_Fav_ShowUsrsWhoHaveMarkedCommAsFav (Com,HowManyUsrs);
}
static void TL_Fav_FavComment (struct TL_Com_Comment *Com)
{
bool IAmTheAuthor;
/***** Initialize image *****/
Med_MediaConstructor (&Com->Content.Media);
/***** Get data of comment *****/
Com->PubCod = TL_Pub_GetParamPubCod ();
TL_Com_GetDataOfCommByCod (Com);
if (Com->PubCod > 0)
{
IAmTheAuthor = Usr_ItsMe (Com->UsrCod);
if (!IAmTheAuthor) // I am not the author
if (!TL_Fav_CheckIfCommIsFavedByUsr (Com->PubCod,
Gbl.Usrs.Me.UsrDat.UsrCod)) // I have not yet favourited the comment
{
/***** Mark as favourite in database *****/
DB_QueryINSERT ("can not favourite comment",
"INSERT IGNORE INTO tl_comments_fav"
" (PubCod,UsrCod,TimeFav)"
" VALUES"
" (%ld,%ld,NOW())",
Com->PubCod,
Gbl.Usrs.Me.UsrDat.UsrCod);
/* Update number of times this comment is favourited */
TL_Fav_GetNumTimesACommHasBeenFav (Com);
/**** Create notification about favourite post
for the author of the post ***/
TL_Pub_CreateNotifToAuthor (Com->UsrCod,Com->PubCod,Ntf_EVENT_TIMELINE_FAV);
}
}
/***** Free image *****/
Med_MediaDestructor (&Com->Content.Media);
}
static void TL_Fav_UnfComment (struct TL_Com_Comment *Com)
{
bool IAmTheAuthor;
/***** Initialize image *****/
Med_MediaConstructor (&Com->Content.Media);
/***** Get data of comment *****/
Com->PubCod = TL_Pub_GetParamPubCod ();
TL_Com_GetDataOfCommByCod (Com);
if (Com->PubCod > 0)
{
IAmTheAuthor = Usr_ItsMe (Com->UsrCod);
if (Com->NumFavs &&
!IAmTheAuthor) // I am not the author
if (TL_Fav_CheckIfCommIsFavedByUsr (Com->PubCod,
Gbl.Usrs.Me.UsrDat.UsrCod)) // I have favourited the comment
{
/***** Delete the mark as favourite from database *****/
DB_QueryDELETE ("can not unfavourite comment",
"DELETE FROM tl_comments_fav"
" WHERE PubCod=%ld AND UsrCod=%ld",
Com->PubCod,
Gbl.Usrs.Me.UsrDat.UsrCod);
/***** Update number of times this comment is favourited *****/
TL_Fav_GetNumTimesACommHasBeenFav (Com);
/***** Mark possible notifications on this comment as removed *****/
Ntf_MarkNotifAsRemoved (Ntf_EVENT_TIMELINE_FAV,Com->PubCod);
}
}
/***** Free image *****/
Med_MediaDestructor (&Com->Content.Media);
}
/*****************************************************************************/
/****************** Check if a user has favourited a note ********************/
/*****************************************************************************/
static bool TL_Fav_CheckIfNoteIsFavedByUsr (long NotCod,long UsrCod)
{
return (DB_QueryCOUNT ("can not check if a user"
" has favourited a note",
"SELECT COUNT(*) FROM tl_notes_fav"
" WHERE NotCod=%ld AND UsrCod=%ld",
NotCod,UsrCod) != 0);
}
/*****************************************************************************/
/**************** Check if a user has favourited a comment *******************/
/*****************************************************************************/
static bool TL_Fav_CheckIfCommIsFavedByUsr (long PubCod,long UsrCod)
{
return (DB_QueryCOUNT ("can not check if a user"
" has favourited a comment",
"SELECT COUNT(*) FROM tl_comments_fav"
" WHERE PubCod=%ld AND UsrCod=%ld",
PubCod,UsrCod) != 0);
}
/*****************************************************************************/
/*************** Get number of times a note has been favourited **************/
/*****************************************************************************/
void TL_Fav_GetNumTimesANoteHasBeenFav (struct TL_Not_Note *Not)
{
/***** Get number of times (users) this note has been favourited *****/
Not->NumFavs =
(unsigned) DB_QueryCOUNT ("can not get number of times"
" a note has been favourited",
"SELECT COUNT(*) FROM tl_notes_fav"
" WHERE NotCod=%ld"
" AND UsrCod<>%ld", // Extra check
Not->NotCod,
Not->UsrCod); // The author
}
/*****************************************************************************/
/************ Get number of times a comment has been favourited **************/
/*****************************************************************************/
void TL_Fav_GetNumTimesACommHasBeenFav (struct TL_Com_Comment *Com)
{
/***** Get number of times (users) this comment has been favourited *****/
Com->NumFavs =
(unsigned) DB_QueryCOUNT ("can not get number of times"
" a comment has been favourited",
"SELECT COUNT(*) FROM tl_comments_fav"
" WHERE PubCod=%ld"
" AND UsrCod<>%ld", // Extra check
Com->PubCod,
Com->UsrCod); // The author
}
/*****************************************************************************/
/************ Show users who have marked this note as favourite **************/
/*****************************************************************************/
static void TL_Fav_ShowUsrsWhoHaveMarkedNoteAsFav (const struct TL_Not_Note *Not,
TL_HowManyUsrs_t HowManyUsrs)
{
MYSQL_RES *mysql_res;
unsigned NumFirstUsrs;
/***** Get users who have marked this note as favourite *****/
if (Not->NumFavs)
/***** Get list of users from database *****/
NumFirstUsrs =
(unsigned) DB_QuerySELECT (&mysql_res,"can not get users",
"SELECT UsrCod FROM tl_notes_fav"
" WHERE NotCod=%ld"
" AND UsrCod<>%ld" // Extra check
" ORDER BY FavCod LIMIT %u",
Not->NotCod,
Not->UsrCod,
HowManyUsrs == TL_SHOW_FEW_USRS ? TL_DEF_USRS_SHOWN :
TL_MAX_USRS_SHOWN);
else
NumFirstUsrs = 0;
/***** Show users *****/
/* Number of users */
HTM_DIV_Begin ("class=\"TL_NUM_USRS\"");
TL_ShowNumSharersOrFavers (Not->NumFavs);
HTM_DIV_End ();
/* List users one by one */
HTM_DIV_Begin ("class=\"TL_USRS\"");
TL_ShowSharersOrFavers (&mysql_res,Not->NumFavs,NumFirstUsrs);
if (NumFirstUsrs < Not->NumFavs) // Not all are shown
/* Clickable ellipsis to show all users */
TL_PutFormToSeeAllFaversSharers (ActAllFavTL_NotGbl,ActAllFavTL_NotUsr,
"NotCod=%ld",Not->NotCod,
HowManyUsrs);
HTM_DIV_End ();
/***** Free structure that stores the query result *****/
if (Not->NumFavs)
DB_FreeMySQLResult (&mysql_res);
}
/*****************************************************************************/
/************ Show users who have marked this note as favourite **************/
/*****************************************************************************/
static void TL_Fav_ShowUsrsWhoHaveMarkedCommAsFav (const struct TL_Com_Comment *Com,
TL_HowManyUsrs_t HowManyUsrs)
{
MYSQL_RES *mysql_res;
unsigned NumFirstUsrs;
/***** Get users who have marked this comment as favourite *****/
if (Com->NumFavs)
/***** Get list of users from database *****/
NumFirstUsrs =
(unsigned) DB_QuerySELECT (&mysql_res,"can not get users",
"SELECT UsrCod FROM tl_comments_fav"
" WHERE PubCod=%ld"
" AND UsrCod<>%ld" // Extra check
" ORDER BY FavCod LIMIT %u",
Com->PubCod,
Com->UsrCod,
HowManyUsrs == TL_SHOW_FEW_USRS ? TL_DEF_USRS_SHOWN :
TL_MAX_USRS_SHOWN);
else
NumFirstUsrs = 0;
/***** Show users *****/
/* Number of users */
HTM_DIV_Begin ("class=\"TL_NUM_USRS\"");
TL_ShowNumSharersOrFavers (Com->NumFavs);
HTM_DIV_End ();
/* List users one by one */
HTM_DIV_Begin ("class=\"TL_USRS\"");
TL_ShowSharersOrFavers (&mysql_res,Com->NumFavs,NumFirstUsrs);
if (NumFirstUsrs < Com->NumFavs)
/* Clickable ellipsis to show all users */
TL_PutFormToSeeAllFaversSharers (ActAllFavTL_ComGbl,ActAllFavTL_ComUsr,
"PubCod=%ld",Com->PubCod,
HowManyUsrs);
HTM_DIV_End ();
/***** Free structure that stores the query result *****/
if (Com->NumFavs)
DB_FreeMySQLResult (&mysql_res);
}
Reference in New Issue View Git Blame Copy Permalink