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(CTX_FLOORS);
66 StrBufAppendPrintf(Target, "%d", myFloor->ID);
70 void tmplput_ROOM_FLOORID(StrBuf *Target, WCTemplputParams *TP)
72 folder *Folder = (folder *)CTX(CTX_ROOMS);
73 StrBufAppendPrintf(Target, "%d", Folder->floorid);
77 void tmplput_ROOM_FLOOR_ID(StrBuf *Target, WCTemplputParams *TP)
79 folder *Folder = (folder *)CTX(CTX_ROOMS);
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(CTX_ROOMS);
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(CTX_FLOORS);
122 StrBufAppendTemplate(Target, TP, myFloor->Name, 0);
126 void tmplput_FLOOR_NROOMS(StrBuf *Target, WCTemplputParams *TP)
128 Floor *myFloor = (Floor *)CTX(CTX_FLOORS);
130 StrBufAppendPrintf(Target, "%d", myFloor->NRooms);
134 void tmplput_ROOM_FLOOR_NROOMS(StrBuf *Target, WCTemplputParams *TP)
136 folder *Folder = (folder *)CTX(CTX_ROOMS);
137 const Floor *pFloor = Folder->Floor;
141 StrBufAppendPrintf(Target, "%d", pFloor->NRooms);
145 int ConditionalFloorHaveNRooms(StrBuf *Target, WCTemplputParams *TP)
147 Floor *MyFloor = (Floor *)CTX(CTX_FLOORS);
150 HaveN = GetTemplateTokenNumber(Target, TP, 0, 0);
152 return HaveN == MyFloor->NRooms;
156 int ConditionalFloorIsRESTSubFloor(StrBuf *Target, WCTemplputParams *TP)
159 Floor *MyFloor = (Floor *)CTX(CTX_FLOORS);
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(CTX_FLOORS);
173 return WCC->CurRoom.floorid == MyFloor->ID;
177 int ConditionalFloorIsVirtual(StrBuf *Target, WCTemplputParams *TP)
179 Floor *MyFloor = (Floor *)CTX(CTX_FLOORS);
181 return MyFloor->ID == VIRTUAL_MY_FLOOR;
185 /*******************************************************************************
186 ********************** ROOM Tokens ********************************************
187 *******************************************************************************/
190 void tmplput_ThisRoom(StrBuf *Target, WCTemplputParams *TP)
195 StrBufAppendTemplate(Target, TP,
203 void tmplput_ROOM_NAME(StrBuf *Target, WCTemplputParams *TP)
205 folder *Folder = (folder *)CTX(CTX_ROOMS);
207 StrBufAppendTemplate(Target, TP, Folder->name, 0);
211 void tmplput_ROOM_BASENAME(StrBuf *Target, WCTemplputParams *TP)
213 folder *room = (folder *)CTX(CTX_ROOMS);
215 if (room->nRoomNameParts > 1)
216 StrBufAppendTemplate(Target, TP,
217 room->RoomNameParts[room->nRoomNameParts - 1], 0);
219 StrBufAppendTemplate(Target, TP, room->name, 0);
223 void tmplput_ROOM_LEVEL_N_TIMES(StrBuf *Target, WCTemplputParams *TP)
225 folder *room = (folder *)CTX(CTX_ROOMS);
227 const char *AppendMe;
231 if (room->nRoomNameParts > 1)
233 GetTemplateTokenString(Target, TP, 0, &AppendMe, &AppendMeLen);
234 for (i = 0; i < room->nRoomNameParts; i++)
235 StrBufAppendBufPlain(Target, AppendMe, AppendMeLen, 0);
240 int ConditionalRoomIsInbox(StrBuf *Target, WCTemplputParams *TP)
242 folder *Folder = (folder *)CTX(CTX_ROOMS);
243 return Folder->is_inbox;
247 /****** Properties ******/
248 int ConditionalRoom_MayEdit(StrBuf *Target, WCTemplputParams *TP)
254 return WCC->CurRoom.XALoaded == 1;
257 int ConditionalThisRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
262 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
263 if (QR_CheckFlag == 0)
264 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
265 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
270 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
271 (TP->Tokens->Params[2]->MaskBy == eNO))
272 return (WCC->CurRoom.QRFlags & QR_CheckFlag) != 0;
274 return (WCC->CurRoom.QRFlags & QR_CheckFlag) == QR_CheckFlag;
278 int ConditionalRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
281 folder *Folder = (folder *)(TP->Context);
283 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
284 if (QR_CheckFlag == 0)
285 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
286 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
288 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
289 (TP->Tokens->Params[2]->MaskBy == eNO))
290 return (Folder->QRFlags & QR_CheckFlag) != 0;
292 return (Folder->QRFlags & QR_CheckFlag) == QR_CheckFlag;
296 void tmplput_ROOM_QRFLAGS(StrBuf *Target, WCTemplputParams *TP)
298 folder *Folder = (folder *)CTX(CTX_ROOMS);
299 StrBufAppendPrintf(Target, "%d", Folder->QRFlags);
303 int ConditionalThisRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
308 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
309 if (QR2_CheckFlag == 0)
310 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
311 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
317 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
318 (TP->Tokens->Params[2]->MaskBy == eNO))
319 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) != 0;
321 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) == QR2_CheckFlag;
325 int ConditionalRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
328 folder *Folder = (folder *)(TP->Context);
330 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
331 if (QR2_CheckFlag == 0)
332 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
333 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
334 return ((Folder->QRFlags2 & QR2_CheckFlag) != 0);
338 int ConditionalRoomHas_UAFlag(StrBuf *Target, WCTemplputParams *TP)
340 folder *Folder = (folder *)(TP->Context);
343 UA_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
344 if (UA_CheckFlag == 0)
345 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
346 "requires one of the #\"UA_*\"- defines or an integer flag 0 is invalid!");
348 return ((Folder->RAFlags & UA_CheckFlag) != 0);
352 void tmplput_ROOM_ACL(StrBuf *Target, WCTemplputParams *TP)
354 folder *Folder = (folder *)CTX(CTX_ROOMS);
356 StrBufAppendPrintf(Target, "%ld", Folder->RAFlags, 0);
360 void tmplput_ROOM_RAFLAGS(StrBuf *Target, WCTemplputParams *TP)
362 folder *Folder = (folder *)(TP->Context);
363 StrBufAppendPrintf(Target, "%d", Folder->RAFlags);
367 void tmplput_ThisRoomAide(StrBuf *Target, WCTemplputParams *TP)
373 StrBufAppendTemplate(Target, TP, WCC->CurRoom.RoomAide, 0);
377 int ConditionalRoomAide(StrBuf *Target, WCTemplputParams *TP)
380 return (WCC != NULL)?
381 ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) : 0;
385 int ConditionalRoomAcessDelete(StrBuf *Target, WCTemplputParams *TP)
388 return (WCC == NULL)? 0 :
389 ( ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) ||
390 (WCC->CurRoom.is_inbox) ||
391 (WCC->CurRoom.QRFlags2 & QR2_COLLABDEL) );
395 int ConditionalHaveRoomeditRights(StrBuf *Target, WCTemplputParams *TP)
399 return ( (WCC != NULL)
403 || ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0)
404 || (WCC->CurRoom.is_inbox)
410 void tmplput_ThisRoomPass(StrBuf *Target, WCTemplputParams *TP)
415 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XAPass, 0);
419 void tmplput_ThisRoom_nNewMessages(StrBuf *Target, WCTemplputParams *TP)
423 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nNewMessages);
427 void tmplput_ThisRoom_nTotalMessages(StrBuf *Target, WCTemplputParams *TP)
431 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nTotalMessages);
435 void tmplput_ThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
441 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.Order);
445 int ConditionalThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
455 CheckThis = GetTemplateTokenNumber(Target, TP, 2, 0);
456 return CheckThis == WCC->CurRoom.Order;
460 void tmplput_ROOM_LISTORDER(StrBuf *Target, WCTemplputParams *TP)
462 folder *Folder = (folder *)CTX(CTX_ROOMS);
463 StrBufAppendPrintf(Target, "%d", Folder->Order);
467 int ConditionalThisRoomXHavePic(StrBuf *Target, WCTemplputParams *TP)
475 return WCC->CurRoom.XHaveRoomPic == 1;
479 int ConditionalThisRoomXHaveInfoText(StrBuf *Target, WCTemplputParams *TP)
487 return (StrLength(WCC->CurRoom.XInfoText)>0);
491 void tmplput_ThisRoomInfoText(StrBuf *Target, WCTemplputParams *TP)
498 nchars = GetTemplateTokenNumber(Target, TP, 0, 0);
500 /* the whole thing */
501 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XInfoText, 1);
504 /* only a certain number of characters */
506 SubBuf = NewStrBufDup(WCC->CurRoom.XInfoText);
507 if (StrLength(SubBuf) > nchars) {
508 StrBuf_Utf8StrCut(SubBuf, nchars);
509 StrBufAppendBufPlain(SubBuf, HKEY("..."), 0);
511 StrBufAppendTemplate(Target, TP, SubBuf, 1);
517 void tmplput_ROOM_LASTCHANGE(StrBuf *Target, WCTemplputParams *TP)
519 folder *Folder = (folder *)CTX(CTX_ROOMS);
520 StrBufAppendPrintf(Target, "%d", Folder->lastchange);
524 void tmplput_ThisRoomDirectory(StrBuf *Target, WCTemplputParams *TP)
530 StrBufAppendTemplate(Target, TP, WCC->CurRoom.Directory, 0);
534 void tmplput_ThisRoomXNFiles(StrBuf *Target, WCTemplputParams *TP)
538 LoadXRoomXCountFiles();
540 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.XDownloadCount);
544 void tmplput_ThisRoomX_FileString(StrBuf *Target, WCTemplputParams *TP)
548 LoadXRoomXCountFiles();
550 if (WCC->CurRoom.XDownloadCount == 1)
551 StrBufAppendBufPlain(Target, _("file"), -1, 0);
553 StrBufAppendBufPlain(Target, _("files"), -1, 0);
557 int ConditionalIsThisThatRoom(StrBuf *Target, WCTemplputParams *TP)
559 folder *Folder = (folder *)CTX(CTX_ROOMS);
565 return Folder == WCC->ThisRoom;
570 InitModule_ROOMTOKENS
573 RegisterNamespace("ROOMBANNER", 0, 1, tmplput_roombanner, NULL, CTX_NONE);
575 RegisterNamespace("FLOOR:ID", 0, 0, tmplput_FLOOR_ID, NULL, CTX_FLOORS);
576 RegisterNamespace("ROOM:INFO:FLOORID", 0, 1, tmplput_ROOM_FLOORID, NULL, CTX_ROOMS);
577 RegisterNamespace("ROOM:INFO:FLOOR:ID", 0, 0, tmplput_ROOM_FLOOR_ID, NULL, CTX_ROOMS);
579 RegisterNamespace("FLOOR:NAME", 0, 1, tmplput_FLOOR_NAME, NULL, CTX_FLOORS);
580 RegisterNamespace("ROOM:INFO:FLOOR:NAME", 0, 1, tmplput_ROOM_FLOOR_NAME, NULL, CTX_ROOMS);
581 RegisterNamespace("THISROOM:FLOOR:NAME", 0, 1, tmplput_ThisRoomFloorName, NULL, CTX_NONE);
583 RegisterNamespace("FLOOR:NROOMS", 0, 0, tmplput_FLOOR_NROOMS, NULL, CTX_FLOORS);
584 RegisterNamespace("ROOM:INFO:FLOOR:NROOMS", 0, 0, tmplput_ROOM_FLOOR_NROOMS, NULL, CTX_ROOMS);
586 RegisterConditional(HKEY("COND:FLOOR:ISSUBROOM"), 0, ConditionalFloorIsSUBROOM, CTX_FLOORS);
587 RegisterConditional(HKEY("COND:FLOOR:NROOMS"), 1, ConditionalFloorHaveNRooms, CTX_FLOORS);
588 RegisterConditional(HKEY("COND:ROOM:REST:ISSUBFLOOR"), 0, ConditionalFloorIsRESTSubFloor, CTX_FLOORS);
589 RegisterConditional(HKEY("COND:FLOOR:ISVIRTUAL"), 0, ConditionalFloorIsVirtual, CTX_FLOORS);
591 /**** Room... ******/
593 RegisterNamespace("THISROOM:NAME", 0, 1, tmplput_ThisRoom, NULL, CTX_NONE);
595 RegisterNamespace("ROOM:INFO:NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_ROOMS);
596 RegisterNamespace("ROOM:INFO:BASENAME", 0, 1, tmplput_ROOM_BASENAME, NULL, CTX_ROOMS);
597 RegisterNamespace("ROOM:INFO:LEVELNTIMES", 1, 2, tmplput_ROOM_LEVEL_N_TIMES, NULL, CTX_ROOMS);
598 RegisterConditional(HKEY("COND:ROOM:INFO:IS_INBOX"), 0, ConditionalRoomIsInbox, CTX_ROOMS);
600 /****** Properties ******/
601 RegisterNamespace("ROOM:INFO:QRFLAGS", 0, 1, tmplput_ROOM_QRFLAGS, NULL, CTX_ROOMS);
602 RegisterConditional(HKEY("COND:THISROOM:FLAG:QR"), 0, ConditionalThisRoomHas_QRFlag, CTX_NONE);
603 RegisterConditional(HKEY("COND:THISROOM:EDIT"), 0, ConditionalRoom_MayEdit, CTX_NONE);
604 RegisterConditional(HKEY("COND:ROOM:FLAG:QR"), 0, ConditionalRoomHas_QRFlag, CTX_ROOMS);
606 RegisterConditional(HKEY("COND:THISROOM:FLAG:QR2"), 0, ConditionalThisRoomHas_QRFlag2, CTX_NONE);
607 RegisterConditional(HKEY("COND:ROOM:FLAG:QR2"), 0, ConditionalRoomHas_QRFlag2, CTX_ROOMS);
609 RegisterConditional(HKEY("COND:ROOM:FLAG:UA"), 0, ConditionalRoomHas_UAFlag, CTX_ROOMS);
610 RegisterNamespace("ROOM:INFO:RAFLAGS", 0, 1, tmplput_ROOM_RAFLAGS, NULL, CTX_ROOMS);
613 RegisterNamespace("ROOM:INFO:LISTORDER", 0, 1, tmplput_ROOM_LISTORDER, NULL, CTX_ROOMS);
614 RegisterNamespace("THISROOM:ORDER", 0, 0, tmplput_ThisRoomOrder, NULL, CTX_NONE);
615 RegisterConditional(HKEY("COND:THISROOM:ORDER"), 0, ConditionalThisRoomOrder, CTX_NONE);
617 RegisterNamespace("ROOM:INFO:LASTCHANGE", 0, 1, tmplput_ROOM_LASTCHANGE, NULL, CTX_ROOMS);
619 RegisterNamespace("THISROOM:MSGS:NEW", 0, 0, tmplput_ThisRoom_nNewMessages, NULL, CTX_NONE);
620 RegisterNamespace("THISROOM:MSGS:TOTAL", 0, 0, tmplput_ThisRoom_nTotalMessages, NULL, CTX_NONE);
622 RegisterNamespace("THISROOM:PASS", 0, 1, tmplput_ThisRoomPass, NULL, CTX_NONE);
623 RegisterNamespace("THISROOM:AIDE", 0, 1, tmplput_ThisRoomAide, NULL, CTX_NONE);
624 RegisterConditional(HKEY("COND:ROOMAIDE"), 2, ConditionalRoomAide, CTX_NONE);
625 RegisterConditional(HKEY("COND:ACCESS:DELETE"), 2, ConditionalRoomAcessDelete, CTX_NONE);
626 RegisterConditional(HKEY("COND:ROOM:EDITACCESS"), 0, ConditionalHaveRoomeditRights, CTX_NONE);
628 RegisterConditional(HKEY("COND:THISROOM:HAVE_PIC"), 0, ConditionalThisRoomXHavePic, CTX_NONE);
630 RegisterNamespace("THISROOM:INFOTEXT", 1, 2, tmplput_ThisRoomInfoText, NULL, CTX_NONE);
631 RegisterConditional(HKEY("COND:THISROOM:HAVE_INFOTEXT"), 0, ConditionalThisRoomXHaveInfoText, CTX_NONE);
633 RegisterNamespace("THISROOM:FILES:N", 0, 1, tmplput_ThisRoomXNFiles, NULL, CTX_NONE);
634 RegisterNamespace("THISROOM:FILES:STR", 0, 1, tmplput_ThisRoomX_FileString, NULL, CTX_NONE);
635 RegisterNamespace("THISROOM:DIRECTORY", 0, 1, tmplput_ThisRoomDirectory, NULL, CTX_NONE);
637 RegisterNamespace("ROOM:INFO:ACL", 0, 1, tmplput_ROOM_ACL, NULL, CTX_ROOMS);
638 RegisterConditional(HKEY("COND:THIS:THAT:ROOM"), 0, ConditionalIsThisThatRoom, CTX_ROOMS);