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.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
22 #include "webserver.h"
26 * Embed the room banner
28 * got The information returned from a GOTO server command
29 * navbar_style Determines which navigation buttons to display
31 void tmplput_roombanner(StrBuf *Target, WCTemplputParams *TP)
35 /* Refresh current room states. Doesn't work? gotoroom(NULL); */
37 wc_printf("<div id=\"banner\">\n");
39 /* The browser needs some information for its own use */
40 wc_printf("<script type=\"text/javascript\"> \n"
41 " room_is_trash = %d; \n"
43 ((WC->CurRoom.RAFlags & UA_ISTRASH) != 0)
47 * If the user happens to select the "make this my start page" link,
48 * we want it to remember the URL as a "/dotskip" one instead of
49 * a "skip" or "gotonext" or something like that.
51 if (WCC->Hdr->this_page == NULL) {
52 WCC->Hdr->this_page = NewStrBuf();
54 StrBufPrintf(WCC->Hdr->this_page, "dotskip?room=%s", ChrPtr(WC->CurRoom.name));
56 do_template("roombanner");
58 do_template("navbar");
59 wc_printf("</div>\n");
63 /*******************************************************************************
64 ********************** FLOOR Tokens *******************************************
65 *******************************************************************************/
68 void tmplput_FLOOR_ID(StrBuf *Target, WCTemplputParams *TP)
70 Floor *myFloor = (Floor *)CTX;
72 StrBufAppendPrintf(Target, "%d", myFloor->ID);
76 void tmplput_ROOM_FLOORID(StrBuf *Target, WCTemplputParams *TP)
78 folder *Folder = (folder *)CTX;
79 StrBufAppendPrintf(Target, "%d", Folder->floorid);
83 void tmplput_ROOM_FLOOR_ID(StrBuf *Target, WCTemplputParams *TP)
85 folder *Folder = (folder *)CTX;
86 const Floor *pFloor = Folder->Floor;
91 StrBufAppendPrintf(Target, "%d", pFloor->ID);
95 void tmplput_ROOM_FLOOR_NAME(StrBuf *Target, WCTemplputParams *TP)
97 folder *Folder = (folder *)CTX;
98 const Floor *pFloor = Folder->Floor;
103 StrBufAppendTemplate(Target, TP, pFloor->Name, 0);
107 void tmplput_ThisRoomFloorName(StrBuf *Target, WCTemplputParams *TP)
110 folder *Folder = &WCC->CurRoom;
116 pFloor = Folder->Floor;
120 StrBufAppendTemplate(Target, TP, pFloor->Name, 0);
124 void tmplput_FLOOR_NAME(StrBuf *Target, WCTemplputParams *TP)
126 Floor *myFloor = (Floor *)CTX;
128 StrBufAppendTemplate(Target, TP, myFloor->Name, 0);
132 void tmplput_FLOOR_NROOMS(StrBuf *Target, WCTemplputParams *TP)
134 Floor *myFloor = (Floor *)CTX;
136 StrBufAppendPrintf(Target, "%d", myFloor->NRooms);
140 void tmplput_ROOM_FLOOR_NROOMS(StrBuf *Target, WCTemplputParams *TP)
142 folder *Folder = (folder *)CTX;
143 const Floor *pFloor = Folder->Floor;
147 StrBufAppendPrintf(Target, "%d", pFloor->NRooms);
151 int ConditionalFloorHaveNRooms(StrBuf *Target, WCTemplputParams *TP)
153 Floor *MyFloor = (Floor *)CTX;
156 HaveN = GetTemplateTokenNumber(Target, TP, 0, 0);
158 return HaveN == MyFloor->NRooms;
162 int ConditionalFloorIsRESTSubFloor(StrBuf *Target, WCTemplputParams *TP)
165 Floor *MyFloor = (Floor *)CTX;
166 /** if we have dav_depth the client just wants the subfloors */
167 if ((WCC->Hdr->HR.dav_depth == 1) &&
168 (GetCount(WCC->Directory) == 0))
170 return WCC->CurrentFloor == MyFloor;
174 int ConditionalFloorIsSUBROOM(StrBuf *Target, WCTemplputParams *TP)
177 Floor *MyFloor = (Floor *)CTX;
179 return WCC->CurRoom.floorid == MyFloor->ID;
183 int ConditionalFloorIsVirtual(StrBuf *Target, WCTemplputParams *TP)
185 Floor *MyFloor = (Floor *)CTX;
187 return MyFloor->ID == VIRTUAL_MY_FLOOR;
191 /*******************************************************************************
192 ********************** ROOM Tokens ********************************************
193 *******************************************************************************/
197 void tmplput_RoomName(StrBuf *Target, WCTemplputParams *TP)
199 StrBufAppendTemplate(Target, TP, WC->CurRoom.name, 0);
203 void tmplput_current_room(StrBuf *Target, WCTemplputParams *TP)
208 StrBufAppendTemplate(Target, TP,
216 void tmplput_ROOM_NAME(StrBuf *Target, WCTemplputParams *TP)
218 folder *Folder = (folder *)CTX;
226 Folder = &WCC->CurRoom;
228 StrBufAppendTemplate(Target, TP, Folder->name, 0);
232 void tmplput_ROOM_BASENAME(StrBuf *Target, WCTemplputParams *TP)
234 folder *room = (folder *)CTX;
236 if (room->nRoomNameParts > 1)
237 StrBufAppendTemplate(Target, TP,
238 room->RoomNameParts[room->nRoomNameParts - 1], 0);
240 StrBufAppendTemplate(Target, TP, room->name, 0);
244 void tmplput_ROOM_LEVEL_N_TIMES(StrBuf *Target, WCTemplputParams *TP)
246 folder *room = (folder *)CTX;
248 const char *AppendMe;
252 if (room->nRoomNameParts > 1)
254 GetTemplateTokenString(Target, TP, 0, &AppendMe, &AppendMeLen);
255 for (i = 0; i < room->nRoomNameParts; i++)
256 StrBufAppendBufPlain(Target, AppendMe, AppendMeLen, 0);
261 int ConditionalRoomIsInbox(StrBuf *Target, WCTemplputParams *TP)
263 folder *Folder = (folder *)CTX;
264 return Folder->is_inbox;
268 /****** Properties ******/
269 int ConditionalRoom_MayEdit(StrBuf *Target, WCTemplputParams *TP)
275 return WCC->CurRoom.XALoaded == 1;
278 int ConditionalThisRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
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!");
291 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
292 (TP->Tokens->Params[2]->MaskBy == eNO))
293 return (WCC->CurRoom.QRFlags & QR_CheckFlag) != 0;
295 return (WCC->CurRoom.QRFlags & QR_CheckFlag) == QR_CheckFlag;
299 int ConditionalRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
302 folder *Folder = (folder *)(TP->Context);
304 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
305 if (QR_CheckFlag == 0)
306 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
307 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
309 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
310 (TP->Tokens->Params[2]->MaskBy == eNO))
311 return (Folder->QRFlags & QR_CheckFlag) != 0;
313 return (Folder->QRFlags & QR_CheckFlag) == QR_CheckFlag;
317 void tmplput_ROOM_QRFLAGS(StrBuf *Target, WCTemplputParams *TP)
319 folder *Folder = (folder *)CTX;
320 StrBufAppendPrintf(Target, "%d", Folder->QRFlags);
324 int ConditionalThisRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
329 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
330 if (QR2_CheckFlag == 0)
331 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
332 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
338 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
339 (TP->Tokens->Params[2]->MaskBy == eNO))
340 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) != 0;
342 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) == QR2_CheckFlag;
346 int ConditionalRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
349 folder *Folder = (folder *)(TP->Context);
351 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
352 if (QR2_CheckFlag == 0)
353 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
354 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
355 return ((Folder->QRFlags2 & QR2_CheckFlag) != 0);
359 int ConditionalRoomHas_UAFlag(StrBuf *Target, WCTemplputParams *TP)
361 folder *Folder = (folder *)(TP->Context);
364 UA_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
365 if (UA_CheckFlag == 0)
366 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
367 "requires one of the #\"UA_*\"- defines or an integer flag 0 is invalid!");
369 return ((Folder->RAFlags & UA_CheckFlag) != 0);
373 void tmplput_ROOM_ACL(StrBuf *Target, WCTemplputParams *TP)
375 folder *Folder = (folder *)CTX;
377 StrBufAppendPrintf(Target, "%ld", Folder->RAFlags, 0);
381 void tmplput_ROOM_RAFLAGS(StrBuf *Target, WCTemplputParams *TP)
383 folder *Folder = (folder *)(TP->Context);
384 StrBufAppendPrintf(Target, "%d", Folder->RAFlags);
388 void tmplput_ThisRoomAide(StrBuf *Target, WCTemplputParams *TP)
394 StrBufAppendTemplate(Target, TP, WCC->CurRoom.RoomAide, 0);
398 int ConditionalRoomAide(StrBuf *Target, WCTemplputParams *TP)
401 return (WCC != NULL)?
402 ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) : 0;
406 int ConditionalRoomAcessDelete(StrBuf *Target, WCTemplputParams *TP)
409 return (WCC == NULL)? 0 :
410 ( ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) ||
411 (WCC->CurRoom.is_inbox) ||
412 (WCC->CurRoom.QRFlags2 & QR2_COLLABDEL) );
416 int ConditionalHaveRoomeditRights(StrBuf *Target, WCTemplputParams *TP)
420 return ( (WCC != NULL)
424 || ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0)
425 || (WCC->CurRoom.is_inbox)
431 void tmplput_ThisRoomPass(StrBuf *Target, WCTemplputParams *TP)
436 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XAPass, 0);
440 void tmplput_ThisRoom_nNewMessages(StrBuf *Target, WCTemplputParams *TP)
444 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nNewMessages);
448 void tmplput_ThisRoom_nTotalMessages(StrBuf *Target, WCTemplputParams *TP)
452 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nTotalMessages);
456 void tmplput_ThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
462 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.Order);
466 int ConditionalThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
476 CheckThis = GetTemplateTokenNumber(Target, TP, 2, 0);
477 return CheckThis == WCC->CurRoom.Order;
481 void tmplput_ROOM_LISTORDER(StrBuf *Target, WCTemplputParams *TP)
483 folder *Folder = (folder *)CTX;
484 StrBufAppendPrintf(Target, "%d", Folder->Order);
488 int ConditionalThisRoomXHavePic(StrBuf *Target, WCTemplputParams *TP)
496 return WCC->CurRoom.XHaveRoomPic == 1;
500 int ConditionalThisRoomXHaveInfoText(StrBuf *Target, WCTemplputParams *TP)
508 return (StrLength(WCC->CurRoom.XInfoText)>0);
512 void tmplput_ThisRoomInfoText(StrBuf *Target, WCTemplputParams *TP)
519 nchars = GetTemplateTokenNumber(Target, TP, 0, 0);
521 /* the whole thing */
522 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XInfoText, 1);
525 /* only a certain number of characters */
527 SubBuf = NewStrBufDup(WCC->CurRoom.XInfoText);
528 if (StrLength(SubBuf) > nchars) {
529 StrBuf_Utf8StrCut(SubBuf, nchars);
530 StrBufAppendBufPlain(SubBuf, HKEY("..."), 0);
532 StrBufAppendTemplate(Target, TP, SubBuf, 1);
538 void tmplput_ROOM_LASTCHANGE(StrBuf *Target, WCTemplputParams *TP)
540 folder *Folder = (folder *)CTX;
541 StrBufAppendPrintf(Target, "%d", Folder->lastchange);
545 void tmplput_ThisRoomDirectory(StrBuf *Target, WCTemplputParams *TP)
551 StrBufAppendTemplate(Target, TP, WCC->CurRoom.Directory, 0);
555 void tmplput_ThisRoomXNFiles(StrBuf *Target, WCTemplputParams *TP)
559 LoadXRoomXCountFiles();
561 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.XDownloadCount);
565 void tmplput_ThisRoomX_FileString(StrBuf *Target, WCTemplputParams *TP)
569 LoadXRoomXCountFiles();
571 if (WCC->CurRoom.XDownloadCount == 1)
572 StrBufAppendBufPlain(Target, _("file"), -1, 0);
574 StrBufAppendBufPlain(Target, _("files"), -1, 0);
578 int ConditionalIsThisThatRoom(StrBuf *Target, WCTemplputParams *TP)
580 folder *Folder = (folder *)CTX;
586 return Folder == WCC->ThisRoom;
591 InitModule_ROOMTOKENS
594 RegisterNamespace("ROOMBANNER", 0, 1, tmplput_roombanner, NULL, CTX_NONE);
596 RegisterNamespace("FLOOR:ID", 0, 0, tmplput_FLOOR_ID, NULL, CTX_FLOORS);
597 RegisterNamespace("ROOM:INFO:FLOORID", 0, 1, tmplput_ROOM_FLOORID, NULL, CTX_ROOMS);
598 RegisterNamespace("ROOM:INFO:FLOOR:ID", 0, 0, tmplput_ROOM_FLOOR_ID, NULL, CTX_ROOMS);
600 RegisterNamespace("FLOOR:NAME", 0, 1, tmplput_FLOOR_NAME, NULL, CTX_FLOORS);
601 RegisterNamespace("ROOM:INFO:FLOOR:NAME", 0, 1, tmplput_ROOM_FLOOR_NAME, NULL, CTX_ROOMS);
602 RegisterNamespace("THISROOM:FLOOR:NAME", 0, 1, tmplput_ThisRoomFloorName, NULL, CTX_NONE);
604 RegisterNamespace("FLOOR:NROOMS", 0, 0, tmplput_FLOOR_NROOMS, NULL, CTX_FLOORS);
605 RegisterNamespace("ROOM:INFO:FLOOR:NROOMS", 0, 0, tmplput_ROOM_FLOOR_NROOMS, NULL, CTX_ROOMS);
607 RegisterConditional(HKEY("COND:FLOOR:ISSUBROOM"), 0, ConditionalFloorIsSUBROOM, CTX_FLOORS);
608 RegisterConditional(HKEY("COND:FLOOR:NROOMS"), 1, ConditionalFloorHaveNRooms, CTX_FLOORS);
609 RegisterConditional(HKEY("COND:ROOM:REST:ISSUBFLOOR"), 0, ConditionalFloorIsRESTSubFloor, CTX_FLOORS);
610 RegisterConditional(HKEY("COND:FLOOR:ISVIRTUAL"), 0, ConditionalFloorIsVirtual, CTX_FLOORS);
612 /**** Room... ******/
614 RegisterNamespace("ROOMNAME", 0, 1, tmplput_RoomName, NULL, CTX_NONE);
615 RegisterNamespace("THISROOM", 0, 1, tmplput_current_room, NULL, CTX_NONE);
616 RegisterNamespace("ROOM:INFO:NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_ROOMS);
617 RegisterNamespace("ROOM:INFO:PRINT_NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_NONE);
618 RegisterNamespace("ROOM:INFO:BASENAME", 0, 1, tmplput_ROOM_BASENAME, NULL, CTX_ROOMS);
619 RegisterNamespace("ROOM:INFO:LEVELNTIMES", 1, 2, tmplput_ROOM_LEVEL_N_TIMES, NULL, CTX_ROOMS);
620 RegisterConditional(HKEY("COND:ROOM:INFO:IS_INBOX"), 0, ConditionalRoomIsInbox, CTX_ROOMS);
622 /****** Properties ******/
623 RegisterNamespace("ROOM:INFO:QRFLAGS", 0, 1, tmplput_ROOM_QRFLAGS, NULL, CTX_ROOMS);
624 RegisterConditional(HKEY("COND:THISROOM:FLAG:QR"), 0, ConditionalThisRoomHas_QRFlag, CTX_NONE);
625 RegisterConditional(HKEY("COND:THISROOM:EDIT"), 0, ConditionalRoom_MayEdit, CTX_NONE);
626 RegisterConditional(HKEY("COND:ROOM:FLAG:QR"), 0, ConditionalRoomHas_QRFlag, CTX_ROOMS);
628 RegisterConditional(HKEY("COND:THISROOM:FLAG:QR2"), 0, ConditionalThisRoomHas_QRFlag2, CTX_NONE);
629 RegisterConditional(HKEY("COND:ROOM:FLAG:QR2"), 0, ConditionalRoomHas_QRFlag2, CTX_ROOMS);
631 RegisterConditional(HKEY("COND:ROOM:FLAG:UA"), 0, ConditionalRoomHas_UAFlag, CTX_ROOMS);
632 RegisterNamespace("ROOM:INFO:RAFLAGS", 0, 1, tmplput_ROOM_RAFLAGS, NULL, CTX_ROOMS);
635 RegisterNamespace("ROOM:INFO:LISTORDER", 0, 1, tmplput_ROOM_LISTORDER, NULL, CTX_ROOMS);
636 RegisterNamespace("THISROOM:ORDER", 0, 0, tmplput_ThisRoomOrder, NULL, CTX_NONE);
637 RegisterConditional(HKEY("COND:THISROOM:ORDER"), 0, ConditionalThisRoomOrder, CTX_NONE);
639 RegisterNamespace("ROOM:INFO:LASTCHANGE", 0, 1, tmplput_ROOM_LASTCHANGE, NULL, CTX_ROOMS);
641 RegisterNamespace("THISROOM:MSGS:NEW", 0, 0, tmplput_ThisRoom_nNewMessages, NULL, CTX_NONE);
642 RegisterNamespace("THISROOM:MSGS:TOTAL", 0, 0, tmplput_ThisRoom_nTotalMessages, NULL, CTX_NONE);
644 RegisterNamespace("THISROOM:PASS", 0, 1, tmplput_ThisRoomPass, NULL, CTX_NONE);
645 RegisterNamespace("THISROOM:AIDE", 0, 1, tmplput_ThisRoomAide, NULL, CTX_NONE);
646 RegisterConditional(HKEY("COND:ROOMAIDE"), 2, ConditionalRoomAide, CTX_NONE);
647 RegisterConditional(HKEY("COND:ACCESS:DELETE"), 2, ConditionalRoomAcessDelete, CTX_NONE);
648 RegisterConditional(HKEY("COND:ROOM:EDITACCESS"), 0, ConditionalHaveRoomeditRights, CTX_NONE);
650 RegisterConditional(HKEY("COND:THISROOM:HAVE_PIC"), 0, ConditionalThisRoomXHavePic, CTX_NONE);
652 RegisterNamespace("THISROOM:INFOTEXT", 1, 2, tmplput_ThisRoomInfoText, NULL, CTX_NONE);
653 RegisterConditional(HKEY("COND:THISROOM:HAVE_INFOTEXT"), 0, ConditionalThisRoomXHaveInfoText, CTX_NONE);
655 RegisterNamespace("THISROOM:FILES:N", 0, 1, tmplput_ThisRoomXNFiles, NULL, CTX_NONE);
656 RegisterNamespace("THISROOM:FILES:STR", 0, 1, tmplput_ThisRoomX_FileString, NULL, CTX_NONE);
657 RegisterNamespace("THISROOM:DIRECTORY", 0, 1, tmplput_ThisRoomDirectory, NULL, CTX_NONE);
659 RegisterNamespace("ROOM:INFO:ACL", 0, 1, tmplput_ROOM_ACL, NULL, CTX_ROOMS);
660 RegisterConditional(HKEY("COND:THIS:THAT:ROOM"), 0, ConditionalIsThisThatRoom, CTX_ROOMS);