clam.hxx

   1 /*
   2  * inoclam - Inotify+ClamAV virus scanner
   3  * Copyright (C) 2007 Vermont Department of Taxes
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  *
  19  * Contributor(s):
  20  *   Tom Cort <tom.cort@state.vt.us>
  21  *   Matt Gagne <matt.gagne@state.vt.us>
  22  */
  23
  24 #ifndef __CLAM_HXX
  25 #define __CLAM_HXX
  26
  27 #include <confuse.h>
  28 #include <pthread.h>
  29 #include <string>
  30
  31 #include "config.hxx"
  32
  33 /**
  34  * Thread that reloads virus definitions as needed
  35  */
  36 void *clam_refresh(void *v);
  37
  38 class clam {
  39       private:
  40
  41
  42       public:
  43 /* TODO: make these private */
  44
  45 /**
  46  * Let's use know if clam_refresh is running or not.
  47  */
  48         bool refresh_thread_alive;
  49
  50 /**
  51  * A lock used to serialize access to the engine. Serialized access is
  52  * needed to keep clam_refresh() from changing the engine while
  53  * contains_virus() is using it.
  54  * @see clam_refresh()
  55  * @see contains_virus()
  56  */
  57         pthread_mutex_t engine_lock;
  58
  59 /**
  60  * Thread attributes used by the clam_refresh() thread. This is
  61  * a global so that main() can free them when its cleaning up.
  62  * @see main()
  63  * @see clam_refresh()
  64  */
  65         pthread_attr_t ta;
  66
  67 /**
  68  * Multiple threads are using and altering "engine".
  69  * Use the engine_lock to prevent concurrency issues.
  70  */
  71         struct cl_engine *engine;
  72
  73
  74
  75 /**
  76  * Load the virus definition files and prepare the engine.
  77  */
  78          clam();
  79
  80 /**
  81  * Scans a file for virus.
  82  * @return -1 Error || 0 No Virus || +1 Virus Found
  83  */
  84         int clam_scan(std::string * filename, config * conf);
  85
  86 /**
  87  * Free resources used by the engine.
  88  */
  89         ~clam();
  90
  91 };
  92 #endif