mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 06:38:20 +00:00
ac1a7508ee
The different analyzers types all had their own methods for enabling/disabling their availability. This change abstracts that into a new API inside their base class (`plugin::Component`) so that they can be toggled in a unified way. In principle, other types of components could/should use this as well now, so that, e.g., an input reader's availability could be toggled at runtime. The code doesn't make that broader change for now because it would requires a series of changes wherever these other component types are being used. However, that means that one now could try toggling some other component through the new API without that having any effect. To catch that, there's a runtime check in place that turns any such attempt into an internal error.
88 lines
2.6 KiB
C++
88 lines
2.6 KiB
C++
// See the file "COPYING" in the main distribution directory for copyright.
|
|
|
|
#include "zeek/plugin/Component.h"
|
|
|
|
#include "zeek/Desc.h"
|
|
#include "zeek/Reporter.h"
|
|
|
|
namespace zeek::plugin {
|
|
|
|
Tag::type_t Component::type_counter(0);
|
|
|
|
Component::Component(component::Type arg_type, const std::string& arg_name, Tag::subtype_t tag_subtype,
|
|
EnumTypePtr etype)
|
|
: type(arg_type), name(arg_name), tag(etype, 1, 0), etype(std::move(etype)), tag_subtype(tag_subtype) {
|
|
canon_name = util::canonify_name(name);
|
|
canon_name_val = make_intrusive<StringVal>(canon_name);
|
|
}
|
|
|
|
void Component::Describe(ODesc* d) const {
|
|
d->Add(" ");
|
|
d->Add("[");
|
|
|
|
switch ( type ) {
|
|
case component::READER: d->Add("Reader"); break;
|
|
|
|
case component::WRITER: d->Add("Writer"); break;
|
|
|
|
case component::ANALYZER: d->Add("Analyzer"); break;
|
|
|
|
case component::PACKET_ANALYZER: d->Add("Packet Analyzer"); break;
|
|
|
|
case component::FILE_ANALYZER: d->Add("File Analyzer"); break;
|
|
|
|
case component::IOSOURCE: d->Add("I/O Source"); break;
|
|
|
|
case component::PKTSRC: d->Add("Packet Source"); break;
|
|
|
|
case component::PKTDUMPER: d->Add("Packet Dumper"); break;
|
|
|
|
case component::SESSION_ADAPTER: d->Add("Session Adapter"); break;
|
|
|
|
default:
|
|
reporter->InternalWarning("unknown component type in plugin::Component::Describe");
|
|
d->Add("<unknown component type>");
|
|
break;
|
|
}
|
|
|
|
d->Add("]");
|
|
d->Add(" ");
|
|
d->Add(name);
|
|
d->Add(" (");
|
|
DoDescribe(d);
|
|
d->Add(")");
|
|
}
|
|
|
|
void Component::InitializeTag() {
|
|
assert(tag_initialized == false);
|
|
tag_initialized = true;
|
|
tag = zeek::Tag(etype, ++type_counter, tag_subtype);
|
|
}
|
|
|
|
zeek::Tag Component::Tag() const {
|
|
assert(tag_initialized);
|
|
return tag;
|
|
}
|
|
|
|
void Component::SetEnabled(bool arg_enabled) {
|
|
switch ( type ) {
|
|
case component::ANALYZER:
|
|
case component::PACKET_ANALYZER:
|
|
case component::FILE_ANALYZER:
|
|
case component::SESSION_ADAPTER:
|
|
// For these types we have logic in place to ignore the component
|
|
// if disabled.
|
|
enabled = arg_enabled;
|
|
break;
|
|
|
|
default:
|
|
// It wouldn't be hard to add support for other component types. We
|
|
// just need to make sure the enabled flag is checked somewhere to
|
|
// skip using the component if off.
|
|
ODesc d;
|
|
Describe(&d);
|
|
reporter->InternalError("SetEnabled() called on unsupported component (%s)", d.Description());
|
|
break;
|
|
}
|
|
}
|
|
} // namespace zeek::plugin
|