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"
20 * Embed the room banner
22 * got The information returned from a GOTO server command
23 * navbar_style Determines which navigation buttons to display
25 void tmplput_roombanner(StrBuf *Target, WCTemplputParams *TP)
29 /* Refresh current room states. Doesn't work? gotoroom(NULL); */
31 wc_printf("<div id=\"banner\">\n");
33 /* The browser needs some information for its own use */
34 wc_printf("<script type=\"text/javascript\"> \n"
35 " room_is_trash = %d; \n"
37 ((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)
64 Floor *myFloor = (Floor *)CTX;
66 StrBufAppendPrintf(Target, "%d", myFloor->ID);
70 void tmplput_ROOM_FLOORID(StrBuf *Target, WCTemplputParams *TP)
72 folder *Folder = (folder *)CTX;
73 StrBufAppendPrintf(Target, "%d", Folder->floorid);
77 void tmplput_ROOM_FLOOR_ID(StrBuf *Target, WCTemplputParams *TP)
79 folder *Folder = (folder *)CTX;
80 const Floor *pFloor = Folder->Floor;
85 StrBufAppendPrintf(Target, "%d", pFloor->ID);
89 void tmplput_ROOM_FLOOR_NAME(StrBuf *Target, WCTemplputParams *TP)
91 folder *Folder = (folder *)CTX;
92 const Floor *pFloor = Folder->Floor;
97 StrBufAppendTemplate(Target, TP, pFloor->Name, 0);
101 void tmplput_ThisRoomFloorName(StrBuf *Target, WCTemplputParams *TP)
104 folder *Folder = &WCC->CurRoom;
110 pFloor = Folder->Floor;
114 StrBufAppendTemplate(Target, TP, pFloor->Name, 0);
118 void tmplput_FLOOR_NAME(StrBuf *Target, WCTemplputParams *TP)
120 Floor *myFloor = (Floor *)CTX;
122 StrBufAppendTemplate(Target, TP, myFloor->Name, 0);
126 void tmplput_FLOOR_NROOMS(StrBuf *Target, WCTemplputParams *TP)
128 Floor *myFloor = (Floor *)CTX;
130 StrBufAppendPrintf(Target, "%d", myFloor->NRooms);
134 void tmplput_ROOM_FLOOR_NROOMS(StrBuf *Target, WCTemplputParams *TP)
136 folder *Folder = (folder *)CTX;
137 const Floor *pFloor = Folder->Floor;
141 StrBufAppendPrintf(Target, "%d", pFloor->NRooms);
145 int ConditionalFloorHaveNRooms(StrBuf *Target, WCTemplputParams *TP)
147 Floor *MyFloor = (Floor *)CTX;
150 HaveN = GetTemplateTokenNumber(Target, TP, 0, 0);
152 return HaveN == MyFloor->NRooms;
156 int ConditionalFloorIsRESTSubFloor(StrBuf *Target, WCTemplputParams *TP)
159 Floor *MyFloor = (Floor *)CTX;
160 /** if we have dav_depth the client just wants the subfloors */
161 if ((WCC->Hdr->HR.dav_depth == 1) &&
162 (GetCount(WCC->Directory) == 0))
164 return WCC->CurrentFloor == MyFloor;
168 int ConditionalFloorIsSUBROOM(StrBuf *Target, WCTemplputParams *TP)
171 Floor *MyFloor = (Floor *)CTX;
173 return WCC->CurRoom.floorid == MyFloor->ID;
177 int ConditionalFloorIsVirtual(StrBuf *Target, WCTemplputParams *TP)
179 Floor *MyFloor = (Floor *)CTX;
181 return MyFloor->ID == VIRTUAL_MY_FLOOR;
185 /*******************************************************************************
186 ********************** ROOM Tokens ********************************************
187 *******************************************************************************/
191 void tmplput_RoomName(StrBuf *Target, WCTemplputParams *TP)
193 StrBufAppendTemplate(Target, TP, WC->CurRoom.name, 0);
197 void tmplput_current_room(StrBuf *Target, WCTemplputParams *TP)
202 StrBufAppendTemplate(Target, TP,
210 void tmplput_ROOM_NAME(StrBuf *Target, WCTemplputParams *TP)
212 folder *Folder = (folder *)CTX;
220 Folder = &WCC->CurRoom;
222 StrBufAppendTemplate(Target, TP, Folder->name, 0);
226 void tmplput_ROOM_BASENAME(StrBuf *Target, WCTemplputParams *TP)
228 folder *room = (folder *)CTX;
230 if (room->nRoomNameParts > 1)
231 StrBufAppendTemplate(Target, TP,
232 room->RoomNameParts[room->nRoomNameParts - 1], 0);
234 StrBufAppendTemplate(Target, TP, room->name, 0);
238 void tmplput_ROOM_LEVEL_N_TIMES(StrBuf *Target, WCTemplputParams *TP)
240 folder *room = (folder *)CTX;
242 const char *AppendMe;
246 if (room->nRoomNameParts > 1)
248 GetTemplateTokenString(Target, TP, 0, &AppendMe, &AppendMeLen);
249 for (i = 0; i < room->nRoomNameParts; i++)
250 StrBufAppendBufPlain(Target, AppendMe, AppendMeLen, 0);
255 int ConditionalRoomIsInbox(StrBuf *Target, WCTemplputParams *TP)
257 folder *Folder = (folder *)CTX;
258 return Folder->is_inbox;
262 /****** Properties ******/
263 int ConditionalRoom_MayEdit(StrBuf *Target, WCTemplputParams *TP)
269 return WCC->CurRoom.XALoaded == 1;
272 int ConditionalThisRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
277 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
278 if (QR_CheckFlag == 0)
279 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
280 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
285 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
286 (TP->Tokens->Params[2]->MaskBy == eNO))
287 return (WCC->CurRoom.QRFlags & QR_CheckFlag) != 0;
289 return (WCC->CurRoom.QRFlags & QR_CheckFlag) == QR_CheckFlag;
293 int ConditionalRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
296 folder *Folder = (folder *)(TP->Context);
298 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
299 if (QR_CheckFlag == 0)
300 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
301 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
303 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
304 (TP->Tokens->Params[2]->MaskBy == eNO))
305 return (Folder->QRFlags & QR_CheckFlag) != 0;
307 return (Folder->QRFlags & QR_CheckFlag) == QR_CheckFlag;
311 void tmplput_ROOM_QRFLAGS(StrBuf *Target, WCTemplputParams *TP)
313 folder *Folder = (folder *)CTX;
314 StrBufAppendPrintf(Target, "%d", Folder->QRFlags);
318 int ConditionalThisRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
323 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
324 if (QR2_CheckFlag == 0)
325 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
326 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
332 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
333 (TP->Tokens->Params[2]->MaskBy == eNO))
334 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) != 0;
336 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) == QR2_CheckFlag;
340 int ConditionalRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
343 folder *Folder = (folder *)(TP->Context);
345 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
346 if (QR2_CheckFlag == 0)
347 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
348 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
349 return ((Folder->QRFlags2 & QR2_CheckFlag) != 0);
353 int ConditionalRoomHas_UAFlag(StrBuf *Target, WCTemplputParams *TP)
355 folder *Folder = (folder *)(TP->Context);
358 UA_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
359 if (UA_CheckFlag == 0)
360 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
361 "requires one of the #\"UA_*\"- defines or an integer flag 0 is invalid!");
363 return ((Folder->RAFlags & UA_CheckFlag) != 0);
367 void tmplput_ROOM_ACL(StrBuf *Target, WCTemplputParams *TP)
369 folder *Folder = (folder *)CTX;
371 StrBufAppendPrintf(Target, "%ld", Folder->RAFlags, 0);
375 void tmplput_ROOM_RAFLAGS(StrBuf *Target, WCTemplputParams *TP)
377 folder *Folder = (folder *)(TP->Context);
378 StrBufAppendPrintf(Target, "%d", Folder->RAFlags);
382 void tmplput_ThisRoomAide(StrBuf *Target, WCTemplputParams *TP)
388 StrBufAppendTemplate(Target, TP, WCC->CurRoom.RoomAide, 0);
392 int ConditionalRoomAide(StrBuf *Target, WCTemplputParams *TP)
395 return (WCC != NULL)?
396 ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) : 0;
400 int ConditionalRoomAcessDelete(StrBuf *Target, WCTemplputParams *TP)
403 return (WCC == NULL)? 0 :
404 ( ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) ||
405 (WCC->CurRoom.is_inbox) ||
406 (WCC->CurRoom.QRFlags2 & QR2_COLLABDEL) );
410 int ConditionalHaveRoomeditRights(StrBuf *Target, WCTemplputParams *TP)
414 return ( (WCC != NULL)
418 || ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0)
419 || (WCC->CurRoom.is_inbox)
425 void tmplput_ThisRoomPass(StrBuf *Target, WCTemplputParams *TP)
430 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XAPass, 0);
434 void tmplput_ThisRoom_nNewMessages(StrBuf *Target, WCTemplputParams *TP)
438 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nNewMessages);
442 void tmplput_ThisRoom_nTotalMessages(StrBuf *Target, WCTemplputParams *TP)
446 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nTotalMessages);
450 void tmplput_ThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
456 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.Order);
460 int ConditionalThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
470 CheckThis = GetTemplateTokenNumber(Target, TP, 2, 0);
471 return CheckThis == WCC->CurRoom.Order;
475 void tmplput_ROOM_LISTORDER(StrBuf *Target, WCTemplputParams *TP)
477 folder *Folder = (folder *)CTX;
478 StrBufAppendPrintf(Target, "%d", Folder->Order);
482 int ConditionalThisRoomXHavePic(StrBuf *Target, WCTemplputParams *TP)
490 return WCC->CurRoom.XHaveRoomPic == 1;
494 int ConditionalThisRoomXHaveInfoText(StrBuf *Target, WCTemplputParams *TP)
502 return (StrLength(WCC->CurRoom.XInfoText)>0);
506 void tmplput_ThisRoomInfoText(StrBuf *Target, WCTemplputParams *TP)
513 nchars = GetTemplateTokenNumber(Target, TP, 0, 0);
515 /* the whole thing */
516 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XInfoText, 1);
519 /* only a certain number of characters */
521 SubBuf = NewStrBufDup(WCC->CurRoom.XInfoText);
522 if (StrLength(SubBuf) > nchars) {
523 StrBuf_Utf8StrCut(SubBuf, nchars);
524 StrBufAppendBufPlain(SubBuf, HKEY("..."), 0);
526 StrBufAppendTemplate(Target, TP, SubBuf, 1);
532 void tmplput_ROOM_LASTCHANGE(StrBuf *Target, WCTemplputParams *TP)
534 folder *Folder = (folder *)CTX;
535 StrBufAppendPrintf(Target, "%d", Folder->lastchange);
539 void tmplput_ThisRoomDirectory(StrBuf *Target, WCTemplputParams *TP)
545 StrBufAppendTemplate(Target, TP, WCC->CurRoom.Directory, 0);
549 void tmplput_ThisRoomXNFiles(StrBuf *Target, WCTemplputParams *TP)
553 LoadXRoomXCountFiles();
555 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.XDownloadCount);
559 void tmplput_ThisRoomX_FileString(StrBuf *Target, WCTemplputParams *TP)
563 LoadXRoomXCountFiles();
565 if (WCC->CurRoom.XDownloadCount == 1)
566 StrBufAppendBufPlain(Target, _("file"), -1, 0);
568 StrBufAppendBufPlain(Target, _("files"), -1, 0);
572 int ConditionalIsThisThatRoom(StrBuf *Target, WCTemplputParams *TP)
574 folder *Folder = (folder *)CTX;
580 return Folder == WCC->ThisRoom;
585 InitModule_ROOMTOKENS
588 RegisterNamespace("ROOMBANNER", 0, 1, tmplput_roombanner, NULL, CTX_NONE);
590 RegisterNamespace("FLOOR:ID", 0, 0, tmplput_FLOOR_ID, NULL, CTX_FLOORS);
591 RegisterNamespace("ROOM:INFO:FLOORID", 0, 1, tmplput_ROOM_FLOORID, NULL, CTX_ROOMS);
592 RegisterNamespace("ROOM:INFO:FLOOR:ID", 0, 0, tmplput_ROOM_FLOOR_ID, NULL, CTX_ROOMS);
594 RegisterNamespace("FLOOR:NAME", 0, 1, tmplput_FLOOR_NAME, NULL, CTX_FLOORS);
595 RegisterNamespace("ROOM:INFO:FLOOR:NAME", 0, 1, tmplput_ROOM_FLOOR_NAME, NULL, CTX_ROOMS);
596 RegisterNamespace("THISROOM:FLOOR:NAME", 0, 1, tmplput_ThisRoomFloorName, NULL, CTX_NONE);
598 RegisterNamespace("FLOOR:NROOMS", 0, 0, tmplput_FLOOR_NROOMS, NULL, CTX_FLOORS);
599 RegisterNamespace("ROOM:INFO:FLOOR:NROOMS", 0, 0, tmplput_ROOM_FLOOR_NROOMS, NULL, CTX_ROOMS);
601 RegisterConditional(HKEY("COND:FLOOR:ISSUBROOM"), 0, ConditionalFloorIsSUBROOM, CTX_FLOORS);
602 RegisterConditional(HKEY("COND:FLOOR:NROOMS"), 1, ConditionalFloorHaveNRooms, CTX_FLOORS);
603 RegisterConditional(HKEY("COND:ROOM:REST:ISSUBFLOOR"), 0, ConditionalFloorIsRESTSubFloor, CTX_FLOORS);
604 RegisterConditional(HKEY("COND:FLOOR:ISVIRTUAL"), 0, ConditionalFloorIsVirtual, CTX_FLOORS);
606 /**** Room... ******/
608 RegisterNamespace("ROOMNAME", 0, 1, tmplput_RoomName, NULL, CTX_NONE);
609 RegisterNamespace("THISROOM", 0, 1, tmplput_current_room, NULL, CTX_NONE);
610 RegisterNamespace("ROOM:INFO:NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_ROOMS);
611 RegisterNamespace("ROOM:INFO:PRINT_NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_NONE);
612 RegisterNamespace("ROOM:INFO:BASENAME", 0, 1, tmplput_ROOM_BASENAME, NULL, CTX_ROOMS);
613 RegisterNamespace("ROOM:INFO:LEVELNTIMES", 1, 2, tmplput_ROOM_LEVEL_N_TIMES, NULL, CTX_ROOMS);
614 RegisterConditional(HKEY("COND:ROOM:INFO:IS_INBOX"), 0, ConditionalRoomIsInbox, CTX_ROOMS);
616 /****** Properties ******/
617 RegisterNamespace("ROOM:INFO:QRFLAGS", 0, 1, tmplput_ROOM_QRFLAGS, NULL, CTX_ROOMS);
618 RegisterConditional(HKEY("COND:THISROOM:FLAG:QR"), 0, ConditionalThisRoomHas_QRFlag, CTX_NONE);
619 RegisterConditional(HKEY("COND:THISROOM:EDIT"), 0, ConditionalRoom_MayEdit, CTX_NONE);
620 RegisterConditional(HKEY("COND:ROOM:FLAG:QR"), 0, ConditionalRoomHas_QRFlag, CTX_ROOMS);
622 RegisterConditional(HKEY("COND:THISROOM:FLAG:QR2"), 0, ConditionalThisRoomHas_QRFlag2, CTX_NONE);
623 RegisterConditional(HKEY("COND:ROOM:FLAG:QR2"), 0, ConditionalRoomHas_QRFlag2, CTX_ROOMS);
625 RegisterConditional(HKEY("COND:ROOM:FLAG:UA"), 0, ConditionalRoomHas_UAFlag, CTX_ROOMS);
626 RegisterNamespace("ROOM:INFO:RAFLAGS", 0, 1, tmplput_ROOM_RAFLAGS, NULL, CTX_ROOMS);
629 RegisterNamespace("ROOM:INFO:LISTORDER", 0, 1, tmplput_ROOM_LISTORDER, NULL, CTX_ROOMS);
630 RegisterNamespace("THISROOM:ORDER", 0, 0, tmplput_ThisRoomOrder, NULL, CTX_NONE);
631 RegisterConditional(HKEY("COND:THISROOM:ORDER"), 0, ConditionalThisRoomOrder, CTX_NONE);
633 RegisterNamespace("ROOM:INFO:LASTCHANGE", 0, 1, tmplput_ROOM_LASTCHANGE, NULL, CTX_ROOMS);
635 RegisterNamespace("THISROOM:MSGS:NEW", 0, 0, tmplput_ThisRoom_nNewMessages, NULL, CTX_NONE);
636 RegisterNamespace("THISROOM:MSGS:TOTAL", 0, 0, tmplput_ThisRoom_nTotalMessages, NULL, CTX_NONE);
638 RegisterNamespace("THISROOM:PASS", 0, 1, tmplput_ThisRoomPass, NULL, CTX_NONE);
639 RegisterNamespace("THISROOM:AIDE", 0, 1, tmplput_ThisRoomAide, NULL, CTX_NONE);
640 RegisterConditional(HKEY("COND:ROOMAIDE"), 2, ConditionalRoomAide, CTX_NONE);
641 RegisterConditional(HKEY("COND:ACCESS:DELETE"), 2, ConditionalRoomAcessDelete, CTX_NONE);
642 RegisterConditional(HKEY("COND:ROOM:EDITACCESS"), 0, ConditionalHaveRoomeditRights, CTX_NONE);
644 RegisterConditional(HKEY("COND:THISROOM:HAVE_PIC"), 0, ConditionalThisRoomXHavePic, CTX_NONE);
646 RegisterNamespace("THISROOM:INFOTEXT", 1, 2, tmplput_ThisRoomInfoText, NULL, CTX_NONE);
647 RegisterConditional(HKEY("COND:THISROOM:HAVE_INFOTEXT"), 0, ConditionalThisRoomXHaveInfoText, CTX_NONE);
649 RegisterNamespace("THISROOM:FILES:N", 0, 1, tmplput_ThisRoomXNFiles, NULL, CTX_NONE);
650 RegisterNamespace("THISROOM:FILES:STR", 0, 1, tmplput_ThisRoomX_FileString, NULL, CTX_NONE);
651 RegisterNamespace("THISROOM:DIRECTORY", 0, 1, tmplput_ThisRoomDirectory, NULL, CTX_NONE);
653 RegisterNamespace("ROOM:INFO:ACL", 0, 1, tmplput_ROOM_ACL, NULL, CTX_ROOMS);
654 RegisterConditional(HKEY("COND:THIS:THAT:ROOM"), 0, ConditionalIsThisThatRoom, CTX_ROOMS);