zetacomponents /EventLog/src/log_message.php

Language PHP Lines 226
MD5 Hash 1fbc46f40e7bad4273cd83e368f7ebfb
Repository https://github.com/Yannix/zetacomponents.git View Raw File View Project SPDX
  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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
<?php
/**
 * File containing the ezcLogMessage class.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 * @package EventLog
 * @version //autogentag//
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 * @access private
 */

/**
 * Holds a log message and provides convenience methods to read the information.
 *
 * The ezclogMessage class is used for subtracting the information from the message
 * parameter from {@link trigger_error()}. See the {@link ezcLog::logHandler} for
 * more information.
 *
 * The message formats that can be parsed are:
 *
 * <pre>
 * [ source, category, error_type ] Message
 * </pre>
 *
 * <pre>
 * [ source, category ] Message
 * </pre>
 *
 * When one name is given between the brackets, the category will be set and the message has a default source:
 * <pre>
 * [ category ] Message
 * </pre>
 *
 * Without any names between the brackets, the default category and source are used:
 * <pre>
 * Message
 * </pre>
 *
 * The following properties are set after construction or after calling {@link parseMessage()}:
 * - message, contains the message without extra the additional information.
 * - source, contains either the default source or the source set in the incoming message.
 * - category, contains either the default category or the category set in the incoming message.
 * - error_type, any severity without the leading "ezcLog::" (see {@link ezcLogMessage::parseMessage}); which are:
 *   ezcLog::DEBUG, ezcLog::INFO, ezcLog::NOTICE, ezcLog::WARNING, ezcLog::ERROR, ezcLog::FATAL, ezcLog::FAILED_AUDIT, ezcLog::SUCCESS_AUDIT.
 * - severity, if error_type is not set: severity of the error. Which is ezcLog::NOTICE, ezcLog::WARNING, or ezcLog::ERROR.
 *
 * @package EventLog
 * @version //autogentag//
 * @access private
 */
class ezcLogMessage
{
    /**
     * Holds the properties of this class.
     *
     * @var array(string=>mixed)
     */
    protected $properties = array( "message" => "", "source" => "", "category" => "", "severity" => "" );

    /**
     * Constructs the ezcLogMessage from the $message, $severity, $defaultSource and $defaultCategory.
     *
     * $message is parsed by parseMessage() and properties are set.
     *
     * @param string $message
     * @param int $severity
     * @param string $defaultSource Use this source when not given in the message itself.
     * @param string $defaultCategory Use this category when not give in the message itself.
     */
    public function __construct( $message, $severity, $defaultSource, $defaultCategory )
    {
        $this->parseMessage( $message, $severity, $defaultSource, $defaultCategory );
    }

    /**
     * Sets the property $name to $value.
     *
     * @throws ezcBasePropertyNotFoundException
     *         If the property $name does not exist
     * @param string $name
     * @param mixed $value
     * @ignore
     */
    public function __set( $name, $value )
    {
        switch ( $name )
        {
            case 'message':
            case 'source':
            case 'category':
            case 'severity':
                $this->properties[$name] = $value;
                return;
        }

        throw new ezcBasePropertyNotFoundException( $name );
    }

    /**
     * Returns the property $name.
     *
     * @throws ezcBasePropertyNotFoundException
     *         If the property $name does not exist
     * @param string $name
     * @return mixed
     * @ignore
     */
    public function __get( $name )
    {
        switch ( $name )
        {
            case 'message':
            case 'source':
            case 'category':
            case 'severity':
                return $this->properties[$name];
        }

        throw new ezcBasePropertyNotFoundException( $name );
    }

    /**
     * Returns true if the property $name is set, otherwise false.
     *
     * @param string $name
     * @return bool
     * @ignore
     */
    public function __isset( $name )
    {
        switch ( $name )
        {
            case 'message':
            case 'source':
            case 'category':
            case 'severity':
                return isset( $this->properties[$name] );

            default:
                return false;
        }
    }

    /**
     * Parses the message $message and sets the properties.
     *
     * See the general class documentation for message format.
     * The severity $severity can be a E_USER_* PHP constant. The values will be translated accordingly:
     * - E_USER_NOTICE -> ezcLog::NOTICE
     * - E_USER_WARNING -> ezcLog::WARNING
     * - E_USER_ERROR -> ezcLog::ERROR
     *
     * Any other severity from ezcLog can be encapsulated in the message, for example:
     * - [source, message, debug] -> ezcLog::DEBUG
     * - [source, message, info] -> ezcLog::INFO
     * - [source, message, notice] -> ezcLog::NOTICE
     * - [source, message, error] -> ezcLog::ERROR
     * - [source, message, warning] -> ezcLog::WARNING
     * - [source, message, fatal] -> ezcLog::FATAL
     * - [source, message, success_audit] -> ezcLog::SUCCESS_AUDIT
     * - [source, message, failed_audit] -> ezcLog::FAILED_AUDIT
     *
     * @param string $message
     * @param int $severity
     * @param string $defaultSource
     * @param string $defaultCategory
     */
    public function parseMessage( $message, $severity, $defaultSource, $defaultCategory )
    {
        preg_match( "/^\s*(?:\[(?:\s?)(?P<source>[^,\]]*)(?:,\s(?P<category>[^,\]]*))?(?:,\s?(?P<level>[a-zA-Z_]*))?\s?\])?\s*(?P<message>.*)$/", $message, $matches );

        $this->message = $matches['message'] === '' ? false : $matches['message'];

        if ( $matches['category'] === '' )
        {
            $this->category = $matches['source'] === '' ? $defaultCategory : $matches['source'];
            $this->source = $defaultSource;
        }
        else
        {
            $this->category = $matches['category'];
            $this->source = $matches['source'];
        }

        if ( $matches['level'] === '' )
        {
            switch ( $severity )
            {
                case E_USER_NOTICE:  $this->severity = ezcLog::NOTICE; break;
                case E_USER_WARNING: $this->severity = ezcLog::WARNING; break;
                case E_USER_ERROR:  $this->severity = ezcLog::ERROR; break;
                default: $this->severity = false;
            }
        }
        else
        {
            $constantName = 'ezcLog::' . strtoupper( trim( $matches['level'] ) );
            if ( !defined( $constantName ) )
            {
                throw new ezcLogWrongSeverityException( trim( $matches['level'] ) );
            }
            else
            {
                $this->severity = constant( $constantName );
            }
        }
    }
}
?>
Back to Top