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

1964 lines
66 KiB
C
Raw Blame History

// swad_program.c: course program
/*
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 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 ***********************************/
/*****************************************************************************/
#define _GNU_SOURCE // For asprintf
#include <linux/limits.h> // For PATH_MAX
#include <stddef.h> // For NULL
#include <stdio.h> // For asprintf
#include <stdlib.h> // For calloc
#include <string.h> // For string functions
#include "swad_box.h"
#include "swad_database.h"
#include "swad_error.h"
#include "swad_figure.h"
#include "swad_form.h"
#include "swad_global.h"
#include "swad_hierarchy_level.h"
#include "swad_HTML.h"
#include "swad_pagination.h"
#include "swad_parameter.h"
#include "swad_photo.h"
#include "swad_program.h"
#include "swad_program_database.h"
#include "swad_role.h"
#include "swad_setting.h"
#include "swad_string.h"
/*****************************************************************************/
/************** External global variables from others modules ****************/
/*****************************************************************************/
extern struct Globals Gbl;
/*****************************************************************************/
/***************************** Private constants *****************************/
/*****************************************************************************/
/*****************************************************************************/
/******************************* Private types *******************************/
/*****************************************************************************/
#define Prg_NUM_TYPES_FORMS 3
typedef enum
{
Prg_DONT_PUT_FORM_ITEM,
Prg_PUT_FORM_CREATE_ITEM,
Prg_PUT_FORM_CHANGE_ITEM,
} Prg_CreateOrChangeItem_t;
#define Prg_NUM_MOVEMENTS_UP_DOWN 2
typedef enum
{
Prg_MOVE_UP,
Prg_MOVE_DOWN,
} Prg_MoveUpDown_t;
struct Level
{
unsigned Number; // Numbers for each level from 1 to maximum level
bool Hidden; // If each level from 1 to maximum level is hidden
};
/*****************************************************************************/
/***************************** Private variables *****************************/
/*****************************************************************************/
static struct
{
struct
{
bool IsRead; // Is the list already read from database...
// ...or it needs to be read?
unsigned NumItems; // Number of items
struct Prg_ItemHierarchy *Items; // List of items
} List;
unsigned MaxLevel; // Maximum level of items
struct Level *Levels; // Numbers and hidden for each level from 1 to maximum level
} Prg_Gbl =
{
.List =
{
.IsRead = false,
.NumItems = 0,
.Items = NULL,
},
.MaxLevel = 0,
.Levels = NULL
};
/*****************************************************************************/
/***************************** Private prototypes ****************************/
/*****************************************************************************/
static void Prg_ShowCourseProgramHighlightingItem (const struct Prg_ItemRange *ToHighlight);
static void Prg_ShowAllItems (Prg_CreateOrChangeItem_t CreateOrChangeItem,
const struct Prg_ItemRange *ToHighlight,
long ParentItmCod,long ItmCodBeforeForm,unsigned FormLevel);
static bool Prg_CheckIfICanCreateItems (void);
static void Prg_PutIconsListItems (__attribute__((unused)) void *Args);
static void Prg_PutIconToCreateNewItem (void);
static void Prg_PutButtonToCreateNewItem (void);
static void Prg_WriteRowItem (unsigned NumItem,struct Prg_Item *Item,
bool PrintView);
static void Prg_WriteRowWithItemForm (Prg_CreateOrChangeItem_t CreateOrChangeItem,
long ItmCod,unsigned FormLevel);
static void Prg_SetTitleClass (char **TitleClass,unsigned Level,bool LightStyle);
static void Prg_FreeTitleClass (char *TitleClass);
static void Prg_SetMaxItemLevel (unsigned Level);
static unsigned Prg_GetMaxItemLevel (void);
static unsigned Prg_CalculateMaxItemLevel (void);
static void Prg_CreateLevels (void);
static void Prg_FreeLevels (void);
static void Prg_IncreaseNumberInLevel (unsigned Level);
static unsigned Prg_GetCurrentNumberInLevel (unsigned Level);
static void Prg_WriteNumItem (unsigned Level);
static void Prg_WriteNumNewItem (unsigned Level);
static void Prg_SetHiddenLevel (unsigned Level,bool Hidden);
static bool Prg_GetHiddenLevel (unsigned Level);
static bool Prg_CheckIfAnyHigherLevelIsHidden (unsigned CurrentLevel);
static void Prg_PutFormsToRemEditOneItem (unsigned NumItem,
struct Prg_Item *Item);
static bool Prg_CheckIfMoveUpIsAllowed (unsigned NumItem);
static bool Prg_CheckIfMoveDownIsAllowed (unsigned NumItem);
static bool Prg_CheckIfMoveLeftIsAllowed (unsigned NumItem);
static bool Prg_CheckIfMoveRightIsAllowed (unsigned NumItem);
static void Prg_PutParams (void *ItmCod);
static void Prg_GetListItems (void);
static void Prg_GetDataOfItemByCod (struct Prg_Item *Item);
static void Prg_GetDataOfItem (struct Prg_Item *Item,
MYSQL_RES **mysql_res,
unsigned NumRows);
static void Prg_ResetItem (struct Prg_Item *Item);
static void Prg_FreeListItems (void);
static void Prg_PutParamItmCod (long ItmCod);
static long Prg_GetParamItmCod (void);
static unsigned Prg_GetNumItemFromItmCod (long ItmCod);
static void Prg_HideOrUnhideItem (bool Hide);
static void Prg_MoveUpDownItem (Prg_MoveUpDown_t UpDown);
static bool Prg_ExchangeItemRanges (int NumItemTop,int NumItemBottom);
static int Prg_GetPrevBrother (int NumItem);
static int Prg_GetNextBrother (int NumItem);
static void Prg_MoveLeftRightItem (Prg_MoveLeftRight_t LeftRight);
static void Prg_SetItemRangeEmpty (struct Prg_ItemRange *ItemRange);
static void Prg_SetItemRangeOnlyItem (unsigned Index,struct Prg_ItemRange *ItemRange);
static void Prg_SetItemRangeWithAllChildren (unsigned NumItem,struct Prg_ItemRange *ItemRange);
static unsigned Prg_GetLastChild (int NumItem);
static void Prg_ShowFormToCreateItem (long ParentItmCod);
static void Prg_ShowFormToChangeItem (long ItmCod);
static void Prg_ShowFormItem (const struct Prg_Item *Item,
const Dat_SetHMS SetHMS[Dat_NUM_START_END_TIME],
const char *Txt);
static void Prg_InsertItem (const struct Prg_Item *ParentItem,
struct Prg_Item *Item,const char *Txt);
/*****************************************************************************/
/************************** List all program items ***************************/
/*****************************************************************************/
void Prg_ShowCourseProgram (void)
{
struct Prg_ItemRange ToHighlight;
/***** Get list of program items *****/
Prg_GetListItems ();
/***** Show course program without highlighting any item *****/
Prg_SetItemRangeEmpty (&ToHighlight);
Prg_ShowCourseProgramHighlightingItem (&ToHighlight);
/***** Free list of program items *****/
Prg_FreeListItems ();
}
static void Prg_ShowCourseProgramHighlightingItem (const struct Prg_ItemRange *ToHighlight)
{
/***** Show all program items *****/
Prg_ShowAllItems (Prg_DONT_PUT_FORM_ITEM,ToHighlight,-1L,-1L,0);
}
/*****************************************************************************/
/************************* Show all program items ****************************/
/*****************************************************************************/
static void Prg_ShowAllItems (Prg_CreateOrChangeItem_t CreateOrChangeItem,
const struct Prg_ItemRange *ToHighlight,
long ParentItmCod,long ItmCodBeforeForm,unsigned FormLevel)
{
extern const char *Hlp_COURSE_Program;
extern const char *Txt_Course_program;
unsigned NumItem;
struct Prg_Item Item;
static bool FirstTBodyOpen = false;
/***** Create numbers and hidden levels *****/
Prg_SetMaxItemLevel (Prg_CalculateMaxItemLevel ());
Prg_CreateLevels ();
/***** Begin box *****/
Box_BoxBegin ("100%",Txt_Course_program,
Prg_PutIconsListItems,NULL,
Hlp_COURSE_Program,Box_NOT_CLOSABLE);
/***** Table *****/
HTM_TABLE_BeginWideMarginPadding (2);
/* In general, the table is divided into three bodys:
1. Rows before highlighted: <tbody></tbody>
2. Rows highlighted: <tbody id="prg_highlighted"></tbody>
3. Rows after highlighted: <tbody></tbody> */
HTM_TBODY_Begin (NULL); // 1st tbody start
FirstTBodyOpen = true;
/***** Write all program items *****/
for (NumItem = 0;
NumItem < Prg_Gbl.List.NumItems;
NumItem++)
{
/* Get data of this program item */
Item.Hierarchy.ItmCod = Prg_Gbl.List.Items[NumItem].ItmCod;
Prg_GetDataOfItemByCod (&Item);
/* Begin range to highlight? */
if (Item.Hierarchy.Index == ToHighlight->Begin) // Begin of the highlighted range
{
if (FirstTBodyOpen)
{
HTM_TBODY_End (); // 1st tbody end
FirstTBodyOpen = false;
}
HTM_TBODY_Begin ("id=\"prg_highlighted\""); // Highlighted tbody start
}
/* Show item */
Prg_WriteRowItem (NumItem,&Item,false); // Not print view
/* Show form to create/change item */
if (Item.Hierarchy.ItmCod == ItmCodBeforeForm)
switch (CreateOrChangeItem)
{
case Prg_DONT_PUT_FORM_ITEM:
break;
case Prg_PUT_FORM_CREATE_ITEM:
Prg_WriteRowWithItemForm (Prg_PUT_FORM_CREATE_ITEM,
ParentItmCod,FormLevel);
break;
case Prg_PUT_FORM_CHANGE_ITEM:
Prg_WriteRowWithItemForm (Prg_PUT_FORM_CHANGE_ITEM,
ItmCodBeforeForm,FormLevel);
break;
}
/* End range to highlight? */
if (Item.Hierarchy.Index == ToHighlight->End) // End of the highlighted range
{
HTM_TBODY_End (); // Highlighted tbody end
if (NumItem < Prg_Gbl.List.NumItems - 1) // Not the last item
HTM_TBODY_Begin (NULL); // 3rd tbody begin
}
Gbl.RowEvenOdd = 1 - Gbl.RowEvenOdd;
}
/***** Create item at the end? *****/
if (ItmCodBeforeForm <= 0 && CreateOrChangeItem == Prg_PUT_FORM_CREATE_ITEM)
Prg_WriteRowWithItemForm (Prg_PUT_FORM_CREATE_ITEM,-1L,1);
/***** End table *****/
HTM_TBODY_End (); // 3rd tbody end
HTM_TABLE_End ();
/***** Button to create a new program item *****/
if (Prg_CheckIfICanCreateItems ())
Prg_PutButtonToCreateNewItem ();
/***** End box *****/
Box_BoxEnd ();
/***** Free hidden levels and numbers *****/
Prg_FreeLevels ();
}
/*****************************************************************************/
/******************* Check if I can create program items *********************/
/*****************************************************************************/
static bool Prg_CheckIfICanCreateItems (void)
{
return (bool) (Gbl.Usrs.Me.Role.Logged == Rol_TCH ||
Gbl.Usrs.Me.Role.Logged == Rol_SYS_ADM);
}
/*****************************************************************************/
/************** Put contextual icons in list of program items ****************/
/*****************************************************************************/
static void Prg_PutIconsListItems (__attribute__((unused)) void *Args)
{
/***** Put icon to create a new program item *****/
if (Prg_CheckIfICanCreateItems ())
Prg_PutIconToCreateNewItem ();
/***** Put icon to show a figure *****/
Fig_PutIconToShowFigure (Fig_COURSE_PROGRAMS);
}
/*****************************************************************************/
/****************** Put icon to create a new program item ********************/
/*****************************************************************************/
static void Prg_PutIconToCreateNewItem (void)
{
extern const char *Txt_New_item;
long ItmCod = -1L;
/***** Put form to create a new program item *****/
Ico_PutContextualIconToAdd (ActFrmNewPrgItm,"item_form",
Prg_PutParams,&ItmCod,
Txt_New_item);
}
/*****************************************************************************/
/***************** Put button to create a new program item *******************/
/*****************************************************************************/
static void Prg_PutButtonToCreateNewItem (void)
{
extern const char *Txt_New_item;
long ItmCod = -1L;
Frm_BeginFormAnchor (ActFrmNewPrgItm,"item_form");
Prg_PutParams (&ItmCod);
Btn_PutConfirmButton (Txt_New_item);
Frm_EndForm ();
}
/*****************************************************************************/
/************************** Show one program item ****************************/
/*****************************************************************************/
static void Prg_WriteRowItem (unsigned NumItem,struct Prg_Item *Item,
bool PrintView)
{
static unsigned UniqueId = 0;
bool LightStyle;
char *Id;
unsigned ColSpan;
unsigned NumCol;
char *TitleClass;
Dat_StartEndTime_t StartEndTime;
char Txt[Cns_MAX_BYTES_TEXT + 1];
/***** Check if this item should be shown as hidden *****/
Prg_SetHiddenLevel (Item->Hierarchy.Level,Item->Hierarchy.Hidden);
if (Item->Hierarchy.Hidden) // this item is marked as hidden
LightStyle = true;
else // this item is not marked as hidden
LightStyle = Prg_CheckIfAnyHigherLevelIsHidden (Item->Hierarchy.Level);
/***** Title CSS class *****/
Prg_SetTitleClass (&TitleClass,Item->Hierarchy.Level,LightStyle);
/***** Increase number in level *****/
Prg_IncreaseNumberInLevel (Item->Hierarchy.Level);
/***** Begin row *****/
HTM_TR_Begin (NULL);
/***** Forms to remove/edit this program item *****/
if (!PrintView)
{
HTM_TD_Begin ("class=\"PRG_COL1 LT COLOR%u\"",Gbl.RowEvenOdd);
Prg_PutFormsToRemEditOneItem (NumItem,Item);
HTM_TD_End ();
}
/***** Indent depending on the level *****/
for (NumCol = 1;
NumCol < Item->Hierarchy.Level;
NumCol++)
{
HTM_TD_Begin ("class=\"COLOR%u\"",Gbl.RowEvenOdd);
HTM_TD_End ();
}
/***** Item number *****/
HTM_TD_Begin ("class=\"PRG_NUM %s RT COLOR%u\"",
TitleClass,Gbl.RowEvenOdd);
Prg_WriteNumItem (Item->Hierarchy.Level);
HTM_TD_End ();
/***** Title and text *****/
/* Begin title and text */
ColSpan = (Prg_GetMaxItemLevel () + 2) - Item->Hierarchy.Level;
if (PrintView)
HTM_TD_Begin ("colspan=\"%u\" class=\"PRG_MAIN\"",
ColSpan);
else
HTM_TD_Begin ("colspan=\"%u\" class=\"PRG_MAIN COLOR%u\"",
ColSpan,Gbl.RowEvenOdd);
/* Title */
HTM_DIV_Begin ("class=\"%s\"",TitleClass);
HTM_Txt (Item->Title);
HTM_DIV_End ();
/* Text */
Prg_DB_GetItemTxt (Item->Hierarchy.ItmCod,Txt);
Str_ChangeFormat (Str_FROM_HTML,Str_TO_RIGOROUS_HTML,
Txt,Cns_MAX_BYTES_TEXT,false); // Convert from HTML to recpectful HTML
Str_InsertLinks (Txt,Cns_MAX_BYTES_TEXT,60); // Insert links
HTM_DIV_Begin ("class=\"PAR PRG_TXT%s\"",
LightStyle ? "PRG_HIDDEN" :
"");
HTM_Txt (Txt);
HTM_DIV_End ();
/* End title and text */
HTM_TD_End ();
/***** Start/end date/time *****/
UniqueId++;
for (StartEndTime = (Dat_StartEndTime_t) 0;
StartEndTime <= (Dat_StartEndTime_t) (Dat_NUM_START_END_TIME - 1);
StartEndTime++)
{
if (asprintf (&Id,"scd_date_%u_%u",(unsigned) StartEndTime,UniqueId) < 0)
Err_NotEnoughMemoryExit ();
if (PrintView)
HTM_TD_Begin ("id=\"%s\" class=\"PRG_DATE %s LT\"",
Id,
LightStyle ? (Item->Open ? "DATE_GREEN_LIGHT" :
"DATE_RED_LIGHT") :
(Item->Open ? "DATE_GREEN" :
"DATE_RED"));
else
HTM_TD_Begin ("id=\"%s\" class=\"PRG_DATE %s LT COLOR%u\"",
Id,
LightStyle ? (Item->Open ? "DATE_GREEN_LIGHT" :
"DATE_RED_LIGHT") :
(Item->Open ? "DATE_GREEN" :
"DATE_RED"),
Gbl.RowEvenOdd);
Dat_WriteLocalDateHMSFromUTC (Id,Item->TimeUTC[StartEndTime],
Gbl.Prefs.DateFormat,Dat_SEPARATOR_BREAK,
true,true,true,0x7);
HTM_TD_End ();
free (Id);
}
/***** End row *****/
HTM_TR_End ();
/***** Free title CSS class *****/
Prg_FreeTitleClass (TitleClass);
}
/*****************************************************************************/
/**************************** Show item form *********************************/
/*****************************************************************************/
static void Prg_WriteRowWithItemForm (Prg_CreateOrChangeItem_t CreateOrChangeItem,
long ItmCod,unsigned FormLevel)
{
char *TitleClass;
unsigned ColSpan;
unsigned NumCol;
static void (*ShowForm[Prg_NUM_TYPES_FORMS])(long ItmCod) =
{
[Prg_DONT_PUT_FORM_ITEM ] = NULL,
[Prg_PUT_FORM_CREATE_ITEM] = Prg_ShowFormToCreateItem,
[Prg_PUT_FORM_CHANGE_ITEM] = Prg_ShowFormToChangeItem,
};
/***** Trivial check *****/
if (CreateOrChangeItem == Prg_DONT_PUT_FORM_ITEM)
return;
/***** Title CSS class *****/
Prg_SetTitleClass (&TitleClass,FormLevel,false);
/***** Change color row? *****/
if (CreateOrChangeItem == Prg_PUT_FORM_CREATE_ITEM)
Gbl.RowEvenOdd = 1 - Gbl.RowEvenOdd;
/***** Begin row *****/
HTM_TR_Begin (NULL);
/***** Column under icons *****/
HTM_TD_Begin ("class=\"PRG_COL1 LT COLOR%u\"",Gbl.RowEvenOdd);
HTM_TD_End ();
/***** Indent depending on the level *****/
for (NumCol = 1;
NumCol < FormLevel;
NumCol++)
{
HTM_TD_Begin ("class=\"COLOR%u\"",Gbl.RowEvenOdd);
HTM_TD_End ();
}
/***** Item number *****/
HTM_TD_Begin ("class=\"PRG_NUM %s RT COLOR%u\"",TitleClass,Gbl.RowEvenOdd);
if (CreateOrChangeItem == Prg_PUT_FORM_CREATE_ITEM)
Prg_WriteNumNewItem (FormLevel);
HTM_TD_End ();
/***** Show form to create new item as child *****/
ColSpan = (Prg_GetMaxItemLevel () + 4) - FormLevel;
HTM_TD_Begin ("colspan=\"%u\" class=\"PRG_MAIN COLOR%u\"",
ColSpan,Gbl.RowEvenOdd);
HTM_ARTICLE_Begin ("item_form");
ShowForm[CreateOrChangeItem] (ItmCod);
HTM_ARTICLE_End ();
HTM_TD_End ();
/***** End row *****/
HTM_TR_End ();
/***** Free title CSS class *****/
Prg_FreeTitleClass (TitleClass);
}
/*****************************************************************************/
/**************** Set / free title class depending on level ******************/
/*****************************************************************************/
static void Prg_SetTitleClass (char **TitleClass,unsigned Level,bool LightStyle)
{
if (asprintf (TitleClass,"PRG_TIT_%u%s",
Level < 5 ? Level :
5,
LightStyle ? "PRG_HIDDEN" :
"") < 0)
Err_NotEnoughMemoryExit ();
}
static void Prg_FreeTitleClass (char *TitleClass)
{
free (TitleClass);
}
/*****************************************************************************/
/************** Set and get maximum level in a course program ****************/
/*****************************************************************************/
static void Prg_SetMaxItemLevel (unsigned Level)
{
Prg_Gbl.MaxLevel = Level;
}
static unsigned Prg_GetMaxItemLevel (void)
{
return Prg_Gbl.MaxLevel;
}
/*****************************************************************************/
/******** Calculate maximum level of indentation in a course program *********/
/*****************************************************************************/
static unsigned Prg_CalculateMaxItemLevel (void)
{
unsigned NumItem;
unsigned MaxLevel = 0; // Return 0 if no items
/***** Compute maximum level of all program items *****/
for (NumItem = 0;
NumItem < Prg_Gbl.List.NumItems;
NumItem++)
if (Prg_Gbl.List.Items[NumItem].Level > MaxLevel)
MaxLevel = Prg_Gbl.List.Items[NumItem].Level;
return MaxLevel;
}
/*****************************************************************************/
/********************* Allocate memory for item numbers **********************/
/*****************************************************************************/
static void Prg_CreateLevels (void)
{
unsigned MaxLevel = Prg_GetMaxItemLevel ();
if (MaxLevel)
{
/***** Allocate memory for item numbers and initialize to 0 *****/
/*
Example: 2.5.2.1
MaxLevel = 4
Level Number
----- ------
0 <--- Not used
1 2
2 5
3 2
4 1
5 0 <--- Used to create a new item
*/
if ((Prg_Gbl.Levels = calloc (1 + MaxLevel + 1,
sizeof (*Prg_Gbl.Levels))) == NULL)
Err_NotEnoughMemoryExit ();
}
else
Prg_Gbl.Levels = NULL;
}
/*****************************************************************************/
/*********************** Free memory for item numbers ************************/
/*****************************************************************************/
static void Prg_FreeLevels (void)
{
if (Prg_GetMaxItemLevel () && Prg_Gbl.Levels)
{
/***** Free allocated memory for item numbers *****/
free (Prg_Gbl.Levels);
Prg_Gbl.Levels = NULL;
}
}
/*****************************************************************************/
/**************************** Increase number of item ************************/
/*****************************************************************************/
static void Prg_IncreaseNumberInLevel (unsigned Level)
{
/***** Increase number for this level *****/
Prg_Gbl.Levels[Level ].Number++;
/***** Reset number for next level (children) *****/
Prg_Gbl.Levels[Level + 1].Number = 0;
}
/*****************************************************************************/
/****************** Get current number of item in a level ********************/
/*****************************************************************************/
static unsigned Prg_GetCurrentNumberInLevel (unsigned Level)
{
if (Prg_Gbl.Levels)
return Prg_Gbl.Levels[Level].Number;
return 0;
}
/*****************************************************************************/
/******************** Write number of item in legal style ********************/
/*****************************************************************************/
static void Prg_WriteNumItem (unsigned Level)
{
HTM_Unsigned (Prg_GetCurrentNumberInLevel (Level));
}
static void Prg_WriteNumNewItem (unsigned Level)
{
HTM_Unsigned (Prg_GetCurrentNumberInLevel (Level) + 1);
}
/*****************************************************************************/
/********************** Set / Get if a level is hidden ***********************/
/*****************************************************************************/
static void Prg_SetHiddenLevel (unsigned Level,bool Hidden)
{
if (Prg_Gbl.Levels)
Prg_Gbl.Levels[Level].Hidden = Hidden;
}
static bool Prg_GetHiddenLevel (unsigned Level)
{
if (Prg_Gbl.Levels)
return Prg_Gbl.Levels[Level].Hidden;
return false;
}
/*****************************************************************************/
/********* Check if any level higher than the current one is hidden **********/
/*****************************************************************************/
static bool Prg_CheckIfAnyHigherLevelIsHidden (unsigned CurrentLevel)
{
unsigned Level;
for (Level = 1;
Level < CurrentLevel;
Level++)
if (Prg_GetHiddenLevel (Level)) // Hidden?
return true;
return false; // None is hidden. All are visible.
}
/*****************************************************************************/
/**************** Put a link (form) to edit one program item *****************/
/*****************************************************************************/
static void Prg_PutFormsToRemEditOneItem (unsigned NumItem,
struct Prg_Item *Item)
{
extern const char *Txt_New_item;
extern const char *Txt_Move_up_X;
extern const char *Txt_Move_down_X;
extern const char *Txt_Increase_level_of_X;
extern const char *Txt_Decrease_level_of_X;
extern const char *Txt_Movement_not_allowed;
char StrItemIndex[Cns_MAX_DECIMAL_DIGITS_UINT + 1];
/***** Initialize item index string *****/
snprintf (StrItemIndex,sizeof (StrItemIndex),"%u",Item->Hierarchy.Index);
switch (Gbl.Usrs.Me.Role.Logged)
{
case Rol_TCH:
case Rol_SYS_ADM:
/***** Put form to remove program item *****/
Ico_PutContextualIconToRemove (ActReqRemPrgItm,NULL,
Prg_PutParams,&Item->Hierarchy.ItmCod);
/***** Put form to hide/show program item *****/
if (Item->Hierarchy.Hidden)
Ico_PutContextualIconToUnhide (ActShoPrgItm,"prg_highlighted",
Prg_PutParams,&Item->Hierarchy.ItmCod);
else
Ico_PutContextualIconToHide (ActHidPrgItm,"prg_highlighted",
Prg_PutParams,&Item->Hierarchy.ItmCod);
/***** Put form to edit program item *****/
Ico_PutContextualIconToEdit (ActFrmChgPrgItm,"item_form",
Prg_PutParams,&Item->Hierarchy.ItmCod);
/***** Put form to add a new child item inside this item *****/
Ico_PutContextualIconToAdd (ActFrmNewPrgItm,"item_form",
Prg_PutParams,&Item->Hierarchy.ItmCod,
Txt_New_item);
HTM_BR ();
/***** Put icon to move up the item *****/
if (Prg_CheckIfMoveUpIsAllowed (NumItem))
{
Lay_PutContextualLinkOnlyIcon (ActUp_PrgItm,"prg_highlighted",
Prg_PutParams,&Item->Hierarchy.ItmCod,
"arrow-up.svg",
Str_BuildStringStr (Txt_Move_up_X,
StrItemIndex));
Str_FreeString ();
}
else
Ico_PutIconOff ("arrow-up.svg",Txt_Movement_not_allowed);
/***** Put icon to move down the item *****/
if (Prg_CheckIfMoveDownIsAllowed (NumItem))
{
Lay_PutContextualLinkOnlyIcon (ActDwnPrgItm,"prg_highlighted",
Prg_PutParams,&Item->Hierarchy.ItmCod,
"arrow-down.svg",
Str_BuildStringStr (Txt_Move_down_X,
StrItemIndex));
Str_FreeString ();
}
else
Ico_PutIconOff ("arrow-down.svg",Txt_Movement_not_allowed);
/***** Icon to move left item (increase level) *****/
if (Prg_CheckIfMoveLeftIsAllowed (NumItem))
{
Lay_PutContextualLinkOnlyIcon (ActLftPrgItm,"prg_highlighted",
Prg_PutParams,&Item->Hierarchy.ItmCod,
"arrow-left.svg",
Str_BuildStringStr (Txt_Increase_level_of_X,
StrItemIndex));
Str_FreeString ();
}
else
Ico_PutIconOff ("arrow-left.svg",Txt_Movement_not_allowed);
/***** Icon to move right item (indent, decrease level) *****/
if (Prg_CheckIfMoveRightIsAllowed (NumItem))
{
Lay_PutContextualLinkOnlyIcon (ActRgtPrgItm,"prg_highlighted",
Prg_PutParams,&Item->Hierarchy.ItmCod,
"arrow-right.svg",
Str_BuildStringStr (Txt_Decrease_level_of_X,
StrItemIndex));
Str_FreeString ();
}
else
Ico_PutIconOff ("arrow-right.svg",Txt_Movement_not_allowed);
break;
case Rol_STD:
case Rol_NET:
break;
default:
break;
}
}
/*****************************************************************************/
/*********************** Check if item can be moved up ***********************/
/*****************************************************************************/
static bool Prg_CheckIfMoveUpIsAllowed (unsigned NumItem)
{
/***** Trivial check: if item is the first one, move up is not allowed *****/
if (NumItem == 0)
return false;
/***** Move up is allowed if the item has brothers before it *****/
// NumItem >= 2
return Prg_Gbl.List.Items[NumItem - 1].Level >=
Prg_Gbl.List.Items[NumItem ].Level;
}
/*****************************************************************************/
/********************** Check if item can be moved down **********************/
/*****************************************************************************/
static bool Prg_CheckIfMoveDownIsAllowed (unsigned NumItem)
{
unsigned i;
unsigned Level;
/***** Trivial check: if item is the last one, move up is not allowed *****/
if (NumItem >= Prg_Gbl.List.NumItems - 1)
return false;
/***** Move down is allowed if the item has brothers after it *****/
// NumItem + 1 < Prg_Gbl.List.NumItems
Level = Prg_Gbl.List.Items[NumItem].Level;
for (i = NumItem + 1;
i < Prg_Gbl.List.NumItems;
i++)
{
if (Prg_Gbl.List.Items[i].Level == Level)
return true; // Next brother found
if (Prg_Gbl.List.Items[i].Level < Level)
return false; // Next lower level found ==> there are no more brothers
}
return false; // End reached ==> there are no more brothers
}
/*****************************************************************************/
/******************* Check if item can be moved to the left ******************/
/*****************************************************************************/
static bool Prg_CheckIfMoveLeftIsAllowed (unsigned NumItem)
{
/***** Move left is allowed if the item has parent *****/
return Prg_Gbl.List.Items[NumItem].Level > 1;
}
/*****************************************************************************/
/****************** Check if item can be moved to the right ******************/
/*****************************************************************************/
static bool Prg_CheckIfMoveRightIsAllowed (unsigned NumItem)
{
/***** If item is the first, move right is not allowed *****/
if (NumItem == 0)
return false;
/***** Move right is allowed if the item has brothers before it *****/
// NumItem >= 2
return Prg_Gbl.List.Items[NumItem - 1].Level >=
Prg_Gbl.List.Items[NumItem ].Level;
}
/*****************************************************************************/
/******************** Params used to edit a program item *********************/
/*****************************************************************************/
static void Prg_PutParams (void *ItmCod)
{
if (ItmCod)
if (*((long *) ItmCod) > 0)
Prg_PutParamItmCod (*((long *) ItmCod));
}
/*****************************************************************************/
/************************** List all program items ***************************/
/*****************************************************************************/
static void Prg_GetListItems (void)
{
MYSQL_RES *mysql_res;
MYSQL_ROW row;
unsigned NumItem;
if (Prg_Gbl.List.IsRead)
Prg_FreeListItems ();
/***** Get list of program items from database *****/
if ((Prg_Gbl.List.NumItems = Prg_DB_GetListItems (&mysql_res))) // Items found...
{
/***** Create list of program items *****/
if ((Prg_Gbl.List.Items = calloc (Prg_Gbl.List.NumItems,
sizeof (*Prg_Gbl.List.Items))) == NULL)
Err_NotEnoughMemoryExit ();
/***** Get the program items codes *****/
for (NumItem = 0;
NumItem < Prg_Gbl.List.NumItems;
NumItem++)
{
/* Get row */
row = mysql_fetch_row (mysql_res);
/* Get code of the program item (row[0]) */
if ((Prg_Gbl.List.Items[NumItem].ItmCod = Str_ConvertStrCodToLongCod (row[0])) <= 0)
Err_WrongItemExit ();
/* Get index of the program item (row[1])
and level of the program item (row[2]) */
Prg_Gbl.List.Items[NumItem].Index = Str_ConvertStrToUnsigned (row[1]);
Prg_Gbl.List.Items[NumItem].Level = Str_ConvertStrToUnsigned (row[2]);
/* Get whether the program item is hidden or not (row[3]) */
Prg_Gbl.List.Items[NumItem].Hidden = (row[3][0] == 'Y');
}
}
/***** Free structure that stores the query result *****/
DB_FreeMySQLResult (&mysql_res);
Prg_Gbl.List.IsRead = true;
}
/*****************************************************************************/
/****************** Get program item data using its code *********************/
/*****************************************************************************/
static void Prg_GetDataOfItemByCod (struct Prg_Item *Item)
{
MYSQL_RES *mysql_res;
unsigned NumRows;
if (Item->Hierarchy.ItmCod > 0)
{
/***** Build query *****/
NumRows = Prg_DB_GetDataOfItemByCod (&mysql_res,Item->Hierarchy.ItmCod);
/***** Get data of program item *****/
Prg_GetDataOfItem (Item,&mysql_res,NumRows);
}
else
/***** Clear all program item data *****/
Prg_ResetItem (Item);
}
/*****************************************************************************/
/************************* Get program item data *****************************/
/*****************************************************************************/
static void Prg_GetDataOfItem (struct Prg_Item *Item,
MYSQL_RES **mysql_res,
unsigned NumRows)
{
MYSQL_ROW row;
/***** Clear all program item data *****/
Prg_ResetItem (Item);
/***** Get data of program item from database *****/
if (NumRows) // Item found...
{
/* Get row */
row = mysql_fetch_row (*mysql_res);
/*
ItmCod row[0]
ItmInd row[1]
Level row[2]
Hidden row[3]
UsrCod row[4]
UNIX_TIMESTAMP(StartTime) row[5]
UNIX_TIMESTAMP(EndTime) row[6]
NOW() BETWEEN StartTime AND EndTime row[7]
Title row[8]
*/
/* Get code of the program item (row[0]) */
Item->Hierarchy.ItmCod = Str_ConvertStrCodToLongCod (row[0]);
/* Get index of the program item (row[1])
and level of the program item (row[2]) */
Item->Hierarchy.Index = Str_ConvertStrToUnsigned (row[1]);
Item->Hierarchy.Level = Str_ConvertStrToUnsigned (row[2]);
/* Get whether the program item is hidden or not (row[3]) */
Item->Hierarchy.Hidden = (row[3][0] == 'Y');
/* Get author of the program item (row[4]) */
Item->UsrCod = Str_ConvertStrCodToLongCod (row[4]);
/* Get start date (row[5] holds the start UTC time)
and end date (row[6] holds the end UTC time) */
Item->TimeUTC[Dat_STR_TIME] = Dat_GetUNIXTimeFromStr (row[5]);
Item->TimeUTC[Dat_END_TIME] = Dat_GetUNIXTimeFromStr (row[6]);
/* Get whether the program item is open or closed (row(7)) */
Item->Open = (row[7][0] == '1');
/* Get the title of the program item (row[8]) */
Str_Copy (Item->Title,row[8],sizeof (Item->Title) - 1);
}
/***** Free structure that stores the query result *****/
DB_FreeMySQLResult (mysql_res);
}
/*****************************************************************************/
/************************ Clear all program item data ************************/
/*****************************************************************************/
static void Prg_ResetItem (struct Prg_Item *Item)
{
Item->Hierarchy.ItmCod = -1L;
Item->Hierarchy.Index = 0;
Item->Hierarchy.Level = 0;
Item->Hierarchy.Hidden = false;
Item->UsrCod = -1L;
Item->TimeUTC[Dat_STR_TIME] =
Item->TimeUTC[Dat_END_TIME] = (time_t) 0;
Item->Open = false;
Item->Title[0] = '\0';
}
/*****************************************************************************/
/************************ Free list of program items *************************/
/*****************************************************************************/
static void Prg_FreeListItems (void)
{
if (Prg_Gbl.List.IsRead && Prg_Gbl.List.Items)
{
/***** Free memory used by the list of program items *****/
free (Prg_Gbl.List.Items);
Prg_Gbl.List.Items = NULL;
Prg_Gbl.List.NumItems = 0;
Prg_Gbl.List.IsRead = false;
}
}
/*****************************************************************************/
/**************** Write parameter with code of program item ******************/
/*****************************************************************************/
static void Prg_PutParamItmCod (long ItmCod)
{
Par_PutHiddenParamLong (NULL,"ItmCod",ItmCod);
}
/*****************************************************************************/
/***************** Get parameter with code of program item *******************/
/*****************************************************************************/
static long Prg_GetParamItmCod (void)
{
/***** Get code of program item *****/
return Par_GetParToLong ("ItmCod");
}
/*****************************************************************************/
/**************** Get number of item in list from item code ******************/
/*****************************************************************************/
static unsigned Prg_GetNumItemFromItmCod (long ItmCod)
{
unsigned NumItem;
/***** List of items must be filled *****/
if (!Prg_Gbl.List.IsRead || Prg_Gbl.List.Items == NULL)
Err_WrongItemsListExit ();
/***** Find item code in list *****/
for (NumItem = 0;
NumItem < Prg_Gbl.List.NumItems;
NumItem++)
if (Prg_Gbl.List.Items[NumItem].ItmCod == ItmCod) // Found!
return NumItem;
/***** Not found *****/
Err_WrongItemExit ();
return 0; // Not reached
}
/*****************************************************************************/
/************* Ask for confirmation of removing a program item ***************/
/*****************************************************************************/
void Prg_ReqRemItem (void)
{
extern const char *Txt_Do_you_really_want_to_remove_the_item_X;
extern const char *Txt_Remove_item;
struct Prg_Item Item;
struct Prg_ItemRange ToHighlight;
/***** Get list of program items *****/
Prg_GetListItems ();
/***** Get data of the program item from database *****/
Item.Hierarchy.ItmCod = Prg_GetParamItmCod ();
Prg_GetDataOfItemByCod (&Item);
if (Item.Hierarchy.ItmCod <= 0)
Err_WrongItemExit ();
/***** Show question and button to remove the program item *****/
Ale_ShowAlertAndButton (ActRemPrgItm,NULL,NULL,
Prg_PutParams,&Item.Hierarchy.ItmCod,
Btn_REMOVE_BUTTON,Txt_Remove_item,
Ale_QUESTION,Txt_Do_you_really_want_to_remove_the_item_X,
Item.Title);
/***** Show program items highlighting subtree *****/
Prg_SetItemRangeWithAllChildren (Prg_GetNumItemFromItmCod (Item.Hierarchy.ItmCod),
&ToHighlight);
Prg_ShowCourseProgramHighlightingItem (&ToHighlight);
/***** Free list of program items *****/
Prg_FreeListItems ();
}
/*****************************************************************************/
/******************* Remove a program item and its children ******************/
/*****************************************************************************/
void Prg_RemoveItem (void)
{
extern const char *Txt_Item_X_removed;
struct Prg_Item Item;
struct Prg_ItemRange ToRemove;
struct Prg_ItemRange ToHighlight;
/***** Get list of program items *****/
Prg_GetListItems ();
/***** Get data of the program item from database *****/
Item.Hierarchy.ItmCod = Prg_GetParamItmCod ();
Prg_GetDataOfItemByCod (&Item);
if (Item.Hierarchy.ItmCod <= 0)
Err_WrongItemExit ();
/***** Indexes of items *****/
Prg_SetItemRangeWithAllChildren (Prg_GetNumItemFromItmCod (Item.Hierarchy.ItmCod),
&ToRemove);
/***** Remove program items *****/
Prg_DB_RemoveItemRange (&ToRemove);
/***** Write message to show the change made *****/
Ale_ShowAlert (Ale_SUCCESS,Txt_Item_X_removed,Item.Title);
/***** Update list of program items *****/
Prg_FreeListItems ();
Prg_GetListItems ();
/***** Show course program without highlighting any item *****/
Prg_SetItemRangeEmpty (&ToHighlight);
Prg_ShowCourseProgramHighlightingItem (&ToHighlight);
/***** Free list of program items *****/
Prg_FreeListItems ();
}
/*****************************************************************************/
/***************************** Hide a program item ***************************/
/*****************************************************************************/
void Prg_HideItem (void)
{
Prg_HideOrUnhideItem (true);
}
void Prg_UnhideItem (void)
{
Prg_HideOrUnhideItem (false);
}
static void Prg_HideOrUnhideItem (bool Hide)
{
struct Prg_Item Item;
struct Prg_ItemRange ToHighlight;
/***** Get list of program items *****/
Prg_GetListItems ();
/***** Get data of the item from database *****/
Item.Hierarchy.ItmCod = Prg_GetParamItmCod ();
Prg_GetDataOfItemByCod (&Item);
if (Item.Hierarchy.ItmCod <= 0)
Err_WrongItemExit ();
/***** Hide/unhide program item *****/
Prg_DB_HideOrUnhideItem (Item.Hierarchy.ItmCod,Hide);
/***** Show program items highlighting subtree *****/
Prg_SetItemRangeWithAllChildren (Prg_GetNumItemFromItmCod (Item.Hierarchy.ItmCod),
&ToHighlight);
Prg_ShowCourseProgramHighlightingItem (&ToHighlight);
/***** Free list of program items *****/
Prg_FreeListItems ();
}
/*****************************************************************************/
/********** Move up/down position of a subtree in a course program ***********/
/*****************************************************************************/
void Prg_MoveUpItem (void)
{
Prg_MoveUpDownItem (Prg_MOVE_UP);
}
void Prg_MoveDownItem (void)
{
Prg_MoveUpDownItem (Prg_MOVE_DOWN);
}
static void Prg_MoveUpDownItem (Prg_MoveUpDown_t UpDown)
{
extern const char *Txt_Movement_not_allowed;
struct Prg_Item Item;
unsigned NumItem;
bool Success = false;
struct Prg_ItemRange ToHighlight;
static bool (*CheckIfAllowed[Prg_NUM_MOVEMENTS_UP_DOWN])(unsigned NumItem) =
{
[Prg_MOVE_UP ] = Prg_CheckIfMoveUpIsAllowed,
[Prg_MOVE_DOWN] = Prg_CheckIfMoveDownIsAllowed,
};
/***** Get list of program items *****/
Prg_GetListItems ();
/***** Get data of the item from database *****/
Item.Hierarchy.ItmCod = Prg_GetParamItmCod ();
Prg_GetDataOfItemByCod (&Item);
if (Item.Hierarchy.ItmCod <= 0)
Err_WrongItemExit ();
/***** Move up/down item *****/
NumItem = Prg_GetNumItemFromItmCod (Item.Hierarchy.ItmCod);
if (CheckIfAllowed[UpDown] (NumItem))
{
/* Exchange subtrees */
switch (UpDown)
{
case Prg_MOVE_UP:
Success = Prg_ExchangeItemRanges (Prg_GetPrevBrother (NumItem),NumItem);
break;
case Prg_MOVE_DOWN:
Success = Prg_ExchangeItemRanges (NumItem,Prg_GetNextBrother (NumItem));
break;
}
}
if (Success)
{
/* Update list of program items */
Prg_FreeListItems ();
Prg_GetListItems ();
Prg_SetItemRangeWithAllChildren (Prg_GetNumItemFromItmCod (Item.Hierarchy.ItmCod),
&ToHighlight);
}
else
{
Ale_ShowAlert (Ale_WARNING,Txt_Movement_not_allowed);
Prg_SetItemRangeEmpty (&ToHighlight);
}
/***** Show program items highlighting subtree *****/
Prg_ShowCourseProgramHighlightingItem (&ToHighlight);
/***** Free list of program items *****/
Prg_FreeListItems ();
}
/*****************************************************************************/
/**** Exchange the order of two consecutive subtrees in a course program *****/
/*****************************************************************************/
// Return true if success
static bool Prg_ExchangeItemRanges (int NumItemTop,int NumItemBottom)
{
struct Prg_ItemRange Top;
struct Prg_ItemRange Bottom;
unsigned DiffBegin;
unsigned DiffEnd;
if (NumItemTop >= 0 &&
NumItemBottom >= 0)
{
Prg_SetItemRangeWithAllChildren (NumItemTop ,&Top );
Prg_SetItemRangeWithAllChildren (NumItemBottom,&Bottom);
DiffBegin = Bottom.Begin - Top.Begin;
DiffEnd = Bottom.End - Top.End;
/***** Lock table to make the move atomic *****/
Prg_DB_LockTable ();
/***** Exchange indexes of items *****/
// This implementation works with non continuous indexes
/*
Example:
Top.Begin = 5
= 10
Top.End = 17
Bottom.Begin = 28
Bottom.End = 49
DiffBegin = 28 - 5 = 23;
DiffEnd = 49 - 17 = 32;
Step 1 Step 2 Step 3 (Equivalent to)
+------+------+ +------+------+ +------+------+ +------+------+ +------+------+
|ItmInd|ItmCod| |ItmInd|ItmCod| |ItmInd|ItmCod| |ItmInd|ItmCod| |ItmInd|ItmCod|
+------+------+ +------+------+ +------+------+ +------+------+ +------+------+
Top.Begin: | 5| 218|-->|--> -5| 218|-->|--> 37| 218| | 37| 218| | 5| 221|
| 10| 219|-->|-->-10| 219|-->|--> 42| 219| | 42| 219| | 26| 222|
Top.End: | 17| 220|-->|-->-17| 220|-->|--> 49| 220| | 49| 220| | 37| 218|
Bottom.Begin: | 28| 221|-->|-->-28| 221| | -28| 221|-->|--> 5| 221| | 42| 219|
Bottom.End: | 49| 222|-->|-->-49| 222| | -49| 222|-->|--> 26| 222| | 49| 220|
+------+------+ +------+------+ +------+------+ +------+------+ +------+------+
*/
/* Step 1: Change all indexes involved to negative,
necessary to preserve unique index (CrsCod,ItmInd) */
Prg_DB_UpdateIndexRange ( (long) 0 , // ItmInd=-ItmInd
(long) Top.Begin ,
(long) Bottom.End ); // All indexes in both parts
/* Step 2: Increase top indexes */
Prg_DB_UpdateIndexRange ( (long) DiffEnd , // ItmInd=-ItmInd+DiffEnd
-((long) Top.End ),
-((long) Top.Begin )); // All indexes in top part
/* Step 3: Decrease bottom indexes */
Prg_DB_UpdateIndexRange (-((long) DiffBegin ), // ItmInd=-ItmInd-DiffBegin
-((long) Bottom.End ),
-((long) Bottom.Begin)); // All indexes in bottom part
/***** Unlock table *****/
Prg_DB_UnlockTable ();
return true; // Success
}
return false; // No success
}
/*****************************************************************************/
/******** Get previous brother item to a given item in current course ********/
/*****************************************************************************/
// Return -1 if no previous brother
static int Prg_GetPrevBrother (int NumItem)
{
unsigned Level;
int i;
/***** Trivial check: if item is the first one, there is no previous brother *****/
if (NumItem <= 0 ||
NumItem >= (int) Prg_Gbl.List.NumItems)
return -1;
/***** Get previous brother before item *****/
// 1 <= NumItem < Prg_Gbl.List.NumItems
Level = Prg_Gbl.List.Items[NumItem].Level;
for (i = NumItem - 1;
i >= 0;
i--)
{
if (Prg_Gbl.List.Items[i].Level == Level)
return i; // Previous brother before item found
if (Prg_Gbl.List.Items[i].Level < Level)
return -1; // Previous lower level found ==> there are no brothers before item
}
return -1; // Start reached ==> there are no brothers before item
}
/*****************************************************************************/
/********** Get next brother item to a given item in current course **********/
/*****************************************************************************/
// Return -1 if no next brother
static int Prg_GetNextBrother (int NumItem)
{
unsigned Level;
int i;
/***** Trivial check: if item is the last one, there is no next brother *****/
if (NumItem < 0 ||
NumItem >= (int) Prg_Gbl.List.NumItems - 1)
return -1;
/***** Get next brother after item *****/
// 0 <= NumItem < Prg_Gbl.List.NumItems - 1
Level = Prg_Gbl.List.Items[NumItem].Level;
for (i = NumItem + 1;
i < (int) Prg_Gbl.List.NumItems;
i++)
{
if (Prg_Gbl.List.Items[i].Level == Level)
return i; // Next brother found
if (Prg_Gbl.List.Items[i].Level < Level)
return -1; // Next lower level found ==> there are no brothers after item
}
return -1; // End reached ==> there are no brothers after item
}
/*****************************************************************************/
/************** Move a subtree to left/right in a course program *************/
/*****************************************************************************/
void Prg_MoveLeftItem (void)
{
Prg_MoveLeftRightItem (Prg_MOVE_LEFT);
}
void Prg_MoveRightItem (void)
{
Prg_MoveLeftRightItem (Prg_MOVE_RIGHT);
}
static void Prg_MoveLeftRightItem (Prg_MoveLeftRight_t LeftRight)
{
extern const char *Txt_Movement_not_allowed;
struct Prg_Item Item;
unsigned NumItem;
struct Prg_ItemRange ToMove;
struct Prg_ItemRange ToHighlight;
static bool (*CheckIfAllowed[Prg_NUM_MOVEMENTS_LEFT_RIGHT])(unsigned NumItem) =
{
[Prg_MOVE_LEFT ] = Prg_CheckIfMoveLeftIsAllowed,
[Prg_MOVE_RIGHT] = Prg_CheckIfMoveRightIsAllowed,
};
/***** Get list of program items *****/
Prg_GetListItems ();
/***** Get data of the item from database *****/
Item.Hierarchy.ItmCod = Prg_GetParamItmCod ();
Prg_GetDataOfItemByCod (&Item);
if (Item.Hierarchy.ItmCod <= 0)
Err_WrongItemExit ();
/***** Move up/down item *****/
NumItem = Prg_GetNumItemFromItmCod (Item.Hierarchy.ItmCod);
if (CheckIfAllowed[LeftRight](NumItem))
{
/* Indexes of items */
Prg_SetItemRangeWithAllChildren (NumItem,&ToMove);
/* Move item and its children to left or right */
Prg_DB_MoveLeftRightItemRange (&ToMove,LeftRight);
/* Update list of program items */
Prg_FreeListItems ();
Prg_GetListItems ();
Prg_SetItemRangeWithAllChildren (Prg_GetNumItemFromItmCod (Item.Hierarchy.ItmCod),
&ToHighlight);
}
else
{
Ale_ShowAlert (Ale_WARNING,Txt_Movement_not_allowed);
Prg_SetItemRangeEmpty (&ToHighlight);
}
/***** Show program items highlighting subtree *****/
Prg_ShowCourseProgramHighlightingItem (&ToHighlight);
/***** Free list of program items *****/
Prg_FreeListItems ();
}
/*****************************************************************************/
/****** Set subtree begin and end from number of item in course program ******/
/*****************************************************************************/
static void Prg_SetItemRangeEmpty (struct Prg_ItemRange *ItemRange)
{
/***** List of items must be filled *****/
if (!Prg_Gbl.List.IsRead)
Err_WrongItemsListExit ();
/***** Range is empty *****/
if (Prg_Gbl.List.NumItems)
ItemRange->Begin =
ItemRange->End = Prg_Gbl.List.Items[Prg_Gbl.List.NumItems - 1].Index + 1;
else
ItemRange->Begin =
ItemRange->End = 1;
}
static void Prg_SetItemRangeOnlyItem (unsigned Index,struct Prg_ItemRange *ItemRange)
{
/***** List of items must be filled *****/
if (!Prg_Gbl.List.IsRead)
Err_WrongItemsListExit ();
/***** Range includes only this item *****/
ItemRange->Begin =
ItemRange->End = Index;
}
static void Prg_SetItemRangeWithAllChildren (unsigned NumItem,struct Prg_ItemRange *ItemRange)
{
/***** List of items must be filled *****/
if (!Prg_Gbl.List.IsRead)
Err_WrongItemsListExit ();
/***** Number of item must be in the correct range *****/
if (NumItem >= Prg_Gbl.List.NumItems)
Err_WrongItemExit ();
/***** Range includes this item and all its children *****/
ItemRange->Begin = Prg_Gbl.List.Items[NumItem ].Index;
ItemRange->End = Prg_Gbl.List.Items[Prg_GetLastChild (NumItem)].Index;
}
/*****************************************************************************/
/********************** Get last child in current course *********************/
/*****************************************************************************/
static unsigned Prg_GetLastChild (int NumItem)
{
unsigned Level;
int i;
/***** Trivial check: if item is wrong, there are no children *****/
if (NumItem < 0 ||
NumItem >= (int) Prg_Gbl.List.NumItems)
Err_WrongItemExit ();
/***** Get next brother after item *****/
// 0 <= NumItem < Prg_Gbl.List.NumItems
Level = Prg_Gbl.List.Items[NumItem].Level;
for (i = NumItem + 1;
i < (int) Prg_Gbl.List.NumItems;
i++)
{
if (Prg_Gbl.List.Items[i].Level <= Level)
return i - 1; // Last child found
}
return Prg_Gbl.List.NumItems - 1; // End reached ==> all items after the given item are its children
}
/*****************************************************************************/
/******* Put a form to create/edit program item and show current items *******/
/*****************************************************************************/
void Prg_RequestCreateItem (void)
{
long ParentItmCod;
unsigned NumItem;
long ItmCodBeforeForm;
unsigned FormLevel;
struct Prg_ItemRange ToHighlight;
/***** Get list of program items *****/
Prg_GetListItems ();
/***** Get the code of the parent program item *****/
ParentItmCod = Prg_GetParamItmCod ();
if (ParentItmCod > 0)
{
NumItem = Prg_GetNumItemFromItmCod (ParentItmCod);
ItmCodBeforeForm = Prg_Gbl.List.Items[Prg_GetLastChild (NumItem)].ItmCod;
FormLevel = Prg_Gbl.List.Items[NumItem].Level + 1;
}
else // No parent item (user clicked on button to add a new first-level item at the end)
{
ParentItmCod = -1L;
if (Prg_Gbl.List.NumItems) // There are items already
ItmCodBeforeForm = Prg_Gbl.List.Items[Prg_Gbl.List.NumItems - 1].ItmCod;
else // No current items
ItmCodBeforeForm = -1L;
FormLevel = 1;
}
/***** Show current program items, if any *****/
Prg_SetItemRangeEmpty (&ToHighlight);
Prg_ShowAllItems (Prg_PUT_FORM_CREATE_ITEM,
&ToHighlight,ParentItmCod,ItmCodBeforeForm,FormLevel);
/***** Free list of program items *****/
Prg_FreeListItems ();
}
void Prg_RequestChangeItem (void)
{
long ItmCodBeforeForm;
unsigned FormLevel;
struct Prg_ItemRange ToHighlight;
/***** Get list of program items *****/
Prg_GetListItems ();
/***** Get the code of the program item *****/
ItmCodBeforeForm = Prg_GetParamItmCod ();
if (ItmCodBeforeForm > 0)
FormLevel = Prg_Gbl.List.Items[Prg_GetNumItemFromItmCod (ItmCodBeforeForm)].Level;
else
FormLevel = 0;
/***** Show current program items, if any *****/
Prg_SetItemRangeEmpty (&ToHighlight);
Prg_ShowAllItems (Prg_PUT_FORM_CHANGE_ITEM,
&ToHighlight,-1L,ItmCodBeforeForm,FormLevel);
/***** Free list of program items *****/
Prg_FreeListItems ();
}
/*****************************************************************************/
/***************** Put a form to create a new program item *******************/
/*****************************************************************************/
static void Prg_ShowFormToCreateItem (long ParentItmCod)
{
extern const char *Hlp_COURSE_Program_new_item;
extern const char *Txt_New_item;
extern const char *Txt_Create_item;
struct Prg_Item ParentItem; // Parent item
struct Prg_Item Item;
static const Dat_SetHMS SetHMS[Dat_NUM_START_END_TIME] =
{
[Dat_STR_TIME] = Dat_HMS_TO_000000,
[Dat_END_TIME] = Dat_HMS_TO_235959
};
/***** Get data of the parent program item from database *****/
ParentItem.Hierarchy.ItmCod = ParentItmCod;
Prg_GetDataOfItemByCod (&ParentItem);
/***** Initialize to empty program item *****/
Prg_ResetItem (&Item);
Item.TimeUTC[Dat_STR_TIME] = Gbl.StartExecutionTimeUTC;
Item.TimeUTC[Dat_END_TIME] = Gbl.StartExecutionTimeUTC + (2 * 60 * 60); // +2 hours
Item.Open = true;
/***** Show pending alerts */
Ale_ShowAlerts (NULL);
/***** Begin form *****/
Frm_BeginFormAnchor (ActNewPrgItm,"prg_highlighted");
Prg_PutParamItmCod (ParentItem.Hierarchy.ItmCod);
/***** Begin box and table *****/
Box_BoxTableBegin ("100%",Txt_New_item,
NULL,NULL,
Hlp_COURSE_Program_new_item,Box_NOT_CLOSABLE,2);
/***** Show form *****/
Prg_ShowFormItem (&Item,SetHMS,NULL);
/***** End table, send button and end box *****/
Box_BoxTableWithButtonEnd (Btn_CREATE_BUTTON,Txt_Create_item);
/***** End form *****/
Frm_EndForm ();
}
/*****************************************************************************/
/***************** Put a form to change program item *******************/
/*****************************************************************************/
static void Prg_ShowFormToChangeItem (long ItmCod)
{
extern const char *Hlp_COURSE_Program_edit_item;
extern const char *Txt_Edit_item;
extern const char *Txt_Save_changes;
struct Prg_Item Item;
char Txt[Cns_MAX_BYTES_TEXT + 1];
static const Dat_SetHMS SetHMS[Dat_NUM_START_END_TIME] =
{
[Dat_STR_TIME] = Dat_HMS_DO_NOT_SET,
[Dat_END_TIME] = Dat_HMS_DO_NOT_SET
};
/***** Get data of the program item from database *****/
Item.Hierarchy.ItmCod = ItmCod;
Prg_GetDataOfItemByCod (&Item);
Prg_DB_GetItemTxt (Item.Hierarchy.ItmCod,Txt);
/***** Show pending alerts */
Ale_ShowAlerts (NULL);
/***** Begin form *****/
Frm_BeginFormAnchor (ActChgPrgItm,"prg_highlighted");
Prg_PutParamItmCod (Item.Hierarchy.ItmCod);
/***** Begin box and table *****/
Box_BoxTableBegin ("100%",
Item.Title[0] ? Item.Title :
Txt_Edit_item,
NULL,NULL,
Hlp_COURSE_Program_edit_item,Box_NOT_CLOSABLE,2);
/***** Show form *****/
Prg_ShowFormItem (&Item,SetHMS,Txt);
/***** End table, send button and end box *****/
Box_BoxTableWithButtonEnd (Btn_CONFIRM_BUTTON,Txt_Save_changes);
/***** End form *****/
Frm_EndForm ();
}
/*****************************************************************************/
/***************** Put a form to create a new program item *******************/
/*****************************************************************************/
static void Prg_ShowFormItem (const struct Prg_Item *Item,
const Dat_SetHMS SetHMS[Dat_NUM_START_END_TIME],
const char *Txt)
{
extern const char *Txt_Title;
extern const char *Txt_Description;
/***** Item title *****/
HTM_TR_Begin (NULL);
/* Label */
Frm_LabelColumn ("RM","Title",Txt_Title);
/* Data */
HTM_TD_Begin ("class=\"LM\"");
HTM_INPUT_TEXT ("Title",Prg_MAX_CHARS_PROGRAM_ITEM_TITLE,Item->Title,
HTM_DONT_SUBMIT_ON_CHANGE,
"id=\"Title\" required=\"required\""
" class=\"PRG_TITLE_DESCRIPTION_WIDTH\"");
HTM_TD_End ();
HTM_TR_End ();
/***** Program item start and end dates *****/
Dat_PutFormStartEndClientLocalDateTimes (Item->TimeUTC,
Dat_FORM_SECONDS_ON,
SetHMS);
/***** Program item text *****/
HTM_TR_Begin (NULL);
/* Label */
Frm_LabelColumn ("RT","Txt",Txt_Description);
/* Data */
HTM_TD_Begin ("class=\"LT\"");
HTM_TEXTAREA_Begin ("id=\"Txt\" name=\"Txt\" rows=\"25\""
" class=\"PRG_TITLE_DESCRIPTION_WIDTH\"");
if (Txt)
if (Txt[0])
HTM_Txt (Txt);
HTM_TEXTAREA_End ();
HTM_TD_End ();
HTM_TR_End ();
}
/*****************************************************************************/
/***************** Receive form to create a new program item *****************/
/*****************************************************************************/
void Prg_ReceiveFormNewItem (void)
{
struct Prg_Item ParentItem; // Parent item
struct Prg_Item NewItem; // Item data received from form
char Description[Cns_MAX_BYTES_TEXT + 1];
struct Prg_ItemRange ToHighlight;
/***** Get list of program items *****/
Prg_GetListItems ();
/***** Get data of the program item from database *****/
ParentItem.Hierarchy.ItmCod = Prg_GetParamItmCod ();
Prg_GetDataOfItemByCod (&ParentItem);
// If item code <= 0 ==> this is the first item in the program
/***** Set new item code *****/
NewItem.Hierarchy.ItmCod = -1L;
NewItem.Hierarchy.Level = ParentItem.Hierarchy.Level + 1; // Create as child
/***** Get start/end date-times *****/
NewItem.TimeUTC[Dat_STR_TIME] = Dat_GetTimeUTCFromForm ("StartTimeUTC");
NewItem.TimeUTC[Dat_END_TIME] = Dat_GetTimeUTCFromForm ("EndTimeUTC" );
/***** Get program item title *****/
Par_GetParToText ("Title",NewItem.Title,Prg_MAX_BYTES_PROGRAM_ITEM_TITLE);
/***** Get program item text *****/
Par_GetParToHTML ("Txt",Description,Cns_MAX_BYTES_TEXT); // Store in HTML format (not rigorous)
/***** Adjust dates *****/
if (NewItem.TimeUTC[Dat_STR_TIME] == 0)
NewItem.TimeUTC[Dat_STR_TIME] = Gbl.StartExecutionTimeUTC;
if (NewItem.TimeUTC[Dat_END_TIME] == 0)
NewItem.TimeUTC[Dat_END_TIME] = NewItem.TimeUTC[Dat_STR_TIME] + 2 * 60 * 60; // +2 hours
/***** Create a new program item *****/
Prg_InsertItem (&ParentItem,&NewItem,Description);
/* Update list of program items */
Prg_FreeListItems ();
Prg_GetListItems ();
/***** Show program items highlighting subtree *****/
Prg_SetItemRangeOnlyItem (NewItem.Hierarchy.Index,&ToHighlight);
Prg_ShowCourseProgramHighlightingItem (&ToHighlight);
/***** Free list of program items *****/
Prg_FreeListItems ();
}
/*****************************************************************************/
/************* Receive form to change an existing program item ***************/
/*****************************************************************************/
void Prg_ReceiveFormChgItem (void)
{
struct Prg_Item OldItem; // Current program item data in database
struct Prg_Item NewItem; // Item data received from form
char Description[Cns_MAX_BYTES_TEXT + 1];
struct Prg_ItemRange ToHighlight;
/***** Get list of program items *****/
Prg_GetListItems ();
/***** Get data of the item from database *****/
NewItem.Hierarchy.ItmCod = Prg_GetParamItmCod ();
Prg_GetDataOfItemByCod (&NewItem);
if (NewItem.Hierarchy.ItmCod <= 0)
Err_WrongItemExit ();
/***** Get data of the old (current) program item from database *****/
OldItem.Hierarchy.ItmCod = NewItem.Hierarchy.ItmCod;
Prg_GetDataOfItemByCod (&OldItem);
/***** Get start/end date-times *****/
NewItem.TimeUTC[Dat_STR_TIME] = Dat_GetTimeUTCFromForm ("StartTimeUTC");
NewItem.TimeUTC[Dat_END_TIME] = Dat_GetTimeUTCFromForm ("EndTimeUTC" );
/***** Get program item title *****/
Par_GetParToText ("Title",NewItem.Title,Prg_MAX_BYTES_PROGRAM_ITEM_TITLE);
/***** Get program item text *****/
Par_GetParToHTML ("Txt",Description,Cns_MAX_BYTES_TEXT); // Store in HTML format (not rigorous)
/***** Adjust dates *****/
if (NewItem.TimeUTC[Dat_STR_TIME] == 0)
NewItem.TimeUTC[Dat_STR_TIME] = Gbl.StartExecutionTimeUTC;
if (NewItem.TimeUTC[Dat_END_TIME] == 0)
NewItem.TimeUTC[Dat_END_TIME] = NewItem.TimeUTC[Dat_STR_TIME] + 2 * 60 * 60; // +2 hours
/***** Update existing item *****/
Prg_DB_UpdateItem (&NewItem,Description);
/***** Show program items highlighting subtree *****/
Prg_SetItemRangeOnlyItem (NewItem.Hierarchy.Index,&ToHighlight);
Prg_ShowCourseProgramHighlightingItem (&ToHighlight);
/***** Free list of program items *****/
Prg_FreeListItems ();
}
/*****************************************************************************/
/*********** Insert a new program item as a child of a parent item ***********/
/*****************************************************************************/
static void Prg_InsertItem (const struct Prg_Item *ParentItem,
struct Prg_Item *Item,const char *Txt)
{
unsigned NumItemLastChild;
/***** Lock table to create program item *****/
Prg_DB_LockTable ();
/***** Get list of program items *****/
Prg_GetListItems ();
if (Prg_Gbl.List.NumItems) // There are items
{
if (ParentItem->Hierarchy.ItmCod > 0) // Parent specified
{
/***** Calculate where to insert *****/
NumItemLastChild = Prg_GetLastChild (Prg_GetNumItemFromItmCod (ParentItem->Hierarchy.ItmCod));
if (NumItemLastChild < Prg_Gbl.List.NumItems - 1)
{
/***** New program item will be inserted after last child of parent *****/
Item->Hierarchy.Index = Prg_Gbl.List.Items[NumItemLastChild + 1].Index;
/***** Move down all indexes of after last child of parent *****/
Prg_DB_MoveDownItems (Item->Hierarchy.Index);
}
else
/***** New program item will be inserted at the end *****/
Item->Hierarchy.Index = Prg_Gbl.List.Items[Prg_Gbl.List.NumItems - 1].Index + 1;
/***** Child ==> parent level + 1 *****/
Item->Hierarchy.Level = ParentItem->Hierarchy.Level + 1;
}
else // No parent specified
{
/***** New program item will be inserted at the end *****/
Item->Hierarchy.Index = Prg_Gbl.List.Items[Prg_Gbl.List.NumItems - 1].Index + 1;
/***** First level *****/
Item->Hierarchy.Level = 1;
}
}
else // There are no items
{
/***** New program item will be inserted as the first one *****/
Item->Hierarchy.Index = 1;
/***** First level *****/
Item->Hierarchy.Level = 1;
}
/***** Insert new program item *****/
Item->Hierarchy.ItmCod = Prg_DB_InsertItem (Item,Txt);
/***** Unlock table *****/
Prg_DB_UnlockTable ();
/***** Free list items *****/
Prg_FreeListItems ();
}
Reference in New Issue View Git Blame Copy Permalink