1 |
#!/usr/bin/perl -w |
#!/usr/bin/perl -w |
2 |
############################################################################### |
############################################################################### |
3 |
# Meteor |
# Meteor |
4 |
# An HTTP server for the 2.0 web |
# An HTTP server for the 2.0 web |
5 |
# Copyright (c) 2006 contributing authors |
# Copyright (c) 2006 contributing authors |
6 |
# |
# |
7 |
# Subscriber.pm |
# Subscriber.pm |
8 |
# |
# |
9 |
# Description: |
# Description: |
10 |
# A Meteor Subscriber |
# A Meteor Subscriber |
11 |
# |
# |
12 |
############################################################################### |
############################################################################### |
13 |
# |
# |
14 |
# This program is free software; you can redistribute it and/or modify it |
# This program is free software; you can redistribute it and/or modify it |
15 |
# under the terms of the GNU General Public License as published by the Free |
# under the terms of the GNU General Public License as published by the Free |
16 |
# Software Foundation; either version 2 of the License, or (at your option) |
# Software Foundation; either version 2 of the License, or (at your option) |
17 |
# any later version. |
# any later version. |
18 |
# |
# |
19 |
# This program is distributed in the hope that it will be useful, but WITHOUT |
# This program is distributed in the hope that it will be useful, but WITHOUT |
20 |
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
21 |
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
22 |
# more details. |
# more details. |
23 |
# |
# |
24 |
# You should have received a copy of the GNU General Public License along |
# You should have received a copy of the GNU General Public License along |
25 |
# with this program; if not, write to the Free Software Foundation, Inc., |
# with this program; if not, write to the Free Software Foundation, Inc., |
26 |
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
27 |
# |
# |
28 |
# For more information visit www.meteorserver.org |
# For more information visit www.meteorserver.org |
29 |
# |
# |
30 |
############################################################################### |
############################################################################### |
31 |
|
|
32 |
package Meteor::Subscriber; |
package Meteor::Subscriber; |
33 |
############################################################################### |
############################################################################### |
34 |
# Configuration |
# Configuration |
35 |
############################################################################### |
############################################################################### |
36 |
|
|
37 |
use strict; |
use strict; |
38 |
|
|
39 |
use Meteor::Connection; |
use Meteor::Connection; |
40 |
use Meteor::Channel; |
use Meteor::Channel; |
41 |
use Meteor::Document; |
use Meteor::Document; |
42 |
|
|
43 |
@Meteor::Subscriber::ISA=qw(Meteor::Connection); |
@Meteor::Subscriber::ISA=qw(Meteor::Connection); |
44 |
|
|
45 |
our %PersistentConnections=(); |
our %PersistentConnections=(); |
46 |
|
our $NumAcceptedConnections=0; |
47 |
############################################################################### |
|
48 |
# Factory methods |
|
49 |
############################################################################### |
############################################################################### |
50 |
sub newFromServer { |
# Factory methods |
51 |
my $class=shift; |
############################################################################### |
52 |
|
sub newFromServer { |
53 |
my $self=$class->SUPER::newFromServer(shift); |
my $class=shift; |
54 |
|
|
55 |
$self->{'headerBuffer'}=''; |
my $self=$class->SUPER::newFromServer(shift); |
56 |
$self->{'MessageCount'}=0; |
|
57 |
$self->{'MaxMessageCount'}=0; |
$self->{'headerBuffer'}=''; |
58 |
|
$self->{'MessageCount'}=0; |
59 |
$self->{'ConnectionStart'}=time; |
$self->{'MaxMessageCount'}=0; |
60 |
my $maxTime=$::CONF{'MaxTime'}; |
|
61 |
if($maxTime>0) |
$self->{'ConnectionStart'}=time; |
62 |
{ |
my $maxTime=$::CONF{'MaxTime'}; |
63 |
$self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$maxTime; |
if($maxTime>0) |
64 |
} |
{ |
65 |
|
$self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$maxTime; |
66 |
$self; |
} |
67 |
} |
|
68 |
|
$::Statistics->{'current_subscribers'}++; |
69 |
############################################################################### |
$::Statistics->{'subscriber_connections_accepted'}++; |
70 |
# Class methods |
|
71 |
############################################################################### |
$self; |
72 |
sub deleteSubscriberWithID { |
} |
73 |
my $class=shift; |
|
74 |
my $id=shift; |
############################################################################### |
75 |
|
# Class methods |
76 |
if(exists($PersistentConnections{$id})) |
############################################################################### |
77 |
{ |
sub deleteSubscriberWithID { |
78 |
$PersistentConnections{$id}->close(1); |
my $class=shift; |
79 |
} |
my $id=shift; |
80 |
} |
|
81 |
|
if(exists($PersistentConnections{$id})) |
82 |
sub pingPersistentConnections { |
{ |
83 |
my $class=shift; |
$PersistentConnections{$id}->close(); |
84 |
|
} |
85 |
my $msg=$::CONF{'PingMessage'}; |
} |
86 |
my @cons=values %PersistentConnections; |
|
87 |
|
sub pingPersistentConnections { |
88 |
map { $_->write($msg) } @cons; |
my $class=shift; |
89 |
} |
|
90 |
|
my @cons=values %PersistentConnections; |
91 |
sub checkPersistentConnectionsForMaxTime { |
|
92 |
my $class=shift; |
map { $_->ping() } @cons; |
93 |
|
} |
94 |
my $time=time; |
|
95 |
my @cons=values %PersistentConnections; |
sub checkPersistentConnectionsForMaxTime { |
96 |
|
my $class=shift; |
97 |
map { $_->checkForMaxTime($time) } @cons; |
|
98 |
} |
my $time=time; |
99 |
|
my @cons=values %PersistentConnections; |
100 |
############################################################################### |
|
101 |
# Instance methods |
map { $_->checkForMaxTime($time) } @cons; |
102 |
############################################################################### |
} |
103 |
sub processLine { |
|
104 |
my $self=shift; |
sub numSubscribers { |
105 |
my $line=shift; |
|
106 |
|
return scalar(keys %PersistentConnections); |
107 |
# Once the header was processed we ignore any input |
} |
108 |
return unless(exists($self->{'headerBuffer'})); |
|
109 |
|
############################################################################### |
110 |
if($line ne '') |
# Instance methods |
111 |
{ |
############################################################################### |
112 |
# |
sub processLine { |
113 |
# Accumulate header |
my $self=shift; |
114 |
# |
my $line=shift; |
115 |
$self->{'headerBuffer'}.="$line\n"; |
|
116 |
} |
# Once the header was processed we ignore any input |
117 |
else |
return unless(exists($self->{'headerBuffer'})); |
118 |
{ |
|
119 |
# |
if($line ne '') |
120 |
# Empty line signals end of header. |
{ |
121 |
# Analyze header, register with appropiate channel |
# |
122 |
# and send pending messages. |
# Accumulate header |
123 |
# |
# |
124 |
# GET $::CONF{'SubscriberDynamicPageAddress'}?channel=ml123&restartfrom=1 HTTP/1.1 |
$self->{'headerBuffer'}.="$line\n"; |
125 |
# |
} |
126 |
# Find the 'GET' line |
else |
127 |
# |
{ |
128 |
if($self->{'headerBuffer'}=~/GET\s+$::CONF{'SubscriberDynamicPageAddress'}\?(\S+)/) |
# |
129 |
{ |
# Empty line signals end of header. |
130 |
my @formData=split('&',$1); |
# Analyze header, register with appropiate channel |
131 |
my $channelName=undef; |
# and send pending messages. |
132 |
my $startIndex=undef; |
# |
133 |
my $backtrack=undef; |
# GET $::CONF{'SubscriberDynamicPageAddress'}/hostid/streamtype/channeldefs HTTP/1.1 |
134 |
my $persist=1; |
# |
135 |
my $subscriberID=undef; |
# Find the 'GET' line |
136 |
foreach my $formElement (@formData) |
# |
137 |
{ |
if($self->{'headerBuffer'}=~/GET\s+$::CONF{'SubscriberDynamicPageAddress'}\/([0-9a-z]+)\/([0-9a-z]+)\/(\S+)/i) |
138 |
if($formElement=~/^channel=(.+)$/) |
{ |
139 |
{ |
my $subscriberID=$1; |
140 |
$channelName=$1; |
$self->{'mode'}=$2; |
141 |
} |
my $persist=$self->getConf('Persist'); |
142 |
elsif($formElement=~/^restartfrom=(\d*)$/) |
|
143 |
{ |
if ($self->{'mode'} eq "xhrinteractive" || $self->{'mode'} eq "iframe" || $self->{'mode'} eq "serversent" || $self->{'mode'} eq "longpoll") { |
144 |
$startIndex=$1; |
$persist=1; |
145 |
$startIndex='' unless(defined($startIndex)); |
$self->{'MaxMessageCount'}=1 unless(!($self->{'mode'} eq "longpoll")); |
146 |
} |
} |
147 |
elsif($formElement=~/^backtrack=(\d+)$/) |
if ($self->{'mode'} eq "iframe") { |
148 |
{ |
$self->{'HeaderTemplateNumber'}=1; |
149 |
$backtrack=$1; |
} else { |
150 |
$backtrack=0 unless(defined($backtrack)); |
$self->{'HeaderTemplateNumber'}=2; |
151 |
} |
} |
152 |
elsif($formElement=~/^persist=(?i)(yes|true|1|no|false|0)$/) |
|
153 |
{ |
my $maxTime=$self->getConf('MaxTime'); |
154 |
$persist=0 if($1=~/(no|false|0)/i); |
if($maxTime>0) |
155 |
} |
{ |
156 |
elsif($formElement=~/^id=(.+)$/) |
$self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$maxTime; |
157 |
{ |
} |
158 |
$subscriberID=$1; |
|
159 |
} |
my @channelData=split('/',$3); |
160 |
elsif($formElement=~/^maxmessages=(\d+)$/i) |
my $channels={}; |
161 |
{ |
my $channelName; |
162 |
$self->{'MaxMessageCount'}=$1; |
my $offset; |
163 |
} |
foreach my $chandef (@channelData) { |
164 |
elsif($formElement=~/^template=(\d+)$/i) |
if($chandef=~/^([a-z0-9]+)(.(r|b|h)([0-9]*))?$/i) { |
165 |
{ |
$channelName = $1; |
166 |
$self->{'HeaderTemplateNumber'}=$1; |
$channels->{$channelName}->{'startIndex'} = undef; |
167 |
} |
if ($3) { |
168 |
elsif($formElement=~/^maxtime=(\d+)$/i) |
$offset = $4; |
169 |
{ |
if ($3 eq 'r') { $channels->{$channelName}->{'startIndex'} = $offset; } |
170 |
my $clientRequest=$1; |
if ($3 eq 'b') { $channels->{$channelName}->{'startIndex'} = -$offset; } |
171 |
my $serverDefault=$::CONF{'MaxTime'}; |
if ($3 eq 'h') { $channels->{$channelName}->{'startIndex'} = 0; } |
172 |
|
} |
173 |
if($serverDefault==0 || $serverDefault>$clientRequest) |
} |
174 |
{ |
} |
175 |
$self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$clientRequest; |
|
176 |
} |
delete($self->{'headerBuffer'}); |
177 |
} |
|
178 |
} |
if($persist) |
179 |
|
{ |
180 |
delete($self->{'headerBuffer'}); |
$self->{'subscriberID'}=$subscriberID; |
181 |
|
$self->deleteSubscriberWithID($subscriberID); |
182 |
if(defined($startIndex) && defined($backtrack)) |
$PersistentConnections{$subscriberID}=$self; |
183 |
{ |
} |
184 |
$self->emitHeader("404 Cannot use both 'restartfrom' and 'backtrack'"); |
|
185 |
$self->close(); |
if(scalar(keys %{$channels})) |
186 |
|
{ |
187 |
return; |
$self->emitOKHeader(); |
188 |
} |
$self->setChannels($channels,$persist); |
189 |
|
$self->close(1) unless($persist); |
190 |
if(defined($subscriberID) && $persist) |
return; |
191 |
{ |
} |
192 |
$self->{'subscriberID'}=$subscriberID; |
} |
193 |
$self->deleteSubscriberWithID($subscriberID); |
elsif($self->{'headerBuffer'}=~/GET\s+\/disconnect\/(\S+)/) |
194 |
$PersistentConnections{$subscriberID}=$self; |
{ |
195 |
} |
$self->deleteSubscriberWithID($1); |
196 |
|
$self->emitOKHeader(); |
197 |
if(defined($channelName)) |
$self->close(1); |
198 |
{ |
return; |
199 |
$self->emitOKHeader(); |
} |
200 |
|
elsif($self->{'headerBuffer'}=~/GET\s+([^\s\?]+)/) |
201 |
$startIndex=-$backtrack if(!defined($startIndex) && defined($backtrack)); |
{ |
202 |
|
Meteor::Document->serveFileToClient($1,$self); |
203 |
$self->setChannelName($channelName,$startIndex,$persist); |
$self->close(1); |
204 |
|
return; |
205 |
$self->close(1) unless($persist); |
} |
206 |
|
|
207 |
return; |
# |
208 |
} |
# If we fall through we did not understand the request |
209 |
} |
# |
210 |
elsif($self->{'headerBuffer'}=~/GET\s+([^\s\?]+)/) |
$self->emitErrorHeader(); |
211 |
{ |
} |
212 |
Meteor::Document->serveFileToClient($1,$self); |
} |
213 |
|
|
214 |
$self->close(1); |
sub setChannels { |
215 |
|
my $self=shift; |
216 |
return; |
my $channels=shift; |
217 |
} |
my $persist=shift; |
218 |
|
|
219 |
# |
foreach my $channelName (keys %{$channels}) |
220 |
# If we fall through we did not understand the request |
{ |
221 |
# |
my $startIndex=$channels->{$channelName}->{'startIndex'}; |
222 |
$self->emitErrorHeader(); |
|
223 |
} |
my $channel=Meteor::Channel->channelWithName($channelName); |
224 |
} |
|
225 |
|
$self->{'channels'}->{$channelName}=$channel if($persist); |
226 |
sub setChannelName { |
|
227 |
my $self=shift; |
$channel->addSubscriber($self,$startIndex,$persist); |
228 |
my $channelName=shift; |
} |
229 |
my $startIndex=shift; |
} |
230 |
my $persist=shift; |
|
231 |
|
sub emitOKHeader { |
232 |
my $channel=Meteor::Channel->channelWithName($channelName); |
my $self=shift; |
233 |
$self->{'channel'}=$channel if($persist); |
|
234 |
|
$self->emitHeader('200 OK'); |
235 |
$channel->addSubscriber($self,$startIndex,$persist); |
} |
236 |
} |
|
237 |
|
sub emitErrorHeader { |
238 |
sub emitOKHeader { |
my $self=shift; |
239 |
my $self=shift; |
|
240 |
|
$self->emitHeader('404 Not Found'); |
241 |
$self->emitHeader('200 OK'); |
$::Statistics->{'errors_served'}++; |
242 |
} |
|
243 |
|
# close up shop here! |
244 |
sub emitErrorHeader { |
$self->close(); |
245 |
my $self=shift; |
} |
246 |
|
|
247 |
$self->emitHeader('404 Not Found'); |
sub emitHeader { |
248 |
|
my $self=shift; |
249 |
# close up shop here! |
my $status=shift; |
250 |
$self->close(); |
|
251 |
} |
my $header=undef; |
252 |
|
if(exists($self->{'HeaderTemplateNumber'})) |
253 |
sub emitHeader { |
{ |
254 |
my $self=shift; |
my $hn='HeaderTemplate'.$self->{'HeaderTemplateNumber'}; |
255 |
my $status=shift; |
|
256 |
|
$header=$self->getConf($hn); |
257 |
my $header=undef; |
} |
258 |
if(exists($self->{'HeaderTemplateNumber'})) |
$header=$self->getConf('HeaderTemplate') unless(defined($header)); |
259 |
{ |
|
260 |
my $hn='HeaderTemplate'.$self->{'HeaderTemplateNumber'}; |
$header=~s/~([^~]*)~/ |
261 |
|
if(!defined($1) || $1 eq '') |
262 |
$header=$::CONF{$hn}; |
{ |
263 |
} |
'~'; |
264 |
$header=$::CONF{'HeaderTemplate'} unless(defined($header)); |
} |
265 |
|
elsif($1 eq 'server') |
266 |
$header=~s/~([^~]+)~/ |
{ |
267 |
if(!defined($1) || $1 eq '') |
$::PGM; |
268 |
{ |
} |
269 |
'~'; |
elsif($1 eq 'status') |
270 |
} |
{ |
271 |
elsif($1 eq 'server') |
$status; |
272 |
{ |
} |
273 |
$::PGM; |
elsif($1 eq 'servertime') |
274 |
} |
{ |
275 |
elsif($1 eq 'status') |
time; |
276 |
{ |
} |
277 |
$status; |
elsif($1 eq 'channelinfo') |
278 |
} |
{ |
279 |
elsif($1 eq 'servertime') |
Meteor::Channel->listChannelsUsingTemplate($self->getConf('ChannelInfoTemplate')); |
280 |
{ |
} |
281 |
time; |
else |
282 |
} |
{ |
283 |
else |
''; |
284 |
{ |
} |
285 |
''; |
/gex; |
286 |
} |
|
287 |
/gex; |
$self->write($header); |
288 |
|
} |
289 |
$self->write($header); |
|
290 |
} |
sub sendMessages { |
291 |
|
my $self=shift; |
292 |
sub sendMessage { |
|
293 |
my $self=shift; |
my $numMessages=0; |
294 |
my $msg=shift; |
my $msgTemplate=$self->getConf('Messagetemplate'); |
295 |
|
my $msgData=''; |
296 |
$self->write($msg); |
|
297 |
|
foreach my $message (@_) |
298 |
my $msgCount=++$self->{'MessageCount'}; |
{ |
299 |
|
$msgData.=$message->messageWithTemplate($msgTemplate); |
300 |
my $maxMsg=$::CONF{'MaxMessages'}; |
$numMessages++; |
301 |
if(defined($maxMsg) && $maxMsg>0 && $msgCount>=$maxMsg) |
} |
302 |
{ |
|
303 |
$self->close(1); |
return if($numMessages<1); |
304 |
} |
|
305 |
|
$self->write($msgData); |
306 |
if($self->{'MaxMessageCount'}>0 && $msgCount>=$self->{'MaxMessageCount'}) |
|
307 |
{ |
$::Statistics->{'messages_served'}+=$numMessages; |
308 |
$self->close(1); |
|
309 |
} |
my $msgCount=$self->{'MessageCount'}; |
310 |
} |
$msgCount+=$numMessages; |
311 |
|
$self->{'MessageCount'}=$msgCount; |
312 |
sub close { |
|
313 |
my $self=shift; |
my $maxMsg=$self->getConf('MaxMessages'); |
314 |
my $noShutdownMsg=shift; |
if(defined($maxMsg) && $maxMsg>0 && $msgCount>=$maxMsg) |
315 |
|
{ |
316 |
$self->{'channel'}->removeSubscriber($self) if($self->{'channel'}); |
$self->close(1); |
317 |
delete($self->{'channel'}); |
} |
318 |
|
|
319 |
if(exists($self->{'subscriberID'})) |
if($self->{'MaxMessageCount'}>0 && $msgCount>=$self->{'MaxMessageCount'}) |
320 |
{ |
{ |
321 |
delete($PersistentConnections{$self->{'subscriberID'}}); |
$self->close(1); |
322 |
} |
} |
323 |
|
|
324 |
# |
} |
325 |
# Send shutdown message unless remote closed or |
|
326 |
# connection not yet established |
sub ping { |
327 |
# |
my $self=shift; |
328 |
unless($noShutdownMsg || $self->{'remoteClosed'} || exists($self->{'headerBuffer'})) |
my $msg=$self->getConf('PingMessage'); |
329 |
{ |
|
330 |
my $msg=$::CONF{'SubscriberShutdownMsg'}; |
$self->write($msg); |
331 |
if(defined($msg) && $msg ne '') |
} |
332 |
{ |
|
333 |
$self->write($msg); |
sub closeChannel { |
334 |
} |
my $self=shift; |
335 |
} |
my $channelName=shift; |
336 |
|
|
337 |
$self->SUPER::close(); |
return unless(exists($self->{'channels'}->{$channelName})); |
338 |
} |
|
339 |
|
my $channel=$self->{'channels'}->{$channelName}; |
340 |
sub checkForMaxTime { |
$channel->removeSubscriber($self); |
341 |
my $self=shift; |
|
342 |
my $time=shift; |
delete($self->{'channels'}->{$channelName}); |
343 |
|
|
344 |
$self->close(1) if(exists($self->{'ConnectionTimeLimit'}) && $self->{'ConnectionTimeLimit'}<$time); |
$self->close() if(scalar(keys %{$self->{'channels'}})==0); |
345 |
} |
} |
346 |
|
|
347 |
1; |
sub close { |
348 |
|
my $self=shift; |
349 |
|
my $noShutdownMsg=shift; |
350 |
|
|
351 |
|
foreach my $channelName (keys %{$self->{'channels'}}) |
352 |
|
{ |
353 |
|
my $channel=$self->{'channels'}->{$channelName}; |
354 |
|
$channel->removeSubscriber($self); |
355 |
|
} |
356 |
|
delete($self->{'channels'}); |
357 |
|
|
358 |
|
if(exists($self->{'subscriberID'})) |
359 |
|
{ |
360 |
|
delete($PersistentConnections{$self->{'subscriberID'}}); |
361 |
|
} |
362 |
|
|
363 |
|
# |
364 |
|
# Send shutdown message unless remote closed or |
365 |
|
# connection not yet established |
366 |
|
# |
367 |
|
unless($noShutdownMsg || $self->{'remoteClosed'} || exists($self->{'headerBuffer'})) |
368 |
|
{ |
369 |
|
my $msg=$self->getConf('SubscriberShutdownMsg'); |
370 |
|
if(defined($msg) && $msg ne '') |
371 |
|
{ |
372 |
|
$self->write($msg); |
373 |
|
} |
374 |
|
} |
375 |
|
|
376 |
|
$self->SUPER::close(); |
377 |
|
} |
378 |
|
|
379 |
|
sub didClose { |
380 |
|
|
381 |
|
$::Statistics->{'current_subscribers'}--; |
382 |
|
} |
383 |
|
|
384 |
|
sub checkForMaxTime { |
385 |
|
my $self=shift; |
386 |
|
my $time=shift; |
387 |
|
|
388 |
|
$self->close(1) if(exists($self->{'ConnectionTimeLimit'}) && $self->{'ConnectionTimeLimit'}<$time); |
389 |
|
} |
390 |
|
|
391 |
|
sub getConf { |
392 |
|
my $self=shift; |
393 |
|
my $key=shift; |
394 |
|
|
395 |
|
if(exists($self->{'mode'}) && $self->{'mode'} ne '') |
396 |
|
{ |
397 |
|
my $k=$key.'.'.$self->{'mode'}; |
398 |
|
|
399 |
|
return $::CONF{$k} if(exists($::CONF{$k})); |
400 |
|
} |
401 |
|
|
402 |
|
$::CONF{$key}; |
403 |
|
} |
404 |
|
|
405 |
|
1; |
406 |
############################################################################EOF |
############################################################################EOF |