git.pond.sub.org Git - empserver/blob - src/lib/common/hours.c

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2007, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                           Ken Stevens, Steve McClure
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  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.
  15  *
  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
  19  *
  20  *  ---
  21  *
  22  *  See files README, COPYING and CREDITS in the root of the source
  23  *  tree for related information and legal notices.  It is expected
  24  *  that future projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  hours.c: Game hours determination; is it legal to play now?
  29  *
  30  *  Known contributors to this file:
  31  *     Dave Pare, 1989
  32  *     Doug Hay, 1998
  33  *     Steve McClure, 1998
  34  *     Markus Armbruster, 2004
  35  */
  36
  37 #include <config.h>
  38
  39 #include <ctype.h>
  40 #include <limits.h>
  41 #include <time.h>
  42 #include "misc.h"
  43 #include "optlist.h"
  44 #include "prototypes.h"
  45
  46 static char *weekday(char *str, int *wday);
  47 static char *daytime(char *str, int *min);
  48 static char *daytime_range(char *str, int *from_min, int *to_min);
  49
  50 /*
  51  * Is week day WDAY (Sunday is 0) allowed by restriction DAYS?
  52  * If DAYS is not empty, it lists the allowed week day names.  See
  53  * weekday() for syntax.
  54  */
  55 int
  56 is_wday_allowed(int wday, char *days)
  57 {
  58     int wd;
  59
  60     if (!days || !*days)
  61         return 1;
  62
  63     while (NULL != (days = weekday(days, &wd)))
  64         if (wd == wday)
  65             return 1;
  66
  67     return 0;
  68 }
  69
  70 /*
  71  * Is day time DTIME (minutes since midnight) allowed by restriction TIMES?
  72  * If TIMES is not empty, it lists the allowed day time ranges.  See
  73  * daytime_range() for syntax.
  74  */
  75 int
  76 is_daytime_allowed(int dtime, char *times)
  77 {
  78     int from, to;
  79
  80     if (!times || !*times)
  81         return 1;
  82
  83     while (NULL != (times = daytime_range(times, &from, &to)))
  84         if (from <= dtime && dtime < to)
  85             return 1;
  86
  87     return 0;
  88 }
  89
  90 /*
  91  * Can the game played at time T?
  92  */
  93 int
  94 gamehours(time_t t)
  95 {
  96     struct tm *tm;
  97
  98     tm = localtime(&t);
  99     if (!is_wday_allowed(tm->tm_wday, game_days))
 100         return 0;
 101     return is_daytime_allowed(60 * tm->tm_hour + tm->tm_min, game_hours);
 102 }
 103
 104 /*
 105  * Is day time DTIME (minutes since midnight) near a time in TIMES?
 106  * TIMES is a list of day times.  See daytime() for syntax.
 107  * DTIME is near a listed time T if its within T and T + SLOP minutes.
 108  */
 109 int
 110 is_daytime_near(int dtime, char *times, int slop)
 111 {
 112     int dt;
 113
 114     if (times)
 115         while (NULL != (times = daytime(times, &dt)))
 116             if (dt <= dtime && dtime < dt + slop)
 117                 return 1;
 118
 119     return 0;
 120 }
 121
 122 /*
 123  * Return time in minutes between DTIME and next time in TIMES.
 124  * If TIMES doesn't give a time, return -1.
 125  * DTIME is day time in minutes since midnight.
 126  * TIMES is a list of day times.  See daytime() for syntax.
 127  */
 128 int
 129 min_to_next_daytime(int dtime, char *times)
 130 {
 131     int mindt = INT_MAX;
 132     int dt;
 133
 134     if (times) {
 135         while (NULL != (times = daytime(times, &dt))) {
 136             if (dt <= dtime)
 137                 dt += 24 * 60;  /* tomorrow */
 138             if (dt < mindt)
 139                 mindt = dt;
 140         }
 141     }
 142
 143     if (mindt == INT_MAX)
 144         return -1;
 145     return mindt - dtime;
 146 }
 147
 148 /*
 149  * Parse weekday name in STR.
 150  * On success assign day number (Sunday is 0) to *WDAY and return
 151  * pointer to first character not parsed.
 152  * Else return NULL.
 153  * Abbreviated names are recognized, but not single characters.
 154  * Initial whitespace is ignored.
 155  */
 156 static char *
 157 weekday(char *str, int *wday)
 158 {
 159     /*
 160      * strptime() format " %a" would do fine, but it's XPG and Windows
 161      * doesn't have it.  Besides, Empire accepts more abbreviations.
 162      */
 163     static char *day_name[7] = {
 164         "sunday", "monday", "tuesday", "wednesday",
 165         "thursday", "friday", "saturday" };
 166     int i, j;
 167
 168     for (; isspace(*str); ++str) ;
 169
 170     for (i = 0; i < 7; ++i) {
 171         j = 0;
 172         while (str[j] && tolower(str[j]) == day_name[i][j])
 173             ++j;
 174         if (j > 1) {
 175             *wday = i;
 176             return str + j;
 177         }
 178     }
 179
 180     return NULL;
 181 }
 182
 183 /*
 184  * Parse day time in STR.
 185  * On success store minutes since midnight in *MIN and return pointer
 186  * to first character not parsed.
 187  * Else return NULL.
 188  * Time format is HOUR:MINUTE.  Initial whitespace is ignored.
 189  */
 190 char *
 191 daytime(char *str, int *min)
 192 {
 193     /*
 194      * strptime() format " %H:%M" would do fine, but it's XPG and
 195      * Windows doesn't have it.
 196      */
 197     char *end;
 198     unsigned long h, m;
 199
 200     h = strtoul(str, &end, 10);
 201     if (end == str || h > 23)
 202         return NULL;
 203
 204     if (*end++ != ':')
 205         return NULL;
 206
 207     str = end;
 208     m = strtoul(str, &end, 10);
 209     if (end == str || m > 59)
 210         return NULL;
 211
 212     *min = 60 * h + m;
 213     return end;
 214 }
 215
 216 /*
 217  * Parse a day time range in STR.
 218  * On success store minutes since midnight in *FROM and *TO, return
 219  * pointer to first character not parsed.
 220  * Else return NULL.
 221  * Format is HOUR:MINUTE-HOUR:MINUTE.  Initial whitespace is ignored.
 222  */
 223 char *
 224 daytime_range(char *str, int *from_min, int *to_min)
 225 {
 226     char *end;
 227
 228     end = daytime(str, from_min);
 229     if (!end)
 230         return NULL;
 231     while (isspace(*end)) ++end;
 232     if (*end++ != '-')
 233         return NULL;
 234     return daytime(end, to_min);
 235 }