3 * Lots of different room-related operations.
5 * Copyright (c) 1996-2012 by the citadel.org team
7 * This program is open source software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License, version 3.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
17 #include "webserver.h"
19 CtxType CTX_ROOMS = CTX_NONE;
20 CtxType CTX_FLOORS = CTX_NONE;
23 * Embed the room banner
25 * got The information returned from a GOTO server command
26 * navbar_style Determines which navigation buttons to display
28 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" "</script>\n", ((WC->CurRoom.RAFlags & UA_ISTRASH) != 0)
41 * If the user happens to select the "make this my start page" link,
42 * we want it to remember the URL as a "/dotskip" one instead of
43 * a "skip" or "gotonext" or something like that.
45 if (WCC->Hdr->this_page == NULL) {
46 WCC->Hdr->this_page = NewStrBuf();
48 StrBufPrintf(WCC->Hdr->this_page, "dotskip?room=%s", ChrPtr(WC->CurRoom.name));
50 do_template("roombanner");
52 do_template("navbar");
53 wc_printf("</div>\n");
57 /*******************************************************************************
58 ********************** FLOOR Tokens *******************************************
59 *******************************************************************************/
62 void tmplput_FLOOR_ID(StrBuf * Target, WCTemplputParams * TP) {
63 Floor *myFloor = (Floor *) CTX(CTX_FLOORS);
65 StrBufAppendPrintf(Target, "%d", myFloor->ID);
69 void tmplput_ROOM_FLOORID(StrBuf * Target, WCTemplputParams * TP) {
70 folder *Folder = (folder *) CTX(CTX_ROOMS);
71 StrBufAppendPrintf(Target, "%d", Folder->floorid);
75 void tmplput_ROOM_FLOOR_ID(StrBuf * Target, WCTemplputParams * TP) {
76 folder *Folder = (folder *) CTX(CTX_ROOMS);
77 const Floor *pFloor = Folder->Floor;
82 StrBufAppendPrintf(Target, "%d", pFloor->ID);
86 void tmplput_ROOM_FLOOR_NAME(StrBuf * Target, WCTemplputParams * TP) {
87 folder *Folder = (folder *) CTX(CTX_ROOMS);
88 const Floor *pFloor = Folder->Floor;
93 StrBufAppendTemplate(Target, TP, pFloor->Name, 0);
97 void tmplput_ThisRoomFloorName(StrBuf * Target, WCTemplputParams * TP) {
99 folder *Folder = &WCC->CurRoom;
105 pFloor = Folder->Floor;
109 StrBufAppendTemplate(Target, TP, pFloor->Name, 0);
113 void tmplput_FLOOR_NAME(StrBuf * Target, WCTemplputParams * TP) {
114 Floor *myFloor = (Floor *) CTX(CTX_FLOORS);
116 StrBufAppendTemplate(Target, TP, myFloor->Name, 0);
120 void tmplput_FLOOR_NROOMS(StrBuf * Target, WCTemplputParams * TP) {
121 Floor *myFloor = (Floor *) CTX(CTX_FLOORS);
123 StrBufAppendPrintf(Target, "%d", myFloor->NRooms);
127 void tmplput_ROOM_FLOOR_NROOMS(StrBuf * Target, WCTemplputParams * TP) {
128 folder *Folder = (folder *) CTX(CTX_ROOMS);
129 const Floor *pFloor = Folder->Floor;
133 StrBufAppendPrintf(Target, "%d", pFloor->NRooms);
137 int ConditionalFloorHaveNRooms(StrBuf * Target, WCTemplputParams * TP) {
138 Floor *MyFloor = (Floor *) CTX(CTX_FLOORS);
141 HaveN = GetTemplateTokenNumber(Target, TP, 0, 0);
143 return HaveN == MyFloor->NRooms;
147 int ConditionalFloorIsRESTSubFloor(StrBuf * Target, WCTemplputParams * TP) {
149 Floor *MyFloor = (Floor *) CTX(CTX_FLOORS);
151 /** if we have dav_depth the client just wants the subfloors */
152 if ((WCC->Hdr->HR.dav_depth == 1) && (GetCount(WCC->Directory) == 0))
154 return WCC->CurrentFloor == MyFloor;
158 int ConditionalFloorIsSUBROOM(StrBuf * Target, WCTemplputParams * TP) {
160 Floor *MyFloor = (Floor *) CTX(CTX_FLOORS);
162 return WCC->CurRoom.floorid == MyFloor->ID;
166 int ConditionalFloorIsVirtual(StrBuf * Target, WCTemplputParams * TP) {
167 Floor *MyFloor = (Floor *) CTX(CTX_FLOORS);
169 return MyFloor->ID == VIRTUAL_MY_FLOOR;
173 /*******************************************************************************
174 ********************** ROOM Tokens ********************************************
175 *******************************************************************************/
179 void tmplput_ThisRoom(StrBuf * Target, WCTemplputParams * TP) {
183 StrBufAppendTemplate(Target, TP, WCC->CurRoom.name, 0);
188 void tmplput_ROOM_NAME(StrBuf * Target, WCTemplputParams * TP) {
189 folder *Folder = (folder *) CTX(CTX_ROOMS);
191 StrBufAppendTemplate(Target, TP, Folder->name, 0);
195 void tmplput_ROOM_BASENAME(StrBuf * Target, WCTemplputParams * TP) {
196 folder *room = (folder *) CTX(CTX_ROOMS);
198 if (room->nRoomNameParts > 1)
199 StrBufAppendTemplate(Target, TP, room->RoomNameParts[room->nRoomNameParts - 1], 0);
201 StrBufAppendTemplate(Target, TP, room->name, 0);
205 void tmplput_ROOM_LEVEL_N_TIMES(StrBuf * Target, WCTemplputParams * TP) {
206 folder *room = (folder *) CTX(CTX_ROOMS);
208 const char *AppendMe;
212 if (room->nRoomNameParts > 1) {
213 GetTemplateTokenString(Target, TP, 0, &AppendMe, &AppendMeLen);
214 for (i = 0; i < room->nRoomNameParts; i++)
215 StrBufAppendBufPlain(Target, AppendMe, AppendMeLen, 0);
220 int ConditionalRoomIsInbox(StrBuf * Target, WCTemplputParams * TP) {
221 folder *Folder = (folder *) CTX(CTX_ROOMS);
222 return Folder->is_inbox;
225 int ConditionalRoomIsType(StrBuf * Target, WCTemplputParams * TP) {
226 folder *Folder = (folder *) CTX(CTX_ROOMS);
231 if ((TP->Tokens->nParameters < 3)) {
232 return ((Folder->view < VIEW_BBS) || (Folder->view > VIEW_MAX));
235 return Folder->view == GetTemplateTokenNumber(Target, TP, 2, VIEW_BBS);
240 /****** Properties ******/
241 int ConditionalRoom_MayEdit(StrBuf * Target, WCTemplputParams * TP) {
246 return WCC->CurRoom.XALoaded == 1;
249 int ConditionalThisRoomHas_QRFlag(StrBuf * Target, WCTemplputParams * TP) {
253 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
254 if (QR_CheckFlag == 0)
255 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
256 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
261 if ((TP->Tokens->Params[2]->MaskBy == eOR) || (TP->Tokens->Params[2]->MaskBy == eNO))
262 return (WCC->CurRoom.QRFlags & QR_CheckFlag) != 0;
264 return (WCC->CurRoom.QRFlags & QR_CheckFlag) == QR_CheckFlag;
268 int ConditionalRoomHas_QRFlag(StrBuf * Target, WCTemplputParams * TP) {
270 folder *Folder = (folder *) (TP->Context);
272 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
273 if (QR_CheckFlag == 0)
274 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
275 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
277 if ((TP->Tokens->Params[2]->MaskBy == eOR) || (TP->Tokens->Params[2]->MaskBy == eNO))
278 return (Folder->QRFlags & QR_CheckFlag) != 0;
280 return (Folder->QRFlags & QR_CheckFlag) == QR_CheckFlag;
284 void tmplput_ROOM_QRFLAGS(StrBuf * Target, WCTemplputParams * TP) {
285 folder *Folder = (folder *) CTX(CTX_ROOMS);
286 StrBufAppendPrintf(Target, "%d", Folder->QRFlags);
290 int ConditionalThisRoomHas_QRFlag2(StrBuf * Target, WCTemplputParams * TP) {
294 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
295 if (QR2_CheckFlag == 0)
296 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
297 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
303 if ((TP->Tokens->Params[2]->MaskBy == eOR) || (TP->Tokens->Params[2]->MaskBy == eNO))
304 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) != 0;
306 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) == QR2_CheckFlag;
310 int ConditionalRoomHas_QRFlag2(StrBuf * Target, WCTemplputParams * TP) {
312 folder *Folder = (folder *) (TP->Context);
314 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
315 if (QR2_CheckFlag == 0)
316 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
317 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
318 return ((Folder->QRFlags2 & QR2_CheckFlag) != 0);
322 int ConditionalRoomHas_UAFlag(StrBuf * Target, WCTemplputParams * TP) {
323 folder *Folder = (folder *) (TP->Context);
326 UA_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
327 if (UA_CheckFlag == 0)
328 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
329 "requires one of the #\"UA_*\"- defines or an integer flag 0 is invalid!");
331 return ((Folder->RAFlags & UA_CheckFlag) != 0);
335 void tmplput_ROOM_ACL(StrBuf * Target, WCTemplputParams * TP) {
336 folder *Folder = (folder *) CTX(CTX_ROOMS);
338 StrBufAppendPrintf(Target, "%ld", Folder->RAFlags, 0);
342 void tmplput_ROOM_RAFLAGS(StrBuf * Target, WCTemplputParams * TP) {
343 folder *Folder = (folder *) (TP->Context);
344 StrBufAppendPrintf(Target, "%d", Folder->RAFlags);
348 void tmplput_ThisRoomAide(StrBuf * Target, WCTemplputParams * TP) {
353 StrBufAppendTemplate(Target, TP, WCC->CurRoom.RoomAide, 0);
357 int ConditionalRoomAide(StrBuf * Target, WCTemplputParams * TP) {
359 return (WCC != NULL) ? ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) : 0;
363 int ConditionalRoomAcessDelete(StrBuf * Target, WCTemplputParams * TP) {
365 return (WCC == NULL) ? 0 :
366 (((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) || (WCC->CurRoom.is_inbox) || (WCC->CurRoom.QRFlags2 & QR2_COLLABDEL));
370 int ConditionalHaveRoomeditRights(StrBuf * Target, WCTemplputParams * TP) {
373 return ((WCC != NULL)
375 && ((WCC->axlevel >= 6)
376 || ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0)
377 || (WCC->CurRoom.is_inbox)
383 void tmplput_ThisRoomPass(StrBuf * Target, WCTemplputParams * TP) {
387 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XAPass, 0);
391 void tmplput_ThisRoom_nNewMessages(StrBuf * Target, WCTemplputParams * TP) {
394 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nNewMessages);
398 void tmplput_ThisRoom_nTotalMessages(StrBuf * Target, WCTemplputParams * TP) {
401 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nTotalMessages);
405 void tmplput_ThisRoomOrder(StrBuf * Target, WCTemplputParams * TP) {
410 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.Order);
414 int ConditionalThisRoomOrder(StrBuf * Target, WCTemplputParams * TP) {
423 CheckThis = GetTemplateTokenNumber(Target, TP, 2, 0);
424 return CheckThis == WCC->CurRoom.Order;
428 void tmplput_ROOM_LISTORDER(StrBuf * Target, WCTemplputParams * TP) {
429 folder *Folder = (folder *) CTX(CTX_ROOMS);
430 StrBufAppendPrintf(Target, "%d", Folder->Order);
434 int ConditionalThisRoomXHavePic(StrBuf * Target, WCTemplputParams * TP) {
441 return WCC->CurRoom.XHaveRoomPic == 1;
444 int ConditionalThisRoomIsEdit(StrBuf * Target, WCTemplputParams * TP) {
449 return ((WCC->CurRoom.nRoomNameParts > 1) &&
450 (strcmp(ChrPtr(WCC->CurRoom.RoomNameParts[WCC->CurRoom.nRoomNameParts]), "edit") == 0));
453 int ConditionalThisRoomXHaveInfoText(StrBuf * Target, WCTemplputParams * TP) {
460 return (StrLength(WCC->CurRoom.XInfoText) > 0);
464 void tmplput_ThisRoomInfoText(StrBuf * Target, WCTemplputParams * TP) {
470 nchars = GetTemplateTokenNumber(Target, TP, 0, 0);
472 /* the whole thing */
473 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XInfoText, 1);
476 /* only a certain number of characters */
478 SubBuf = NewStrBufDup(WCC->CurRoom.XInfoText);
479 if (StrLength(SubBuf) > nchars) {
480 StrBuf_Utf8StrCut(SubBuf, nchars);
481 StrBufAppendBufPlain(SubBuf, HKEY("..."), 0);
483 StrBufAppendTemplate(Target, TP, SubBuf, 1);
489 void tmplput_ROOM_LASTCHANGE(StrBuf * Target, WCTemplputParams * TP) {
490 folder *Folder = (folder *) CTX(CTX_ROOMS);
491 StrBufAppendPrintf(Target, "%d", Folder->lastchange);
495 void tmplput_ThisRoomDirectory(StrBuf * Target, WCTemplputParams * TP) {
500 StrBufAppendTemplate(Target, TP, WCC->CurRoom.Directory, 0);
504 void tmplput_ThisRoomXNFiles(StrBuf * Target, WCTemplputParams * TP) {
507 LoadXRoomXCountFiles();
509 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.XDownloadCount);
513 void tmplput_ThisRoomX_FileString(StrBuf * Target, WCTemplputParams * TP) {
516 LoadXRoomXCountFiles();
518 if (WCC->CurRoom.XDownloadCount == 1)
519 StrBufAppendBufPlain(Target, _("file"), -1, 0);
521 StrBufAppendBufPlain(Target, _("files"), -1, 0);
525 int ConditionalIsThisThatRoom(StrBuf * Target, WCTemplputParams * TP) {
526 folder *Folder = (folder *) CTX(CTX_ROOMS);
532 return Folder == WCC->ThisRoom;
535 int ConditionalRoomIsName(StrBuf * Target, WCTemplputParams * TP) {
536 folder *Folder = (folder *) CTX(CTX_ROOMS);
537 const char *CheckRoomName = NULL;
538 long CheckRoomNameLen;
540 GetTemplateTokenString(Target, TP, 3, &CheckRoomName, &CheckRoomNameLen);
541 if (CheckRoomName == NULL)
543 return strcmp(ChrPtr(Folder->name), CheckRoomName) == 0;
547 void InitModule_ROOMTOKENS(void) {
548 /* we duplicate this, just to be shure its already done. */
549 RegisterCTX(CTX_ROOMS);
550 RegisterCTX(CTX_FLOORS);
552 RegisterNamespace("ROOMBANNER", 0, 1, tmplput_roombanner, NULL, CTX_NONE);
554 RegisterNamespace("FLOOR:ID", 0, 0, tmplput_FLOOR_ID, NULL, CTX_FLOORS);
555 RegisterNamespace("ROOM:INFO:FLOORID", 0, 1, tmplput_ROOM_FLOORID, NULL, CTX_ROOMS);
556 RegisterNamespace("ROOM:INFO:FLOOR:ID", 0, 0, tmplput_ROOM_FLOOR_ID, NULL, CTX_ROOMS);
558 RegisterNamespace("FLOOR:NAME", 0, 1, tmplput_FLOOR_NAME, NULL, CTX_FLOORS);
559 RegisterNamespace("ROOM:INFO:FLOOR:NAME", 0, 1, tmplput_ROOM_FLOOR_NAME, NULL, CTX_ROOMS);
560 RegisterNamespace("THISROOM:FLOOR:NAME", 0, 1, tmplput_ThisRoomFloorName, NULL, CTX_NONE);
562 RegisterNamespace("FLOOR:NROOMS", 0, 0, tmplput_FLOOR_NROOMS, NULL, CTX_FLOORS);
563 RegisterNamespace("ROOM:INFO:FLOOR:NROOMS", 0, 0, tmplput_ROOM_FLOOR_NROOMS, NULL, CTX_ROOMS);
565 RegisterConditional("COND:FLOOR:ISSUBROOM", 0, ConditionalFloorIsSUBROOM, CTX_FLOORS);
566 RegisterConditional("COND:FLOOR:NROOMS", 1, ConditionalFloorHaveNRooms, CTX_FLOORS);
567 RegisterConditional("COND:ROOM:REST:ISSUBFLOOR", 0, ConditionalFloorIsRESTSubFloor, CTX_FLOORS);
568 RegisterConditional("COND:FLOOR:ISVIRTUAL", 0, ConditionalFloorIsVirtual, CTX_FLOORS);
570 /**** Room... ******/
573 RegisterNamespace("THISROOM:NAME", 0, 1, tmplput_ThisRoom, NULL, CTX_NONE);
575 RegisterNamespace("ROOM:INFO:NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_ROOMS);
576 RegisterNamespace("ROOM:INFO:BASENAME", 0, 1, tmplput_ROOM_BASENAME, NULL, CTX_ROOMS);
577 RegisterNamespace("ROOM:INFO:LEVELNTIMES", 1, 2, tmplput_ROOM_LEVEL_N_TIMES, NULL, CTX_ROOMS);
578 RegisterConditional("COND:ROOM:INFO:IS_INBOX", 0, ConditionalRoomIsInbox, CTX_ROOMS);
579 RegisterConditional("COND:ROOM:INFO:TYPE_IS", 0, ConditionalRoomIsType, CTX_ROOMS);
580 RegisterConditional("COND:ROOM:INFO:NAME_IS", 1, ConditionalRoomIsName, CTX_ROOMS);
582 /****** Properties ******/
583 RegisterNamespace("ROOM:INFO:QRFLAGS", 0, 1, tmplput_ROOM_QRFLAGS, NULL, CTX_ROOMS);
584 RegisterConditional("COND:THISROOM:FLAG:QR", 0, ConditionalThisRoomHas_QRFlag, CTX_NONE);
585 RegisterConditional("COND:THISROOM:EDIT", 0, ConditionalRoom_MayEdit, CTX_NONE);
586 RegisterConditional("COND:ROOM:FLAG:QR", 0, ConditionalRoomHas_QRFlag, CTX_ROOMS);
588 RegisterConditional("COND:THISROOM:FLAG:QR2", 0, ConditionalThisRoomHas_QRFlag2, CTX_NONE);
589 RegisterConditional("COND:ROOM:FLAG:QR2", 0, ConditionalRoomHas_QRFlag2, CTX_ROOMS);
591 RegisterConditional("COND:ROOM:FLAG:UA", 0, ConditionalRoomHas_UAFlag, CTX_ROOMS);
592 RegisterNamespace("ROOM:INFO:RAFLAGS", 0, 1, tmplput_ROOM_RAFLAGS, NULL, CTX_ROOMS);
595 RegisterNamespace("ROOM:INFO:LISTORDER", 0, 1, tmplput_ROOM_LISTORDER, NULL, CTX_ROOMS);
596 RegisterNamespace("THISROOM:ORDER", 0, 0, tmplput_ThisRoomOrder, NULL, CTX_NONE);
597 RegisterConditional("COND:THISROOM:ORDER", 0, ConditionalThisRoomOrder, CTX_NONE);
599 RegisterNamespace("ROOM:INFO:LASTCHANGE", 0, 1, tmplput_ROOM_LASTCHANGE, NULL, CTX_ROOMS);
601 RegisterNamespace("THISROOM:MSGS:NEW", 0, 0, tmplput_ThisRoom_nNewMessages, NULL, CTX_NONE);
602 RegisterNamespace("THISROOM:MSGS:TOTAL", 0, 0, tmplput_ThisRoom_nTotalMessages, NULL, CTX_NONE);
604 RegisterNamespace("THISROOM:PASS", 0, 1, tmplput_ThisRoomPass, NULL, CTX_NONE);
605 RegisterNamespace("THISROOM:AIDE", 0, 1, tmplput_ThisRoomAide, NULL, CTX_NONE);
606 RegisterConditional("COND:ROOMAIDE", 2, ConditionalRoomAide, CTX_NONE);
607 RegisterConditional("COND:ACCESS:DELETE", 2, ConditionalRoomAcessDelete, CTX_NONE);
608 RegisterConditional("COND:ROOM:EDITACCESS", 0, ConditionalHaveRoomeditRights, CTX_NONE);
610 RegisterConditional("COND:THISROOM:HAVE_PIC", 0, ConditionalThisRoomXHavePic, CTX_NONE);
611 RegisterConditional("COND:THISROOM:IS_EDIT", 0, ConditionalThisRoomIsEdit, CTX_NONE);
613 RegisterNamespace("THISROOM:INFOTEXT", 1, 2, tmplput_ThisRoomInfoText, NULL, CTX_NONE);
614 RegisterConditional("COND:THISROOM:HAVE_INFOTEXT", 0, ConditionalThisRoomXHaveInfoText, CTX_NONE);
616 RegisterNamespace("THISROOM:FILES:N", 0, 1, tmplput_ThisRoomXNFiles, NULL, CTX_NONE);
617 RegisterNamespace("THISROOM:FILES:STR", 0, 1, tmplput_ThisRoomX_FileString, NULL, CTX_NONE);
618 RegisterNamespace("THISROOM:DIRECTORY", 0, 1, tmplput_ThisRoomDirectory, NULL, CTX_NONE);
620 RegisterNamespace("ROOM:INFO:ACL", 0, 1, tmplput_ROOM_ACL, NULL, CTX_ROOMS);
621 RegisterConditional("COND:THIS:THAT:ROOM", 0, ConditionalIsThisThatRoom, CTX_ROOMS);