source3/utils/net_cache.c

   1 /*
   2    Samba Unix/Linux SMB client library
   3    Distributed SMB/CIFS Server Management Utility
   4    Copyright (C) Rafal Szczesniak    2002
   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 3 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, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "includes.h"
  21 #include "net.h"
  22
  23 /**
  24  * @file net_cache.c
  25  * @brief This is part of the net tool which is basically command
  26  *        line wrapper for gencache.c functions (mainly for testing)
  27  *
  28  **/
  29
  30
  31 /*
  32  * These routines are used via gencache_iterate() to display the cache's contents
  33  * (print_cache_entry) and to flush it (delete_cache_entry).
  34  * Both of them are defined by first arg of gencache_iterate() routine.
  35  */
  36 static void print_cache_entry(const char* keystr, const char* datastr,
  37                               const time_t timeout, void* dptr)
  38 {
  39         char *timeout_str;
  40         char *alloc_str = NULL;
  41         time_t now_t = time(NULL);
  42         struct tm timeout_tm, *now_tm;
  43         /* localtime returns statically allocated pointer, so timeout_tm
  44            has to be copied somewhere else */
  45
  46         now_tm = localtime(&timeout);
  47         if (!now_tm) {
  48                 return;
  49         }
  50         memcpy(&timeout_tm, now_tm, sizeof(struct tm));
  51         now_tm = localtime(&now_t);
  52         if (!now_tm) {
  53                 return;
  54         }
  55
  56         /* form up timeout string depending whether it's today's date or not */
  57         if (timeout_tm.tm_year != now_tm->tm_year ||
  58                         timeout_tm.tm_mon != now_tm->tm_mon ||
  59                         timeout_tm.tm_mday != now_tm->tm_mday) {
  60
  61                 timeout_str = asctime(&timeout_tm);
  62                 if (!timeout_str) {
  63                         return;
  64                 }
  65                 timeout_str[strlen(timeout_str) - 1] = '\0';    /* remove tailing CR */
  66         } else {
  67                 if (asprintf(&alloc_str, "%.2d:%.2d:%.2d", timeout_tm.tm_hour,
  68                          timeout_tm.tm_min, timeout_tm.tm_sec) == -1) {
  69                         return;
  70                 }
  71                 timeout_str = alloc_str;
  72         }
  73
  74         d_printf(_("Key: %s\t Timeout: %s\t Value: %s  %s\n"), keystr,
  75                  timeout_str, datastr, timeout > now_t ? "": _("(expired)"));
  76
  77         SAFE_FREE(alloc_str);
  78 }
  79
  80 static void delete_cache_entry(const char* keystr, const char* datastr,
  81                                const time_t timeout, void* dptr)
  82 {
  83         if (!gencache_del(keystr))
  84                 d_fprintf(stderr, _("Couldn't delete entry! key = %s\n"),
  85                           keystr);
  86 }
  87
  88
  89 /**
  90  * Parse text representation of timeout value
  91  *
  92  * @param timeout_str string containing text representation of the timeout
  93  * @return numeric timeout of time_t type
  94  **/
  95 static time_t parse_timeout(const char* timeout_str)
  96 {
  97         char sign = '\0', *number = NULL, unit = '\0';
  98         int len, number_begin, number_end;
  99         time_t timeout;
 100
 101         /* sign detection */
 102         if (timeout_str[0] == '!' || timeout_str[0] == '+') {
 103                 sign = timeout_str[0];
 104                 number_begin = 1;
 105         } else {
 106                 number_begin = 0;
 107         }
 108
 109         /* unit detection */
 110         len = strlen(timeout_str);
 111         switch (timeout_str[len - 1]) {
 112         case 's':
 113         case 'm':
 114         case 'h':
 115         case 'd':
 116         case 'w': unit = timeout_str[len - 1];
 117         }
 118
 119         /* number detection */
 120         len = (sign) ? strlen(&timeout_str[number_begin]) : len;
 121         number_end = (unit) ? len - 1 : len;
 122         number = SMB_STRNDUP(&timeout_str[number_begin], number_end);
 123
 124         /* calculate actual timeout value */
 125         timeout = (time_t)atoi(number);
 126
 127         switch (unit) {
 128         case 'm': timeout *= 60; break;
 129         case 'h': timeout *= 60*60; break;
 130         case 'd': timeout *= 60*60*24; break;
 131         case 'w': timeout *= 60*60*24*7; break;  /* that's fair enough, I think :) */
 132         }
 133
 134         switch (sign) {
 135         case '!': timeout = time(NULL) - timeout; break;
 136         case '+':
 137         default:  timeout += time(NULL); break;
 138         }
 139
 140         if (number) SAFE_FREE(number);
 141         return timeout;
 142 }
 143
 144
 145 /**
 146  * Add an entry to the cache. If it does exist, then set it.
 147  *
 148  * @param c     A net_context structure
 149  * @param argv key, value and timeout are passed in command line
 150  * @return 0 on success, otherwise failure
 151  **/
 152 static int net_cache_add(struct net_context *c, int argc, const char **argv)
 153 {
 154         const char *keystr, *datastr, *timeout_str;
 155         time_t timeout;
 156
 157         if (argc < 3 || c->display_usage) {
 158                 d_printf(_("\nUsage:\nnet cache add <key string> <data string> "
 159                            "<timeout>\n"));
 160                 return -1;
 161         }
 162
 163         keystr = argv[0];
 164         datastr = argv[1];
 165         timeout_str = argv[2];
 166
 167         /* parse timeout given in command line */
 168         timeout = parse_timeout(timeout_str);
 169         if (!timeout) {
 170                 d_fprintf(stderr, _("Invalid timeout argument.\n"));
 171                 return -1;
 172         }
 173
 174         if (gencache_set(keystr, datastr, timeout)) {
 175                 d_printf(_("New cache entry stored successfully.\n"));
 176                 return 0;
 177         }
 178
 179         d_fprintf(stderr, _("Entry couldn't be added. Perhaps there's already such a key.\n"));
 180         return -1;
 181 }
 182
 183 /**
 184  * Delete an entry in the cache
 185  *
 186  * @param c     A net_context structure
 187  * @param argv key to delete an entry of
 188  * @return 0 on success, otherwise failure
 189  **/
 190 static int net_cache_del(struct net_context *c, int argc, const char **argv)
 191 {
 192         const char *keystr = argv[0];
 193
 194         if (argc < 1 || c->display_usage) {
 195                 d_printf(_("\nUsage: net cache del <key string>\n"));
 196                 return -1;
 197         }
 198
 199         if(gencache_del(keystr)) {
 200                 d_printf(_("Entry deleted.\n"));
 201                 return 0;
 202         }
 203
 204         d_fprintf(stderr, _("Couldn't delete specified entry\n"));
 205         return -1;
 206 }
 207
 208
 209 /**
 210  * Get and display an entry from the cache
 211  *
 212  * @param c     A net_context structure
 213  * @param argv key to search an entry of
 214  * @return 0 on success, otherwise failure
 215  **/
 216 static int net_cache_get(struct net_context *c, int argc, const char **argv)
 217 {
 218         const char* keystr = argv[0];
 219         char* valuestr = NULL;
 220         time_t timeout;
 221
 222         if (argc < 1 || c->display_usage) {
 223                 d_printf(_("\nUsage: net cache get <key>\n"));
 224                 return -1;
 225         }
 226
 227         if (gencache_get(keystr, &valuestr, &timeout)) {
 228                 print_cache_entry(keystr, valuestr, timeout, NULL);
 229                 SAFE_FREE(valuestr);
 230                 return 0;
 231         }
 232
 233         d_fprintf(stderr, _("Failed to find entry\n"));
 234         return -1;
 235 }
 236
 237
 238 /**
 239  * Search an entry/entries in the cache
 240  *
 241  * @param c     A net_context structure
 242  * @param argv key pattern to match the entries to
 243  * @return 0 on success, otherwise failure
 244  **/
 245 static int net_cache_search(struct net_context *c, int argc, const char **argv)
 246 {
 247         const char* pattern;
 248
 249         if (argc < 1 || c->display_usage) {
 250                 d_printf(_("Usage: net cache search <pattern>\n"));
 251                 return -1;
 252         }
 253
 254         pattern = argv[0];
 255         gencache_iterate(print_cache_entry, NULL, pattern);
 256         return 0;
 257 }
 258
 259
 260 /**
 261  * List the contents of the cache
 262  *
 263  * @param c     A net_context structure
 264  * @param argv ignored in this functionailty
 265  * @return always returns 0
 266  **/
 267 static int net_cache_list(struct net_context *c, int argc, const char **argv)
 268 {
 269         const char* pattern = "*";
 270
 271         if (c->display_usage) {
 272                 d_printf(_("Usage:\n"
 273                            "net cache list\n"
 274                            "    List all cache entries.\n"));
 275                 return 0;
 276         }
 277         gencache_iterate(print_cache_entry, NULL, pattern);
 278         return 0;
 279 }
 280
 281
 282 /**
 283  * Flush the whole cache
 284  *
 285  * @param c     A net_context structure
 286  * @param argv ignored in this functionality
 287  * @return always returns 0
 288  **/
 289 static int net_cache_flush(struct net_context *c, int argc, const char **argv)
 290 {
 291         const char* pattern = "*";
 292         if (c->display_usage) {
 293                 d_printf(_("Usage:\n"
 294                            "net cache flush\n"
 295                            "    Delete all cache entries.\n"));
 296                 return 0;
 297         }
 298         gencache_iterate(delete_cache_entry, NULL, pattern);
 299         return 0;
 300 }
 301
 302 static int net_cache_stabilize(struct net_context *c, int argc,
 303                                const char **argv)
 304 {
 305         if (c->display_usage) {
 306                 d_printf(_("Usage:\n"
 307                            "net cache flush\n"
 308                            "    Delete all cache entries.\n"));
 309                 return 0;
 310         }
 311
 312         if (!gencache_stabilize()) {
 313                 return -1;
 314         }
 315         return 0;
 316 }
 317 /**
 318  * Entry point to 'net cache' subfunctionality
 319  *
 320  * @param c     A net_context structure
 321  * @param argv arguments passed to further called functions
 322  * @return whatever further functions return
 323  **/
 324 int net_cache(struct net_context *c, int argc, const char **argv)
 325 {
 326         struct functable func[] = {
 327                 {
 328                         "add",
 329                         net_cache_add,
 330                         NET_TRANSPORT_LOCAL,
 331                         N_("Add new cache entry"),
 332                         N_("net cache add <key string> <data string> <timeout>\n"
 333                            "  Add new cache entry.\n"
 334                            "    key string\tKey string to add cache data under.\n"
 335                            "    data string\tData to store under given key.\n"
 336                            "    timeout\tTimeout for cache data.")
 337                 },
 338                 {
 339                         "del",
 340                         net_cache_del,
 341                         NET_TRANSPORT_LOCAL,
 342                         N_("Delete existing cache entry by key"),
 343                         N_("net cache del <key string>\n"
 344                            "  Delete existing cache entry by key.\n"
 345                            "    key string\tKey string to delete.")
 346                 },
 347                 {
 348                         "get",
 349                         net_cache_get,
 350                         NET_TRANSPORT_LOCAL,
 351                         N_("Get cache entry by key"),
 352                         N_("net cache get <key string>\n"
 353                            "  Get cache entry by key.\n"
 354                            "    key string\tKey string to look up cache entry for.")
 355
 356                 },
 357                 {
 358                         "search",
 359                         net_cache_search,
 360                         NET_TRANSPORT_LOCAL,
 361                         N_("Search entry by pattern"),
 362                         N_("net cache search <pattern>\n"
 363                            "  Search entry by pattern.\n"
 364                            "    pattern\tPattern to search for in cache.")
 365                 },
 366                 {
 367                         "list",
 368                         net_cache_list,
 369                         NET_TRANSPORT_LOCAL,
 370                         N_("List all cache entries"),
 371                         N_("net cache list\n"
 372                            "  List all cache entries")
 373                 },
 374                 {
 375                         "flush",
 376                         net_cache_flush,
 377                         NET_TRANSPORT_LOCAL,
 378                         N_("Delete all cache entries"),
 379                         N_("net cache flush\n"
 380                            "  Delete all cache entries")
 381                 },
 382                 {
 383                         "stabilize",
 384                         net_cache_stabilize,
 385                         NET_TRANSPORT_LOCAL,
 386                         N_("Move transient cache content to stable storage"),
 387                         N_("net cache stabilize\n"
 388                            "  Move transient cache content to stable storage")
 389                 },
 390                 {NULL, NULL, 0, NULL, NULL}
 391         };
 392
 393         return net_run_function(c, argc, argv, "net cache", func);
 394 }