-
Notifications
You must be signed in to change notification settings - Fork 17
/
swad_action.c
445 lines (377 loc) · 15.3 KB
/
swad_action.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
// swad_action.c: actions
/*
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-2024 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 <stddef.h> // For NULL
#include <string.h> // For string functions
#include "swad_action.h"
#include "swad_action_list.h"
#include "swad_global.h"
#include "swad_group_database.h"
#include "swad_photo.h"
#include "swad_role.h"
#include "swad_test_config.h"
/*****************************************************************************/
/************** External global variables from others modules ****************/
/*****************************************************************************/
extern struct Globals Gbl;
extern const struct Act_Actions ActLst_Actions[ActLst_NUM_ACTIONS];
/*****************************************************************************/
/****************** Get action from permanent action code ********************/
/*****************************************************************************/
Act_Action_t Act_GetActionFromActCod (long ActCod)
{
extern Act_Action_t ActLst_FromActCodToAction[1 + ActLst_MAX_ACTION_COD];
if (ActCod < 0 || ActCod > ActLst_MAX_ACTION_COD)
return ActUnk;
return ActLst_FromActCodToAction[ActCod];
}
/*****************************************************************************/
/****************** Get permanent action code from action ********************/
/*****************************************************************************/
long Act_GetActCod (Act_Action_t Action)
{
if ((unsigned) Action >= ActLst_NUM_ACTIONS)
return -1L;
return ActLst_Actions[Action].ActCod;
}
/*****************************************************************************/
/***************** Get index in menu associated to an action ******************/
/*****************************************************************************/
unsigned Act_GetIndexInMenu (Act_Action_t Action)
{
return ActLst_Actions[Action].IndexInMenu;
}
/*****************************************************************************/
/********************* Get tab associated to an action ***********************/
/*****************************************************************************/
Tab_Tab_t Act_GetTab (Act_Action_t Action)
{
return ActLst_Actions[Action].Tab;
}
/*****************************************************************************/
/***************** Get superaction associated to an action *******************/
/*****************************************************************************/
Act_Action_t Act_GetSuperAction (Act_Action_t Action)
{
extern struct Mnu_Menu Mnu_Menu[Tab_NUM_TABS][Act_MAX_OPTIONS_IN_MENU_PER_TAB];
Tab_Tab_t Tab;
if ((unsigned) Action >= ActLst_NUM_ACTIONS)
return ActUnk;
if ((Tab = Act_GetTab (Action)) == TabUnk)
return Action;
return Mnu_Menu[Tab][Act_GetIndexInMenu (Action)].Action;
}
/*****************************************************************************/
/************* Check if I have permission to execute an action ***************/
/*****************************************************************************/
Usr_Can_t Act_CheckIfICanExecuteAction (Act_Action_t Action)
{
if ((unsigned) Action >= ActLst_NUM_ACTIONS)
return Usr_CAN_NOT;
if (Gbl.Hierarchy.Level == Hie_UNK)
return Usr_CAN_NOT;
return ((ActLst_Actions[Action].Permission[Gbl.Hierarchy.Level][Gbl.Usrs.Me.IBelongToCurrent[Gbl.Hierarchy.Level]]
& (1 << Gbl.Usrs.Me.Role.Logged))) ? Usr_CAN :
Usr_CAN_NOT;
}
/*****************************************************************************/
/***************** Get content type associated to an action ******************/
/*****************************************************************************/
Act_Content_t Act_GetContentType (Act_Action_t Action)
{
if ((unsigned) Action >= ActLst_NUM_ACTIONS)
return Act_NORM;
return ActLst_Actions[Action].ContentType;
}
/*****************************************************************************/
/****************** Get browser tab associated to an action ******************/
/*****************************************************************************/
Act_BrowserTab_t Act_GetBrowserTab (Act_Action_t Action)
{
if ((unsigned) Action >= ActLst_NUM_ACTIONS)
return Act_UNK;
return ActLst_Actions[Action].BrowserTab;
}
/*****************************************************************************/
/********* Get pointer to function a priori associated to an action **********/
/*****************************************************************************/
void (*Act_GetFunctionPriori (Act_Action_t Action)) (void)
{
if ((unsigned) Action >= ActLst_NUM_ACTIONS)
return NULL;
return ActLst_Actions[Action].FunctionPriori;
}
/*****************************************************************************/
/******* Get pointer to function a posteriori associated to an action ********/
/*****************************************************************************/
void (*Act_GetFunctionPosteriori (Act_Action_t Action)) (void)
{
if ((unsigned) Action >= ActLst_NUM_ACTIONS)
return NULL;
return ActLst_Actions[Action].FunctionPosteriori;
}
/*****************************************************************************/
/********************** Get icon associated to an action *********************/
/*****************************************************************************/
const char *Act_GetIconFromAction (Act_Action_t Action)
{
if ((unsigned) Action >= ActLst_NUM_ACTIONS)
return NULL;
return Ico_GetIcon (Mnu_GetIconFromAction (Action));
}
/*****************************************************************************/
/******************* Get the title associated to an action *******************/
/*****************************************************************************/
const char *Act_GetTitleAction (Act_Action_t Action)
{
extern const char *Txt_MENU_TITLE[Tab_NUM_TABS][Act_MAX_OPTIONS_IN_MENU_PER_TAB];
Tab_Tab_t Tab;
if ((unsigned) Action >= ActLst_NUM_ACTIONS)
return NULL;
if ((Tab = Act_GetTab (Action)) == TabUnk)
return NULL;
return Txt_MENU_TITLE[Tab][Act_GetIndexInMenu (Action)];
}
/*****************************************************************************/
/********************* Get text for action from database *********************/
/*****************************************************************************/
const char *Act_GetActionText (Act_Action_t Action)
{
extern const char *Txt_Actions[ActLst_NUM_ACTIONS];
if ((unsigned) Action < ActLst_NUM_ACTIONS)
if (Txt_Actions[Action])
if (Txt_Actions[Action][0])
return Txt_Actions[Action];
return "?";
}
/*****************************************************************************/
/***************** Adjust current action when no user's logged ***************/
/*****************************************************************************/
void Act_AdjustActionWhenNoUsrLogged (void)
{
static Act_Action_t Actions[Hie_NUM_LEVELS] =
{
[Hie_UNK] = ActUnk, // Unknown
[Hie_SYS] = ActFrmLogIn, // System
[Hie_CTY] = ActSeeCtyInf, // Country
[Hie_INS] = ActSeeInsInf, // Institution
[Hie_CTR] = ActSeeCtrInf, // Center
[Hie_DEG] = ActSeeDegInf, // Degree
[Hie_CRS] = ActSeeCrsInf, // Course
};
if (Gbl.Hierarchy.Level >= Hie_NUM_LEVELS)
Gbl.Hierarchy.Level = Hie_UNK;
Gbl.Action.Act = Actions[Gbl.Hierarchy.Level];
Tab_SetCurrentTab ();
}
/*****************************************************************************/
/****** Adjust current action if it's mandatory to fill any empty data *******/
/*****************************************************************************/
void Act_AdjustCurrentAction (void)
{
bool IAmATeacherInAnyCrs;
bool JustAfterLogin = Gbl.Action.Act == ActLogIn ||
Gbl.Action.Act == ActLogInLan ||
Gbl.Action.Act == ActLogInNew ||
Gbl.Action.Act == ActAnnSee;
/***** Don't adjust anything when:
- refreshing
- web service *****/
if (Gbl.Action.UsesAJAX ||
Gbl.WebService.IsWebService)
return;
/***** Don't adjust anything when current action is not a menu option
(except some actions just after login) *****/
if (!JustAfterLogin && // Not just after login
Gbl.Action.Act != Act_GetSuperAction (Gbl.Action.Act)) // It is not a menu option
return;
/***** Adjustment 1:
-------------
If I have no password in database,
the only action possible
is to show a form to change my account *****/
if (!Gbl.Usrs.Me.UsrDat.Password[0])
{
Gbl.Action.Act = ActFrmMyAcc;
Tab_SetCurrentTab ();
return;
}
/***** Adjustment 2:
-------------
Just after login, check if my password seems good.
If my password is not enough secure,
the only action possible
is to show a form to change my account *****/
if (Gbl.Action.Act == ActLogIn)
if (!Pwd_FastCheckIfPasswordSeemsGood (Gbl.Usrs.Me.LoginPlainPassword))
{
Gbl.Action.Act = ActFrmMyAcc;
Tab_SetCurrentTab ();
return;
}
/***** Adjustment 3:
-------------
If I have no nickname or email in database,
the only action possible
is to show a form to change my account *****/
if (!Gbl.Usrs.Me.UsrDat.Nickname[0] ||
!Gbl.Usrs.Me.UsrDat.Email[0])
{
Gbl.Action.Act = ActFrmMyAcc;
Tab_SetCurrentTab ();
return;
}
/***** Check if I am a teacher in any course *****/
Rol_GetRolesInAllCrss (&Gbl.Usrs.Me.UsrDat);
IAmATeacherInAnyCrs = (Gbl.Usrs.Me.UsrDat.Roles.InCrss & ((1 << Rol_NET) | // I am a non-editing teacher...
(1 << Rol_TCH))); // ...or a teacher in any course
/***** Adjustment 4:
-------------
If I haven't filled
- my sex
- my first name
- my surname 1
- my country
- my institution
or if I'm a teacher and I haven't filled
- my center
- my department,
the only action possible
is to show a form to change my shared record card *****/
if ( Gbl.Usrs.Me.UsrDat.Sex == Usr_SEX_UNKNOWN ||
!Gbl.Usrs.Me.UsrDat.FrstName[0] ||
!Gbl.Usrs.Me.UsrDat.Surname1 [0] ||
Gbl.Usrs.Me.UsrDat.CtyCod <= 0 ||
Gbl.Usrs.Me.UsrDat.InsCod < 0 ||
(IAmATeacherInAnyCrs && (Gbl.Usrs.Me.UsrDat.Tch.CtrCod < 0 ||
Gbl.Usrs.Me.UsrDat.Tch.DptCod < 0)))
{
Gbl.Action.Act = ActReqEdiRecSha;
Tab_SetCurrentTab ();
return;
}
/***** Adjustment 5:
-------------
If any of my settings about privacy is unknown
the only action possible
is to show a form to change my settings *****/
if (Gbl.Usrs.Me.UsrDat.PhotoVisibility == Pri_VISIBILITY_UNKNOWN ||
Gbl.Usrs.Me.UsrDat.BaPrfVisibility == Pri_VISIBILITY_UNKNOWN ||
Gbl.Usrs.Me.UsrDat.ExPrfVisibility == Pri_VISIBILITY_UNKNOWN)
{
Gbl.Action.Act = ActReqEdiSet;
Tab_SetCurrentTab ();
return;
}
/***** If I belong to current course *****/
if (Gbl.Usrs.Me.IBelongToCurrent[Hie_CRS] == Usr_BELONG)
{
/***** Adjustment 6:
-------------
If I have not accepted my enrolment in the current course,
the only action possible
is to show a form to ask for enrolment *****/
if (!Gbl.Usrs.Me.UsrDat.Accepted)
{
switch (Gbl.Usrs.Me.UsrDat.Roles.InCurrentCrs)
{
case Rol_STD:
Gbl.Action.Act = ActReqAccEnrStd;
break;
case Rol_NET:
Gbl.Action.Act = ActReqAccEnrNET;
break;
case Rol_TCH:
Gbl.Action.Act = ActReqAccEnrTch;
break;
default:
break;
}
Tab_SetCurrentTab ();
return;
}
/***** Depending on the role I am logged in the current course... *****/
switch (Gbl.Usrs.Me.Role.Logged)
{
case Rol_STD:
/***** Adjustment 7:
-------------
If there are some group types
with available groups in which I must register,
the only action possible
is show a form to register in groups *****/
if (JustAfterLogin) // Only after login because the following query may be slow
if (Grp_DB_CheckIfAvailableGrpTyp (-1L)) // This query may be slow
{
Gbl.Action.Act = ActReqSelAllGrp;
Tab_SetCurrentTab ();
return;
}
/***** Adjustment 8:
-------------
If I have no photo
and current action is not available for unknown users,
then update number of clicks without photo.
If limit of clicks is reached,
the only action possible
is to show a form to send my photo *****/
if (!Gbl.Usrs.Me.MyPhotoExists)
if (!(ActLst_Actions[Gbl.Action.Act].Permission[Hie_CRS][Usr_BELONG] & (1 << Rol_UNK)))
if ((Gbl.Usrs.Me.NumAccWithoutPhoto =
Pho_UpdateMyClicksWithoutPhoto ()) > Pho_MAX_CLICKS_WITHOUT_PHOTO)
{
/* If limit of clicks has been reached,
the only action possible is show a form to send my photo */
Gbl.Action.Act = ActReqMyPho;
Tab_SetCurrentTab ();
return;
}
/***** Check if it is mandatory to read any information about course *****/
if (Gbl.Action.Act == ActMnu) // Do the following check sometimes, for example when the user changes the current tab
Gbl.Crs.Info.ShowMsgMustBeRead = Inf_GetIfIMustReadAnyCrsInfoInThisCrs ();
break;
case Rol_NET:
break;
case Rol_TCH:
/***** Adjustment 9:
-------------
If current course has tests and pluggable is unknown,
the only action possible is configure tests *****/
if (TstCfg_CheckIfPluggableIsUnknownAndCrsHasTests ())
{
Gbl.Action.Act = ActCfgTst;
Tab_SetCurrentTab ();
return;
}
break;
default:
break;
}
}
/***** Adjustment 10:
--------------
Just after login with all checks OK ==> go to default action *****/
if (JustAfterLogin)
{
Gbl.Action.Act = ActLst_DEFAULT_ACTION_AFTER_LOGIN;
Tab_SetCurrentTab ();
}
}