rset/rstemp.c

   1 /* $Id: rstemp.c,v 1.59 2005-01-17 00:01:51 adam Exp $
   2    Copyright (C) 1995-2005
   3    Index Data ApS
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23 #include <assert.h>
  24 #include <fcntl.h>
  25 #include <stdlib.h>
  26 #include <stdio.h>
  27 #include <string.h>
  28 #ifdef WIN32
  29 #include <io.h>
  30 #else
  31 #include <unistd.h>
  32 #endif
  33 #include <sys/types.h>
  34
  35 #include <zebrautl.h>
  36 #include <rset.h>
  37
  38 static RSFD r_open (RSET ct, int flag);
  39 static void r_close (RSFD rfd);
  40 static void r_delete (RSET ct);
  41 static int r_read (RSFD rfd, void *buf, TERMID *term);
  42 static int r_write (RSFD rfd, const void *buf);
  43 static void r_pos (RSFD rfd, double *current, double  *total);
  44 static void r_flush (RSFD rfd, int mk);
  45 static void r_reread (RSFD rfd);
  46
  47
  48 static const struct rset_control control =
  49 {
  50     "temp",
  51     r_delete,
  52     rset_get_one_term,
  53     r_open,
  54     r_close,
  55     rset_default_forward,
  56     r_pos,
  57     r_read,
  58     r_write,
  59 };
  60
  61 const struct rset_control *rset_kind_temp = &control;
  62
  63 struct rset_temp_info {
  64     int     fd;            /* file descriptor for temp file */
  65     char   *fname;         /* name of temp file */
  66     char   *buf_mem;       /* window buffer */
  67     size_t  buf_size;      /* size of window */
  68     size_t  pos_end;       /* last position in set */
  69     size_t  pos_buf;       /* position of first byte in window */
  70     size_t  pos_border;    /* position of last byte+1 in window */
  71     int     dirty;         /* window is dirty */
  72     zint     hits;          /* no of hits */
  73     char   *temp_path;
  74 };
  75
  76 struct rset_temp_rfd {
  77     void *buf;
  78     size_t  pos_cur;       /* current position in set */
  79                            /* FIXME - term pos or what ??  */
  80     zint cur; /* number of the current hit */
  81 };
  82
  83 static int log_level=0;
  84 static int log_level_initialized=0;
  85
  86 RSET rstemp_create( NMEM nmem, const struct key_control *kcontrol,
  87                     int scope,
  88                     const char *temp_path, TERMID term)
  89 {
  90     RSET rnew=rset_create_base(&control, nmem, kcontrol, scope,term);
  91     struct rset_temp_info *info;
  92     if (!log_level_initialized)
  93     {
  94         log_level=yaz_log_module_level("rstemp");
  95         log_level_initialized=1;
  96     }
  97     info = (struct rset_temp_info *) nmem_malloc(rnew->nmem, sizeof(*info));
  98     info->fd = -1;
  99     info->fname = NULL;
 100     info->buf_size = 4096;
 101     info->buf_mem = (char *) nmem_malloc (rnew->nmem, info->buf_size);
 102     info->pos_end = 0;
 103     info->pos_buf = 0;
 104     info->dirty = 0;
 105     info->hits = 0;
 106
 107     if (!temp_path)
 108         info->temp_path = NULL;
 109     else
 110         info->temp_path = nmem_strdup(rnew->nmem, temp_path);
 111     rnew->priv=info;
 112     return rnew;
 113 } /* rstemp_create */
 114
 115 static void r_delete (RSET ct)
 116 {
 117     struct rset_temp_info *info = (struct rset_temp_info*) ct->priv;
 118
 119     yaz_log (log_level, "r_delete: set size %ld", (long) info->pos_end);
 120     if (info->fname)
 121     {
 122         yaz_log (log_level, "r_delete: unlink %s", info->fname);
 123         unlink (info->fname);
 124     }
 125 }
 126
 127
 128 static RSFD r_open (RSET ct, int flag)
 129 {
 130     struct rset_temp_info *info = (struct rset_temp_info *) ct->priv;
 131     RSFD rfd;
 132     struct rset_temp_rfd *prfd;
 133
 134     if (info->fd == -1 && info->fname)
 135     {
 136         if (flag & RSETF_WRITE)
 137             info->fd = open (info->fname, O_BINARY|O_RDWR|O_CREAT, 0666);
 138         else
 139             info->fd = open (info->fname, O_BINARY|O_RDONLY);
 140         if (info->fd == -1)
 141         {
 142             yaz_log (YLOG_FATAL|YLOG_ERRNO, "rstemp: open failed %s", info->fname);
 143             exit (1);
 144         }
 145     }
 146     rfd = rfd_create_base(ct);
 147     if (!rfd->priv){
 148         prfd= (struct rset_temp_rfd *) nmem_malloc(ct->nmem, sizeof(*prfd));
 149         rfd->priv=(void *)prfd;
 150         prfd->buf = nmem_malloc (ct->nmem,ct->keycontrol->key_size);
 151     } else
 152         prfd= rfd->priv;
 153     r_flush (rfd, 0);
 154     prfd->pos_cur = 0;
 155     info->pos_buf = 0;
 156     r_reread (rfd);
 157     prfd->cur = 0;
 158     return rfd;
 159 }
 160
 161 /* r_flush:
 162       flush current window to file if file is assocated with set
 163  */
 164 static void r_flush (RSFD rfd, int mk)
 165 {
 166     /* struct rset_temp_info *info = ((struct rset_temp_rfd*) rfd)->info; */
 167     struct rset_temp_info *info = rfd->rset->priv;
 168
 169     if (!info->fname && mk)
 170     {
 171 #if HAVE_MKSTEMP
 172         char template[1024];
 173         if (info->temp_path)
 174             sprintf(template, "%s/zrsXXXXXX", info->temp_path);
 175         else
 176             sprintf(template, "zrsXXXXXX");
 177
 178         info->fd = mkstemp(template);
 179
 180         if (info->fd == -1)
 181         {
 182             yaz_log(YLOG_FATAL|YLOG_ERRNO, "rstemp: mkstemp %s", template);
 183             exit (1);
 184         }
 185         info->fname = nmem_strdup(rfd->rset->nmem, template);
 186 #else
 187         char *s = (char*) tempnam (info->temp_path, "zrs");
 188         info->fname= nmem_strdup(rfd->rset->nmem, s);
 189
 190         yaz_log(log_level, "creating tempfile %s", info->fname);
 191         info->fd = open(info->fname, O_BINARY|O_RDWR|O_CREAT, 0666);
 192         if (info->fd == -1)
 193         {
 194             yaz_log(YLOG_FATAL|YLOG_ERRNO, "rstemp: open %s", info->fname);
 195             exit (1);
 196         }
 197 #endif
 198     }
 199     if (info->fname && info->fd != -1 && info->dirty)
 200     {
 201         size_t count;
 202         int r;
 203
 204         if (lseek (info->fd, info->pos_buf, SEEK_SET) == -1)
 205         {
 206             yaz_log (YLOG_FATAL|YLOG_ERRNO, "rstemp: lseek %s", info->fname);
 207             exit (1);
 208         }
 209         count = info->buf_size;
 210         if (count > info->pos_end - info->pos_buf)
 211             count = info->pos_end - info->pos_buf;
 212         if ((r = write (info->fd, info->buf_mem, count)) < (int) count)
 213         {
 214             if (r == -1)
 215                 yaz_log (YLOG_FATAL|YLOG_ERRNO, "rstemp: write %s", info->fname);
 216             else
 217                 yaz_log (YLOG_FATAL, "rstemp: write of %ld but got %ld",
 218                       (long) count, (long) r);
 219             exit (1);
 220         }
 221         info->dirty = 0;
 222     }
 223 }
 224
 225 static void r_close (RSFD rfd)
 226 {
 227     /*struct rset_temp_rfd *mrfd = (struct rset_temp_rfd*) rfd->priv; */
 228     struct rset_temp_info *info = (struct rset_temp_info *)rfd->rset->priv;
 229     r_flush (rfd, 0);
 230     if (info->fname && info->fd != -1)
 231     {
 232         close (info->fd);
 233         info->fd = -1;
 234     } /* FIXME - Is this right, don't we risk closing the file too early ?*/
 235     rfd_delete_base(rfd);
 236 }
 237
 238
 239 /* r_reread:
 240       read from file to window if file is assocated with set -
 241       indicated by fname
 242  */
 243 static void r_reread (RSFD rfd)
 244 {
 245     struct rset_temp_rfd *mrfd = (struct rset_temp_rfd*) rfd->priv;
 246     struct rset_temp_info *info = (struct rset_temp_info *)rfd->rset->priv;
 247
 248     if (info->fname)
 249     {
 250         size_t count;
 251         int r;
 252
 253         info->pos_border = mrfd->pos_cur +
 254             info->buf_size;
 255         if (info->pos_border > info->pos_end)
 256             info->pos_border = info->pos_end;
 257         count = info->pos_border - info->pos_buf;
 258         if (count > 0)
 259         {
 260             if (lseek (info->fd, info->pos_buf, SEEK_SET) == -1)
 261             {
 262                 yaz_log (YLOG_FATAL|YLOG_ERRNO, "rstemp: lseek %s", info->fname);
 263                 exit (1);
 264             }
 265             if ((r = read (info->fd, info->buf_mem, count)) < (int) count)
 266             {
 267                 if (r == -1)
 268                     yaz_log (YLOG_FATAL|YLOG_ERRNO, "rstemp: read %s", info->fname);
 269                 else
 270                     yaz_log (YLOG_FATAL, "read of %ld but got %ld",
 271                           (long) count, (long) r);
 272                 exit (1);
 273             }
 274         }
 275     }
 276     else
 277         info->pos_border = info->pos_end;
 278 }
 279
 280
 281 static int r_read (RSFD rfd, void *buf, TERMID *term)
 282 {
 283     struct rset_temp_rfd *mrfd = (struct rset_temp_rfd*) rfd->priv;
 284     struct rset_temp_info *info = (struct rset_temp_info *)rfd->rset->priv;
 285
 286     size_t nc = mrfd->pos_cur + rfd->rset->keycontrol->key_size;
 287
 288     if (mrfd->pos_cur < info->pos_buf || nc > info->pos_border)
 289     {
 290         if (nc > info->pos_end)
 291             return 0;
 292         r_flush (rfd, 0);
 293         info->pos_buf = mrfd->pos_cur;
 294         r_reread (rfd);
 295     }
 296     memcpy (buf, info->buf_mem + (mrfd->pos_cur - info->pos_buf),
 297             rfd->rset->keycontrol->key_size);
 298     if (term)
 299         *term=rfd->rset->term;
 300         /* FIXME - should we store and return terms ?? */
 301     mrfd->pos_cur = nc;
 302     mrfd->cur++;
 303     return 1;
 304 }
 305
 306 static int r_write (RSFD rfd, const void *buf)
 307 {
 308     struct rset_temp_rfd *mrfd = (struct rset_temp_rfd*) rfd->priv;
 309     struct rset_temp_info *info = (struct rset_temp_info *)rfd->rset->priv;
 310
 311     size_t nc = mrfd->pos_cur + rfd->rset->keycontrol->key_size;
 312
 313     if (nc > info->pos_buf + info->buf_size)
 314     {
 315         r_flush (rfd, 1);
 316         info->pos_buf = mrfd->pos_cur;
 317         if (info->pos_buf < info->pos_end)
 318             r_reread (rfd);
 319     }
 320     info->dirty = 1;
 321     memcpy (info->buf_mem + (mrfd->pos_cur - info->pos_buf), buf,
 322             rfd->rset->keycontrol->key_size);
 323     mrfd->pos_cur = nc;
 324     if (nc > info->pos_end)
 325         info->pos_border = info->pos_end = nc;
 326     info->hits++;
 327     return 1;
 328 }
 329
 330 static void r_pos (RSFD rfd, double  *current, double  *total)
 331 {
 332     /* struct rset_temp_rfd *mrfd = (struct rset_temp_rfd*) rfd; */
 333     struct rset_temp_rfd *mrfd = (struct rset_temp_rfd*) rfd->priv;
 334     struct rset_temp_info *info = (struct rset_temp_info *)rfd->rset->priv;
 335
 336     *current=(double) mrfd->cur;
 337     *total=(double) info->hits;
 338 }