flt_visited.c

Go to the documentation of this file.

/* {{{ Initial comments */
/*
 * $LastChangedDate: 2004-04-01 18:34:17 +0200 (Thu, 01 Apr 2004) $
 * $LastChangedRevision: 50 $
 * $LastChangedBy: ckruse $
 *
 */
/* }}} */

/* {{{ Includes */
#include "config.h"
#include "defines.h"

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <sys/types.h>
#include <sys/stat.h>

#include "readline.h"
#include "hashlib.h"
#include "utils.h"
#include "configparser.h"
#include "cfcgi.h"
#include "template.h"
#include "clientlib.h"
/* }}} */

struct {
  int   HighlightVisitedPostings;
  u_char *VisitedPostingsColorF;
  u_char *VisitedPostingsColorB;
  u_char *VisitedFile;
  t_cf_tree tree;
} Cfg = { 0, NULL, NULL, NULL, { NULL, NULL, NULL } };

int flt_visited_compare(t_cf_tree_dataset *a,t_cf_tree_dataset *b) {
  if(*((u_int64_t *)a->key) < *((u_int64_t *)b->key)) return -1;
  if(*((u_int64_t *)a->key) > *((u_int64_t *)b->key)) return 1;

  return 0;
}

void flt_visited_create_tree() {
  if(Cfg.tree.root == NULL) {
    FILE *fd;
    struct stat st;
    u_int64_t *field;
    u_int32_t i,nmem = 0;

    t_cf_tree_dataset data;
    data.data = NULL;

    if(stat(Cfg.VisitedFile,&st) == 0) {
      nmem  = st.st_size / sizeof(*field);
      field = fo_alloc(NULL,nmem,sizeof(*field),FO_ALLOC_MALLOC);

      if((fd = fopen(Cfg.VisitedFile,"r")) == NULL) {
        free(field);
        return;
      }

      fread(field,sizeof(*field),st.st_size / sizeof(*field),fd);
      fclose(fd);

      cf_tree_init(&Cfg.tree,flt_visited_compare,NULL);
      for(i=0;i<nmem;i++) {
        data.key = memdup(&field[i],sizeof(*field));
        cf_tree_insert(&Cfg.tree,NULL,&data);
      }

      free(field);
    }
    else {
      if((fd = fopen(Cfg.VisitedFile,"w")) != NULL) {
        fclose(fd);
      }
    }
  }
}

/* module api function, checks if message has been visited */
void *flt_visited_is_visited(void *vmid) {
  u_int64_t *mid = (u_int64_t *)vmid;
  t_cf_tree_dataset data;

  data.data = NULL;

  if(Cfg.VisitedFile) {
    flt_visited_create_tree();

    data.key = mid;
    if(cf_tree_find(&Cfg.tree,Cfg.tree.root,&data)) {
      return (void *)mid;
    }
  }

  return NULL;
}

/* module api function, mark a posting visited */
void *flt_visited_mark_visited(void *vmid) {
  u_int64_t *mid = (u_int64_t *)vmid;
  t_cf_tree_dataset data;
  FILE *fd;

  data.data = NULL;

  if(Cfg.VisitedFile) {
    flt_visited_create_tree();

    data.key = memdup(mid,sizeof(*mid));
    if(cf_tree_find(&Cfg.tree,Cfg.tree.root,&data) == NULL) {
      if((fd = fopen(Cfg.VisitedFile,"a")) != NULL) {
        cf_tree_insert(&Cfg.tree,NULL,&data);
        fwrite(mid,sizeof(*mid),1,fd);
        fclose(fd);

        return vmid;
      }
    }

    free(data.key);
  }

  return NULL;
}

/*
 * Returns: int   one of the FLT_* values
 * Parameters:
 *   - t_cf_hash *head          a pointer to the cgi paramter list
 *   - t_configuration *dc      a pointer to the default configuration
 *   - t_configuration *vc      a pointer to the fo_view configuration
 *   - t_configuration *uc      a pointer to the user config
 *
 * This function is the api function for the "mark visited messages" plugin. It is a
 * t_filter_begin function
 *
 */
int execute_filter(t_cf_hash *head,t_configuration *dc,t_configuration *vc,int sock) {
  u_char *uname = cf_hash_get(GlobalValues,"UserName",8);
  t_cf_tree_dataset data = { NULL, NULL };
  u_char *cmid;
  u_char *ctid;
  u_int64_t mid,tid;
  FILE *fd;
  int ret;
  rline_t tsd;
  t_message *msg;
  t_cl_thread thread;

  if(uname && Cfg.VisitedFile) {
    /* register module api */
    cf_register_mod_api_ent("flt_visited","is_visited",flt_visited_is_visited);
    cf_register_mod_api_ent("flt_visited","mark_visited",flt_visited_mark_visited);

    if(head && Cfg.HighlightVisitedPostings) {
      cmid = cf_cgi_get(head,"m");
      ctid  = cf_cgi_get(head,"mv");

      /* we shall mark a whole thread visited */
      if(ctid) {
        tid = strtoull(ctid,NULL,10);
        memset(&tsd,0,sizeof(tsd));
        memset(&thread,0,sizeof(thread));

        if(tid) {
          #ifdef CF_SHARED_MEM
          ret = cf_get_message_through_shm((void *)sock,&thread,NULL,tid,0,CF_KILL_DELETED);
          #else
          ret = cf_get_message_through_sock(sock,&tsd,&thread,NULL,tid,0,CF_KILL_DELETED);
          #endif

          if(ret == -1) {
            return FLT_DECLINE;
          }

          if((fd = fopen(Cfg.VisitedFile,"a")) == NULL) {
            return FLT_DECLINE;
          }

          for(msg=thread.messages;msg;msg=msg->next) {
            data.key = memdup(&msg->mid,sizeof(msg->mid));

            if(!cf_tree_find(&Cfg.tree,Cfg.tree.root,&data)) {
              fwrite(&msg->mid,sizeof(msg->mid),1,fd);
              cf_tree_insert(&Cfg.tree,NULL,&data);
            }
          }

          cleanup_struct(&thread);
          fclose(fd);
        }
      }

      /* we shall only mark a message visited */
      else if(cmid) {
        mid = strtoull(cmid,NULL,10);

        if(mid) {
          flt_visited_create_tree();

          data.key = memdup(&mid,sizeof(mid));

          if(!cf_tree_find(&Cfg.tree,Cfg.tree.root,&data)) {
            cf_tree_insert(&Cfg.tree,NULL,&data);
            fd = fopen(Cfg.VisitedFile,"a");
            if(fd) {
              fwrite(&mid,sizeof(mid),1,fd);
              fclose(fd);
            }
          }
          else {
            free(data.key);
          }
        }
      }

      return FLT_OK;
    }
  }

  return FLT_DECLINE;
}

int set_col(t_cf_hash *head,t_configuration *dc,t_configuration *vc,t_cf_template *begin,t_cf_template *end) {
  if(Cfg.VisitedPostingsColorF || Cfg.VisitedPostingsColorB) {
    tpl_cf_setvar(begin,"visitedcol","1",1,0);

    if(Cfg.VisitedPostingsColorF && *Cfg.VisitedPostingsColorF) {
      tpl_cf_setvar(begin,"visitedcolfg",Cfg.VisitedPostingsColorF,strlen(Cfg.VisitedPostingsColorF),0);
    }
    if(Cfg.VisitedPostingsColorB && *Cfg.VisitedPostingsColorB) {
      tpl_cf_setvar(begin,"visitedcolbg",Cfg.VisitedPostingsColorB,strlen(Cfg.VisitedPostingsColorB),0);
    }
  }

  return FLT_OK;
}

int posting_handler(t_cf_hash *head,t_configuration *dc,t_configuration *vc,t_cl_thread *thread,t_cf_template *tpl) {
  return set_col(head,dc,vc,tpl,NULL);
}

int mark_visited(t_cf_hash *head,t_configuration *dc,t_configuration *vc,t_message *msg,unsigned long long tid,int mode) {
  u_char *uname = cf_hash_get(GlobalValues,"UserName",8);
  t_cf_tree_dataset data;

  data.data = NULL;

  if(uname && Cfg.VisitedFile && Cfg.HighlightVisitedPostings) {
    flt_visited_create_tree();

    data.key = memdup(&msg->mid,sizeof(msg->mid));
    if(cf_tree_find(&Cfg.tree,Cfg.tree.root,&data)) {
      tpl_cf_setvar(&msg->tpl,"visited","1",1,0);
    }

    return FLT_OK;
  }

  return FLT_DECLINE;
}

int flt_visit_handle_command(t_configfile *cf,t_conf_opt *opt,u_char **args,int argnum) {
  if(cf_strcmp(opt->name,"HighlightVisitedPostings") == 0) {
    Cfg.HighlightVisitedPostings = !cf_strcmp(args[0],"yes");
  }
  else if(cf_strcmp(opt->name,"VisitedPostingsColors") == 0) {
    if(Cfg.VisitedPostingsColorF) free(Cfg.VisitedPostingsColorF);
    if(Cfg.VisitedPostingsColorB) free(Cfg.VisitedPostingsColorB);
    Cfg.VisitedPostingsColorF = strdup(args[0]);
    Cfg.VisitedPostingsColorB = strdup(args[1]);
  }
  else if(cf_strcmp(opt->name,"VisitedFile") == 0) {
    if(Cfg.VisitedFile) free(Cfg.VisitedFile);
    Cfg.VisitedFile = strdup(args[0]);
  }

  return 0;
}

int flt_visited_validate(t_cf_hash *head,t_configuration *dc,t_configuration *vc,time_t last_modified,int sock) {
  struct stat st;

  if(Cfg.VisitedFile) {
    if(stat(Cfg.VisitedFile,&st) == -1) return FLT_DECLINE;
    if(st.st_mtime > last_modified) return FLT_EXIT;
  }

  return FLT_OK;
}

time_t flt_visited_lm(t_cf_hash *head,t_configuration *dc,t_configuration *vc,int sock) {
  struct stat st;

  if(Cfg.VisitedFile) {
    if(stat(Cfg.VisitedFile,&st) == -1) return -1;
    return st.st_mtime;
  }


  return -1;
}

void flt_visited_cleanup(void) {
  if(Cfg.VisitedPostingsColorF) free(Cfg.VisitedPostingsColorF);
  if(Cfg.VisitedPostingsColorB) free(Cfg.VisitedPostingsColorB);
  if(Cfg.VisitedFile)      free(Cfg.VisitedFile);

  cf_tree_destroy(&Cfg.tree);
}

t_conf_opt flt_visited_config[] = {
  { "HighlightVisitedPostings", flt_visit_handle_command, NULL },
  { "VisitedPostingsColors",    flt_visit_handle_command, NULL },
  { "VisitedFile",              flt_visit_handle_command, NULL },
  { NULL, NULL, NULL }
};

t_handler_config flt_visited_handlers[] = {
  { CONNECT_INIT_HANDLER, execute_filter  },
  { VIEW_INIT_HANDLER,    set_col         },
  { POSTING_HANDLER,      posting_handler },
  { VIEW_LIST_HANDLER,    mark_visited    },
  { 0, NULL }
};

t_module_config flt_visited = {
  flt_visited_config,
  flt_visited_handlers,
  flt_visited_validate,
  flt_visited_lm,
  NULL,
  flt_visited_cleanup
};


/* eof */

---