2017-09-15 13:19:27 +02:00
|
|
|
|
// swad_project.h: projects (final degree projects, thesis)
|
|
|
|
|
|
|
|
|
|
#ifndef _SWAD_PRJ
|
|
|
|
|
#define _SWAD_PRJ
|
|
|
|
|
/*
|
|
|
|
|
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.
|
2021-02-09 12:43:45 +01:00
|
|
|
|
Copyright (C) 1999-2021 Antonio Ca<EFBFBD>as Vargas
|
2017-09-15 13:19:27 +02:00
|
|
|
|
|
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
|
|
|
it under the terms of the GNU Affero General Public License as
|
|
|
|
|
published by the Free Software Foundation, either version 3 of the
|
|
|
|
|
License, or (at your option) any later version.
|
|
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
GNU Affero General Public License for more details.
|
|
|
|
|
|
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
*/
|
|
|
|
|
/*****************************************************************************/
|
|
|
|
|
/********************************* Headers ***********************************/
|
|
|
|
|
/*****************************************************************************/
|
|
|
|
|
|
|
|
|
|
#include "swad_date.h"
|
|
|
|
|
#include "swad_file_browser.h"
|
|
|
|
|
#include "swad_notification.h"
|
|
|
|
|
#include "swad_user.h"
|
|
|
|
|
|
|
|
|
|
/*****************************************************************************/
|
|
|
|
|
/************************** Public types and constants ***********************/
|
|
|
|
|
/*****************************************************************************/
|
|
|
|
|
|
2019-10-25 22:48:34 +02:00
|
|
|
|
/***** Configuration *****/
|
|
|
|
|
#define Prj_EDITABLE_DEFAULT true
|
|
|
|
|
|
2019-10-22 22:39:37 +02:00
|
|
|
|
/***** Filters to list projects *****/
|
2019-11-12 00:31:41 +01:00
|
|
|
|
/* Whose projects */
|
|
|
|
|
#define Prj_FILTER_WHO_DEFAULT Usr_WHO_ME
|
2017-09-15 13:19:27 +02:00
|
|
|
|
|
2019-10-25 01:15:11 +02:00
|
|
|
|
/* Assigned projects / non-assigned projects */
|
|
|
|
|
#define Prj_NUM_ASSIGNED_NONASSIG 2
|
2017-10-02 01:16:10 +02:00
|
|
|
|
typedef enum
|
|
|
|
|
{
|
2019-10-25 01:15:11 +02:00
|
|
|
|
Prj_ASSIGNED = 0,
|
|
|
|
|
Prj_NONASSIG = 1,
|
|
|
|
|
} Prj_AssignedNonassig_t;
|
|
|
|
|
#define Prj_NEW_PRJ_ASSIGNED_NONASSIG_DEFAULT Prj_NONASSIG
|
|
|
|
|
#define Prj_FILTER_ASSIGNED_DEFAULT (1 << Prj_ASSIGNED) // on
|
|
|
|
|
#define Prj_FILTER_NONASSIG_DEFAULT (1 << Prj_NONASSIG) // on
|
2017-09-15 13:19:27 +02:00
|
|
|
|
|
2019-04-17 22:06:23 +02:00
|
|
|
|
/* Locked/unlocked project */
|
|
|
|
|
#define Prj_NUM_LOCKED_UNLOCKED 2
|
2019-04-17 12:40:04 +02:00
|
|
|
|
typedef enum
|
|
|
|
|
{
|
|
|
|
|
Prj_LOCKED = 0,
|
|
|
|
|
Prj_UNLOCKED = 1,
|
|
|
|
|
} Prj_Locked_t;
|
|
|
|
|
|
2019-04-17 22:06:23 +02:00
|
|
|
|
/* Hidden/visible project */
|
2017-10-10 12:37:09 +02:00
|
|
|
|
#define Prj_NUM_HIDDEN_VISIBL 2
|
2017-09-23 15:24:22 +02:00
|
|
|
|
typedef enum
|
|
|
|
|
{
|
2017-10-10 12:37:09 +02:00
|
|
|
|
Prj_HIDDEN = 0,
|
|
|
|
|
Prj_VISIBL = 1,
|
|
|
|
|
} Prj_HiddenVisibl_t;
|
|
|
|
|
#define Prj_NEW_PRJ_HIDDEN_VISIBL_DEFAULT Prj_VISIBL
|
|
|
|
|
#define Prj_FILTER_HIDDEN_DEFAULT (1 << Prj_HIDDEN) // on
|
|
|
|
|
#define Prj_FILTER_VISIBL_DEFAULT (1 << Prj_VISIBL) // on
|
|
|
|
|
|
2019-10-16 01:11:42 +02:00
|
|
|
|
/* Faulty/faultless project */
|
|
|
|
|
#define Prj_NUM_FAULTINESS 2
|
|
|
|
|
typedef enum
|
|
|
|
|
{
|
|
|
|
|
Prj_FAULTY = 0,
|
|
|
|
|
Prj_FAULTLESS = 1,
|
|
|
|
|
} Prj_Faultiness_t;
|
|
|
|
|
#define Prj_FILTER_FAULTY_DEFAULT (1 << Prj_FAULTY) // on
|
|
|
|
|
#define Prj_FILTER_FAULTLESS_DEFAULT (1 << Prj_FAULTLESS) // on
|
|
|
|
|
|
2017-10-10 12:37:09 +02:00
|
|
|
|
/* Project department */
|
|
|
|
|
#define Prj_FILTER_DPT_DEFAULT -1L // Any department
|
2017-09-23 15:24:22 +02:00
|
|
|
|
|
2017-10-10 12:52:02 +02:00
|
|
|
|
/* Struct with all filters */
|
|
|
|
|
struct Prj_Filter
|
|
|
|
|
{
|
2019-11-12 00:31:41 +01:00
|
|
|
|
Usr_Who_t Who; // Show my / selected users' / all projects
|
2019-10-25 01:15:11 +02:00
|
|
|
|
unsigned Assign; // Show assigned / non assigned projects
|
|
|
|
|
unsigned Hidden; // Show hidden / visible projects
|
2019-10-16 01:11:42 +02:00
|
|
|
|
unsigned Faulti; // Show faulty / faultless projects
|
2017-10-10 12:52:02 +02:00
|
|
|
|
long DptCod; // Show projects of this department
|
|
|
|
|
};
|
|
|
|
|
|
2017-10-10 12:37:09 +02:00
|
|
|
|
/***** Order listing of projects by... *****/
|
2017-10-10 01:26:45 +02:00
|
|
|
|
#define Prj_NUM_ORDERS 4
|
|
|
|
|
typedef enum
|
|
|
|
|
{
|
|
|
|
|
Prj_ORDER_START_TIME = 0,
|
|
|
|
|
Prj_ORDER_END_TIME = 1,
|
|
|
|
|
Prj_ORDER_TITLE = 2,
|
|
|
|
|
Prj_ORDER_DEPARTMENT = 3,
|
|
|
|
|
} Prj_Order_t;
|
|
|
|
|
#define Prj_ORDER_DEFAULT Prj_ORDER_START_TIME
|
|
|
|
|
|
2017-10-10 12:37:09 +02:00
|
|
|
|
/***** Project title *****/
|
2020-03-09 14:37:55 +01:00
|
|
|
|
#define Prj_MAX_CHARS_PROJECT_TITLE (256 - 1) // 255
|
|
|
|
|
#define Prj_MAX_BYTES_PROJECT_TITLE ((Prj_MAX_CHARS_PROJECT_TITLE + 1) * Str_MAX_BYTES_PER_CHAR - 1) // 4095
|
2017-10-10 01:26:45 +02:00
|
|
|
|
|
2017-10-10 12:37:09 +02:00
|
|
|
|
/***** Type of proposal ******/
|
|
|
|
|
#define Prj_NUM_PROPOSAL_TYPES 3
|
2017-10-10 01:26:45 +02:00
|
|
|
|
typedef enum
|
|
|
|
|
{
|
2017-10-10 12:37:09 +02:00
|
|
|
|
Prj_PROPOSAL_NEW,
|
|
|
|
|
Prj_PROPOSAL_MODIFIED,
|
|
|
|
|
Prj_PROPOSAL_UNMODIFIED,
|
|
|
|
|
} Prj_Proposal_t;
|
|
|
|
|
#define Prj_PROPOSAL_DEFAULT Prj_PROPOSAL_NEW
|
2017-10-10 01:26:45 +02:00
|
|
|
|
|
2017-10-10 12:37:09 +02:00
|
|
|
|
/***** User roles in a project *****/
|
|
|
|
|
// Don't change these numbers! They are used in database
|
|
|
|
|
#define Prj_NUM_ROLES_IN_PROJECT 4
|
2017-10-10 01:26:45 +02:00
|
|
|
|
typedef enum
|
|
|
|
|
{
|
2017-10-10 12:37:09 +02:00
|
|
|
|
Prj_ROLE_UNK = 0, // Unknown
|
|
|
|
|
Prj_ROLE_STD = 1, // Student
|
|
|
|
|
Prj_ROLE_TUT = 2, // Tutor
|
2019-04-11 09:55:35 +02:00
|
|
|
|
Prj_ROLE_EVL = 3, // Evaluator
|
2017-10-10 12:37:09 +02:00
|
|
|
|
} Prj_RoleInProject_t;
|
2017-10-10 01:26:45 +02:00
|
|
|
|
|
2020-04-08 22:09:35 +02:00
|
|
|
|
/***** Struct to store context/status of projects *****/
|
|
|
|
|
struct Prj_Projects
|
|
|
|
|
{
|
|
|
|
|
struct
|
|
|
|
|
{
|
|
|
|
|
bool Editable;
|
|
|
|
|
} Config;
|
|
|
|
|
struct Prj_Filter Filter;
|
|
|
|
|
bool LstIsRead; // Is the list already read from database, or it needs to be read?
|
|
|
|
|
unsigned Num; // Number of projects
|
|
|
|
|
long *LstPrjCods; // List of project codes
|
|
|
|
|
Prj_Order_t SelectedOrder;
|
|
|
|
|
unsigned CurrentPage;
|
|
|
|
|
long PrjCod; // Current project
|
|
|
|
|
};
|
|
|
|
|
|
2017-10-10 12:37:09 +02:00
|
|
|
|
/***** Struct to store a project *****/
|
2020-04-08 22:09:35 +02:00
|
|
|
|
struct Prj_Project
|
2017-09-15 13:19:27 +02:00
|
|
|
|
{
|
|
|
|
|
long PrjCod;
|
2017-10-06 15:13:19 +02:00
|
|
|
|
long CrsCod;
|
2019-04-17 12:40:04 +02:00
|
|
|
|
Prj_Locked_t Locked;
|
2017-10-10 01:26:45 +02:00
|
|
|
|
Prj_HiddenVisibl_t Hidden;
|
2019-10-25 01:15:11 +02:00
|
|
|
|
Prj_AssignedNonassig_t Assigned;
|
2017-10-02 02:19:14 +02:00
|
|
|
|
unsigned NumStds;
|
2017-10-02 19:34:31 +02:00
|
|
|
|
Prj_Proposal_t Proposal;
|
2017-10-07 22:08:38 +02:00
|
|
|
|
time_t CreatTime;
|
|
|
|
|
time_t ModifTime;
|
2017-09-17 23:37:03 +02:00
|
|
|
|
char Title[Prj_MAX_BYTES_PROJECT_TITLE + 1];
|
2017-09-22 00:26:14 +02:00
|
|
|
|
long DptCod;
|
2017-09-19 01:12:05 +02:00
|
|
|
|
char *Description;
|
|
|
|
|
char *Knowledge;
|
|
|
|
|
char *Materials;
|
2017-09-18 01:06:51 +02:00
|
|
|
|
char URL[Cns_MAX_BYTES_WWW + 1];
|
2017-09-15 13:19:27 +02:00
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/*****************************************************************************/
|
|
|
|
|
/***************************** Public prototypes *****************************/
|
|
|
|
|
/*****************************************************************************/
|
|
|
|
|
|
2020-04-10 19:14:08 +02:00
|
|
|
|
void Prj_SetPrjCod (long PrjCod);
|
|
|
|
|
long Prj_GetPrjCod (void);
|
|
|
|
|
|
2019-11-14 09:39:21 +01:00
|
|
|
|
void Prj_ListUsrsToSelect (void);
|
2017-09-15 13:19:27 +02:00
|
|
|
|
void Prj_SeeProjects (void);
|
2019-11-14 09:39:21 +01:00
|
|
|
|
void Prj_ShowTableSelectedPrjs (void);
|
2017-10-10 01:26:45 +02:00
|
|
|
|
|
2017-10-10 12:52:02 +02:00
|
|
|
|
void Prj_PutParams (struct Prj_Filter *Filter,
|
2017-10-10 01:26:45 +02:00
|
|
|
|
Prj_Order_t Order,
|
|
|
|
|
unsigned NumPage,
|
|
|
|
|
long PrjCod);
|
2017-10-06 01:20:05 +02:00
|
|
|
|
|
2020-04-08 22:09:35 +02:00
|
|
|
|
void Prj_ShowOneUniqueProject (struct Prj_Project *Prj);
|
2017-10-06 01:20:05 +02:00
|
|
|
|
|
2017-09-15 13:19:27 +02:00
|
|
|
|
void Prj_PrintOneProject (void);
|
|
|
|
|
|
2019-04-11 15:24:05 +02:00
|
|
|
|
void Prj_FlushCacheMyRolesInProject (void);
|
|
|
|
|
Prj_RoleInProject_t Prj_GetMyRolesInProject (long PrjCod);
|
2017-10-07 20:01:34 +02:00
|
|
|
|
|
2020-04-08 22:09:35 +02:00
|
|
|
|
void Prj_ReqAddStds (void);
|
|
|
|
|
void Prj_ReqAddTuts (void);
|
|
|
|
|
void Prj_ReqAddEvls (void);
|
2017-09-20 17:12:34 +02:00
|
|
|
|
|
2019-04-11 09:55:35 +02:00
|
|
|
|
void Prj_GetSelectedUsrsAndAddStds (void);
|
|
|
|
|
void Prj_GetSelectedUsrsAndAddTuts (void);
|
|
|
|
|
void Prj_GetSelectedUsrsAndAddEvls (void);
|
2017-09-20 17:12:34 +02:00
|
|
|
|
|
2017-09-22 00:56:17 +02:00
|
|
|
|
void Prj_ReqRemStd (void);
|
|
|
|
|
void Prj_ReqRemTut (void);
|
2019-04-11 09:55:35 +02:00
|
|
|
|
void Prj_ReqRemEvl (void);
|
2017-09-22 00:56:17 +02:00
|
|
|
|
|
|
|
|
|
void Prj_RemStd (void);
|
|
|
|
|
void Prj_RemTut (void);
|
2019-04-11 09:55:35 +02:00
|
|
|
|
void Prj_RemEvl (void);
|
2017-09-22 00:56:17 +02:00
|
|
|
|
|
2017-09-21 00:40:09 +02:00
|
|
|
|
void Prj_RequestCreatePrj (void);
|
|
|
|
|
void Prj_RequestEditPrj (void);
|
|
|
|
|
|
2020-04-08 22:09:35 +02:00
|
|
|
|
void Prj_AllocMemProject (struct Prj_Project *Prj);
|
|
|
|
|
void Prj_FreeMemProject (struct Prj_Project *Prj);
|
2017-10-07 12:28:19 +02:00
|
|
|
|
|
2020-04-08 22:09:35 +02:00
|
|
|
|
void Prj_GetDataOfProjectByCod (struct Prj_Project *Prj);
|
2017-10-07 12:28:19 +02:00
|
|
|
|
long Prj_GetCourseOfProject (long PrjCod);
|
2020-04-10 19:14:08 +02:00
|
|
|
|
void Prj_FreeListProjects (struct Prj_Projects *Projects);
|
2017-09-15 13:19:27 +02:00
|
|
|
|
|
2017-10-06 20:56:01 +02:00
|
|
|
|
void Prj_PutParamPrjCod (long PrjCod);
|
2017-09-15 13:19:27 +02:00
|
|
|
|
long Prj_GetParamPrjCod (void);
|
|
|
|
|
void Prj_ReqRemProject (void);
|
|
|
|
|
void Prj_RemoveProject (void);
|
|
|
|
|
void Prj_HideProject (void);
|
2019-11-15 03:34:48 +01:00
|
|
|
|
void Prj_UnhideProject (void);
|
2019-04-18 14:06:00 +02:00
|
|
|
|
|
2020-05-05 21:49:00 +02:00
|
|
|
|
void Prj_ReceiveFormProject (void);
|
2019-10-25 22:48:34 +02:00
|
|
|
|
|
|
|
|
|
void Prj_ShowFormConfig (void);
|
|
|
|
|
void Prj_ReceiveConfigPrj (void);
|
2019-11-14 09:39:21 +01:00
|
|
|
|
void Prj_ReqLockSelectedPrjsEdition (void);
|
|
|
|
|
void Prj_ReqUnloSelectedPrjsEdition (void);
|
|
|
|
|
void Prj_LockSelectedPrjsEdition (void);
|
|
|
|
|
void Prj_UnloSelectedPrjsEdition (void);
|
2019-10-25 22:48:34 +02:00
|
|
|
|
void Prj_LockProjectEdition (void);
|
2019-11-14 09:39:21 +01:00
|
|
|
|
void Prj_UnloProjectEdition (void);
|
2017-09-24 22:35:18 +02:00
|
|
|
|
|
2017-09-15 13:19:27 +02:00
|
|
|
|
void Prj_RemoveCrsProjects (long CrsCod);
|
2017-09-24 22:35:18 +02:00
|
|
|
|
void Prj_RemoveUsrFromProjects (long UsrCod);
|
2017-09-15 13:19:27 +02:00
|
|
|
|
|
2021-02-11 22:57:09 +01:00
|
|
|
|
unsigned Prj_GetNumCoursesWithProjects (Hie_Lvl_Level_t Scope);
|
|
|
|
|
unsigned Prj_GetNumProjects (Hie_Lvl_Level_t Scope);
|
2017-09-15 13:19:27 +02:00
|
|
|
|
|
|
|
|
|
#endif
|