2 * Lots of different room-related operations.
4 * Copyright (c) 1996-2011 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 as published
8 * by the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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 ConditionalThisRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
274 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
275 if (QR_CheckFlag == 0)
276 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
277 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
282 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
283 (TP->Tokens->Params[2]->MaskBy == eNO))
284 return (WCC->CurRoom.QRFlags & QR_CheckFlag) != 0;
286 return (WCC->CurRoom.QRFlags & QR_CheckFlag) == QR_CheckFlag;
290 int ConditionalRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
293 folder *Folder = (folder *)(TP->Context);
295 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
296 if (QR_CheckFlag == 0)
297 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
298 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
300 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
301 (TP->Tokens->Params[2]->MaskBy == eNO))
302 return (Folder->QRFlags & QR_CheckFlag) != 0;
304 return (Folder->QRFlags & QR_CheckFlag) == QR_CheckFlag;
308 void tmplput_ROOM_QRFLAGS(StrBuf *Target, WCTemplputParams *TP)
310 folder *Folder = (folder *)CTX;
311 StrBufAppendPrintf(Target, "%d", Folder->QRFlags);
315 int ConditionalThisRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
320 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
321 if (QR2_CheckFlag == 0)
322 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
323 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
329 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
330 (TP->Tokens->Params[2]->MaskBy == eNO))
331 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) != 0;
333 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) == QR2_CheckFlag;
337 int ConditionalRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
340 folder *Folder = (folder *)(TP->Context);
342 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
343 if (QR2_CheckFlag == 0)
344 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
345 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
346 return ((Folder->QRFlags2 & QR2_CheckFlag) != 0);
350 int ConditionalRoomHas_UAFlag(StrBuf *Target, WCTemplputParams *TP)
352 folder *Folder = (folder *)(TP->Context);
355 UA_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
356 if (UA_CheckFlag == 0)
357 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
358 "requires one of the #\"UA_*\"- defines or an integer flag 0 is invalid!");
360 return ((Folder->RAFlags & UA_CheckFlag) != 0);
364 void tmplput_ROOM_ACL(StrBuf *Target, WCTemplputParams *TP)
366 folder *Folder = (folder *)CTX;
368 StrBufAppendPrintf(Target, "%ld", Folder->RAFlags, 0);
372 void tmplput_ROOM_RAFLAGS(StrBuf *Target, WCTemplputParams *TP)
374 folder *Folder = (folder *)(TP->Context);
375 StrBufAppendPrintf(Target, "%d", Folder->RAFlags);
379 void tmplput_ThisRoomAide(StrBuf *Target, WCTemplputParams *TP)
385 StrBufAppendTemplate(Target, TP, WCC->CurRoom.RoomAide, 0);
389 int ConditionalRoomAide(StrBuf *Target, WCTemplputParams *TP)
392 return (WCC != NULL)?
393 ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) : 0;
397 int ConditionalRoomAcessDelete(StrBuf *Target, WCTemplputParams *TP)
400 return (WCC == NULL)? 0 :
401 ( ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) ||
402 (WCC->CurRoom.is_inbox) ||
403 (WCC->CurRoom.QRFlags2 & QR2_COLLABDEL) );
407 int ConditionalHaveRoomeditRights(StrBuf *Target, WCTemplputParams *TP)
411 return ( (WCC != NULL)
415 || ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0)
416 || (WCC->CurRoom.is_inbox)
422 void tmplput_ThisRoomPass(StrBuf *Target, WCTemplputParams *TP)
427 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XAPass, 0);
431 void tmplput_ThisRoom_nNewMessages(StrBuf *Target, WCTemplputParams *TP)
435 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nNewMessages);
439 void tmplput_ThisRoom_nTotalMessages(StrBuf *Target, WCTemplputParams *TP)
443 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.nTotalMessages);
447 void tmplput_ThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
453 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.Order);
457 int ConditionalThisRoomOrder(StrBuf *Target, WCTemplputParams *TP)
467 CheckThis = GetTemplateTokenNumber(Target, TP, 2, 0);
468 return CheckThis == WCC->CurRoom.Order;
472 void tmplput_ROOM_LISTORDER(StrBuf *Target, WCTemplputParams *TP)
474 folder *Folder = (folder *)CTX;
475 StrBufAppendPrintf(Target, "%d", Folder->Order);
479 int ConditionalThisRoomXHavePic(StrBuf *Target, WCTemplputParams *TP)
487 return WCC->CurRoom.XHaveRoomPic == 1;
491 int ConditionalThisRoomXHaveInfoText(StrBuf *Target, WCTemplputParams *TP)
499 return (StrLength(WCC->CurRoom.XInfoText)>0);
503 void tmplput_ThisRoomInfoText(StrBuf *Target, WCTemplputParams *TP)
510 nchars = GetTemplateTokenNumber(Target, TP, 0, 0);
512 /* the whole thing */
513 StrBufAppendTemplate(Target, TP, WCC->CurRoom.XInfoText, 1);
516 /* only a certain number of characters */
518 SubBuf = NewStrBufDup(WCC->CurRoom.XInfoText);
519 if (StrLength(SubBuf) > nchars) {
520 StrBuf_Utf8StrCut(SubBuf, nchars);
521 StrBufAppendBufPlain(SubBuf, HKEY("..."), 0);
523 StrBufAppendTemplate(Target, TP, SubBuf, 1);
529 void tmplput_ROOM_LASTCHANGE(StrBuf *Target, WCTemplputParams *TP)
531 folder *Folder = (folder *)CTX;
532 StrBufAppendPrintf(Target, "%d", Folder->lastchange);
536 void tmplput_ThisRoomDirectory(StrBuf *Target, WCTemplputParams *TP)
542 StrBufAppendTemplate(Target, TP, WCC->CurRoom.Directory, 0);
546 void tmplput_ThisRoomXNFiles(StrBuf *Target, WCTemplputParams *TP)
550 LoadXRoomXCountFiles();
552 StrBufAppendPrintf(Target, "%d", WCC->CurRoom.XDownloadCount);
556 void tmplput_ThisRoomX_FileString(StrBuf *Target, WCTemplputParams *TP)
560 LoadXRoomXCountFiles();
562 if (WCC->CurRoom.XDownloadCount == 1)
563 StrBufAppendBufPlain(Target, _("file"), -1, 0);
565 StrBufAppendBufPlain(Target, _("files"), -1, 0);
569 int ConditionalIsThisThatRoom(StrBuf *Target, WCTemplputParams *TP)
571 folder *Folder = (folder *)CTX;
577 return Folder == WCC->ThisRoom;
582 InitModule_ROOMTOKENS
585 RegisterNamespace("ROOMBANNER", 0, 1, tmplput_roombanner, NULL, CTX_NONE);
587 RegisterNamespace("FLOOR:ID", 0, 0, tmplput_FLOOR_ID, NULL, CTX_FLOORS);
588 RegisterNamespace("ROOM:INFO:FLOORID", 0, 1, tmplput_ROOM_FLOORID, NULL, CTX_ROOMS);
589 RegisterNamespace("ROOM:INFO:FLOOR:ID", 0, 0, tmplput_ROOM_FLOOR_ID, NULL, CTX_ROOMS);
591 RegisterNamespace("FLOOR:NAME", 0, 1, tmplput_FLOOR_NAME, NULL, CTX_FLOORS);
592 RegisterNamespace("ROOM:INFO:FLOOR:NAME", 0, 1, tmplput_ROOM_FLOOR_NAME, NULL, CTX_ROOMS);
593 RegisterNamespace("THISROOM:FLOOR:NAME", 0, 1, tmplput_ThisRoomFloorName, NULL, CTX_NONE);
595 RegisterNamespace("FLOOR:NROOMS", 0, 0, tmplput_FLOOR_NROOMS, NULL, CTX_FLOORS);
596 RegisterNamespace("ROOM:INFO:FLOOR:NROOMS", 0, 0, tmplput_ROOM_FLOOR_NROOMS, NULL, CTX_ROOMS);
598 RegisterConditional(HKEY("COND:FLOOR:ISSUBROOM"), 0, ConditionalFloorIsSUBROOM, CTX_FLOORS);
599 RegisterConditional(HKEY("COND:FLOOR:NROOMS"), 1, ConditionalFloorHaveNRooms, CTX_FLOORS);
600 RegisterConditional(HKEY("COND:ROOM:REST:ISSUBFLOOR"), 0, ConditionalFloorIsRESTSubFloor, CTX_FLOORS);
601 RegisterConditional(HKEY("COND:FLOOR:ISVIRTUAL"), 0, ConditionalFloorIsVirtual, CTX_FLOORS);
603 /**** Room... ******/
605 RegisterNamespace("ROOMNAME", 0, 1, tmplput_RoomName, NULL, CTX_NONE);
606 RegisterNamespace("CURRENT_ROOM", 0, 1, tmplput_current_room, NULL, CTX_NONE);
607 RegisterNamespace("ROOM:INFO:NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_ROOMS);
608 RegisterNamespace("ROOM:INFO:PRINT_NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_NONE);
609 RegisterNamespace("ROOM:INFO:BASENAME", 0, 1, tmplput_ROOM_BASENAME, NULL, CTX_ROOMS);
610 RegisterNamespace("ROOM:INFO:LEVELNTIMES", 1, 2, tmplput_ROOM_LEVEL_N_TIMES, NULL, CTX_ROOMS);
611 RegisterConditional(HKEY("COND:ROOM:INFO:IS_INBOX"), 0, ConditionalRoomIsInbox, CTX_ROOMS);
613 /****** Properties ******/
614 RegisterNamespace("ROOM:INFO:QRFLAGS", 0, 1, tmplput_ROOM_QRFLAGS, NULL, CTX_ROOMS);
615 RegisterConditional(HKEY("COND:THISROOM:FLAG:QR"), 0, ConditionalThisRoomHas_QRFlag, CTX_NONE);
616 RegisterConditional(HKEY("COND:ROOM:FLAG:QR"), 0, ConditionalRoomHas_QRFlag, CTX_ROOMS);
618 RegisterConditional(HKEY("COND:THISROOM:FLAG:QR2"), 0, ConditionalThisRoomHas_QRFlag2, CTX_NONE);
619 RegisterConditional(HKEY("COND:ROOM:FLAG:QR2"), 0, ConditionalRoomHas_QRFlag2, CTX_ROOMS);
621 RegisterConditional(HKEY("COND:ROOM:FLAG:UA"), 0, ConditionalRoomHas_UAFlag, CTX_ROOMS);
622 RegisterNamespace("ROOM:INFO:RAFLAGS", 0, 1, tmplput_ROOM_RAFLAGS, NULL, CTX_ROOMS);
625 RegisterNamespace("ROOM:INFO:LISTORDER", 0, 1, tmplput_ROOM_LISTORDER, NULL, CTX_ROOMS);
626 RegisterNamespace("THISROOM:ORDER", 0, 0, tmplput_ThisRoomOrder, NULL, CTX_NONE);
627 RegisterConditional(HKEY("COND:THISROOM:ORDER"), 0, ConditionalThisRoomOrder, CTX_NONE);
629 RegisterNamespace("ROOM:INFO:LASTCHANGE", 0, 1, tmplput_ROOM_LASTCHANGE, NULL, CTX_ROOMS);
631 RegisterNamespace("THISROOM:MSGS:NEW", 0, 0, tmplput_ThisRoom_nNewMessages, NULL, CTX_NONE);
632 RegisterNamespace("THISROOM:MSGS:TOTAL", 0, 0, tmplput_ThisRoom_nTotalMessages, NULL, CTX_NONE);
634 RegisterNamespace("THISROOM:PASS", 0, 1, tmplput_ThisRoomPass, NULL, CTX_NONE);
635 RegisterNamespace("THISROOM:AIDE", 0, 1, tmplput_ThisRoomAide, NULL, CTX_NONE);
636 RegisterConditional(HKEY("COND:ROOMAIDE"), 2, ConditionalRoomAide, CTX_NONE);
637 RegisterConditional(HKEY("COND:ACCESS:DELETE"), 2, ConditionalRoomAcessDelete, CTX_NONE);
638 RegisterConditional(HKEY("COND:ROOM:EDITACCESS"), 0, ConditionalHaveRoomeditRights, CTX_NONE);
640 RegisterConditional(HKEY("COND:THISROOM:HAVE_PIC"), 0, ConditionalThisRoomXHavePic, CTX_NONE);
642 RegisterNamespace("THISROOM:INFOTEXT", 1, 2, tmplput_ThisRoomInfoText, NULL, CTX_NONE);
643 RegisterConditional(HKEY("COND:THISROOM:HAVE_INFOTEXT"), 0, ConditionalThisRoomXHaveInfoText, CTX_NONE);
645 RegisterNamespace("THISROOM:FILES:N", 0, 1, tmplput_ThisRoomXNFiles, NULL, CTX_NONE);
646 RegisterNamespace("THISROOM:FILES:STR", 0, 1, tmplput_ThisRoomX_FileString, NULL, CTX_NONE);
647 RegisterNamespace("THISROOM:DIRECTORY", 0, 1, tmplput_ThisRoomDirectory, NULL, CTX_NONE);
649 RegisterNamespace("ROOM:INFO:ACL", 0, 1, tmplput_ROOM_ACL, NULL, CTX_ROOMS);
650 RegisterConditional(HKEY("COND:THIS:THAT:ROOM"), 0, ConditionalIsThisThatRoom, CTX_ROOMS);