/[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 17 by knops.gerd, Tue May 1 17:10:10 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 $subscriberID=undef;
136                          foreach my $formElement (@formData)                          my $channels={};
137                          {                          foreach my $formElement (@formData)
138                                  if($formElement=~/^channel=(.+)$/)                          {
139                                  {                                  if($formElement=~/^channel=(.+)$/)
140                                          $channelName=$1;                                  {
141                                  }                                          if(defined($channelName))
142                                  elsif($formElement=~/^restartfrom=(\d*)$/)                                          {
143                                  {                                                  if(defined($startIndex) && defined($backtrack))
144                                          $startIndex=$1;                                                  {
145                                          $startIndex='' unless(defined($startIndex));                                                          $self->emitHeader("404 Cannot use both 'restartfrom' and 'backtrack'");
146                                  }                                                          $self->close();
147                                  elsif($formElement=~/^backtrack=(\d+)$/)                                                          
148                                  {                                                          return;
149                                          $backtrack=$1;                                                  }
150                                          $backtrack=0 unless(defined($backtrack));                                                  
151                                  }                                                  $startIndex=-$backtrack if(!defined($startIndex) && defined($backtrack));
152                                  elsif($formElement=~/^persist=(?i)(yes|true|1|no|false|0)$/)                                                  $channels->{$channelName}->{'startIndex'}=$startIndex;
153                                  {                                                  
154                                          $persist=0 if($1=~/(no|false|0)/i);                                                  $startIndex=undef;
155                                  }                                                  $backtrack=undef;
156                                  elsif($formElement=~/^id=(.+)$/)                                          }
157                                  {                                          $channelName=$1;
158                                          $subscriberID=$1;                                  }
159                                  }                                  elsif($formElement=~/^restartfrom=(\d*)$/)
160                                  elsif($formElement=~/^maxmessages=(\d+)$/i)                                  {
161                                  {                                          $startIndex=$1;
162                                          $self->{'MaxMessageCount'}=$1;                                          $startIndex='' unless(defined($startIndex));
163                                  }                                  }
164                                  elsif($formElement=~/^template=(\d+)$/i)                                  elsif($formElement=~/^backtrack=(\d+)$/)
165                                  {                                  {
166                                          $self->{'HeaderTemplateNumber'}=$1;                                          $backtrack=$1;
167                                  }                                          $backtrack=0 unless(defined($backtrack));
168                                  elsif($formElement=~/^maxtime=(\d+)$/i)                                  }
169                                  {                                  elsif($formElement=~/^persist=(?i)(yes|true|1|no|false|0)$/)
170                                          my $clientRequest=$1;                                  {
171                                          my $serverDefault=$::CONF{'MaxTime'};                                          $persist=0 if($1=~/(no|false|0)/i);
172                                                                            }
173                                          if($serverDefault==0 || $serverDefault>$clientRequest)                                  elsif($formElement=~/^id=(.+)$/)
174                                          {                                  {
175                                                  $self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$clientRequest;                                          $subscriberID=$1;
176                                          }                                  }
177                                  }                                  elsif($formElement=~/^maxmessages=(\d+)$/i)
178                          }                                  {
179                                                                                            $self->{'MaxMessageCount'}=$1;
180                          delete($self->{'headerBuffer'});                                  }
181                                                            elsif($formElement=~/^template=(\d+)$/i)
182                          if(defined($startIndex) && defined($backtrack))                                  {
183                          {                                          $self->{'HeaderTemplateNumber'}=$1;
184                                  $self->emitHeader("404 Cannot use both 'restartfrom' and 'backtrack'");                                  }
185                                  $self->close();                                  elsif($formElement=~/^maxtime=(\d+)$/i)
186                                                                    {
187                                  return;                                          my $clientRequest=$1;
188                          }                                          my $serverDefault=$::CONF{'MaxTime'};
189                                                                    
190                          if(defined($subscriberID) && $persist)                                          if($serverDefault==0 || $serverDefault>$clientRequest)
191                          {                                          {
192                                  $self->{'subscriberID'}=$subscriberID;                                                  $self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$clientRequest;
193                                  $self->deleteSubscriberWithID($subscriberID);                                          }
194                                  $PersistentConnections{$subscriberID}=$self;                                  }
195                          }                          }
196                                                    
197                          if(defined($channelName))                          if(defined($channelName))
198                          {                          {
199                                  $self->emitOKHeader();                                  if(defined($startIndex) && defined($backtrack))
200                                                                    {
201                                  $startIndex=-$backtrack if(!defined($startIndex) && defined($backtrack));                                          $self->emitHeader("404 Cannot use both 'restartfrom' and 'backtrack'");
202                                                                            $self->close();
203                                  $self->setChannelName($channelName,$startIndex,$persist);                                          
204                                                                            return;
205                                  $self->close(1) unless($persist);                                  }
206                                                                    
207                                  return;                                  $startIndex=-$backtrack if(!defined($startIndex) && defined($backtrack));
208                          }                                  $channels->{$channelName}->{'startIndex'}=$startIndex;
209                  }                          }
210                  elsif($self->{'headerBuffer'}=~/GET\s+([^\s\?]+)/)                          
211                  {                          delete($self->{'headerBuffer'});
212                          Meteor::Document->serveFileToClient($1,$self);                          
213                                                    if(defined($subscriberID) && $persist)
214                          $self->close(1);                          {
215                                                            $self->{'subscriberID'}=$subscriberID;
216                          return;                                  $self->deleteSubscriberWithID($subscriberID);
217                  }                                  $PersistentConnections{$subscriberID}=$self;
218                                            }
219                  #                          
220                  # If we fall through we did not understand the request                          if(scalar(keys %{$channels}))
221                  #                          {
222                  $self->emitErrorHeader();                                  $self->emitOKHeader();
223          }                                  
224  }                                  $self->setChannels($channels,$persist);
225                                    
226  sub setChannelName {                                  $self->close(1) unless($persist);
227          my $self=shift;                                  
228          my $channelName=shift;                                  return;
229          my $startIndex=shift;                          }
230          my $persist=shift;                  }
231                            elsif($self->{'headerBuffer'}=~/GET\s+([^\s\?]+)/)
232          my $channel=Meteor::Channel->channelWithName($channelName);                  {
233          $self->{'channel'}=$channel if($persist);                          Meteor::Document->serveFileToClient($1,$self);
234                                    
235          $channel->addSubscriber($self,$startIndex,$persist);                          $self->close(1);
236  }                          
237                            return;
238  sub emitOKHeader {                  }
239          my $self=shift;                  
240                            #
241          $self->emitHeader('200 OK');                  # If we fall through we did not understand the request
242  }                  #
243                    $self->emitErrorHeader();
244  sub emitErrorHeader {          }
245          my $self=shift;  }
246            
247          $self->emitHeader('404 Not Found');  sub setChannels {
248                    my $self=shift;
249          # close up shop here!          my $channels=shift;
250          $self->close();          my $persist=shift;
251  }          
252            foreach my $channelName (keys %{$channels})
253  sub emitHeader {          {
254          my $self=shift;                  my $startIndex=$channels->{$channelName}->{'startIndex'};
255          my $status=shift;                  
256                            my $channel=Meteor::Channel->channelWithName($channelName);
257          my $header=undef;                  
258          if(exists($self->{'HeaderTemplateNumber'}))                  $self->{'channels'}->{$channelName}=$channel if($persist);
259          {                  
260                  my $hn='HeaderTemplate'.$self->{'HeaderTemplateNumber'};                  $channel->addSubscriber($self,$startIndex,$persist);
261                            }
262                  $header=$::CONF{$hn};  }
263          }  
264          $header=$::CONF{'HeaderTemplate'} unless(defined($header));  sub emitOKHeader {
265                    my $self=shift;
266          $header=~s/~([^~]+)~/          
267                  if(!defined($1) || $1 eq '')          $self->emitHeader('200 OK');
268                  {  }
269                          '~';  
270                  }  sub emitErrorHeader {
271                  elsif($1 eq 'server')          my $self=shift;
272                  {          
273                          $::PGM;          $self->emitHeader('404 Not Found');
274                  }          
275                  elsif($1 eq 'status')          # close up shop here!
276                  {          $self->close();
277                          $status;  }
278                  }  
279                  elsif($1 eq 'servertime')  sub emitHeader {
280                  {          my $self=shift;
281                          time;          my $status=shift;
282                  }          
283                  else          my $header=undef;
284                  {          if(exists($self->{'HeaderTemplateNumber'}))
285                          '';          {
286                  }                  my $hn='HeaderTemplate'.$self->{'HeaderTemplateNumber'};
287          /gex;                  
288                            $header=$::CONF{$hn};
289          $self->write($header);          }
290  }          $header=$::CONF{'HeaderTemplate'} unless(defined($header));
291            
292  sub sendMessage {          $header=~s/~([^~]+)~/
293          my $self=shift;                  if(!defined($1) || $1 eq '')
294          my $msg=shift;                  {
295                                    '~';
296          $self->write($msg);                  }
297                            elsif($1 eq 'server')
298          my $msgCount=++$self->{'MessageCount'};                  {
299                                    $::PGM;
300          my $maxMsg=$::CONF{'MaxMessages'};                  }
301          if(defined($maxMsg) && $maxMsg>0 && $msgCount>=$maxMsg)                  elsif($1 eq 'status')
302          {                  {
303                  $self->close(1);                          $status;
304          }                  }
305                            elsif($1 eq 'servertime')
306          if($self->{'MaxMessageCount'}>0 && $msgCount>=$self->{'MaxMessageCount'})                  {
307          {                          time;
308                  $self->close(1);                  }
309          }                  else
310  }                  {
311                            '';
312  sub close {                  }
313          my $self=shift;          /gex;
314          my $noShutdownMsg=shift;          
315                    $self->write($header);
316          $self->{'channel'}->removeSubscriber($self) if($self->{'channel'});  }
317          delete($self->{'channel'});  
318            sub sendMessage {
319          if(exists($self->{'subscriberID'}))          my $self=shift;
320          {          my $msg=shift;
321                  delete($PersistentConnections{$self->{'subscriberID'}});          
322          }          $self->write($msg);
323                    
324          #          my $msgCount=++$self->{'MessageCount'};
325          # Send shutdown message unless remote closed or          
326          # connection not yet established          my $maxMsg=$::CONF{'MaxMessages'};
327          #          if(defined($maxMsg) && $maxMsg>0 && $msgCount>=$maxMsg)
328          unless($noShutdownMsg || $self->{'remoteClosed'} || exists($self->{'headerBuffer'}))          {
329          {                  $self->close(1);
330                  my $msg=$::CONF{'SubscriberShutdownMsg'};          }
331                  if(defined($msg) && $msg ne '')          
332                  {          if($self->{'MaxMessageCount'}>0 && $msgCount>=$self->{'MaxMessageCount'})
333                          $self->write($msg);          {
334                  }                  $self->close(1);
335          }          }
336            }
337          $self->SUPER::close();  
338  }  sub closeChannel {
339            my $self=shift;
340  sub checkForMaxTime {          my $channelName=shift;
341          my $self=shift;          
342          my $time=shift;          return unless(exists($self->{'channels'}->{$channelName}));
343                    
344          $self->close(1) if(exists($self->{'ConnectionTimeLimit'}) && $self->{'ConnectionTimeLimit'}<$time);          my $channel=$self->{'channels'}->{$channelName};
345  }          $channel->removeSubscriber($self);
346            
347  1;          delete($self->{'channels'}->{$channelName});
348            
349            $self->close() if(scalar(keys %{$self->{'channels'}})==0);
350    }
351    
352    sub close {
353            my $self=shift;
354            my $noShutdownMsg=shift;
355            
356            foreach my $channelName (keys %{$self->{'channels'}})
357            {
358                    my $channel=$self->{'channels'}->{$channelName};
359                    $channel->removeSubscriber($self);
360            }
361            delete($self->{'channels'});
362            
363            if(exists($self->{'subscriberID'}))
364            {
365                    delete($PersistentConnections{$self->{'subscriberID'}});
366            }
367            
368            #
369            # Send shutdown message unless remote closed or
370            # connection not yet established
371            #
372            unless($noShutdownMsg || $self->{'remoteClosed'} || exists($self->{'headerBuffer'}))
373            {
374                    my $msg=$::CONF{'SubscriberShutdownMsg'};
375                    if(defined($msg) && $msg ne '')
376                    {
377                            $self->write($msg);
378                    }
379            }
380            
381            $self->SUPER::close();
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    1;
392  ############################################################################EOF  ############################################################################EOF
Legend:
Removed from v.9  
changed lines
  Added in v.17
  ViewVC Help
Powered by ViewVC 1.1.26