2 * Lots of different room-related operations.
4 * Copyright (c) 1996-2012 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License, version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 #include "webserver.h"
18 CtxType CTX_ROOMS = CTX_NONE;
19 CtxType CTX_FLOORS = CTX_NONE;
22 * Embed the room banner
24 * got The information returned from a GOTO server command
25 * navbar_style Determines which navigation buttons to display
27 void tmplput_roombanner(StrBuf *Target, WCTemplputParams *TP)
31 /* Refresh current room states. Doesn't work? gotoroom(NULL); */
33 wc_printf("<div id=\"banner\">\n");
35 /* The browser needs some information for its own use */
36 wc_printf("<script type=\"text/javascript\"> \n"
37 " room_is_trash = %d; \n"
39 ((WC->CurRoom.RAFlags & UA_ISTRASH) != 0)
43 * If the user happens to select the "make this my start page" link,
44 * we want it to remember the URL as a "/dotskip" one instead of
45 * a "skip" or "gotonext" or something like that.
47 if (WCC->Hdr->this_page == NULL) {
48 WCC->Hdr->this_page = NewStrBuf();
50 StrBufPrintf(WCC->Hdr->this_page, "dotskip?room=%s", ChrPtr(WC->CurRoom.name));
52 do_template("roombanner");
54 do_template("navbar");
55 wc_printf("</div>\n");
59 /*******************************************************************************
60 ********************** FLOOR Tokens *******************************************
61 *******************************************************************************/
64 void tmplput_FLOOR_ID(StrBuf *Target, WCTemplputParams *TP)
66 Floor *myFloor = (Floor *)CTX(CTX_FLOORS);
68 StrBufAppendPrintf(Target, "%d", myFloor->ID);
72 void tmplput_ROOM_FLOORID(StrBuf *Target, WCTemplputParams *TP)
74 folder *Folder = (folder *)CTX(CTX_ROOMS);
75 StrBufAppendPrintf(Target, "%d", Folder->floorid);
79 void tmplput_ROOM_FLOOR_ID(StrBuf *Target, WCTemplputParams *TP)
81 folder *Folder = (folder *)CTX(CTX_ROOMS);
82 const Floor *pFloor = Folder->Floor;
87 StrBufAppendPrintf(Target, "%d", pFloor->ID);
91 void tmplput_ROOM_FLOOR_NAME(StrBuf *Target, WCTemplputParams *TP)
93 folder *Folder = (folder *)CTX(CTX_ROOMS);
94 const Floor *pFloor = Folder->Floor;
99 StrBufAppendTemplate(Target, TP, pFloor->Name, 0);
103 void tmplput_ThisRoomFloorName(StrBuf *Target, WCTemplputParams *TP)
106 folder *Folder = &WCC->CurRoom;
112 pFloor = Folder->Floor;
116 StrBufAppendTemplate(Target, TP, pFloor->Name, 0);
120 void tmplput_FLOOR_NAME(StrBuf *Target, WCTemplputParams *TP)
122 Floor *myFloor = (Floor *)CTX(CTX_FLOORS);
124 StrBufAppendTemplate(Target, TP, myFloor->Name, 0);
128 void tmplput_FLOOR_NROOMS(StrBuf *Target, WCTemplputParams *TP)
130 Floor *myFloor = (Floor *)CTX(CTX_FLOORS);
132 StrBufAppendPrintf(Target, "%d", myFloor->NRooms);
136 void tmplput_ROOM_FLOOR_NROOMS(StrBuf *Target, WCTemplputParams *TP)
138 folder *Folder = (folder *)CTX(CTX_ROOMS);
139 const Floor *pFloor = Folder->Floor;
143 StrBufAppendPrintf(Target, "%d", pFloor->NRooms);
147 int ConditionalFloorHaveNRooms(StrBuf *Target, WCTemplputParams *TP)
149 Floor *MyFloor = (Floor *)CTX(CTX_FLOORS);
152 HaveN = GetTemplateTokenNumber(Target, TP, 0, 0);
154 return HaveN == MyFloor->NRooms;
158 int ConditionalFloorIsRESTSubFloor(StrBuf *Target, WCTemplputParams *TP)
161 Floor *MyFloor = (Floor *)CTX(CTX_FLOORS);
162 /** if we have dav_depth the client just wants the subfloors */
163 if ((WCC->Hdr->HR.dav_depth == 1) &&
164 (GetCount(WCC->Directory) == 0))
166 return WCC->CurrentFloor == MyFloor;
170 int ConditionalFloorIsSUBROOM(StrBuf *Target, WCTemplputParams *TP)
173 Floor *MyFloor = (Floor *)CTX(CTX_FLOORS);
175 return WCC->CurRoom.floorid == MyFloor->ID;
179 int ConditionalFloorIsVirtual(StrBuf *Target, WCTemplputParams *TP)
181 Floor *MyFloor = (Floor *)CTX(CTX_FLOORS);
183 return MyFloor->ID == VIRTUAL_MY_FLOOR;
187 /*******************************************************************************
188 ********************** ROOM Tokens ********************************************
189 *******************************************************************************/
192 void tmplput_ThisRoom(StrBuf *Target, WCTemplputParams *TP)
197 StrBufAppendTemplate(Target, TP,
205 void tmplput_ROOM_NAME(StrBuf *Target, WCTemplputParams *TP)
207 folder *Folder = (folder *)CTX(CTX_ROOMS);
209 StrBufAppendTemplate(Target, TP, Folder->name, 0);
213 void tmplput_ROOM_BASENAME(StrBuf *Target, WCTemplputParams *TP)
215 folder *room = (folder *)CTX(CTX_ROOMS);
217 if (room->nRoomNameParts > 1)
218 StrBufAppendTemplate(Target, TP,
219 room->RoomNameParts[room->nRoomNameParts - 1], 0);
221 StrBufAppendTemplate(Target, TP, room->name, 0);
225 void tmplput_ROOM_LEVEL_N_TIMES(StrBuf *Target, WCTemplputParams *TP)
227 folder *room = (folder *)CTX(CTX_ROOMS);
229 const char *AppendMe;
233 if (room->nRoomNameParts > 1)
235 GetTemplateTokenString(Target, TP, 0, &AppendMe, &AppendMeLen);
236 for (i = 0; i < room->nRoomNameParts; i++)
237 StrBufAppendBufPlain(Target, AppendMe, AppendMeLen, 0);
242 int ConditionalRoomIsInbox(StrBuf *Target, WCTemplputParams *TP)
244 folder *Folder = (folder *)CTX(CTX_ROOMS);
245 return Folder->is_inbox;
248 int ConditionalRoomIsType(StrBuf *Target, WCTemplputParams *TP)
250 folder *Folder = (folder *)CTX(CTX_ROOMS);
255 if ((TP->Tokens->nParameters < 3))
257 return ((Folder->view < VIEW_BBS) ||
258 (Folder->view > VIEW_MAX));
261 return Folder->view == GetTemplateTokenNumber(Target, TP, 2, VIEW_BBS);
266 /****** Properties ******/
267 int ConditionalRoom_MayEdit(StrBuf *Target, WCTemplputParams *TP)
273 return WCC->CurRoom.XALoaded == 1;
276 int ConditionalThisRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
281 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
282 if (QR_CheckFlag == 0)
283 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
284 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
289 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
290 (TP->Tokens->Params[2]->MaskBy == eNO))
291 return (WCC->CurRoom.QRFlags & QR_CheckFlag) != 0;
293 return (WCC->CurRoom.QRFlags & QR_CheckFlag) == QR_CheckFlag;
297 int ConditionalRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
300 folder *Folder = (folder *)(TP->Context);
302 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
303 if (QR_CheckFlag == 0)
304 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
305 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
307 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
308 (TP->Tokens->Params[2]->MaskBy == eNO))
309 return (Folder->QRFlags & QR_CheckFlag) != 0;
311 return (Folder->QRFlags & QR_CheckFlag) == QR_CheckFlag;
315 void tmplput_ROOM_QRFLAGS(StrBuf *Target, WCTemplputParams *TP)
317 folder *Folder = (folder *)CTX(CTX_ROOMS);
318 StrBufAppendPrintf(Target, "%d", Folder->QRFlags);
322 int ConditionalThisRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
327 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
328 if (QR2_CheckFlag == 0)
329 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
330 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
336 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
337 (TP->Tokens->Params[2]->MaskBy == eNO))
338 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) != 0;
340 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) == QR2_CheckFlag;
344 int ConditionalRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
347 folder *Folder = (folder *)(TP->Context);
349 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
350 if (QR2_CheckFlag == 0)
351 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
352 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
353 return ((Folder->QRFlags2 & QR2_CheckFlag) != 0);
357 int ConditionalRoomHas_UAFlag(StrBuf *Target, WCTemplputParams *TP)
359 folder *Folder = (folder *)(TP->Context);
362 UA_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
363 if (UA_CheckFlag == 0)
364 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
365 "requires one of the #\"UA_*\"- defines or an integer flag 0 is invalid!");
367 return ((Folder->RAFlags & UA_CheckFlag) != 0);
371 void tmplput_ROOM_ACL(StrBuf *Target, WCTemplputParams *TP)
373 folder *Folder = (folder *)CTX(CTX_ROOMS);
375 StrBufAppendPrintf(Target, "%ld", Folder->RAFlags, 0);
379 void tmplput_ROOM_RAFLAGS(StrBuf *Target, WCTemplputParams *TP)
381 folder *Folder = (folder *)(TP->Context);
382 StrBufAppendPrintf(Target, "%d", Folder->RAFlags);
386 void tmplput_ThisRoomAide(StrBuf *Target, WCTemplputParams *TP)
392 StrBufAppendTemplate(Target, TP, WCC->CurRoom.RoomAide, 0);
396 int ConditionalRoomAide(StrBuf *Target, WCTemplputParams *TP)
399 return (WCC != NULL)?
400 ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) : 0;
404 int ConditionalRoomAcessDelete(StrBuf *Target, WCTemplputParams *TP)
407 return (WCC == NULL)? 0 :
408 ( ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) ||
409 (WCC->CurRoom.is_inbox) ||
410 (WCC->CurRoom.QRFlags2 & QR2_COLLABDEL) );
414 int ConditionalHaveRoomeditRights(StrBuf *Target, WCTemplputParams *TP)
418 return ( (WCC != NULL)
422 || ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0)
423 || (WCC->CurRoom.is_inbox)
429 void tmplput_ThisRoomPass(StrBuf *Target, WCTemplputParams *TP)
434 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XAPass, 0);
438 void tmplput_ThisRoom_nNewMessages(StrBuf *Target, WCTemplputParams *TP)
442 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nNewMessages);
446 void tmplput_ThisRoom_nTotalMessages(StrBuf *Target, WCTemplputParams *TP)
450 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nTotalMessages);
454 void tmplput_ThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
460 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.Order);
464 int ConditionalThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
474 CheckThis = GetTemplateTokenNumber(Target, TP, 2, 0);
475 return CheckThis == WCC->CurRoom.Order;
479 void tmplput_ROOM_LISTORDER(StrBuf *Target, WCTemplputParams *TP)
481 folder *Folder = (folder *)CTX(CTX_ROOMS);
482 StrBufAppendPrintf(Target, "%d", Folder->Order);
486 int ConditionalThisRoomXHavePic(StrBuf *Target, WCTemplputParams *TP)
494 return WCC->CurRoom.XHaveRoomPic == 1;
498 int ConditionalThisRoomXHaveInfoText(StrBuf *Target, WCTemplputParams *TP)
506 return (StrLength(WCC->CurRoom.XInfoText)>0);
510 void tmplput_ThisRoomInfoText(StrBuf *Target, WCTemplputParams *TP)
517 nchars = GetTemplateTokenNumber(Target, TP, 0, 0);
519 /* the whole thing */
520 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XInfoText, 1);
523 /* only a certain number of characters */
525 SubBuf = NewStrBufDup(WCC->CurRoom.XInfoText);
526 if (StrLength(SubBuf) > nchars) {
527 StrBuf_Utf8StrCut(SubBuf, nchars);
528 StrBufAppendBufPlain(SubBuf, HKEY("..."), 0);
530 StrBufAppendTemplate(Target, TP, SubBuf, 1);
536 void tmplput_ROOM_LASTCHANGE(StrBuf *Target, WCTemplputParams *TP)
538 folder *Folder = (folder *)CTX(CTX_ROOMS);
539 StrBufAppendPrintf(Target, "%d", Folder->lastchange);
543 void tmplput_ThisRoomDirectory(StrBuf *Target, WCTemplputParams *TP)
549 StrBufAppendTemplate(Target, TP, WCC->CurRoom.Directory, 0);
553 void tmplput_ThisRoomXNFiles(StrBuf *Target, WCTemplputParams *TP)
557 LoadXRoomXCountFiles();
559 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.XDownloadCount);
563 void tmplput_ThisRoomX_FileString(StrBuf *Target, WCTemplputParams *TP)
567 LoadXRoomXCountFiles();
569 if (WCC->CurRoom.XDownloadCount == 1)
570 StrBufAppendBufPlain(Target, _("file"), -1, 0);
572 StrBufAppendBufPlain(Target, _("files"), -1, 0);
576 int ConditionalIsThisThatRoom(StrBuf *Target, WCTemplputParams *TP)
578 folder *Folder = (folder *)CTX(CTX_ROOMS);
584 return Folder == WCC->ThisRoom;
587 int ConditionalRoomIsName(StrBuf *Target, WCTemplputParams *TP)
589 folder *Folder = (folder *)CTX(CTX_ROOMS);
590 const char *CheckRoomName = NULL;
591 long CheckRoomNameLen;
593 GetTemplateTokenString(Target, TP, 3, &CheckRoomName, &CheckRoomNameLen);
594 if (CheckRoomName == NULL)
596 return strcmp(ChrPtr(Folder->name), CheckRoomName) == 0;
601 InitModule_ROOMTOKENS
604 /* we duplicate this, just to be shure its already done. */
605 RegisterCTX(CTX_ROOMS);
606 RegisterCTX(CTX_FLOORS);
608 RegisterNamespace("ROOMBANNER", 0, 1, tmplput_roombanner, NULL, CTX_NONE);
610 RegisterNamespace("FLOOR:ID", 0, 0, tmplput_FLOOR_ID, NULL, CTX_FLOORS);
611 RegisterNamespace("ROOM:INFO:FLOORID", 0, 1, tmplput_ROOM_FLOORID, NULL, CTX_ROOMS);
612 RegisterNamespace("ROOM:INFO:FLOOR:ID", 0, 0, tmplput_ROOM_FLOOR_ID, NULL, CTX_ROOMS);
614 RegisterNamespace("FLOOR:NAME", 0, 1, tmplput_FLOOR_NAME, NULL, CTX_FLOORS);
615 RegisterNamespace("ROOM:INFO:FLOOR:NAME", 0, 1, tmplput_ROOM_FLOOR_NAME, NULL, CTX_ROOMS);
616 RegisterNamespace("THISROOM:FLOOR:NAME", 0, 1, tmplput_ThisRoomFloorName, NULL, CTX_NONE);
618 RegisterNamespace("FLOOR:NROOMS", 0, 0, tmplput_FLOOR_NROOMS, NULL, CTX_FLOORS);
619 RegisterNamespace("ROOM:INFO:FLOOR:NROOMS", 0, 0, tmplput_ROOM_FLOOR_NROOMS, NULL, CTX_ROOMS);
621 RegisterConditional("COND:FLOOR:ISSUBROOM", 0, ConditionalFloorIsSUBROOM, CTX_FLOORS);
622 RegisterConditional("COND:FLOOR:NROOMS", 1, ConditionalFloorHaveNRooms, CTX_FLOORS);
623 RegisterConditional("COND:ROOM:REST:ISSUBFLOOR", 0, ConditionalFloorIsRESTSubFloor, CTX_FLOORS);
624 RegisterConditional("COND:FLOOR:ISVIRTUAL", 0, ConditionalFloorIsVirtual, CTX_FLOORS);
626 /**** Room... ******/
628 RegisterNamespace("THISROOM:NAME", 0, 1, tmplput_ThisRoom, NULL, CTX_NONE);
630 RegisterNamespace("ROOM:INFO:NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_ROOMS);
631 RegisterNamespace("ROOM:INFO:BASENAME", 0, 1, tmplput_ROOM_BASENAME, NULL, CTX_ROOMS);
632 RegisterNamespace("ROOM:INFO:LEVELNTIMES", 1, 2, tmplput_ROOM_LEVEL_N_TIMES, NULL, CTX_ROOMS);
633 RegisterConditional("COND:ROOM:INFO:IS_INBOX", 0, ConditionalRoomIsInbox, CTX_ROOMS);
634 RegisterConditional("COND:ROOM:INFO:TYPE_IS", 0, ConditionalRoomIsType, CTX_ROOMS);
635 RegisterConditional("COND:ROOM:INFO:NAME_IS", 1, ConditionalRoomIsName, CTX_ROOMS);
637 /****** Properties ******/
638 RegisterNamespace("ROOM:INFO:QRFLAGS", 0, 1, tmplput_ROOM_QRFLAGS, NULL, CTX_ROOMS);
639 RegisterConditional("COND:THISROOM:FLAG:QR", 0, ConditionalThisRoomHas_QRFlag, CTX_NONE);
640 RegisterConditional("COND:THISROOM:EDIT", 0, ConditionalRoom_MayEdit, CTX_NONE);
641 RegisterConditional("COND:ROOM:FLAG:QR", 0, ConditionalRoomHas_QRFlag, CTX_ROOMS);
643 RegisterConditional("COND:THISROOM:FLAG:QR2", 0, ConditionalThisRoomHas_QRFlag2, CTX_NONE);
644 RegisterConditional("COND:ROOM:FLAG:QR2", 0, ConditionalRoomHas_QRFlag2, CTX_ROOMS);
646 RegisterConditional("COND:ROOM:FLAG:UA", 0, ConditionalRoomHas_UAFlag, CTX_ROOMS);
647 RegisterNamespace("ROOM:INFO:RAFLAGS", 0, 1, tmplput_ROOM_RAFLAGS, NULL, CTX_ROOMS);
650 RegisterNamespace("ROOM:INFO:LISTORDER", 0, 1, tmplput_ROOM_LISTORDER, NULL, CTX_ROOMS);
651 RegisterNamespace("THISROOM:ORDER", 0, 0, tmplput_ThisRoomOrder, NULL, CTX_NONE);
652 RegisterConditional("COND:THISROOM:ORDER", 0, ConditionalThisRoomOrder, CTX_NONE);
654 RegisterNamespace("ROOM:INFO:LASTCHANGE", 0, 1, tmplput_ROOM_LASTCHANGE, NULL, CTX_ROOMS);
656 RegisterNamespace("THISROOM:MSGS:NEW", 0, 0, tmplput_ThisRoom_nNewMessages, NULL, CTX_NONE);
657 RegisterNamespace("THISROOM:MSGS:TOTAL", 0, 0, tmplput_ThisRoom_nTotalMessages, NULL, CTX_NONE);
659 RegisterNamespace("THISROOM:PASS", 0, 1, tmplput_ThisRoomPass, NULL, CTX_NONE);
660 RegisterNamespace("THISROOM:AIDE", 0, 1, tmplput_ThisRoomAide, NULL, CTX_NONE);
661 RegisterConditional("COND:ROOMAIDE", 2, ConditionalRoomAide, CTX_NONE);
662 RegisterConditional("COND:ACCESS:DELETE", 2, ConditionalRoomAcessDelete, CTX_NONE);
663 RegisterConditional("COND:ROOM:EDITACCESS", 0, ConditionalHaveRoomeditRights, CTX_NONE);
665 RegisterConditional("COND:THISROOM:HAVE_PIC", 0, ConditionalThisRoomXHavePic, CTX_NONE);
667 RegisterNamespace("THISROOM:INFOTEXT", 1, 2, tmplput_ThisRoomInfoText, NULL, CTX_NONE);
668 RegisterConditional("COND:THISROOM:HAVE_INFOTEXT", 0, ConditionalThisRoomXHaveInfoText, CTX_NONE);
670 RegisterNamespace("THISROOM:FILES:N", 0, 1, tmplput_ThisRoomXNFiles, NULL, CTX_NONE);
671 RegisterNamespace("THISROOM:FILES:STR", 0, 1, tmplput_ThisRoomX_FileString, NULL, CTX_NONE);
672 RegisterNamespace("THISROOM:DIRECTORY", 0, 1, tmplput_ThisRoomDirectory, NULL, CTX_NONE);
674 RegisterNamespace("ROOM:INFO:ACL", 0, 1, tmplput_ROOM_ACL, NULL, CTX_ROOMS);
675 RegisterConditional("COND:THIS:THAT:ROOM", 0, ConditionalIsThisThatRoom, CTX_ROOMS);