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;
249 /****** Properties ******/
250 int ConditionalRoom_MayEdit(StrBuf *Target, WCTemplputParams *TP)
256 return WCC->CurRoom.XALoaded == 1;
259 int ConditionalThisRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
264 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
265 if (QR_CheckFlag == 0)
266 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
267 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
272 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
273 (TP->Tokens->Params[2]->MaskBy == eNO))
274 return (WCC->CurRoom.QRFlags & QR_CheckFlag) != 0;
276 return (WCC->CurRoom.QRFlags & QR_CheckFlag) == QR_CheckFlag;
280 int ConditionalRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
283 folder *Folder = (folder *)(TP->Context);
285 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
286 if (QR_CheckFlag == 0)
287 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
288 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
290 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
291 (TP->Tokens->Params[2]->MaskBy == eNO))
292 return (Folder->QRFlags & QR_CheckFlag) != 0;
294 return (Folder->QRFlags & QR_CheckFlag) == QR_CheckFlag;
298 void tmplput_ROOM_QRFLAGS(StrBuf *Target, WCTemplputParams *TP)
300 folder *Folder = (folder *)CTX(CTX_ROOMS);
301 StrBufAppendPrintf(Target, "%d", Folder->QRFlags);
305 int ConditionalThisRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
310 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
311 if (QR2_CheckFlag == 0)
312 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
313 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
319 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
320 (TP->Tokens->Params[2]->MaskBy == eNO))
321 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) != 0;
323 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) == QR2_CheckFlag;
327 int ConditionalRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
330 folder *Folder = (folder *)(TP->Context);
332 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
333 if (QR2_CheckFlag == 0)
334 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
335 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
336 return ((Folder->QRFlags2 & QR2_CheckFlag) != 0);
340 int ConditionalRoomHas_UAFlag(StrBuf *Target, WCTemplputParams *TP)
342 folder *Folder = (folder *)(TP->Context);
345 UA_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
346 if (UA_CheckFlag == 0)
347 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
348 "requires one of the #\"UA_*\"- defines or an integer flag 0 is invalid!");
350 return ((Folder->RAFlags & UA_CheckFlag) != 0);
354 void tmplput_ROOM_ACL(StrBuf *Target, WCTemplputParams *TP)
356 folder *Folder = (folder *)CTX(CTX_ROOMS);
358 StrBufAppendPrintf(Target, "%ld", Folder->RAFlags, 0);
362 void tmplput_ROOM_RAFLAGS(StrBuf *Target, WCTemplputParams *TP)
364 folder *Folder = (folder *)(TP->Context);
365 StrBufAppendPrintf(Target, "%d", Folder->RAFlags);
369 void tmplput_ThisRoomAide(StrBuf *Target, WCTemplputParams *TP)
375 StrBufAppendTemplate(Target, TP, WCC->CurRoom.RoomAide, 0);
379 int ConditionalRoomAide(StrBuf *Target, WCTemplputParams *TP)
382 return (WCC != NULL)?
383 ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) : 0;
387 int ConditionalRoomAcessDelete(StrBuf *Target, WCTemplputParams *TP)
390 return (WCC == NULL)? 0 :
391 ( ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) ||
392 (WCC->CurRoom.is_inbox) ||
393 (WCC->CurRoom.QRFlags2 & QR2_COLLABDEL) );
397 int ConditionalHaveRoomeditRights(StrBuf *Target, WCTemplputParams *TP)
401 return ( (WCC != NULL)
405 || ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0)
406 || (WCC->CurRoom.is_inbox)
412 void tmplput_ThisRoomPass(StrBuf *Target, WCTemplputParams *TP)
417 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XAPass, 0);
421 void tmplput_ThisRoom_nNewMessages(StrBuf *Target, WCTemplputParams *TP)
425 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nNewMessages);
429 void tmplput_ThisRoom_nTotalMessages(StrBuf *Target, WCTemplputParams *TP)
433 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nTotalMessages);
437 void tmplput_ThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
443 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.Order);
447 int ConditionalThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
457 CheckThis = GetTemplateTokenNumber(Target, TP, 2, 0);
458 return CheckThis == WCC->CurRoom.Order;
462 void tmplput_ROOM_LISTORDER(StrBuf *Target, WCTemplputParams *TP)
464 folder *Folder = (folder *)CTX(CTX_ROOMS);
465 StrBufAppendPrintf(Target, "%d", Folder->Order);
469 int ConditionalThisRoomXHavePic(StrBuf *Target, WCTemplputParams *TP)
477 return WCC->CurRoom.XHaveRoomPic == 1;
481 int ConditionalThisRoomXHaveInfoText(StrBuf *Target, WCTemplputParams *TP)
489 return (StrLength(WCC->CurRoom.XInfoText)>0);
493 void tmplput_ThisRoomInfoText(StrBuf *Target, WCTemplputParams *TP)
500 nchars = GetTemplateTokenNumber(Target, TP, 0, 0);
502 /* the whole thing */
503 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XInfoText, 1);
506 /* only a certain number of characters */
508 SubBuf = NewStrBufDup(WCC->CurRoom.XInfoText);
509 if (StrLength(SubBuf) > nchars) {
510 StrBuf_Utf8StrCut(SubBuf, nchars);
511 StrBufAppendBufPlain(SubBuf, HKEY("..."), 0);
513 StrBufAppendTemplate(Target, TP, SubBuf, 1);
519 void tmplput_ROOM_LASTCHANGE(StrBuf *Target, WCTemplputParams *TP)
521 folder *Folder = (folder *)CTX(CTX_ROOMS);
522 StrBufAppendPrintf(Target, "%d", Folder->lastchange);
526 void tmplput_ThisRoomDirectory(StrBuf *Target, WCTemplputParams *TP)
532 StrBufAppendTemplate(Target, TP, WCC->CurRoom.Directory, 0);
536 void tmplput_ThisRoomXNFiles(StrBuf *Target, WCTemplputParams *TP)
540 LoadXRoomXCountFiles();
542 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.XDownloadCount);
546 void tmplput_ThisRoomX_FileString(StrBuf *Target, WCTemplputParams *TP)
550 LoadXRoomXCountFiles();
552 if (WCC->CurRoom.XDownloadCount == 1)
553 StrBufAppendBufPlain(Target, _("file"), -1, 0);
555 StrBufAppendBufPlain(Target, _("files"), -1, 0);
559 int ConditionalIsThisThatRoom(StrBuf *Target, WCTemplputParams *TP)
561 folder *Folder = (folder *)CTX(CTX_ROOMS);
567 return Folder == WCC->ThisRoom;
572 InitModule_ROOMTOKENS
575 /* we duplicate this, just to be shure its already done. */
576 RegisterCTX(CTX_ROOMS);
577 RegisterCTX(CTX_FLOORS);
579 RegisterNamespace("ROOMBANNER", 0, 1, tmplput_roombanner, NULL, CTX_NONE);
581 RegisterNamespace("FLOOR:ID", 0, 0, tmplput_FLOOR_ID, NULL, CTX_FLOORS);
582 RegisterNamespace("ROOM:INFO:FLOORID", 0, 1, tmplput_ROOM_FLOORID, NULL, CTX_ROOMS);
583 RegisterNamespace("ROOM:INFO:FLOOR:ID", 0, 0, tmplput_ROOM_FLOOR_ID, NULL, CTX_ROOMS);
585 RegisterNamespace("FLOOR:NAME", 0, 1, tmplput_FLOOR_NAME, NULL, CTX_FLOORS);
586 RegisterNamespace("ROOM:INFO:FLOOR:NAME", 0, 1, tmplput_ROOM_FLOOR_NAME, NULL, CTX_ROOMS);
587 RegisterNamespace("THISROOM:FLOOR:NAME", 0, 1, tmplput_ThisRoomFloorName, NULL, CTX_NONE);
589 RegisterNamespace("FLOOR:NROOMS", 0, 0, tmplput_FLOOR_NROOMS, NULL, CTX_FLOORS);
590 RegisterNamespace("ROOM:INFO:FLOOR:NROOMS", 0, 0, tmplput_ROOM_FLOOR_NROOMS, NULL, CTX_ROOMS);
592 RegisterConditional(HKEY("COND:FLOOR:ISSUBROOM"), 0, ConditionalFloorIsSUBROOM, CTX_FLOORS);
593 RegisterConditional(HKEY("COND:FLOOR:NROOMS"), 1, ConditionalFloorHaveNRooms, CTX_FLOORS);
594 RegisterConditional(HKEY("COND:ROOM:REST:ISSUBFLOOR"), 0, ConditionalFloorIsRESTSubFloor, CTX_FLOORS);
595 RegisterConditional(HKEY("COND:FLOOR:ISVIRTUAL"), 0, ConditionalFloorIsVirtual, CTX_FLOORS);
597 /**** Room... ******/
599 RegisterNamespace("THISROOM:NAME", 0, 1, tmplput_ThisRoom, NULL, CTX_NONE);
601 RegisterNamespace("ROOM:INFO:NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_ROOMS);
602 RegisterNamespace("ROOM:INFO:BASENAME", 0, 1, tmplput_ROOM_BASENAME, NULL, CTX_ROOMS);
603 RegisterNamespace("ROOM:INFO:LEVELNTIMES", 1, 2, tmplput_ROOM_LEVEL_N_TIMES, NULL, CTX_ROOMS);
604 RegisterConditional(HKEY("COND:ROOM:INFO:IS_INBOX"), 0, ConditionalRoomIsInbox, CTX_ROOMS);
606 /****** Properties ******/
607 RegisterNamespace("ROOM:INFO:QRFLAGS", 0, 1, tmplput_ROOM_QRFLAGS, NULL, CTX_ROOMS);
608 RegisterConditional(HKEY("COND:THISROOM:FLAG:QR"), 0, ConditionalThisRoomHas_QRFlag, CTX_NONE);
609 RegisterConditional(HKEY("COND:THISROOM:EDIT"), 0, ConditionalRoom_MayEdit, CTX_NONE);
610 RegisterConditional(HKEY("COND:ROOM:FLAG:QR"), 0, ConditionalRoomHas_QRFlag, CTX_ROOMS);
612 RegisterConditional(HKEY("COND:THISROOM:FLAG:QR2"), 0, ConditionalThisRoomHas_QRFlag2, CTX_NONE);
613 RegisterConditional(HKEY("COND:ROOM:FLAG:QR2"), 0, ConditionalRoomHas_QRFlag2, CTX_ROOMS);
615 RegisterConditional(HKEY("COND:ROOM:FLAG:UA"), 0, ConditionalRoomHas_UAFlag, CTX_ROOMS);
616 RegisterNamespace("ROOM:INFO:RAFLAGS", 0, 1, tmplput_ROOM_RAFLAGS, NULL, CTX_ROOMS);
619 RegisterNamespace("ROOM:INFO:LISTORDER", 0, 1, tmplput_ROOM_LISTORDER, NULL, CTX_ROOMS);
620 RegisterNamespace("THISROOM:ORDER", 0, 0, tmplput_ThisRoomOrder, NULL, CTX_NONE);
621 RegisterConditional(HKEY("COND:THISROOM:ORDER"), 0, ConditionalThisRoomOrder, CTX_NONE);
623 RegisterNamespace("ROOM:INFO:LASTCHANGE", 0, 1, tmplput_ROOM_LASTCHANGE, NULL, CTX_ROOMS);
625 RegisterNamespace("THISROOM:MSGS:NEW", 0, 0, tmplput_ThisRoom_nNewMessages, NULL, CTX_NONE);
626 RegisterNamespace("THISROOM:MSGS:TOTAL", 0, 0, tmplput_ThisRoom_nTotalMessages, NULL, CTX_NONE);
628 RegisterNamespace("THISROOM:PASS", 0, 1, tmplput_ThisRoomPass, NULL, CTX_NONE);
629 RegisterNamespace("THISROOM:AIDE", 0, 1, tmplput_ThisRoomAide, NULL, CTX_NONE);
630 RegisterConditional(HKEY("COND:ROOMAIDE"), 2, ConditionalRoomAide, CTX_NONE);
631 RegisterConditional(HKEY("COND:ACCESS:DELETE"), 2, ConditionalRoomAcessDelete, CTX_NONE);
632 RegisterConditional(HKEY("COND:ROOM:EDITACCESS"), 0, ConditionalHaveRoomeditRights, CTX_NONE);
634 RegisterConditional(HKEY("COND:THISROOM:HAVE_PIC"), 0, ConditionalThisRoomXHavePic, CTX_NONE);
636 RegisterNamespace("THISROOM:INFOTEXT", 1, 2, tmplput_ThisRoomInfoText, NULL, CTX_NONE);
637 RegisterConditional(HKEY("COND:THISROOM:HAVE_INFOTEXT"), 0, ConditionalThisRoomXHaveInfoText, CTX_NONE);
639 RegisterNamespace("THISROOM:FILES:N", 0, 1, tmplput_ThisRoomXNFiles, NULL, CTX_NONE);
640 RegisterNamespace("THISROOM:FILES:STR", 0, 1, tmplput_ThisRoomX_FileString, NULL, CTX_NONE);
641 RegisterNamespace("THISROOM:DIRECTORY", 0, 1, tmplput_ThisRoomDirectory, NULL, CTX_NONE);
643 RegisterNamespace("ROOM:INFO:ACL", 0, 1, tmplput_ROOM_ACL, NULL, CTX_ROOMS);
644 RegisterConditional(HKEY("COND:THIS:THAT:ROOM"), 0, ConditionalIsThisThatRoom, CTX_ROOMS);