summaryrefslogtreecommitdiff
path: root/zend/origexception.h
blob: f997608d39aa4677d23321ace1597c9e916d489a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/**
 *  OrigException.h
 *
 *  Class that wraps around an exception that was thrown by PHP code,
 *  and that could - but not necessarily has to - be caught by C++
 *
 *  @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
 *  @copyright 2013 Copernica BV
 */

/**
 *  Set up namespace
 */
namespace Php {

/**
 *  Class definition
 */
class OrigException : public Value, public Exception
{
private:
    /**
     *  Is this a an exception that was caught by extension C++ code.
     *
     *  When the object is initially created, we assume that it will be caught
     *  by C++ code. If it later turns out that the PHP-CPP can catch this
     *  exception after the extension C++ code ran, the variable is set back
     *  to false.
     *
     *  @var bool
     */
    bool _handled = true;

#ifdef ZTS
    /**
     *  When we run in multi-thread mode, we store the thread handle
     *  @var void***
     */
    TSRMLS_D;
#endif

public:
    /**
     *  Constructor
     *  @param  val
     */
    OrigException(zval *val TSRMLS_DC) :
        Value(val), Exception("OrigException")
    {
#ifdef ZTS
        // copy tsrm_ls
        this->TSRMLS_C = TSRMLS_C;
#endif
    }

    /**
     *  Copy constructor
     *  @param  exception
     */
    OrigException(const OrigException &exception) :
        Value(exception), Exception("OrigException"), _handled(exception._handled)
    {
#ifdef ZTS
        // copy tsrm_ls
        TSRMLS_C = exception.TSRMLS_C;
#endif
    }

    /**
     *  Move constructor
     *  @param  exception
     */
    OrigException(OrigException &&exception) :
        Value(std::move(exception)), Exception("OrigException"), _handled(exception._handled)
    {
        // set other exception to handled so that it wont do anything on destruction
        exception._handled = true;

#ifdef ZTS
        // copy tsrm_ls
        TSRMLS_C = exception.TSRMLS_C;
#endif
    }

    /**
     *  Destructor
     */
    virtual ~OrigException() throw()
    {
        // if the exception was not handled by C++ code, we're not going to do anything
        // and the exception stays active
        if (!_handled) return;

        // the exception was handled, so we should clean it up
        zend_clear_exception(TSRMLS_C);
    }

    /**
     *  This is _not_ a native exception, it was thrown by a PHP script
     *  @return bool
     */
    virtual bool native() const override
    {
        return false;
    }

    /**
     *  Reactivate the exception
     */
    void reactivate()
    {
        // it was not handled by extension C++ code
        _handled = false;
    }
};

/**
 *  Global function to process an exception
 *  @param  exception
 *  @param  tsrm_ls
 */
inline void process(Exception &exception TSRMLS_DC)
{
    // is this a native exception?
    if (exception.native())
    {
        // the exception is native, call the zend throw method
        zend_throw_exception(zend_exception_get_default(TSRMLS_C), (char *)exception.what(), 0 TSRMLS_CC);
    }

    // or does it have its own report function?
    else if (!exception.report())
    {
        // this is not a native exception, so it was originally thrown by a
        // php script, and then not caught by the c++ of the extension, we are
        // going to tell to the exception that it is still active
        OrigException &orig = static_cast<OrigException&>(exception);

        // reactive the exception
        orig.reactivate();
    }
}

/**
 *  End of namespace
 */
}