citadel/modules/expire/expire_policy.c

   1 /*
   2  * Functions which manage expire policy for rooms
   3  * Copyright (c) 1987-2015 by the citadel.org team
   4  *
   5  * This program is open source software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License, version 3.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  */
  13
  14 #include "sysdep.h"
  15 #include <stdlib.h>
  16 #include <unistd.h>
  17 #include <stdio.h>
  18 #include <sys/stat.h>
  19 #include <string.h>
  20
  21 #if TIME_WITH_SYS_TIME
  22 # include <sys/time.h>
  23 # include <time.h>
  24 #else
  25 # if HAVE_SYS_TIME_H
  26 #  include <sys/time.h>
  27 # else
  28 #  include <time.h>
  29 # endif
  30 #endif
  31
  32 #include <limits.h>
  33 #include <libcitadel.h>
  34 #include "citadel.h"
  35 #include "server.h"
  36 #include "database.h"
  37 #include "config.h"
  38 #include "room_ops.h"
  39 #include "sysdep_decls.h"
  40 #include "support.h"
  41 #include "msgbase.h"
  42 #include "citserver.h"
  43 #include "config.h"
  44 #include "ctdl_module.h"
  45 #include "user_ops.h"
  46
  47 /*
  48  * Retrieve the applicable expire policy for a specific room
  49  */
  50 void GetExpirePolicy(struct ExpirePolicy *epbuf, struct ctdlroom *qrbuf) {
  51         struct floor *fl;
  52
  53         /* If the room has its own policy, return it */
  54         if (qrbuf->QRep.expire_mode != 0) {
  55                 memcpy(epbuf, &qrbuf->QRep, sizeof(struct ExpirePolicy));
  56                 return;
  57         }
  58
  59         /* (non-mailbox rooms)
  60          * If the floor has its own policy, return it
  61          */
  62         if ( (qrbuf->QRflags & QR_MAILBOX) == 0) {
  63                 fl = CtdlGetCachedFloor(qrbuf->QRfloor);
  64                 if (fl->f_ep.expire_mode != 0) {
  65                         memcpy(epbuf, &fl->f_ep, sizeof(struct ExpirePolicy));
  66                         return;
  67                 }
  68         }
  69
  70         /* (Mailbox rooms)
  71          * If there is a default policy for mailbox rooms, return it
  72          */
  73         if (qrbuf->QRflags & QR_MAILBOX) {
  74                 if (config.c_mbxep.expire_mode != 0) {
  75                         memcpy(epbuf, &config.c_mbxep, sizeof(struct ExpirePolicy));
  76                         return;
  77                 }
  78         }
  79
  80         /* Otherwise, fall back on the system default */
  81         memcpy(epbuf, &config.c_ep, sizeof(struct ExpirePolicy));
  82 }
  83
  84
  85 /*
  86  * Get Policy EXpire
  87  */
  88 void cmd_gpex(char *argbuf) {
  89         struct ExpirePolicy exp;
  90         struct floor *fl;
  91         char which[128];
  92
  93         extract_token(which, argbuf, 0, '|', sizeof which);
  94         if (!strcasecmp(which, strof(roompolicy))||
  95             !strcasecmp(which, "room")) { /* Deprecated version */
  96                 memcpy(&exp, &CC->room.QRep, sizeof(struct ExpirePolicy));
  97         }
  98         else if (!strcasecmp(which, strof(floorpolicy))||
  99                  !strcasecmp(which, "floor")) { /* Deprecated version */
 100                 fl = CtdlGetCachedFloor(CC->room.QRfloor);
 101                 memcpy(&exp, &fl->f_ep, sizeof(struct ExpirePolicy));
 102         }
 103         else if (!strcasecmp(which, strof(mailboxespolicy))||
 104                  !strcasecmp(which, "mailboxes")) {/* Deprecated version */
 105                 memcpy(&exp, &config.c_mbxep, sizeof(struct ExpirePolicy));
 106         }
 107         else if (!strcasecmp(which, strof(sitepolicy))||
 108                  !strcasecmp(which, "site")) {/* Deprecated version */
 109                 memcpy(&exp, &config.c_ep, sizeof(struct ExpirePolicy));
 110         }
 111         else {
 112                 cprintf("%d Invalid keyword \"%s\"\n", ERROR + ILLEGAL_VALUE, which);
 113                 return;
 114         }
 115
 116         cprintf("%d %d|%d\n", CIT_OK, exp.expire_mode, exp.expire_value);
 117 }
 118
 119
 120 /*
 121  * Set Policy EXpire
 122  */
 123 void cmd_spex(char *argbuf) {
 124         struct ExpirePolicy exp;
 125         struct floor flbuf;
 126         char which[128];
 127
 128         memset(&exp, 0, sizeof(struct ExpirePolicy));
 129         extract_token(which, argbuf, 0, '|', sizeof which);
 130         exp.expire_mode = extract_int(argbuf, 1);
 131         exp.expire_value = extract_int(argbuf, 2);
 132
 133         if ((exp.expire_mode < 0) || (exp.expire_mode > 3)) {
 134                 cprintf("%d Invalid policy.\n", ERROR + ILLEGAL_VALUE);
 135                 return;
 136         }
 137
 138         if (    (!strcasecmp(which, strof(roompolicy)))
 139                 || (!strcasecmp(which, "room"))
 140         ) {
 141                 if (!is_room_aide()) {
 142                         cprintf("%d Higher access required.\n", ERROR + HIGHER_ACCESS_REQUIRED);
 143                         return;
 144                 }
 145                 CtdlGetRoomLock(&CC->room, CC->room.QRname);
 146                 memcpy(&CC->room.QRep, &exp, sizeof(struct ExpirePolicy));
 147                 CtdlPutRoomLock(&CC->room);
 148                 cprintf("%d Room expire policy for '%s' has been updated.\n", CIT_OK, CC->room.QRname);
 149                 syslog(LOG_DEBUG, "Room: %s , Policy: %d , Value: %d",
 150                         CC->room.QRname,
 151                         exp.expire_mode,
 152                         exp.expire_value
 153                 );
 154                 return;
 155         }
 156
 157         if (CC->user.axlevel < AxAideU) {
 158                 cprintf("%d Higher access required.\n", ERROR + HIGHER_ACCESS_REQUIRED);
 159                 return;
 160         }
 161
 162         if (    (!strcasecmp(which, strof(floorpolicy)))
 163                 || (!strcasecmp(which, "floor"))
 164         ) {
 165                 lgetfloor(&flbuf, CC->room.QRfloor);
 166                 memcpy(&flbuf.f_ep, &exp, sizeof(struct ExpirePolicy));
 167                 lputfloor(&flbuf, CC->room.QRfloor);
 168                 cprintf("%d Floor expire policy has been updated.\n", CIT_OK);
 169                 return;
 170         }
 171
 172         else if (       (!strcasecmp(which, strof(mailboxespolicy)))
 173                         || (!strcasecmp(which, "mailboxes"))
 174                 ) {
 175                 memcpy(&config.c_mbxep, &exp, sizeof(struct ExpirePolicy));
 176                 put_config();
 177                 cprintf("%d Default expire policy for mailboxes set.\n", CIT_OK);
 178                 return;
 179         }
 180
 181         else if (       (!strcasecmp(which, strof(sitepolicy)))
 182                         || (!strcasecmp(which, "site"))
 183                 ) {
 184                 if (exp.expire_mode == EXPIRE_NEXTLEVEL) {
 185                         cprintf("%d Invalid policy (no higher level)\n",
 186                                 ERROR + ILLEGAL_VALUE);
 187                         return;
 188                 }
 189                 memcpy(&config.c_ep, &exp, sizeof(struct ExpirePolicy));
 190                 put_config();
 191                 cprintf("%d Site expire policy has been updated.\n", CIT_OK);
 192                 return;
 193         }
 194
 195         cprintf("%d Invalid keyword '%s'\n", ERROR + ILLEGAL_VALUE, which);
 196 }