src/clam.hxx

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