icinga2/lib/base/scriptframe.hpp
Yonas Habteab 29a5268961 Replace all existing copyright headers with SPDX headers
I've used the following command to replace the original copyright header
lines in a C-style comment block:

```
$ find . \( -type d \( -name '\..*' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f -exec perl -pi -e 's{/\*[^*]*\(\s*c\s*\)\s*(\d{4})\s*Icinga\s+GmbH[^*]*\*/}{// SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n// SPDX-License-Identifier: GPL-2.0-or-later}gi' {} +
```

For files that use shell-style comments (#) like CMakeLists.txt, I've
used this command:

```
$ find . \( -type d \( -name '\..*' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f -exec perl -pi -e 's{#.*\(\s*c\s*\)\s(\d{4})\sIcinga\s+GmbH.*}{# SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n# SPDX-License-Identifier: GPL-2.0-or-later}gi' {} +
```

And for SQL files:

```
$ find . \( -type d \( -name '\..*' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f \( -name '*.sql' \) -exec perl -pi -e 's{--.*\(c\)\s(\d{4})\sIcinga\sGmbH.*}{-- SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n-- SPDX-License-Identifier: GPL-2.0-or-later}gi' {} +
$ find . \( -type d \( -name '\..*' -o -name third-party -o -name scripts -o -name prefix -o -name malloc -o -name server -o -name docker -o -name build -o -name doc \) -prune \) -o -type f \( -name '*.sql' \) -exec perl -pi -e 's{-- Copyright \(c\)\s(\d{4})\sIcinga\s+Development\sTeam.*}{-- SPDX-FileCopyrightText: \1 Icinga GmbH <https://icinga.com>\n-- SPDX-License-Identifier: GPL-2.0-or-later}gi' {} +
```
2026-02-03 17:54:50 +01:00

68 lines
1.9 KiB
C++

// SPDX-FileCopyrightText: 2012 Icinga GmbH <https://icinga.com>
// SPDX-License-Identifier: GPL-2.0-or-later
#ifndef SCRIPTFRAME_H
#define SCRIPTFRAME_H
#include "base/i2-base.hpp"
#include "base/dictionary.hpp"
#include "base/namespace.hpp"
#include "base/scriptpermission.hpp"
#include <boost/thread/tss.hpp>
#include <stack>
namespace icinga
{
/**
* A frame describing the context a section of script code is executed in.
*
* This is implemented by each new object that is constructed getting pushed on a thread_local
* global stack that is accessible from anywhere during script evaluation.
*
* Most properties in this frame, like local variables do not carry over to successive frames,
* except the `PermChecker` and `Sandboxed` members, which get propagated to enforce access
* control and availability of unsafe functions.
*/
struct ScriptFrame
{
Dictionary::Ptr Locals;
ScriptPermissionChecker::Ptr PermChecker; /* inherited by next frame */
Value Self;
bool Sandboxed; /* inherited by next frame */
int Depth;
ScriptFrame(bool allocLocals);
ScriptFrame(bool allocLocals, Value self);
~ScriptFrame();
void IncreaseStackDepth();
void DecreaseStackDepth();
static ScriptFrame *GetCurrentFrame();
Namespace::Ptr GetGlobals();
private:
/**
* Caches a sanitized version of the global namespace for the current `ScriptFrame`.
*
* This is a value that is dependent on a ScriptFrame's `Sandboxed` and `CheckPerms`
* members. These are both independent of each other and while they are inherited by
* subsequent frames themselves, their values can be changed for new frames easily.
* Therefore Globals can hold a different value for each ScriptFrame and is not
* inherited.
*/
Namespace::Ptr Globals;
static boost::thread_specific_ptr<std::stack<ScriptFrame *> > m_ScriptFrames;
static void PushFrame(ScriptFrame *frame);
static ScriptFrame *PopFrame();
void InitializeFrame();
};
}
#endif /* SCRIPTFRAME_H */