2 * Lots of different room-related operations.
4 * Copyright (c) 1996-2010 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", NULL);
58 /* roombanner contains this for mobile */
62 do_template("navbar", NULL);
63 wc_printf("</div>\n");
67 /*******************************************************************************
68 ********************** FLOOR Tokens *******************************************
69 *******************************************************************************/
72 void tmplput_FLOOR_ID(StrBuf *Target, WCTemplputParams *TP)
74 Floor *myFloor = (Floor *)CTX;
76 StrBufAppendPrintf(Target, "%d", myFloor->ID);
80 void tmplput_ROOM_FLOORID(StrBuf *Target, WCTemplputParams *TP)
82 folder *Folder = (folder *)CTX;
83 StrBufAppendPrintf(Target, "%d", Folder->floorid);
87 void tmplput_ROOM_FLOOR_ID(StrBuf *Target, WCTemplputParams *TP)
89 folder *Folder = (folder *)CTX;
90 const Floor *pFloor = Folder->Floor;
95 StrBufAppendPrintf(Target, "%d", pFloor->ID);
99 void tmplput_ROOM_FLOOR_NAME(StrBuf *Target, WCTemplputParams *TP)
101 folder *Folder = (folder *)CTX;
102 const Floor *pFloor = Folder->Floor;
107 StrBufAppendTemplate(Target, TP, pFloor->Name, 0);
111 void tmplput_ThisRoomFloorName(StrBuf *Target, WCTemplputParams *TP)
114 folder *Folder = &WCC->CurRoom;
120 pFloor = Folder->Floor;
124 StrBufAppendTemplate(Target, TP, pFloor->Name, 0);
128 void tmplput_FLOOR_NAME(StrBuf *Target, WCTemplputParams *TP)
130 Floor *myFloor = (Floor *)CTX;
132 StrBufAppendTemplate(Target, TP, myFloor->Name, 0);
136 void tmplput_FLOOR_NROOMS(StrBuf *Target, WCTemplputParams *TP)
138 Floor *myFloor = (Floor *)CTX;
140 StrBufAppendPrintf(Target, "%d", myFloor->NRooms);
144 void tmplput_ROOM_FLOOR_NROOMS(StrBuf *Target, WCTemplputParams *TP)
146 folder *Folder = (folder *)CTX;
147 const Floor *pFloor = Folder->Floor;
151 StrBufAppendPrintf(Target, "%d", pFloor->NRooms);
155 int ConditionalFloorHaveNRooms(StrBuf *Target, WCTemplputParams *TP)
157 Floor *MyFloor = (Floor *)CTX;
160 HaveN = GetTemplateTokenNumber(Target, TP, 0, 0);
162 return HaveN == MyFloor->NRooms;
166 int ConditionalFloorIsRESTSubFloor(StrBuf *Target, WCTemplputParams *TP)
169 Floor *MyFloor = (Floor *)CTX;
170 /** if we have dav_depth the client just wants the subfloors */
171 if ((WCC->Hdr->HR.dav_depth == 1) &&
172 (GetCount(WCC->Directory) == 0))
174 return WCC->CurrentFloor == MyFloor;
178 int ConditionalFloorIsSUBROOM(StrBuf *Target, WCTemplputParams *TP)
181 Floor *MyFloor = (Floor *)CTX;
183 return WCC->CurRoom.floorid == MyFloor->ID;
187 int ConditionalFloorIsVirtual(StrBuf *Target, WCTemplputParams *TP)
189 Floor *MyFloor = (Floor *)CTX;
191 return MyFloor->ID == VIRTUAL_MY_FLOOR;
195 /*******************************************************************************
196 ********************** ROOM Tokens ********************************************
197 *******************************************************************************/
201 void tmplput_RoomName(StrBuf *Target, WCTemplputParams *TP)
203 StrBufAppendTemplate(Target, TP, WC->CurRoom.name, 0);
207 void tmplput_current_room(StrBuf *Target, WCTemplputParams *TP)
212 StrBufAppendTemplate(Target, TP,
220 void tmplput_ROOM_NAME(StrBuf *Target, WCTemplputParams *TP)
222 folder *Folder = (folder *)CTX;
230 Folder = &WCC->CurRoom;
232 StrBufAppendTemplate(Target, TP, Folder->name, 0);
236 void tmplput_ROOM_BASENAME(StrBuf *Target, WCTemplputParams *TP)
238 folder *room = (folder *)CTX;
240 if (room->nRoomNameParts > 1)
241 StrBufAppendTemplate(Target, TP,
242 room->RoomNameParts[room->nRoomNameParts - 1], 0);
244 StrBufAppendTemplate(Target, TP, room->name, 0);
248 void tmplput_ROOM_LEVEL_N_TIMES(StrBuf *Target, WCTemplputParams *TP)
250 folder *room = (folder *)CTX;
252 const char *AppendMe;
256 if (room->nRoomNameParts > 1)
258 GetTemplateTokenString(Target, TP, 0, &AppendMe, &AppendMeLen);
259 for (i = 0; i < room->nRoomNameParts; i++)
260 StrBufAppendBufPlain(Target, AppendMe, AppendMeLen, 0);
265 int ConditionalRoomIsInbox(StrBuf *Target, WCTemplputParams *TP)
267 folder *Folder = (folder *)CTX;
268 return Folder->is_inbox;
272 /****** Properties ******/
273 int ConditionalThisRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
278 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
279 if (QR_CheckFlag == 0)
280 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
281 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
286 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
287 (TP->Tokens->Params[2]->MaskBy == eNO))
288 return (WCC->CurRoom.QRFlags & QR_CheckFlag) != 0;
290 return (WCC->CurRoom.QRFlags & QR_CheckFlag) == QR_CheckFlag;
294 int ConditionalRoomHas_QRFlag(StrBuf *Target, WCTemplputParams *TP)
297 folder *Folder = (folder *)(TP->Context);
299 QR_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
300 if (QR_CheckFlag == 0)
301 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
302 "requires one of the #\"QR*\"- defines or an integer flag 0 is invalid!");
304 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
305 (TP->Tokens->Params[2]->MaskBy == eNO))
306 return (Folder->QRFlags & QR_CheckFlag) != 0;
308 return (Folder->QRFlags & QR_CheckFlag) == QR_CheckFlag;
312 void tmplput_ROOM_QRFLAGS(StrBuf *Target, WCTemplputParams *TP)
314 folder *Folder = (folder *)CTX;
315 StrBufAppendPrintf(Target, "%d", Folder->QRFlags);
319 int ConditionalThisRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
324 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
325 if (QR2_CheckFlag == 0)
326 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
327 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
333 if ((TP->Tokens->Params[2]->MaskBy == eOR) ||
334 (TP->Tokens->Params[2]->MaskBy == eNO))
335 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) != 0;
337 return (WCC->CurRoom.QRFlags2 & QR2_CheckFlag) == QR2_CheckFlag;
341 int ConditionalRoomHas_QRFlag2(StrBuf *Target, WCTemplputParams *TP)
344 folder *Folder = (folder *)(TP->Context);
346 QR2_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
347 if (QR2_CheckFlag == 0)
348 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
349 "requires one of the #\"QR2*\"- defines or an integer flag 0 is invalid!");
350 return ((Folder->QRFlags2 & QR2_CheckFlag) != 0);
354 int ConditionalRoomHas_UAFlag(StrBuf *Target, WCTemplputParams *TP)
356 folder *Folder = (folder *)(TP->Context);
359 UA_CheckFlag = GetTemplateTokenNumber(Target, TP, 2, 0);
360 if (UA_CheckFlag == 0)
361 LogTemplateError(Target, "Conditional", ERR_PARM1, TP,
362 "requires one of the #\"UA_*\"- defines or an integer flag 0 is invalid!");
364 return ((Folder->RAFlags & UA_CheckFlag) != 0);
368 void tmplput_ROOM_ACL(StrBuf *Target, WCTemplputParams *TP)
370 folder *Folder = (folder *)CTX;
372 StrBufAppendPrintf(Target, "%ld", Folder->RAFlags, 0);
376 void tmplput_ROOM_RAFLAGS(StrBuf *Target, WCTemplputParams *TP)
378 folder *Folder = (folder *)(TP->Context);
379 StrBufAppendPrintf(Target, "%d", Folder->RAFlags);
383 void tmplput_ThisRoomAide(StrBuf *Target, WCTemplputParams *TP)
389 StrBufAppendTemplate(Target, TP, WCC->CurRoom.RoomAide, 0);
393 int ConditionalRoomAide(StrBuf *Target, WCTemplputParams *TP)
396 return (WCC != NULL)?
397 ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) : 0;
401 int ConditionalRoomAcessDelete(StrBuf *Target, WCTemplputParams *TP)
404 return (WCC == NULL)? 0 :
405 ( ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) ||
406 (WCC->CurRoom.is_inbox) ||
407 (WCC->CurRoom.QRFlags2 & QR2_COLLABDEL) );
411 int ConditionalHaveRoomeditRights(StrBuf *Target, WCTemplputParams *TP)
415 return ( (WCC!= NULL) &&
416 ((WCC->axlevel >= 6) ||
417 ((WCC->CurRoom.RAFlags & UA_ADMINALLOWED) != 0) ||
418 (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);
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("ROOMNAME", 0, 1, tmplput_RoomName, NULL, CTX_NONE);
594 RegisterNamespace("CURRENT_ROOM", 0, 1, tmplput_current_room, NULL, CTX_NONE);
595 RegisterNamespace("ROOM:INFO:NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_ROOMS);
596 RegisterNamespace("ROOM:INFO:PRINT_NAME", 0, 1, tmplput_ROOM_NAME, NULL, CTX_NONE);
597 RegisterNamespace("ROOM:INFO:BASENAME", 0, 1, tmplput_ROOM_BASENAME, NULL, CTX_ROOMS);
598 RegisterNamespace("ROOM:INFO:LEVELNTIMES", 1, 2, tmplput_ROOM_LEVEL_N_TIMES, NULL, CTX_ROOMS);
599 RegisterConditional(HKEY("COND:ROOM:INFO:IS_INBOX"), 0, ConditionalRoomIsInbox, CTX_ROOMS);
601 /****** Properties ******/
602 RegisterNamespace("ROOM:INFO:QRFLAGS", 0, 1, tmplput_ROOM_QRFLAGS, NULL, CTX_ROOMS);
603 RegisterConditional(HKEY("COND:THISROOM:FLAG:QR"), 0, ConditionalThisRoomHas_QRFlag, 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);