Initial import of svn+ssh:://svn.icir.org/bro/trunk/bro as of r7088

src/File.h

@@ -0,0 +1,162 @@
+// $Id: File.h 6888 2009-08-20 18:23:11Z vern $
+//
+// See the file "COPYING" in the main distribution directory for copyright.
+
+#ifndef file_h
+#define file_h
+
+#include <fcntl.h>
+#include "util.h"
+#include "Obj.h"
+#include "Attr.h"
+
+#ifdef USE_OPENSSL
+# ifdef NEED_KRB5_H
+#  include <krb5.h>
+# endif // NEED_KRB5_H
+extern "C" {
+# include "openssl/evp.h"
+# include "openssl/pem.h"
+# include "openssl/err.h"
+}
+#endif
+
+class BroType;
+class RotateTimer;
+
+class BroFile : public BroObj {
+public:
+	BroFile(FILE* arg_f);
+	BroFile(FILE* arg_f, const char* filename, const char* access);
+	BroFile(const char* filename, const char* access, BroType* arg_t = 0);
+	virtual ~BroFile();
+
+	const char* Name() const;
+
+	// Returns false if an error occured.
+	int Write(const char* data, int len = 0);
+
+	void Flush()	{ fflush(f); }
+
+	FILE* Seek(long position);	// seek to absolute position
+
+	void SetBuf(bool buffered);	// false=line buffered, true=fully buffered
+
+	BroType* FType() const	{ return t; }
+
+	// Whether the file is open in a general sense; it might
+	// not be open as a Unix file due to our management of
+	// a finite number of FDs.
+	int IsOpen() const	{ return is_open; }
+
+	// Returns true if the close made sense, false if it was already
+	// closed, not active, or whatever.
+	int Close();
+
+	void Describe(ODesc* d) const;
+
+	void SetRotateInterval(double secs);
+
+	// Rotates the logfile. Returns rotate_info.
+	RecordVal* Rotate();
+
+	// Set &rotate_interval, &rotate_size, &postprocessor,
+	// &disable_print_hook, and &raw_output attributes.
+	void SetAttrs(Attributes* attrs);
+
+	// Returns the current size of the file, after fresh stat'ing.
+	double Size()	{ fflush(f); UpdateFileSize(); return current_size; }
+
+	// Set rotate/postprocessor for all files that don't define them
+	// by their own. (interval/max_size=0 for no rotation; size in bytes).
+	static void SetDefaultRotation(double interval, double max_size);
+
+	// Close all files which are managed by us.
+	static void CloseCachedFiles();
+
+	// Get the file with the given name, opening it if it doesn't yet exist.
+	static BroFile* GetFile(const char* name);
+
+	void DisablePrintHook() 	{ print_hook = false; }
+	bool IsPrintHookEnabled() const	{ return print_hook; }
+
+	void EnableRawOutput()		{ raw_output = true; }
+	bool IsRawOutput() const	{ return raw_output; }
+
+	bool Serialize(SerialInfo* info) const;
+	static BroFile* Unserialize(UnserialInfo* info);
+
+protected:
+	friend class RotateTimer;
+
+	BroFile()	{ Init(); }
+	void Init();
+	bool Open(FILE* f = 0);	// if file is given, it's an open file to use
+
+	BroFile* Prev()	{ return prev; }
+	BroFile* Next()	{ return next; }
+	void SetPrev(BroFile* f)	{ prev = f; }
+	void SetNext(BroFile* f)	{ next = f; }
+
+	void Suspend();
+	void PurgeCache();
+	void Unlink();
+	void InsertAtBeginning();
+	void MoveToBeginning();
+	void InstallRotateTimer();
+
+	// Returns nil if the file is not active, was in error, etc.
+	// (Protected because we do not want anyone to write directly
+	// to the file.)
+	FILE* File();
+	FILE* BringIntoCache();
+
+	// Stats the file to get its current size.
+	void UpdateFileSize();
+
+	// Initialize encryption with the given public key.
+	void InitEncrypt(const char* keyfile);
+	// Finalize encryption.
+	void FinishEncrypt();
+
+	DECLARE_SERIAL(BroFile);
+
+	FILE* f;
+	BroType* t;
+	char* name;
+	char* access;
+	int is_in_cache;	// whether it's currently in the open-file cache
+	int is_open;	// whether the file is open in a general sense
+	int okay_to_manage;	// we're allowed to cache/uncache
+	long position;	// only valid if ! is_in_cache
+	BroFile* next;	// doubly-linked list of cached files
+	BroFile* prev;
+	Attributes* attrs;
+	double rotate_interval;
+	bool buffered;
+
+	// Sizes are double's so that it's easy to specify large
+	// ones with scientific notation, and so they can exceed 4GB.
+	double rotate_size;
+	double current_size;
+
+	Timer* rotate_timer;
+	double open_time;
+	bool dont_rotate; // See InstallRotateTimer()
+	bool print_hook;
+	bool raw_output;
+
+	static double default_rotation_interval;
+	static double default_rotation_size;
+
+#ifdef USE_OPENSSL
+	EVP_PKEY* pub_key;
+	EVP_CIPHER_CTX* cipher_ctx;
+
+	static const int MIN_BUFFER_SIZE = 1024;
+	unsigned char* cipher_buffer;
+#endif
+
+};
+
+#endif