mirror of
https://github.com/zeek/zeek.git
synced 2025-10-13 20:18:20 +00:00
131 lines
3.3 KiB
C++
131 lines
3.3 KiB
C++
// See the file "COPYING" in the main distribution directory for copyright.
|
|
|
|
#pragma once
|
|
|
|
#include <list>
|
|
#include <string>
|
|
#include <utility>
|
|
|
|
#include <fcntl.h>
|
|
|
|
#ifdef NEED_KRB5_H
|
|
#include <krb5.h>
|
|
#endif // NEED_KRB5_H
|
|
|
|
#include "Obj.h"
|
|
#include "IntrusivePtr.h"
|
|
#include "util.h"
|
|
|
|
ZEEK_FORWARD_DECLARE_NAMESPACED(PrintStmt, zeek::detail);
|
|
ZEEK_FORWARD_DECLARE_NAMESPACED(Attributes, zeek::detail);
|
|
ZEEK_FORWARD_DECLARE_NAMESPACED(RecordVal, zeek);
|
|
|
|
namespace zeek {
|
|
class Type;
|
|
using TypePtr = IntrusivePtr<Type>;
|
|
|
|
class File;
|
|
using FilePtr = IntrusivePtr<File>;
|
|
|
|
class File final : public Obj {
|
|
public:
|
|
explicit File(FILE* arg_f);
|
|
File(FILE* arg_f, const char* filename, const char* access);
|
|
File(const char* filename, const char* access);
|
|
~File() override;
|
|
|
|
const char* Name() const;
|
|
|
|
// Returns false if an error occured.
|
|
bool 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
|
|
|
|
[[deprecated("Remove in v4.1. Use GetType().")]]
|
|
Type* FType() const { return t.get(); }
|
|
|
|
const TypePtr& GetType() 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.
|
|
bool IsOpen() const { return is_open; }
|
|
|
|
// Returns true if the close made sense, false if it was already
|
|
// closed, not active, or whatever.
|
|
bool Close();
|
|
|
|
void Describe(ODesc* d) const override;
|
|
|
|
// Rotates the logfile. Returns rotate_info.
|
|
RecordVal* Rotate();
|
|
|
|
// Set &raw_output attribute.
|
|
void SetAttrs(detail::Attributes* attrs);
|
|
|
|
// Returns the current size of the file, after fresh stat'ing.
|
|
double Size();
|
|
|
|
// Close all files which are currently open.
|
|
static void CloseOpenFiles();
|
|
|
|
// Get the file with the given name, opening it if it doesn't yet exist.
|
|
static FilePtr Get(const char* name);
|
|
[[deprecated("Remove in v4.1. Use File::Get().")]]
|
|
static File* GetFile(const char* name)
|
|
{ return Get(name).release(); }
|
|
|
|
void EnableRawOutput() { raw_output = true; }
|
|
bool IsRawOutput() const { return raw_output; }
|
|
|
|
protected:
|
|
|
|
friend class detail::PrintStmt;
|
|
|
|
File() { Init(); }
|
|
void Init();
|
|
|
|
/**
|
|
* If file is given, it's an open file to use already.
|
|
* If file is not given and mode is, the filename will be opened with that
|
|
* access mode.
|
|
*/
|
|
bool Open(FILE* f = nullptr, const char* mode = nullptr);
|
|
|
|
void Unlink();
|
|
|
|
// 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, but the PrintStmt friend uses this to check whether
|
|
// it's really stdout.)
|
|
FILE* FileHandle();
|
|
|
|
// Raises a file_opened event.
|
|
void RaiseOpenEvent();
|
|
|
|
FILE* f;
|
|
TypePtr t;
|
|
char* name;
|
|
char* access;
|
|
detail::Attributes* attrs;
|
|
double open_time;
|
|
bool is_open; // whether the file is open in a general sense
|
|
bool buffered;
|
|
bool raw_output;
|
|
|
|
static const int MIN_BUFFER_SIZE = 1024;
|
|
|
|
private:
|
|
static std::list<std::pair<std::string, File*>> open_files;
|
|
};
|
|
|
|
} // namespace zeek
|
|
|
|
using BroType [[deprecated("Remove in v4.1. Use zeek::Type instead.")]] = zeek::Type;
|
|
using BroFile [[deprecated("Remove in v4.1. Use zeek::File instead.")]] = zeek::File;
|
|
using BroFilePtr [[deprecated("Remove in v4.1. Use zeek::FilePtr instead.")]] = zeek::FilePtr;
|