--- googlecode.com/svn/trunk/Meteor/Subscriber.pm	2007/04/30 18:16:17	13
+++ googlecode.com/svn/trunk/Meteor/Subscriber.pm	2009/01/19 11:19:41	64
@@ -43,6 +43,8 @@
 	@Meteor::Subscriber::ISA=qw(Meteor::Connection);
 	
 	our %PersistentConnections=();
+	our $NumAcceptedConnections=0;
+    
 
 ###############################################################################
 # Factory methods
@@ -53,15 +55,10 @@
 	my $self=$class->SUPER::newFromServer(shift);
 	
 	$self->{'headerBuffer'}='';
-	$self->{'MessageCount'}=0;
-	$self->{'MaxMessageCount'}=0;
+	$self->{'messageCount'}=0;
 	
-	$self->{'ConnectionStart'}=time;
-	my $maxTime=$::CONF{'MaxTime'};
-	if($maxTime>0)
-	{
-		$self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$maxTime;
-	}
+	$::Statistics->{'current_subscribers'}++;
+	$::Statistics->{'subscriber_connections_accepted'}++;
 	
 	$self;
 }
@@ -75,17 +72,23 @@
 	
 	if(exists($PersistentConnections{$id}))
 	{
-		$PersistentConnections{$id}->close(1);
+		$PersistentConnections{$id}->close(0,'newSubscriberWithSameID');
 	}
 }
 
+sub subscriberExists {
+	my $class=shift;
+	my $id=shift;
+
+	return exists($PersistentConnections{$id});
+}
+
 sub pingPersistentConnections {
 	my $class=shift;
 	
-	my $msg=$::CONF{'PingMessage'};
 	my @cons=values %PersistentConnections;
 	
-	map { $_->write($msg) } @cons;
+	map { $_->ping() } @cons;
 }
 
 sub checkPersistentConnectionsForMaxTime {
@@ -97,6 +100,22 @@
 	map { $_->checkForMaxTime($time) } @cons;
 }
 
+sub numSubscribers {
+	
+	return scalar(keys %PersistentConnections);
+}
+
+sub listSubscribers {
+	my $class=shift;
+	my $list='';
+	foreach my $subscriber (keys %PersistentConnections)
+	{
+		my $sub = $PersistentConnections{$subscriber};
+		$list .= $subscriber.' '.$sub->{'ip'}.' '.$sub->{'connectionStart'}.' '.$sub->{'connectionTimeLimit'}.' '.($sub->{'connectionTimeLimit'}-time).' '.$sub->{'messageCount'}.' "'.$sub->{'useragent'}."\"$::CRLF";
+	}
+	$list;
+}
+
 ###############################################################################
 # Instance methods
 ###############################################################################
@@ -104,7 +123,7 @@
 	my $self=shift;
 	my $line=shift;
 	
-	# Once the header was processed we ignore any input
+	# Once the header was processed we ignore any input - Meteor does not accept or process request bodies
 	return unless(exists($self->{'headerBuffer'}));
 	
 	if($line ne '')
@@ -121,125 +140,85 @@
 		# Analyze header, register with appropiate channel
 		# and send pending messages.
 		#
-		# GET $::CONF{'SubscriberDynamicPageAddress'}?channel=ml123&restartfrom=1 HTTP/1.1
+		# GET $::CONF{'SubscriberDynamicPageAddress'}/hostid/streamtype/channeldefs HTTP/1.1
 		#
 		# Find the 'GET' line
 		#
-		if($self->{'headerBuffer'}=~/GET\s+$::CONF{'SubscriberDynamicPageAddress'}\?(\S+)/)
+		if($self->{'headerBuffer'}=~/GET\s+$::CONF{'SubscriberDynamicPageAddress'}\/([0-9a-z]+)\/([0-9a-z]+)\/([a-z0-9_\-\%\.\/]+).*?/i)
 		{
-			my @formData=split('&',$1);
-			my $channelName=undef;
-			my $startIndex=undef;
-			my $backtrack=undef;
-			my $persist=1;
-			my $anyPersist=0;
-			my $subscriberID=undef;
+			$self->{'subscriberID'}=$1;
+			$self->{'mode'}=$2;
+			my $persist=$self->getConf('Persist');
+			my $maxTime=$self->getConf('MaxTime');
+			$self->{'connectionTimeLimit'} = ($self->{'connectionStart'}+$maxTime) if ($maxTime>0);
+			
+			my @channelData=split('/',$3);
 			my $channels={};
-			foreach my $formElement (@formData)
-			{
-				if($formElement=~/^channel=(.+)$/)
-				{
-					if(defined($channelName))
-					{
-						if(defined($startIndex) && defined($backtrack))
-						{
-							$self->emitHeader("404 Cannot use both 'restartfrom' and 'backtrack'");
-							$self->close();
-							
-							return;
-						}
-						
-						$startIndex=-$backtrack if(!defined($startIndex) && defined($backtrack));
-						$channels->{$channelName}->{'startIndex'}=$startIndex;
-						$channels->{$channelName}->{'persist'}=$persist;
-						$anyPersist|=$persist;
-						
-						$startIndex=undef;
-						$backtrack=undef;
-						$persist=1;
+			my $channelName;
+			my $offset;
+			foreach my $chandef (@channelData) {
+				if($chandef=~/^([a-z0-9_\-\%]+)(.(r|b|h)([0-9]*))?$/i) {
+					$channelName = $1;
+					$channels->{$channelName}->{'startIndex'} = undef;
+					if ($3) {
+					   $offset = $4;
+					   if ($3 eq 'r') { $channels->{$channelName}->{'startIndex'} = $offset; }
+					   if ($3 eq 'b') { $channels->{$channelName}->{'startIndex'} = -$offset; }
+					   if ($3 eq 'h') { $channels->{$channelName}->{'startIndex'} = 0; }
 					}
-					$channelName=$1;
-				}
-				elsif($formElement=~/^restartfrom=(\d*)$/)
-				{
-					$startIndex=$1;
-					$startIndex='' unless(defined($startIndex));
-				}
-				elsif($formElement=~/^backtrack=(\d+)$/)
-				{
-					$backtrack=$1;
-					$backtrack=0 unless(defined($backtrack));
 				}
-				elsif($formElement=~/^persist=(?i)(yes|true|1|no|false|0)$/)
-				{
-					$persist=0 if($1=~/(no|false|0)/i);
-				}
-				elsif($formElement=~/^id=(.+)$/)
-				{
-					$subscriberID=$1;
-				}
-				elsif($formElement=~/^maxmessages=(\d+)$/i)
-				{
-					$self->{'MaxMessageCount'}=$1;
-				}
-				elsif($formElement=~/^template=(\d+)$/i)
-				{
-					$self->{'HeaderTemplateNumber'}=$1;
-				}
-				elsif($formElement=~/^maxtime=(\d+)$/i)
-				{
-					my $clientRequest=$1;
-					my $serverDefault=$::CONF{'MaxTime'};
-					
-					if($serverDefault==0 || $serverDefault>$clientRequest)
-					{
-						$self->{'ConnectionTimeLimit'}=$self->{'ConnectionStart'}+$clientRequest;
-					}
-				}
-			}
-			
-			if(defined($channelName))
-			{
-				if(defined($startIndex) && defined($backtrack))
-				{
-					$self->emitHeader("404 Cannot use both 'restartfrom' and 'backtrack'");
-					$self->close();
-					
-					return;
-				}
-				
-				$startIndex=-$backtrack if(!defined($startIndex) && defined($backtrack));
-				$channels->{$channelName}->{'startIndex'}=$startIndex;
-				$channels->{$channelName}->{'persist'}=$persist;
-				$anyPersist|=$persist;
 			}
+			$self->{'useragent'} = ($self->{'headerBuffer'}=~/User-Agent: (.+)/i) ? $1 : "-";
 			
-			delete($self->{'headerBuffer'});
-			
-			if(defined($subscriberID) && $anyPersist)
-			{
-				$self->{'subscriberID'}=$subscriberID;
-				$self->deleteSubscriberWithID($subscriberID);
-				$PersistentConnections{$subscriberID}=$self;
+			if ($persist) {
+				# New persistent connection: kill any existing connection with same ID
+				$self->deleteSubscriberWithID($self->{'subscriberID'});
+				# Add new persistent connection to collection
+				$PersistentConnections{$self->{'subscriberID'}}=$self;
+			} else {
+				$::Pollers->{$self->{'subscriberID'}} = time;
 			}
 			
-			if(scalar(keys %{$channels}))
-			{
+			if(scalar(keys %{$channels})) {
+
+				$self->{'channelinfo'} = '';
+				my $citemplate = $self->getConf('ChannelInfoTemplate');
+				foreach $channelName (keys %{$channels}) {
+					my $channel=Meteor::Channel->channelWithName($channelName);
+					$self->{'channels'}->{$channelName}=$channel;
+					if (defined($self->{'channels'}->{$channelName}->{'startIndex'}) && $self->{'channels'}->{$channelName}->{'startIndex'} > 0) {
+						$self->{'channelinfo'} .= $channel->descriptionWithTemplate($citemplate);
+					}
+				}
 				$self->emitOKHeader();
-				
-				$self->setChannels($channels);
-				
-				$self->close(1) unless($anyPersist);
-				
+				foreach $channelName (keys %{$channels}) {
+					my $startIndex=$channels->{$channelName}->{'startIndex'};
+					$self->{'channels'}->{$channelName}->addSubscriber($self,$startIndex,$persist,$self->{'mode'},$self->{'useragent'});
+				}
+				if (!$persist) {
+					delete ($self->{'channels'});
+					$self->close(1, 'responseComplete');
+				}
+				delete($self->{'headerBuffer'});
+
+				# If long polling, close connection immediately if any messages have been sent
+				if ($self->{'messageCount'} > 0 && $self->{'mode'} eq 'longpoll') {
+					$self->close(1, 'closedOnEvent');
+				}
 				return;
 			}
 		}
+		elsif($self->{'headerBuffer'}=~/GET\s+\/disconnect\/(\S+)/)
+		{
+			$self->deleteSubscriberWithID($1);
+			$self->emitOKHeader();
+			$self->close(1, 'disconnectRequested');
+			return;
+		}
 		elsif($self->{'headerBuffer'}=~/GET\s+([^\s\?]+)/)
 		{
 			Meteor::Document->serveFileToClient($1,$self);
-			
-			$self->close(1);
-			
+			$self->SUPER::close();
 			return;
 		}
 		
@@ -250,23 +229,6 @@
 	}
 }
 
-sub setChannels {
-	my $self=shift;
-	my $channels=shift;
-	
-	foreach my $channelName (keys %{$channels})
-	{
-		my $persist=$channels->{$channelName}->{'persist'};
-		my $startIndex=$channels->{$channelName}->{'startIndex'};
-		
-		my $channel=Meteor::Channel->channelWithName($channelName);
-		
-		$self->{'channels'}->{$channelName}=$channel if($persist);
-		
-		$channel->addSubscriber($self,$startIndex,$persist);
-	}
-}
-
 sub emitOKHeader {
 	my $self=shift;
 	
@@ -277,43 +239,30 @@
 	my $self=shift;
 	
 	$self->emitHeader('404 Not Found');
+	$::Statistics->{'errors_served'}++;
 	
 	# close up shop here!
-	$self->close();
+	$self->close(0, 'error');
 }
 
 sub emitHeader {
 	my $self=shift;
 	my $status=shift;
 	
-	my $header=undef;
-	if(exists($self->{'HeaderTemplateNumber'}))
-	{
-		my $hn='HeaderTemplate'.$self->{'HeaderTemplateNumber'};
-		
-		$header=$::CONF{$hn};
-	}
-	$header=$::CONF{'HeaderTemplate'} unless(defined($header));
+	my $header=$self->getConf('HeaderTemplate');
 	
-	$header=~s/~([^~]+)~/
-		if(!defined($1) || $1 eq '')
-		{
+	$header=~s/~([^~]*)~/
+		if(!defined($1) || $1 eq '') {
 			'~';
-		}
-		elsif($1 eq 'server')
-		{
+		} elsif($1 eq 'server') {
 			$::PGM;
-		}
-		elsif($1 eq 'status')
-		{
+		} elsif($1 eq 'status') {
 			$status;
-		}
-		elsif($1 eq 'servertime')
-		{
+		} elsif($1 eq 'servertime') {
 			time;
-		}
-		else
-		{
+		} elsif($1 eq 'channelinfo') {
+			$self->{'channelinfo'};
+		} else {
 			'';
 		}
 	/gex;
@@ -321,26 +270,43 @@
 	$self->write($header);
 }
 
-sub sendMessage {
+sub sendMessages {
 	my $self=shift;
-	my $msg=shift;
 	
-	$self->write($msg);
+	my $numMessages=0;
+	my $msgTemplate=$self->getConf('MessageTemplate');
+	my $msgData='';
 	
-	my $msgCount=++$self->{'MessageCount'};
-	
-	my $maxMsg=$::CONF{'MaxMessages'};
-	if(defined($maxMsg) && $maxMsg>0 && $msgCount>=$maxMsg)
+	foreach my $message (@_)
 	{
-		$self->close(1);
+		$msgData.=$message->messageWithTemplate($msgTemplate);
+		$numMessages++;
 	}
 	
-	if($self->{'MaxMessageCount'}>0 && $msgCount>=$self->{'MaxMessageCount'})
-	{
-		$self->close(1);
+	return if($numMessages<1);
+	
+	$self->write($msgData);
+	
+	$::Statistics->{'messages_served'}+=$numMessages;
+	
+	my $msgCount=$self->{'messageCount'};
+	$msgCount+=$numMessages;
+	$self->{'messageCount'}=$msgCount;
+	
+	# If long polling, close connection, as a message has now been sent.
+	# Don't close if still processing the header (we may be sending a backlog from multiple channels)
+	if($self->getConf('CloseOnEvent') && !exists($self->{'headerBuffer'})) {
+		$self->close(1, 'closedOnEvent');
 	}
 }
 
+sub ping {
+	my $self=shift;
+	my $msg=$self->getConf('PingMessage');
+	
+	$self->write($msg);
+}
+
 sub closeChannel {
 	my $self=shift;
 	my $channelName=shift;
@@ -348,50 +314,77 @@
 	return unless(exists($self->{'channels'}->{$channelName}));
 	
 	my $channel=$self->{'channels'}->{$channelName};
-	$channel->removeSubscriber($self);
+	$channel->removeSubscriber($self,'channelClose');
 	
 	delete($self->{'channels'}->{$channelName});
 	
-	$self->close() if(scalar(keys %{$self->{'channels'}})==0);
+	$self->close(0,'channelClose') if(scalar(keys %{$self->{'channels'}})==0);
 }
 
 sub close {
 	my $self=shift;
 	my $noShutdownMsg=shift;
+	my $reason=shift;
 	
 	foreach my $channelName (keys %{$self->{'channels'}})
 	{
 		my $channel=$self->{'channels'}->{$channelName};
-		$channel->removeSubscriber($self);
+		$channel->removeSubscriber($self,$reason);
 	}
 	delete($self->{'channels'});
 	
-	if(exists($self->{'subscriberID'}))
-	{
+	# If this connection is in the PersistentConnections array, delete it, then anonymise 
+	# it so that if we have to wait for the write buffer to empty before close, it's only
+	# removed once.
+	if(exists($self->{'subscriberID'})) {
 		delete($PersistentConnections{$self->{'subscriberID'}});
+		delete($self->{'subscriberID'});
 	}
 	
-	#
 	# Send shutdown message unless remote closed or
 	# connection not yet established
-	#
 	unless($noShutdownMsg || $self->{'remoteClosed'} || exists($self->{'headerBuffer'}))
 	{
-		my $msg=$::CONF{'SubscriberShutdownMsg'};
+		my $msg=$self->getConf('SubscriberShutdownMsg');
 		if(defined($msg) && $msg ne '')
 		{
 			$self->write($msg);
 		}
 	}
-	
+
+	my $fmsg=$self->getConf('FooterTemplate');
+	if(defined($fmsg) && $fmsg ne '')
+	{
+		$self->write($fmsg);
+	}
+
 	$self->SUPER::close();
 }
 
+sub didClose {
+	
+	$::Statistics->{'current_subscribers'}--;
+}
+
 sub checkForMaxTime {
 	my $self=shift;
 	my $time=shift;
 	
-	$self->close(1) if(exists($self->{'ConnectionTimeLimit'}) && $self->{'ConnectionTimeLimit'}<$time);
+	$self->close(1,'maxTime') if(exists($self->{'connectionTimeLimit'}) && $self->{'connectionTimeLimit'}<$time);
+}
+
+sub getConf {
+	my $self=shift;
+	my $key=shift;
+	
+	if(exists($self->{'mode'}) && $self->{'mode'} ne '') {
+		my $k=$key.$self->{'mode'};		
+		if(exists($::CONF{$k})) {
+			return $::CONF{$k};
+		}
+	}
+	
+	$::CONF{$key};
 }
 
 1;