##############################################################################
#
# 70_STV.pm
#
# a module to send messages or commands to a Samsung TV
# for example a LE40B650
#
# written 2012 by Gabriel Bentele <gabriel at bentele.de>>
#
# $Id$
#
# Version = 1.4
#
##############################################################################
# 
# define <name> STV <host> <port>
# define <name> STV <host> 55000 for newer Samsung models
#
# set <name> <key> <value>
#
# where <key> is one of mute, volume, call, sms, date
# examples:
# set <name> mute on
# set <name> volume 20
# set <name> call Peter 1111111 Klaus 222222Peter 1111111 Klaus 222222
# set <name> sms Peter 1111111 Klaus 222222 das ist der text
# set <name> date 2012-12-10 18:07:04 Peter 11111 Bier 2012-12-11 23:59:20 Paulaner
#
##############################################################################

package main;
use IO::Socket::INET;
use Sys::Hostname;
use MIME::Base64;

my @gets = ('dummy');

sub
STV_Initialize($)
{
my ($hash) = @_;
 $hash->{DefFn}    = "STV_Define";
 $hash->{StateFn}  = "STV_SetState";
 $hash->{SetFn}    = "STV_Set";
 $hash->{AttrFn}   = "STV_Attr";
 $hash->{AttrList} = "MAC";
}

sub 
STV_Attr(@)
{
  my @a = @_;
  my $hash = $defs{$a[1]};
  my $mac = AttrVal($a[1], "MAC", undef);
  $hash->{MAC} = $mac if (defined($mac));
  return;
}

sub
STV_SetState($$$$)
{
  my ($hash, $tim, $vt, $val) = @_;
  $val = $1 if($val =~ m/^(.*) \d+$/);
  return "Undefined value $val" if(!defined($it_c2b{$val}));
  return undef;
}

sub getIP()
{
 my $host = hostname();
 my $address = inet_ntoa(scalar gethostbyname(hostname() || 'localhost'));
 return "$address";
}

sub STV_Define($$)
{
 my ($hash, $def) = @_;
 my @args = split("[ \t]+", $def);

 if (int(@args) < 3)
 {
  return "Define: not enough arguments. Usage:\n" .
         "define <name> STV <host> <port>";
 }

 $hash->{Host} = $args[2];
 if (defined $args[3]) { 
	$hash->{Port} = $args[3]
 } else {
	$hash->{Port} = 52235;
	$hash->{".validcommands"} = "mute volume call sms date";
 }

 if ( $hash->{Port} eq 55000 ){
      $hash->{".validcommands"} = "0 1 2 3 4 5 6 7 8 9 UP DOWN LEFT RIGHT ENTER ".
                    "MENU PRECH GUIDE INFO RETURN CH_LIST EXIT ".
                    "SOURCE AD PICTURE_SIZE VOLUP VOLDOWN MUTE ".
                    "TOOLS POWEROFF CHUP CHDOWN CONTENTS W_LINK ".
                    "RSS MTS SRS CAPTION TOPMENU SLEEP ESAVING ".
                    "PLAY PAUSE REWIND FF REC STOP ".
                    "TV HDMI PIP_ONOFF ASPECT"; 
	my $system = $^O;
	if($system =~ m/Win/) {
		$result = `ipconfig /all`;
		my @myarp=split(/\n/,$result);
		foreach (@myarp){
			if ( /([0-9a-f]{2}[:-][0-9a-f]{2}[:-][0-9a-f]{2}[:-][0-9a-f]{2}[:-][0-9a-f]{2}[:-][0-9a-f]{2})$/i )
			{
				$result = $1;
				$result =~ s/-/:/g;
			}
		}
	}
	if($system eq "linux") {
	$result = `ifconfig -a`;
		my @myarp=split(/\n/,$result);
		foreach (@myarp){
			if ( /^(lan|eth0) .*(..:..:..:..:..:..) .*$/ )
			{
				$result = $2;
			}
		}
	}
	# Fritzbox "? (192.168.0.1) at 00:0b:5d:91:fc:bb [ether]  on lan"
	# debian   "192.168.0.1              ether   c0:25:06:1f:3c:14   C                     eth0"
	#$result = "? (192.168.0.1) at 00:0b:5d:91:fc:bb [ether]  on lan";

	$hash->{MAC} = $result;
	$hash->{MyIP} = getIP();
}	

if ( $hash->{Port} != 55000 && $hash->{Port} != 52235 ){
	return "[STV] Port is not supported";
}

 Log3 undef, 3, "[STV] defined with host: $hash->{Host} port: $hash->{Port} MAC: $hash->{MAC}";
 $hash->{STATE} = 'Initialized';
 return undef;
}

sub connection($$)
{
	my $tmp =  shift ; 
	Log3 undef, 4, "[STV] connection message: $tmp";
	my $TV = shift;
	my $buffer = "";
	my $tmp2 = "";

	my $sock = new IO::Socket::INET (
        	PeerAddr => $TV,
        	PeerPort => '52235',
        	Proto => 'tcp',
        	Timout => 5
        );
	if (defined ($sock)){
		print $sock $tmp;
		my $buff ="";
		while ((read $sock, $buff, 1) > 0){
			$buffer .= $buff;
		}
		@tmp2 = split (/\n/,$buffer);

		$sock->close();
		Log3 undef, 4, "[STV] $TV: socket closed";
	}else{
		Log3 undef, 4, "[STV] $TV: not able to close socket";
	}
}

# new Samsung Models
sub STV_55000($$$)
{
  my ($hash,$name,$cmd) = @_;
  my $par=undef;
  my @ARGV = split(" ",$cmd);
  #### Configuration
  my $name = $hash->{NAME};
  my $tv    = "UE46ES8090";  # Might need changing to match your TV type  #"UE46ES8090"
  my $port  = $hash->{Port}; # TCP port of Samsung TV
  my $tvip  = $hash->{Host}; # IP Address of TV #"192.168.2.124"
  my $myip  = $hash->{MyIP}; # IP Address of FHEM Server
  my $mymac = $hash->{MAC};  # Used for the access control/validation '"24:65:11:80:0D:01"
  my $appstring = "iphone..iapp.samsung"; # What the iPhone app reports
  my $tvappstring = "iphone.".$tv.".iapp.samsung"; # TV type
  my $remotename = "Perl Samsung Remote"; # What gets reported when it asks for permission/also shows in General->Wireless Remote Control menu
  
  #### MAC überprüfen wenn nicht gültig vom attribute übernehmen.
  if ($mymac !~ /^\w\w:\w\w:\w\w:\w\w|\w\w:\w\w:\w\w:\w\w$/) {
	  Log3 $name, 3, "[STV] mymac: $mymac invalid format";
  }else{
	  # command-line help
	  if (!$tv|!$tvip|!$myip|!$mymac) {
		return "[STV] Error - Parameter missing:\nmodel, tvip, myip, mymac.";
	  }
	  Log3 $name, 5, "[STV] opening socket with tvip: $tvip, cmd: $cmd";
	  my $sock = new IO::Socket::INET (
	  PeerAddr => $tvip,
	  PeerPort => $port,
	  Proto => 'tcp',
	  Timout => 5
	  );
	if (defined ($sock)){
		  my $messagepart1 = chr(0x64) . chr(0x00) . chr(length(encode_base64($myip, ""))) . chr(0x00) . encode_base64($myip, "") . chr(length(encode_base64($mymac, ""))) . chr(0x00) . encode_base64($mymac, "") . chr(length(encode_base64($remotename, ""))) . chr(0x00) . encode_base64($remotename, "");
		  my $part1 = chr(0x00) . chr(length($appstring)) . chr(0x00) . $appstring . chr(length($messagepart1)) . chr(0x00) . $messagepart1;
		  print $sock $part1;

		  my $messagepart2 = chr(0xc8) . chr(0x00);
		  my $part2 = chr(0x00) . chr(length($appstring)) . chr(0x00) . $appstring . chr(length($messagepart2)) . chr(0x00) . $messagepart2;
		  print $sock $part2;
		  # Preceding sections all first time only

		  if (defined($par)) {
			 # Send text, e.g. in YouTube app's search, N.B. NOT BBC iPlayer app.
			 my $text = $par;
			 my $messagepart3 = chr(0x01) . chr(0x00) . chr(length(encode_base64($text, ""))) . chr(0x00) . encode_base64($text, "");
			 my $part3 = chr(0x01) . chr(length($appstring)) . chr(0x00) . $appstring . chr(length($messagepart3)) . chr(0x00) . $messagepart3;
			 print $sock $part3;
		  }
		  else {
			foreach my $argnum (0 .. $#ARGV) {
			  # Send remote key(s)
			  #Log4 $name, 4, "[STV] sending ".uc($ARGV[$argnum]);
			  my $key = "KEY_" . uc($ARGV[$argnum]);
			  my $messagepart3 = chr(0x00) . chr(0x00) . chr(0x00) . chr(length(encode_base64($key, ""))) . chr(0x00) . encode_base64($key, "");
			  my $part3 = chr(0x00) . chr(length($tvappstring)) . chr(0x00) . $tvappstring . chr(length($messagepart3)) . chr(0x00) . $messagepart3;
			  print $sock $part3;
			  sleep(1);
		#        select(undef, undef, undef, 0.5);
			 }
		  }

		  close($sock);
	}else{
		#Log5 $name, 3, "[STV] Could not create socket. Aborting." unless $sock;
	}
  }
}

# old Samsung Models
sub STV_52235($@$@)
{

  my ($hash, @a) = @_;
  my $name = $hash->{NAME};
  my $TV = $hash->{Host};
  my $count = @a;
  my $arg    = lc($a[2]);      # mute volume
  my $cont1  = ucfirst($arg);  # Mute
  my $cont2 = ""; 
  my $cont3 = "";
  my $cont4 = "";
  my $cont5 = "";
  my $cont6 = "";
  my $cont7 = "";
  my $cont8 = "";
  my $cont9 = "";
	
  if (defined $a[3]) { $cont2 = $a[3]}
  if (defined $a[4]) { $cont3 = $a[4]}
  if (defined $a[5]) { $cont4 = $a[5]}
  if (defined $a[6]) { $cont5 = $a[6]}
  if (defined $a[7]) { $cont6 = $a[7]}
  if (defined $a[8]) { $cont7 = $a[8]}
  if (defined $a[9]) { $cont8 = $a[9]}

  my $callsoap = "";
  my $message = "";
  my $head = "";
  my $kind = 0;
  my $size = "";
  my $body = "";

if ( $arg eq "mute" )
{	
	$kind = 1;
	if ( $cont2 eq "off" ){
		$cont2 = 0 ;
	}else {
		$cont2 = 1 ;
	}
}
if ( $arg eq "volume")
{	
	if ( $cont2 > 0 and $cont2 < 100 ){
		$kind = 1;
	}else {
		Log3 $name, 3, "[STV] $name Volume: not correct";	
		$kind = 0;
	}
}
if ( $arg eq "call")
{
	$kind = 2;
	
}
if ( $arg eq "sms")
{
	$kind = 3;
	for my $i (6..$count){
		$body .= $a[$i];
		$body .= " ";
	}	
}
if ( $arg eq "date")
{
	$kind = 4;
	for my $i (10..$count){
		$body .= $a[$i];
		$body .= " ";
	}	
}

if ( $kind eq 1){
        $callsoap .= "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n";
        $callsoap .= "<s:Envelope s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">\r\n";
        $callsoap .= "<s:Body>\r\n";
        $callsoap .= "<ns0:Set$cont1 xmlns:ns0=\"urn:schemas-upnp-org:service:RenderingControl:1\">\r\n";
        $callsoap .= "<InstanceID>0</InstanceID>\r\n";
        $callsoap .= "<Desired$cont1>$cont2</Desired$cont1>\r\n";
        $callsoap .= "<Channel>Master</Channel>\r\n";
        $callsoap .= "</ns0:Set$cont1>\r\n";
        $callsoap .= "</s:Body>\r\n";
        $callsoap .= "</s:Envelope>\r\n";

        $size = length($callsoap);

        $head .= "POST /upnp/control/RenderingControl1 HTTP/1.1\r\n";
        $head .= "Content-Type: text/xml; charset=\"utf-8\"\r\n";
        $head .= "SOAPACTION: \"SoapAction:urn:schemas-upnp-org:service:RenderingControl:1#Set$cont1\"\r\n";
        $head .= "Cache-Control: no-cache\r\n";
        $head .= "Host: $TV:52235\r\n";
        $head .= "Content-Length: $size\r\n";
        $head .= "Connection: Close\r\n";
        $head .= "\r\n";

        $message .= $head;
        $message .= $callsoap;
}

my $calldate=`date +"%Y-%m-%d"`;
chomp($calldate);
my $calltime=`date +"%H:%M:%S"`;
chomp($calltime);

if ( $kind eq 2 ){ # CALL
        $callsoap .= "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n";
        $callsoap .= "<s:Envelope s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\" >\r\n";
        $callsoap .= "<s:Body>\r\n";
        $callsoap .= "<u:AddMessage xmlns:u=\"urn:samsung.com:service:MessageBoxService:1\\\">\r\n";
        $callsoap .= "<MessageType>text/xml</MessageType>\r\n";
        $callsoap .= "<MessageID>1334799348</MessageID>\r\n";
        $callsoap .= "<Message>\r\n";
        $callsoap .= "&lt;Category&gt;Incoming Call&lt;/Category&gt;\r\n";
        $callsoap .= "&lt;DisplayType&gt;Maximum&lt;/DisplayType&gt;\r\n";
        $callsoap .= "&lt;CallTime&gt;\r\n";
        $callsoap .= "&lt;Date&gt;$calldate&lt;/Date&gt;\r\n";
        $callsoap .= "&lt;Time&gt;$calltime&lt;/Time&gt;\r\n";
        $callsoap .= "&lt;/CallTime&gt;\r\n";
        $callsoap .= "&lt;Callee&gt;\r\n";
        $callsoap .= "&lt;Name&gt;An: $cont4&lt;/Name&gt;\r\n";
        $callsoap .= "&lt;Number&gt;Nr: $cont5&lt;/Number&gt;\r\n";
        $callsoap .= "&lt;/Callee&gt;\r\n";
        $callsoap .= "&lt;Caller&gt;\r\n";
        $callsoap .= "&lt;Name&gt;Von: $cont2&lt;/Name&gt;\r\n";
        $callsoap .= "&lt;Number&gt;Nr: $cont3&lt;/Number&gt;\r\n";
        $callsoap .= "&lt;/Caller&gt;\r\n";
        $callsoap .= "</Message>\r\n";
        $callsoap .= "</u:AddMessage>\r\n";
        $callsoap .= "</s:Body>\r\n";
        $callsoap .= "</s:Envelope>\r\n";

        $size = length($callsoap);
        $head .= "POST /PMR/control/MessageBoxService HTTP/1.1\r\n";
        $head .= "Content-Type: text/xml; charset=\"utf-8\"\r\n";
        $head .= "SOAPACTION: \"urn:samsung.com:service:MessageBoxService:1#AddMessage\"\r\n";
        $head .= "Cache-Control: no-cache\r\n";
        $head .= "Host: $TV:52235\r\n";
        $head .= "Content-Length: $size\r\n";
        $head .= "Connection: Close\r\n";
        $head .= "\r\n";

        $message .= $head;
        $message .= $callsoap;
   }

if ( $kind eq 3 ){ # SMS
        $callsoap .= "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n";
        $callsoap .= "<s:Envelope s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\" >\r\n";
        $callsoap .= "<s:Body>\r\n";
        $callsoap .= "<u:AddMessage xmlns:u=\"urn:samsung.com:service:MessageBoxService:1\\\">\r\n";
        $callsoap .= "<MessageType>text/xml</MessageType>\r\n";
        $callsoap .= "<MessageID>1334799348</MessageID>\r\n";
        $callsoap .= "<Message>\r\n";
        $callsoap .= "&lt;Category&gt;SMS&lt;/Category&gt;\r\n";
        $callsoap .= "&lt;DisplayType&gt;Maximum&lt;/DisplayType&gt;\r\n";
        $callsoap .= "&lt;ReceiveTime&gt;\r\n";
        $callsoap .= "&lt;Date&gt;$calldate&lt;/Date&gt;\r\n";
        $callsoap .= "&lt;Time&gt;$calltime&lt;/Time&gt;\r\n";
        $callsoap .= "&lt;/ReceiveTime&gt;\r\n";
        $callsoap .= "&lt;Receiver&gt;\r\n";
        $callsoap .= "&lt;Name&gt;An: $cont4&lt;/Name&gt;\r\n";
        $callsoap .= "&lt;Number&gt;Nr: $cont5&lt;/Number&gt;\r\n";
        $callsoap .= "&lt;/Receiver&gt;\r\n";
        $callsoap .= "&lt;Sender&gt;\r\n";
        $callsoap .= "&lt;Name&gt;Von: $cont2&lt;/Name&gt;\r\n";
        $callsoap .= "&lt;Number&gt;Nr: $cont3&lt;/Number&gt;\r\n";
        $callsoap .= "&lt;/Sender&gt;\r\n";
		$callsoap .= "&lt;Body&gt;Inhalt: $body&lt;/Body&gt;\r\n";
        $callsoap .= "</Message>\r\n";
        $callsoap .= "</u:AddMessage>\r\n";
        $callsoap .= "</s:Body>\r\n";
        $callsoap .= "</s:Envelope>\r\n";

        $size = length($callsoap);
        $head .= "POST /PMR/control/MessageBoxService HTTP/1.1\r\n";
        $head .= "Content-Type: text/xml; charset=\"utf-8\"\r\n";
        $head .= "SOAPACTION: \"urn:samsung.com:service:MessageBoxService:1#AddMessage\"\r\n";
        $head .= "Cache-Control: no-cache\r\n";
        $head .= "Host: $TV:52235\r\n";
        $head .= "Content-Length: $size\r\n";
        $head .= "Connection: Close\r\n";
        $head .= "\r\n";

        $message .= $head;
        $message .= $callsoap;
   }

if ( $kind eq 4 ){ # Termin
        $callsoap .= "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n";
        $callsoap .= "<s:Envelope s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\" xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\" >\r\n";
        $callsoap .= "<s:Body>\r\n";
        $callsoap .= "<u:AddMessage xmlns:u=\"urn:samsung.com:service:MessageBoxService:1\\\">\r\n";
        $callsoap .= "<MessageType>text/xml</MessageType>\r\n";
        $callsoap .= "<MessageID>1334799348</MessageID>\r\n";
        $callsoap .= "<Message>\r\n";
        $callsoap .= "&lt;Category&gt;Schedule Reminder&lt;/Category&gt;\r\n";
        $callsoap .= "&lt;DisplayType&gt;Maximum&lt;/DisplayType&gt;\r\n";
        $callsoap .= "&lt;StartTime&gt;\r\n";
        $callsoap .= "&lt;Date&gt;$cont2&lt;/Date&gt;\r\n";
        $callsoap .= "&lt;Time&gt;$cont3&lt;/Time&gt;\r\n";
        $callsoap .= "&lt;/StartTime&gt;\r\n";
		$callsoap .= "&lt;Owner&gt;\r\n";
		$callsoap .= "&lt;Name&gt;Fr: $cont4&lt;/Name&gt;\r\n";
		$callsoap .= "&lt;Number&gt;Nr: $cont5&lt;/Number&gt;\r\n";
		$callsoap .= "&lt;/Owner&gt;\r\n";
		$callsoap .= "&lt;Subject&gt;Betreff: $cont6&lt;/Subject&gt;\r\n";
        $callsoap .= "&lt;EndTime&gt;\r\n";
        $callsoap .= "&lt;Date&gt;$cont7&lt;/Date&gt;\r\n";
        $callsoap .= "&lt;Time&gt;$cont8&lt;/Time&gt;\r\n";
        $callsoap .= "&lt;/EndTime&gt;\r\n";
        $callsoap .= "&lt;Location&gt;Ort: $cont9&lt;/Location&gt;\r\n";
        $callsoap .= "&lt;Body&gt;Inhalt: $body&lt;/Body&gt;\r\n";
        $callsoap .= "</Message>\r\n";
        $callsoap .= "</u:AddMessage>\r\n";
        $callsoap .= "</s:Body>\r\n";
        $callsoap .= "</s:Envelope>\r\n";

        $size = length($callsoap);
        $head .= "POST /PMR/control/MessageBoxService HTTP/1.1\r\n";
        $head .= "Content-Type: text/xml; charset=\"utf-8\"\r\n";
        $head .= "SOAPACTION: \"urn:samsung.com:service:MessageBoxService:1#AddMessage\"\r\n";
        $head .= "Cache-Control: no-cache\r\n";
        $head .= "Host: $TV:52235\r\n";
        $head .= "Content-Length: $size\r\n";
        $head .= "Connection: Close\r\n";
        $head .= "\r\n";

        $message .= $head;
        $message .= $callsoap;
}

if ( $kind ne 0 ){
	connection($message, $TV);
   }else{
	return "Unknown argument $name, choose one of mute volume call sms date";
   }
}

sub STV_Set($@)
{
  my ($hash, @a) = @_;
  my $nam = $a[0];
  my $name = $hash->{NAME};
  my $Port = $hash->{Port};
  my $cmd = (defined($a[1]) ? $a[1] : ""); #command
  my $par = (defined($a[2]) ? $a[2] : ""); #parameter
  if ($cmd eq "?" || $cmd eq "") {
       return $hash->{".validcommands"};
  }
  if ($hash->{".validcommands"} =~ /$cmd/) {
	  if ($Port eq 55000 ){
		STV_55000($hash,$nam,$cmd);
	  }
	  if ($Port eq 52235 ){
		STV_52235($hash,@_);
	  }
  } else {
		my $ret = "[STV] Invalid command $cmd. Use any of:\n";
		my @cmds = split(" ",$hash->{".validcommands"});
		foreach my $line (0..$#cmds) {
			$ret .= "\n" if ($line > 1 && $line/10 == int($line/10));
			$ret .= $cmds[$line]." ";
		}
		return $ret;
  }
}

1;

=pod
=begin html

<a name="STV"></a>

<h3>STV</h3>
<ul><p>
This module supports Samsung TV devices.<br>
LEXXBXX (B Series) use port 52235 <br>
LEXXCXX (C|D Series) use port 55000 <br>
</p>
 <b>Define</b><br>
  <code>define &lt;name&gt; STV &lt;host&gt;]</code><br>
  <p>
  Example:<br>
  define Television1 STV 192.168.178.20 <br> or
  define Television2 STV 192.168.178.20 52235 <br>
  define Television2 STV 192.168.178.20 55000 <br>
  </p>
 <b>Set</b><br>
  set &lt;name&gt; &lt;value&gt; &lt;nummber&gt;<br>where value is one of:<br><br>
  <ul>
  <li><code>mute</code> </li>
  <li><code>volume </code> </li>
  <li><code>call</code> </li>
  <li><code>sms  </code> </li>
  <li><code>date </code> </li>
  </ul>
   <br>Example:<br>
  set &lt;name&gt; mute <br>
  set &lt;name&gt; volume 20 <br>
  set &lt;name&gt; call Peter 012345678 Phone 87654321 <br><br>
  
 <b>Get</b><br>
   <ul>N/A</ul><br>
</ul>
   
=end html
=cut