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
|
<?php
/**
* TLogRouter, TLogRoute, TFileLogRoute, TEmailLogRoute class file
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Util
*/
namespace Prado\Util;
use Prado\Exceptions\TConfigurationException;
use Prado\Exceptions\TInvalidDataTypeException;
use Prado\Prado;
use Prado\TApplication;
use Prado\Xml\TXmlDocument;
/**
* TLogRouter class.
*
* TLogRouter manages routes that record log messages in different media different ways.
* For example, a file log route {@link TFileLogRoute} records log messages
* in log files. An email log route {@link TEmailLogRoute} sends log messages
* to email addresses.
*
* Log routes may be configured in application or page folder configuration files
* or an external configuration file specified by {@link setConfigFile ConfigFile}.
* The format is as follows,
* <code>
* <route class="TFileLogRoute" Categories="System.Web.UI" Levels="Warning" />
* <route class="TEmailLogRoute" Categories="Application" Levels="Fatal" Emails="admin@pradosoft.com" />
* </code>
* PHP configuration style:
* <code>
*
* </code>
* You can specify multiple routes with different filtering conditions and different
* targets, even if the routes are of the same type.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Carl G. Mathisen <carlgmathisen@gmail.com>
* @package Prado\Util
* @since 3.0
*/
class TLogRouter extends \Prado\TModule
{
/**
* @var array list of routes available
*/
private $_routes=array();
/**
* @var string external configuration file
*/
private $_configFile=null;
/**
* Initializes this module.
* This method is required by the IModule interface.
* @param mixed configuration for this module, can be null
* @throws TConfigurationException if {@link getConfigFile ConfigFile} is invalid.
*/
public function init($config)
{
if($this->_configFile!==null)
{
if(is_file($this->_configFile))
{
if($this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
{
$phpConfig = include $this->_configFile;
$this->loadConfig($phpConfig);
}
else
{
$dom=new TXmlDocument;
$dom->loadFromFile($this->_configFile);
$this->loadConfig($dom);
}
}
else
throw new TConfigurationException('logrouter_configfile_invalid',$this->_configFile);
}
$this->loadConfig($config);
$this->getApplication()->attachEventHandler('OnEndRequest',array($this,'collectLogs'));
}
/**
* Loads configuration from an XML element or PHP array
* @param mixed configuration node
* @throws TConfigurationException if log route class or type is not specified
*/
private function loadConfig($config)
{
if(is_array($config))
{
if(isset($config['routes']) && is_array($config['routes']))
{
foreach($config['routes'] as $route)
{
$properties = isset($route['properties'])?$route['properties']:array();
if(!isset($route['class']))
throw new TConfigurationException('logrouter_routeclass_required');
$route=Prado::createComponent($route['class']);
if(!($route instanceof TLogRoute))
throw new TConfigurationException('logrouter_routetype_invalid');
foreach($properties as $name=>$value)
$route->setSubproperty($name,$value);
$this->_routes[]=$route;
$route->init($route);
}
}
}
else
{
foreach($config->getElementsByTagName('route') as $routeConfig)
{
$properties=$routeConfig->getAttributes();
if(($class=$properties->remove('class'))===null)
throw new TConfigurationException('logrouter_routeclass_required');
$route=Prado::createComponent($class);
if(!($route instanceof TLogRoute))
throw new TConfigurationException('logrouter_routetype_invalid');
foreach($properties as $name=>$value)
$route->setSubproperty($name,$value);
$this->_routes[]=$route;
$route->init($routeConfig);
}
}
}
/**
* Adds a TLogRoute instance to the log router.
*
* @param TLogRoute $route
* @throws TInvalidDataTypeException if the route object is invalid
*/
public function addRoute($route)
{
if(!($route instanceof TLogRoute))
throw new TInvalidDataTypeException('logrouter_routetype_invalid');
$this->_routes[]=$route;
$route->init(null);
}
/**
* @return string external configuration file. Defaults to null.
*/
public function getConfigFile()
{
return $this->_configFile;
}
/**
* @param string external configuration file in namespace format. The file
* must be suffixed with '.xml'.
* @throws TConfigurationException if the file is invalid.
*/
public function setConfigFile($value)
{
if(($this->_configFile=Prado::getPathOfNamespace($value,$this->getApplication()->getConfigurationFileExt()))===null)
throw new TConfigurationException('logrouter_configfile_invalid',$value);
}
/**
* Collects log messages from a logger.
* This method is an event handler to application's EndRequest event.
* @param mixed event parameter
*/
public function collectLogs($param)
{
$logger=Prado::getLogger();
foreach($this->_routes as $route)
$route->collectLogs($logger);
}
}
|
