/[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 13 by knops.gerd, Mon Apr 30 18:16:17 2007 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    
47  ###############################################################################  ###############################################################################
48  # Factory methods  # Factory methods
49  ###############################################################################  ###############################################################################
50  sub newFromServer {  sub newFromServer {
51          my $class=shift;          my $class=shift;
52                    
53          my $self=$class->SUPER::newFromServer(shift);          my $self=$class->SUPER::newFromServer(shift);
54                    
55          $self->{'headerBuffer'}='';          $self->{'headerBuffer'}='';
56          $self->{'MessageCount'}=0;          $self->{'MessageCount'}=0;
57          $self->{'MaxMessageCount'}=0;          $self->{'MaxMessageCount'}=0;
58                    
59          $self->{'ConnectionStart'}=time;          $self->{'ConnectionStart'}=time;
60          my $maxTime=$::CONF{'MaxTime'};          my $maxTime=$::CONF{'MaxTime'};
61          if($maxTime>0)          if($maxTime>0)
62          {          {
63                  $self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$maxTime;                  $self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$maxTime;
64          }          }
65                    
66          $self;          $self;
67  }  }
68    
69  ###############################################################################  ###############################################################################
70  # Class methods  # Class methods
71  ###############################################################################  ###############################################################################
72  sub deleteSubscriberWithID {  sub deleteSubscriberWithID {
73          my $class=shift;          my $class=shift;
74          my $id=shift;          my $id=shift;
75                    
76          if(exists($PersistentConnections{$id}))          if(exists($PersistentConnections{$id}))
77          {          {
78                  $PersistentConnections{$id}->close(1);                  $PersistentConnections{$id}->close(1);
79          }          }
80  }  }
81    
82  sub pingPersistentConnections {  sub pingPersistentConnections {
83          my $class=shift;          my $class=shift;
84                    
85          my $msg=$::CONF{'PingMessage'};          my $msg=$::CONF{'PingMessage'};
86          my @cons=values %PersistentConnections;          my @cons=values %PersistentConnections;
87                    
88          map { $_->write($msg) } @cons;          map { $_->write($msg) } @cons;
89  }  }
90    
91  sub checkPersistentConnectionsForMaxTime {  sub checkPersistentConnectionsForMaxTime {
92          my $class=shift;          my $class=shift;
93                    
94          my $time=time;          my $time=time;
95          my @cons=values %PersistentConnections;          my @cons=values %PersistentConnections;
96                    
97          map { $_->checkForMaxTime($time) } @cons;          map { $_->checkForMaxTime($time) } @cons;
98  }  }
99    
100  ###############################################################################  ###############################################################################
101  # Instance methods  # Instance methods
102  ###############################################################################  ###############################################################################
103  sub processLine {  sub processLine {
104          my $self=shift;          my $self=shift;
105          my $line=shift;          my $line=shift;
106                    
107          # Once the header was processed we ignore any input          # Once the header was processed we ignore any input
108          return unless(exists($self->{'headerBuffer'}));          return unless(exists($self->{'headerBuffer'}));
109                    
110          if($line ne '')          if($line ne '')
111          {          {
112                  #                  #
113                  # Accumulate header                  # Accumulate header
114                  #                  #
115                  $self->{'headerBuffer'}.="$line\n";                  $self->{'headerBuffer'}.="$line\n";
116          }          }
117          else          else
118          {          {
119                  #                  #
120                  # Empty line signals end of header.                  # Empty line signals end of header.
121                  # Analyze header, register with appropiate channel                  # Analyze header, register with appropiate channel
122                  # and send pending messages.                  # and send pending messages.
123                  #                  #
124                  # GET $::CONF{'SubscriberDynamicPageAddress'}?channel=ml123&restartfrom=1 HTTP/1.1                  # GET $::CONF{'SubscriberDynamicPageAddress'}?channel=ml123&restartfrom=1 HTTP/1.1
125                  #                  #
126                  # Find the 'GET' line                  # Find the 'GET' line
127                  #                  #
128                  if($self->{'headerBuffer'}=~/GET\s+$::CONF{'SubscriberDynamicPageAddress'}\?(\S+)/)                  if($self->{'headerBuffer'}=~/GET\s+$::CONF{'SubscriberDynamicPageAddress'}\?(\S+)/)
129                  {                  {
130                          my @formData=split('&',$1);                          my @formData=split('&',$1);
131                          my $channelName=undef;                          my $channelName=undef;
132                          my $startIndex=undef;                          my $startIndex=undef;
133                          my $backtrack=undef;                          my $backtrack=undef;
134                          my $persist=1;                          my $persist=1;
135                          my $subscriberID=undef;                          my $anyPersist=0;
136                          foreach my $formElement (@formData)                          my $subscriberID=undef;
137                          {                          my $channels={};
138                                  if($formElement=~/^channel=(.+)$/)                          foreach my $formElement (@formData)
139                                  {                          {
140                                          $channelName=$1;                                  if($formElement=~/^channel=(.+)$/)
141                                  }                                  {
142                                  elsif($formElement=~/^restartfrom=(\d*)$/)                                          if(defined($channelName))
143                                  {                                          {
144                                          $startIndex=$1;                                                  if(defined($startIndex) && defined($backtrack))
145                                          $startIndex='' unless(defined($startIndex));                                                  {
146                                  }                                                          $self->emitHeader("404 Cannot use both 'restartfrom' and 'backtrack'");
147                                  elsif($formElement=~/^backtrack=(\d+)$/)                                                          $self->close();
148                                  {                                                          
149                                          $backtrack=$1;                                                          return;
150                                          $backtrack=0 unless(defined($backtrack));                                                  }
151                                  }                                                  
152                                  elsif($formElement=~/^persist=(?i)(yes|true|1|no|false|0)$/)                                                  $startIndex=-$backtrack if(!defined($startIndex) && defined($backtrack));
153                                  {                                                  $channels->{$channelName}->{'startIndex'}=$startIndex;
154                                          $persist=0 if($1=~/(no|false|0)/i);                                                  $channels->{$channelName}->{'persist'}=$persist;
155                                  }                                                  $anyPersist|=$persist;
156                                  elsif($formElement=~/^id=(.+)$/)                                                  
157                                  {                                                  $startIndex=undef;
158                                          $subscriberID=$1;                                                  $backtrack=undef;
159                                  }                                                  $persist=1;
160                                  elsif($formElement=~/^maxmessages=(\d+)$/i)                                          }
161                                  {                                          $channelName=$1;
162                                          $self->{'MaxMessageCount'}=$1;                                  }
163                                  }                                  elsif($formElement=~/^restartfrom=(\d*)$/)
164                                  elsif($formElement=~/^template=(\d+)$/i)                                  {
165                                  {                                          $startIndex=$1;
166                                          $self->{'HeaderTemplateNumber'}=$1;                                          $startIndex='' unless(defined($startIndex));
167                                  }                                  }
168                                  elsif($formElement=~/^maxtime=(\d+)$/i)                                  elsif($formElement=~/^backtrack=(\d+)$/)
169                                  {                                  {
170                                          my $clientRequest=$1;                                          $backtrack=$1;
171                                          my $serverDefault=$::CONF{'MaxTime'};                                          $backtrack=0 unless(defined($backtrack));
172                                                                            }
173                                          if($serverDefault==0 || $serverDefault>$clientRequest)                                  elsif($formElement=~/^persist=(?i)(yes|true|1|no|false|0)$/)
174                                          {                                  {
175                                                  $self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$clientRequest;                                          $persist=0 if($1=~/(no|false|0)/i);
176                                          }                                  }
177                                  }                                  elsif($formElement=~/^id=(.+)$/)
178                          }                                  {
179                                                                                            $subscriberID=$1;
180                          delete($self->{'headerBuffer'});                                  }
181                                                            elsif($formElement=~/^maxmessages=(\d+)$/i)
182                          if(defined($startIndex) && defined($backtrack))                                  {
183                          {                                          $self->{'MaxMessageCount'}=$1;
184                                  $self->emitHeader("404 Cannot use both 'restartfrom' and 'backtrack'");                                  }
185                                  $self->close();                                  elsif($formElement=~/^template=(\d+)$/i)
186                                                                    {
187                                  return;                                          $self->{'HeaderTemplateNumber'}=$1;
188                          }                                  }
189                                                            elsif($formElement=~/^maxtime=(\d+)$/i)
190                          if(defined($subscriberID) && $persist)                                  {
191                          {                                          my $clientRequest=$1;
192                                  $self->{'subscriberID'}=$subscriberID;                                          my $serverDefault=$::CONF{'MaxTime'};
193                                  $self->deleteSubscriberWithID($subscriberID);                                          
194                                  $PersistentConnections{$subscriberID}=$self;                                          if($serverDefault==0 || $serverDefault>$clientRequest)
195                          }                                          {
196                                                                            $self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$clientRequest;
197                          if(defined($channelName))                                          }
198                          {                                  }
199                                  $self->emitOKHeader();                          }
200                                                            
201                                  $startIndex=-$backtrack if(!defined($startIndex) && defined($backtrack));                          if(defined($channelName))
202                                                            {
203                                  $self->setChannelName($channelName,$startIndex,$persist);                                  if(defined($startIndex) && defined($backtrack))
204                                                                    {
205                                  $self->close(1) unless($persist);                                          $self->emitHeader("404 Cannot use both 'restartfrom' and 'backtrack'");
206                                                                            $self->close();
207                                  return;                                          
208                          }                                          return;
209                  }                                  }
210                  elsif($self->{'headerBuffer'}=~/GET\s+([^\s\?]+)/)                                  
211                  {                                  $startIndex=-$backtrack if(!defined($startIndex) && defined($backtrack));
212                          Meteor::Document->serveFileToClient($1,$self);                                  $channels->{$channelName}->{'startIndex'}=$startIndex;
213                                                            $channels->{$channelName}->{'persist'}=$persist;
214                          $self->close(1);                                  $anyPersist|=$persist;
215                                                    }
216                          return;                          
217                  }                          delete($self->{'headerBuffer'});
218                                            
219                  #                          if(defined($subscriberID) && $anyPersist)
220                  # If we fall through we did not understand the request                          {
221                  #                                  $self->{'subscriberID'}=$subscriberID;
222                  $self->emitErrorHeader();                                  $self->deleteSubscriberWithID($subscriberID);
223          }                                  $PersistentConnections{$subscriberID}=$self;
224  }                          }
225                            
226  sub setChannelName {                          if(scalar(keys %{$channels}))
227          my $self=shift;                          {
228          my $channelName=shift;                                  $self->emitOKHeader();
229          my $startIndex=shift;                                  
230          my $persist=shift;                                  $self->setChannels($channels);
231                                            
232          my $channel=Meteor::Channel->channelWithName($channelName);                                  $self->close(1) unless($anyPersist);
233          $self->{'channel'}=$channel if($persist);                                  
234                                            return;
235          $channel->addSubscriber($self,$startIndex,$persist);                          }
236  }                  }
237                    elsif($self->{'headerBuffer'}=~/GET\s+([^\s\?]+)/)
238  sub emitOKHeader {                  {
239          my $self=shift;                          Meteor::Document->serveFileToClient($1,$self);
240                                    
241          $self->emitHeader('200 OK');                          $self->close(1);
242  }                          
243                            return;
244  sub emitErrorHeader {                  }
245          my $self=shift;                  
246                            #
247          $self->emitHeader('404 Not Found');                  # If we fall through we did not understand the request
248                            #
249          # close up shop here!                  $self->emitErrorHeader();
250          $self->close();          }
251  }  }
252    
253  sub emitHeader {  sub setChannels {
254          my $self=shift;          my $self=shift;
255          my $status=shift;          my $channels=shift;
256                    
257          my $header=undef;          foreach my $channelName (keys %{$channels})
258          if(exists($self->{'HeaderTemplateNumber'}))          {
259          {                  my $persist=$channels->{$channelName}->{'persist'};
260                  my $hn='HeaderTemplate'.$self->{'HeaderTemplateNumber'};                  my $startIndex=$channels->{$channelName}->{'startIndex'};
261                                    
262                  $header=$::CONF{$hn};                  my $channel=Meteor::Channel->channelWithName($channelName);
263          }                  
264          $header=$::CONF{'HeaderTemplate'} unless(defined($header));                  $self->{'channels'}->{$channelName}=$channel if($persist);
265                            
266          $header=~s/~([^~]+)~/                  $channel->addSubscriber($self,$startIndex,$persist);
267                  if(!defined($1) || $1 eq '')          }
268                  {  }
269                          '~';  
270                  }  sub emitOKHeader {
271                  elsif($1 eq 'server')          my $self=shift;
272                  {          
273                          $::PGM;          $self->emitHeader('200 OK');
274                  }  }
275                  elsif($1 eq 'status')  
276                  {  sub emitErrorHeader {
277                          $status;          my $self=shift;
278                  }          
279                  elsif($1 eq 'servertime')          $self->emitHeader('404 Not Found');
280                  {          
281                          time;          # close up shop here!
282                  }          $self->close();
283                  else  }
284                  {  
285                          '';  sub emitHeader {
286                  }          my $self=shift;
287          /gex;          my $status=shift;
288                    
289          $self->write($header);          my $header=undef;
290  }          if(exists($self->{'HeaderTemplateNumber'}))
291            {
292  sub sendMessage {                  my $hn='HeaderTemplate'.$self->{'HeaderTemplateNumber'};
293          my $self=shift;                  
294          my $msg=shift;                  $header=$::CONF{$hn};
295                    }
296          $self->write($msg);          $header=$::CONF{'HeaderTemplate'} unless(defined($header));
297                    
298          my $msgCount=++$self->{'MessageCount'};          $header=~s/~([^~]+)~/
299                            if(!defined($1) || $1 eq '')
300          my $maxMsg=$::CONF{'MaxMessages'};                  {
301          if(defined($maxMsg) && $maxMsg>0 && $msgCount>=$maxMsg)                          '~';
302          {                  }
303                  $self->close(1);                  elsif($1 eq 'server')
304          }                  {
305                                    $::PGM;
306          if($self->{'MaxMessageCount'}>0 && $msgCount>=$self->{'MaxMessageCount'})                  }
307          {                  elsif($1 eq 'status')
308                  $self->close(1);                  {
309          }                          $status;
310  }                  }
311                    elsif($1 eq 'servertime')
312  sub close {                  {
313          my $self=shift;                          time;
314          my $noShutdownMsg=shift;                  }
315                            else
316          $self->{'channel'}->removeSubscriber($self) if($self->{'channel'});                  {
317          delete($self->{'channel'});                          '';
318                            }
319          if(exists($self->{'subscriberID'}))          /gex;
320          {          
321                  delete($PersistentConnections{$self->{'subscriberID'}});          $self->write($header);
322          }  }
323            
324          #  sub sendMessage {
325          # Send shutdown message unless remote closed or          my $self=shift;
326          # connection not yet established          my $msg=shift;
327          #          
328          unless($noShutdownMsg || $self->{'remoteClosed'} || exists($self->{'headerBuffer'}))          $self->write($msg);
329          {          
330                  my $msg=$::CONF{'SubscriberShutdownMsg'};          my $msgCount=++$self->{'MessageCount'};
331                  if(defined($msg) && $msg ne '')          
332                  {          my $maxMsg=$::CONF{'MaxMessages'};
333                          $self->write($msg);          if(defined($maxMsg) && $maxMsg>0 && $msgCount>=$maxMsg)
334                  }          {
335          }                  $self->close(1);
336                    }
337          $self->SUPER::close();          
338  }          if($self->{'MaxMessageCount'}>0 && $msgCount>=$self->{'MaxMessageCount'})
339            {
340  sub checkForMaxTime {                  $self->close(1);
341          my $self=shift;          }
342          my $time=shift;  }
343            
344          $self->close(1) if(exists($self->{'ConnectionTimeLimit'}) && $self->{'ConnectionTimeLimit'}<$time);  sub closeChannel {
345  }          my $self=shift;
346            my $channelName=shift;
347  1;          
348            return unless(exists($self->{'channels'}->{$channelName}));
349            
350            my $channel=$self->{'channels'}->{$channelName};
351            $channel->removeSubscriber($self);
352            
353            delete($self->{'channels'}->{$channelName});
354            
355            $self->close() if(scalar(keys %{$self->{'channels'}})==0);
356    }
357    
358    sub close {
359            my $self=shift;
360            my $noShutdownMsg=shift;
361            
362            foreach my $channelName (keys %{$self->{'channels'}})
363            {
364                    my $channel=$self->{'channels'}->{$channelName};
365                    $channel->removeSubscriber($self);
366            }
367            delete($self->{'channels'});
368            
369            if(exists($self->{'subscriberID'}))
370            {
371                    delete($PersistentConnections{$self->{'subscriberID'}});
372            }
373            
374            #
375            # Send shutdown message unless remote closed or
376            # connection not yet established
377            #
378            unless($noShutdownMsg || $self->{'remoteClosed'} || exists($self->{'headerBuffer'}))
379            {
380                    my $msg=$::CONF{'SubscriberShutdownMsg'};
381                    if(defined($msg) && $msg ne '')
382                    {
383                            $self->write($msg);
384                    }
385            }
386            
387            $self->SUPER::close();
388    }
389    
390    sub checkForMaxTime {
391            my $self=shift;
392            my $time=shift;
393            
394            $self->close(1) if(exists($self->{'ConnectionTimeLimit'}) && $self->{'ConnectionTimeLimit'}<$time);
395    }
396    
397    1;
398  ############################################################################EOF  ############################################################################EOF
Legend:
Removed from v.9  
changed lines
  Added in v.13
  ViewVC Help
Powered by ViewVC 1.1.26