mirror of https://github.com/acanas/swad-core.git
117 lines
4.5 KiB
C
117 lines
4.5 KiB
C
// swad_action.h: actions
|
|
|
|
#ifndef _SWAD_ACT
|
|
#define _SWAD_ACT
|
|
/*
|
|
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-2023 Antonio Cañas Vargas
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Affero General Public License as
|
|
published by the Free Software Foundation, either version 3 of the
|
|
License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Affero General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
/*****************************************************************************/
|
|
/********************************** Headers **********************************/
|
|
/*****************************************************************************/
|
|
|
|
#include <stdbool.h> // For boolean type
|
|
|
|
#include "swad_constant.h"
|
|
#include "swad_cryptography.h"
|
|
#include "swad_language.h"
|
|
#include "swad_string.h"
|
|
#include "swad_tab.h"
|
|
|
|
/*****************************************************************************/
|
|
/****************************** Public constants *****************************/
|
|
/*****************************************************************************/
|
|
|
|
#define Act_MAX_CHARS_ACTION_TXT (256 - 1) // 255
|
|
#define Act_MAX_BYTES_ACTION_TXT Act_MAX_CHARS_ACTION_TXT // 255
|
|
|
|
#define Act_MAX_OPTIONS_IN_MENU_PER_TAB 13
|
|
|
|
/*****************************************************************************/
|
|
/******************************** Public types *******************************/
|
|
/*****************************************************************************/
|
|
|
|
#define Act_NUM_CONTENTS 2
|
|
typedef enum
|
|
{
|
|
Act_CONT_NORM,
|
|
Act_CONT_DATA,
|
|
} Act_Content_t;
|
|
|
|
typedef enum
|
|
{
|
|
Act_BRW_UNK_TAB, // Unknown tab
|
|
Act_BRW_1ST_TAB, // The main (original, first) tab in the browser
|
|
Act_BRW_NEW_TAB, // A new (second) blank tab in the browser
|
|
Act_BRW_2ND_TAB, // The second tab in the browser
|
|
Act_AJAX_NORMAL, // Update a zone of the page using AJAX
|
|
Act_AJAX_RFRESH, // Update a zone of the page using AJAX, with auto-refresh
|
|
Act_UPLOAD_FILE, // Upload a file. Do not write HTML content. Write Status code instead for Dropzone.js
|
|
Act_DOWNLD_FILE, // Download a file in a new tab. Do not write HTML content.
|
|
Act_204_NO_CONT, // Do not write HTML content. HTTP will return Status 204 No Content
|
|
Act_WEB_SERVICE, // Web service. Send output to client using SOAP.
|
|
} Act_BrowserTab_t;
|
|
|
|
typedef signed int Act_Action_t; // Must be a signed type, because -1 is used to indicate obsolete action
|
|
|
|
struct Act_Actions
|
|
{
|
|
long ActCod; // Unique, time-persistent numerical code for the action
|
|
signed int IndexInMenu;
|
|
Tab_Tab_t Tab;
|
|
Act_Action_t SuperAction;
|
|
unsigned PermissionCrsIfIBelong;
|
|
unsigned PermissionCrsIfIDontBelong;
|
|
unsigned PermissionDeg;
|
|
unsigned PermissionCtr;
|
|
unsigned PermissionIns;
|
|
unsigned PermissionCty;
|
|
unsigned PermissionSys;
|
|
Act_Content_t ContentType;
|
|
Act_BrowserTab_t BrowserTab;
|
|
void (*FunctionPriori) ();
|
|
void (*FunctionPosteriori) ();
|
|
const char *Icon;
|
|
};
|
|
|
|
/*****************************************************************************/
|
|
/***************************** Public prototypes *****************************/
|
|
/*****************************************************************************/
|
|
|
|
Act_Action_t Act_GetActionFromActCod (long ActCod);
|
|
long Act_GetActCod (Act_Action_t Action);
|
|
signed int Act_GetIndexInMenu (Act_Action_t Action);
|
|
Tab_Tab_t Act_GetTab (Act_Action_t Action);
|
|
Act_Action_t Act_GetSuperAction (Act_Action_t Action);
|
|
bool Act_CheckIfIHavePermissionToExecuteAction (Act_Action_t Action);
|
|
Act_Content_t Act_GetContentType (Act_Action_t Action);
|
|
Act_BrowserTab_t Act_GetBrowserTab (Act_Action_t Action);
|
|
void (*Act_GetFunctionPriori (Act_Action_t Action)) (void);
|
|
void (*Act_GetFunctionPosteriori (Act_Action_t Action)) (void);
|
|
const char *Act_GetIcon (Act_Action_t Action);
|
|
|
|
const char *Act_GetTitleAction (Act_Action_t Action);
|
|
const char *Act_GetActionText (Act_Action_t Action);
|
|
|
|
void Act_AdjustActionWhenNoUsrLogged (void);
|
|
void Act_AdjustCurrentAction (void);
|
|
|
|
#endif
|