/[meteor]/googlecode.com/svn/trunk/Meteor/Subscriber.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /googlecode.com/svn/trunk/Meteor/Subscriber.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 9 by andrew.betts, Fri Dec 8 16:52:58 2006 UTC revision 50 by andrew.betts, Wed Feb 27 13:55:35 2008 UTC
# Line 1  Line 1 
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(0,'newSubscriberWithSameID');
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                                  {                          $self->{'subscriberID'}=$1;
140                                          $channelName=$1;                          $self->{'mode'}=$2;
141                                  }                          my $persist=$self->getConf('Persist');
142                                  elsif($formElement=~/^restartfrom=(\d*)$/)                          my $maxTime=$self->getConf('MaxTime');
143                                  {                          $self->{'ConnectionTimeLimit'} = ($self->{'ConnectionStart'}+$maxTime) if ($maxTime>0);
144                                          $startIndex=$1;                          
145                                          $startIndex='' unless(defined($startIndex));                          my @channelData=split('/',$3);
146                                  }                          my $channels={};
147                                  elsif($formElement=~/^backtrack=(\d+)$/)                          my $channelName;
148                                  {                          my $offset;
149                                          $backtrack=$1;                          foreach my $chandef (@channelData) {
150                                          $backtrack=0 unless(defined($backtrack));                                  if($chandef=~/^([a-z0-9]+)(.(r|b|h)([0-9]*))?$/i) {
151                                  }                                          $channelName = $1;
152                                  elsif($formElement=~/^persist=(?i)(yes|true|1|no|false|0)$/)                                          $channels->{$channelName}->{'startIndex'} = undef;
153                                  {                                          if ($3) {
154                                          $persist=0 if($1=~/(no|false|0)/i);                                             $offset = $4;
155                                  }                                             if ($3 eq 'r') { $channels->{$channelName}->{'startIndex'} = $offset; }
156                                  elsif($formElement=~/^id=(.+)$/)                                             if ($3 eq 'b') { $channels->{$channelName}->{'startIndex'} = -$offset; }
157                                  {                                             if ($3 eq 'h') { $channels->{$channelName}->{'startIndex'} = 0; }
158                                          $subscriberID=$1;                                          }
159                                  }                                  }
160                                  elsif($formElement=~/^maxmessages=(\d+)$/i)                          }
161                                  {                          my $useragent = ($self->{'headerBuffer'}=~/User-Agent: (.+)/i) ? $1 : "-";
162                                          $self->{'MaxMessageCount'}=$1;                          
163                                  }                          delete($self->{'headerBuffer'});
164                                  elsif($formElement=~/^template=(\d+)$/i)                          
165                                  {                          if ($persist) {
166                                          $self->{'HeaderTemplateNumber'}=$1;                                  $self->deleteSubscriberWithID($self->{'subscriberID'});
167                                  }                                  $PersistentConnections{$self->{'subscriberID'}}=$self;
168                                  elsif($formElement=~/^maxtime=(\d+)$/i)                          }
169                                  {                          
170                                          my $clientRequest=$1;                          if(scalar(keys %{$channels}))
171                                          my $serverDefault=$::CONF{'MaxTime'};                          {
172                                                                            $self->emitOKHeader();
173                                          if($serverDefault==0 || $serverDefault>$clientRequest)                                  $self->setChannels($channels,$persist,$self->{'mode'},$useragent);
174                                          {                                  $self->close(1, 'responseComplete') unless($persist);
175                                                  $self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$clientRequest;                                  return;
176                                          }                          }
177                                  }                  }
178                          }                  elsif($self->{'headerBuffer'}=~/GET\s+\/disconnect\/(\S+)/)
179                                                                    {
180                          delete($self->{'headerBuffer'});                          $self->deleteSubscriberWithID($1);
181                                                    $self->emitOKHeader();
182                          if(defined($startIndex) && defined($backtrack))                          $self->close(1, 'disconnectRequested');
183                          {                          return;
184                                  $self->emitHeader("404 Cannot use both 'restartfrom' and 'backtrack'");                  }
185                                  $self->close();                  elsif($self->{'headerBuffer'}=~/GET\s+([^\s\?]+)/)
186                                                    {
187                                  return;                          Meteor::Document->serveFileToClient($1,$self);
188                          }                          $self->close(1, 'responseComplete');
189                                                    return;
190                          if(defined($subscriberID) && $persist)                  }
191                          {                  
192                                  $self->{'subscriberID'}=$subscriberID;                  #
193                                  $self->deleteSubscriberWithID($subscriberID);                  # If we fall through we did not understand the request
194                                  $PersistentConnections{$subscriberID}=$self;                  #
195                          }                  $self->emitErrorHeader();
196                                    }
197                          if(defined($channelName))  }
198                          {  
199                                  $self->emitOKHeader();  sub setChannels {
200                                            my $self=shift;
201                                  $startIndex=-$backtrack if(!defined($startIndex) && defined($backtrack));          my $channels=shift;
202                                            my $persist=shift;
203                                  $self->setChannelName($channelName,$startIndex,$persist);          my $mode=shift || '';
204                                            my $userAgent=shift || '';
205                                  $self->close(1) unless($persist);          
206                                            foreach my $channelName (keys %{$channels})
207                                  return;          {
208                          }                  my $startIndex=$channels->{$channelName}->{'startIndex'};
209                  }                  
210                  elsif($self->{'headerBuffer'}=~/GET\s+([^\s\?]+)/)                  my $channel=Meteor::Channel->channelWithName($channelName);
211                  {                  
212                          Meteor::Document->serveFileToClient($1,$self);                  $self->{'channels'}->{$channelName}=$channel if($persist);
213                                            
214                          $self->close(1);                  $channel->addSubscriber($self,$startIndex,$persist,$mode,$userAgent);
215                                    }
216                          return;  }
217                  }  
218                    sub emitOKHeader {
219                  #          my $self=shift;
220                  # If we fall through we did not understand the request          
221                  #          $self->emitHeader('200 OK');
222                  $self->emitErrorHeader();  }
223          }  
224  }  sub emitErrorHeader {
225            my $self=shift;
226  sub setChannelName {          
227          my $self=shift;          $self->emitHeader('404 Not Found');
228          my $channelName=shift;          $::Statistics->{'errors_served'}++;
229          my $startIndex=shift;          
230          my $persist=shift;          # close up shop here!
231                    $self->close(0, 'error');
232          my $channel=Meteor::Channel->channelWithName($channelName);  }
233          $self->{'channel'}=$channel if($persist);  
234            sub emitHeader {
235          $channel->addSubscriber($self,$startIndex,$persist);          my $self=shift;
236  }          my $status=shift;
237            
238  sub emitOKHeader {          my $header=$self->getConf('HeaderTemplate');
239          my $self=shift;          
240                    $header=~s/~([^~]*)~/
241          $self->emitHeader('200 OK');                  if(!defined($1) || $1 eq '')
242  }                  {
243                            '~';
244  sub emitErrorHeader {                  }
245          my $self=shift;                  elsif($1 eq 'server')
246                            {
247          $self->emitHeader('404 Not Found');                          $::PGM;
248                            }
249          # close up shop here!                  elsif($1 eq 'status')
250          $self->close();                  {
251  }                          $status;
252                    }
253  sub emitHeader {                  elsif($1 eq 'servertime')
254          my $self=shift;                  {
255          my $status=shift;                          time;
256                            }
257          my $header=undef;                  elsif($1 eq 'channelinfo')
258          if(exists($self->{'HeaderTemplateNumber'}))                  {
259          {                          Meteor::Channel->listChannelsUsingTemplate($self->getConf('ChannelInfoTemplate'));
260                  my $hn='HeaderTemplate'.$self->{'HeaderTemplateNumber'};                  }
261                                    else
262                  $header=$::CONF{$hn};                  {
263          }                          '';
264          $header=$::CONF{'HeaderTemplate'} unless(defined($header));                  }
265                    /gex;
266          $header=~s/~([^~]+)~/          
267                  if(!defined($1) || $1 eq '')          $self->write($header);
268                  {  }
269                          '~';  
270                  }  sub sendMessages {
271                  elsif($1 eq 'server')          my $self=shift;
272                  {          
273                          $::PGM;          my $numMessages=0;
274                  }          my $msgTemplate=$self->getConf('MessageTemplate');
275                  elsif($1 eq 'status')          my $msgData='';
276                  {          
277                          $status;          foreach my $message (@_)
278                  }          {
279                  elsif($1 eq 'servertime')                  $msgData.=$message->messageWithTemplate($msgTemplate);
280                  {                  $numMessages++;
281                          time;          }
282                  }          
283                  else          return if($numMessages<1);
284                  {          
285                          '';          $self->write($msgData);
286                  }          
287          /gex;          $::Statistics->{'messages_served'}+=$numMessages;
288                    
289          $self->write($header);          my $msgCount=$self->{'MessageCount'};
290  }          $msgCount+=$numMessages;
291            $self->{'MessageCount'}=$msgCount;
292  sub sendMessage {          
293          my $self=shift;          my $maxMsg=$self->getConf('MaxMessages');
294          my $msg=shift;          if(defined($maxMsg) && $maxMsg>0 && $msgCount>=$maxMsg)
295                    {
296          $self->write($msg);                  $self->close(1, 'maxMessageCountReached');
297                    }
298          my $msgCount=++$self->{'MessageCount'};          
299                    if($self->{'MaxMessageCount'}>0 && $msgCount>=$self->{'MaxMessageCount'})
300          my $maxMsg=$::CONF{'MaxMessages'};          {
301          if(defined($maxMsg) && $maxMsg>0 && $msgCount>=$maxMsg)                  $self->close(1, 'maxMessageCountReached');
302          {          }
303                  $self->close(1);          
304          }  }
305            
306          if($self->{'MaxMessageCount'}>0 && $msgCount>=$self->{'MaxMessageCount'})  sub ping {
307          {          my $self=shift;
308                  $self->close(1);          my $msg=$self->getConf('PingMessage');
309          }          
310  }          $self->write($msg);
311    }
312  sub close {  
313          my $self=shift;  sub closeChannel {
314          my $noShutdownMsg=shift;          my $self=shift;
315                    my $channelName=shift;
316          $self->{'channel'}->removeSubscriber($self) if($self->{'channel'});          
317          delete($self->{'channel'});          return unless(exists($self->{'channels'}->{$channelName}));
318                    
319          if(exists($self->{'subscriberID'}))          my $channel=$self->{'channels'}->{$channelName};
320          {          $channel->removeSubscriber($self,'channelClose');
321                  delete($PersistentConnections{$self->{'subscriberID'}});          
322          }          delete($self->{'channels'}->{$channelName});
323                    
324          #          $self->close(0,'channelClose') if(scalar(keys %{$self->{'channels'}})==0);
325          # Send shutdown message unless remote closed or  }
326          # connection not yet established  
327          #  sub close {
328          unless($noShutdownMsg || $self->{'remoteClosed'} || exists($self->{'headerBuffer'}))          my $self=shift;
329          {          my $noShutdownMsg=shift;
330                  my $msg=$::CONF{'SubscriberShutdownMsg'};          my $reason=shift;
331                  if(defined($msg) && $msg ne '')          
332                  {          foreach my $channelName (keys %{$self->{'channels'}})
333                          $self->write($msg);          {
334                  }                  my $channel=$self->{'channels'}->{$channelName};
335          }                  $channel->removeSubscriber($self,$reason);
336                    }
337          $self->SUPER::close();          delete($self->{'channels'});
338  }          
339            # If this connection is in the PersistentConnections array, delete it, then anonymise
340  sub checkForMaxTime {          # it so that if we have to wait for the write buffer to empty before close, it's only
341          my $self=shift;          # removed once.
342          my $time=shift;          if(exists($self->{'subscriberID'})) {
343                            delete($PersistentConnections{$self->{'subscriberID'}});
344          $self->close(1) if(exists($self->{'ConnectionTimeLimit'}) && $self->{'ConnectionTimeLimit'}<$time);                  delete($self->{'subscriberID'});
345  }          }
346            
347  1;          # Send shutdown message unless remote closed or
348            # connection not yet established
349            unless($noShutdownMsg || $self->{'remoteClosed'} || exists($self->{'headerBuffer'}))
350            {
351                    my $msg=$self->getConf('SubscriberShutdownMsg');
352                    if(defined($msg) && $msg ne '')
353                    {
354                            $self->write($msg);
355                    }
356            }
357            
358            $self->SUPER::close();
359    }
360    
361    sub didClose {
362            
363            $::Statistics->{'current_subscribers'}--;
364    }
365    
366    sub checkForMaxTime {
367            my $self=shift;
368            my $time=shift;
369            
370            $self->close(1,'maxTime') if(exists($self->{'ConnectionTimeLimit'}) && $self->{'ConnectionTimeLimit'}<$time);
371    }
372    
373    sub getConf {
374            my $self=shift;
375            my $key=shift;
376            
377            if(exists($self->{'mode'}) && $self->{'mode'} ne '')
378            {
379                    my $k=$key.$self->{'mode'};
380                    
381                    if(exists($::CONF{$k})) {
382                            return $::CONF{$k};
383                    }
384            }
385            
386            $::CONF{$key};
387    }
388    
389    1;
390  ############################################################################EOF  ############################################################################EOF

Legend:
Removed from v.9  
changed lines
  Added in v.50

  ViewVC Help
Powered by ViewVC 1.1.26