Repository navigation
Expand file tree
/
Copy path_generic_ping.plugin.php
More file actions
203 lines (175 loc) · 4.92 KB
/
Copy path_generic_ping.plugin.php
File metadata and controls
203 lines (175 loc) · 4.92 KB
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
<?php
/**
* This file implements the generic_ping_plugin.
*
* This file is part of the evoCore framework - {@link http://evocore.net/}
* See also {@link https://github.com/b2evolution/b2evolution}.
*
* @license GNU GPL v2 - {@link http://b2evolution.net/about/gnu-gpl-license}
*
* @copyright (c)2003-2015 by Francois Planque - {@link http://fplanque.com/}
* Parts of this file are copyright (c)2004-2006 by Daniel HAHLER - {@link http://thequod.de/contact}.
*
* @package plugins
*
* @author blueyed: Daniel HAHLER
*/
if( !defined('EVO_MAIN_INIT') ) die( 'Please, do not access this page directly.' );
/**
* Generic Ping Plugin
*
* @package plugins
*/
class generic_ping_plugin extends Plugin
{
/**
* Variables below MUST be overriden by plugin implementations,
* either in the subclass declaration or in the subclass constructor.
*/
var $code = 'b2evGPing';
var $priority = 50;
var $version = '5.0.0';
var $author = 'The b2evo Group';
var $help_url = ''; // empty URL defaults to manual wiki
/*
* These variables MAY be overriden.
*/
var $group = 'ping';
/**
* Init
*
* This gets called after a plugin has been registered/instantiated.
*/
function PluginInit( & $params )
{
$this->name = T_('Generic Ping plugin');
$this->short_desc = T_('Use this plugin to add a generic ping service to your installation.');
if( $params['is_installed'] )
{ // is not set for not-installed Plugins
$this->ping_service_name = $this->Settings->get('ping_service_name');
$this->ping_service_note = $this->Settings->get('ping_service_note');
}
}
/**
* Get the settings that the plugin can use.
*
* Those settings are transfered into a Settings member object of the plugin
* and can be edited in the backoffice (Settings / Plugins).
*
* @see Plugin::GetDefaultSettings()
* @see PluginSettings
* @see Plugin::PluginSettingsValidateSet()
* @return array
*/
function GetDefaultSettings()
{
return array(
'ping_service_url' => array(
'label' => T_('Ping service URL'),
'defaultvalue' => '',
'type' => 'text',
'size' => 50,
'note' => T_('The URL of the ping service.').' '.sprintf('E.g. «%s»', 'rpc.weblogs.com/RPC2 or rpc.foobar.com:8080'),
),
'ping_service_extended' => array(
'label' => T_('Extended ping?'),
'type' => 'checkbox',
'defaultvalue' => 0,
'note' => T_('Use weblogUpdates.extendedPing method instead of weblogUpdates.ping?'),
),
'ping_service_name' => array(
'label' => T_('Ping service name'),
'defaultvalue' => '',
'type' => 'text',
'size' => 25,
'note' => T_('The name of the ping service, used for displaying only.'),
),
'ping_service_note' => array(
'label' => T_('Ping service note'),
'defaultvalue' => '',
'type' => 'text',
'size' => 50,
'note' => T_('Notes about the ping service, used for displaying only.'),
),
);
}
/**
* Check ping service URL and plugin code.
*/
function BeforeEnable()
{
$ping_service_url = $this->Settings->get('ping_service_url');
if( empty($ping_service_url) )
{
return T_('You must configure a ping service URL before the plugin can be enabled.');
}
if( empty($this->code) )
{
return T_('The ping plugin needs a non-empty code.');
}
return true;
}
/**
* Check ping service URL.
*/
function PluginSettingsValidateSet( & $params )
{
if( $params['name'] == 'ping_service_url' )
{
if( ! $this->parse_ping_url($params['value']) )
{
return T_('The ping service URL is invalid.');
}
}
}
/**
* Parse a given ping service URL
*
* @return false|array False in case of error, array with keys 'host', 'port', 'path' otherwise
*/
function parse_ping_url( $url )
{
if( ! preg_match( '~^([^/:]+)(:\d+)?(/.*)?$~', $url, $match ) )
{
return false;
}
$r = array(
'host' => $match[1],
'port' => empty($match[2]) ? 80 : $match[2],
'path' => empty($match[3]) ? '/' : $match[3],
);
return $r;
}
/**
* Send a ping to the configured service.
*/
function ItemSendPing( & $params )
{
global $debug;
$url = $this->parse_ping_url( $this->Settings->get( 'ping_service_url' ) );
$Item = $params['Item'];
$item_Blog = $Item->get_Blog();
$client = new xmlrpc_client( $url['path'], $url['host'], $url['port'] );
$client->debug = ($debug && $params['display']);
if( $this->Settings->get('ping_service_extended') )
{
$message = new xmlrpcmsg("weblogUpdates.extendedPing", array(
new xmlrpcval( $item_Blog->get('name') ),
new xmlrpcval( $item_Blog->get('url') ),
new xmlrpcval( $Item->get_permanent_url() ),
new xmlrpcval( $item_Blog->get('atom_url') ),
// TODO: tags..
));
}
else
{
$message = new xmlrpcmsg("weblogUpdates.ping", array(
new xmlrpcval( $item_Blog->get('name') ),
new xmlrpcval( $item_Blog->get('url') ) ));
}
$result = $client->send($message);
$params['xmlrpcresp'] = $result;
return true;
}
}
?>