#

# Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

# All rights reserved.

# This component and the accompanying materials are made available

# under the terms of "Eclipse Public License v1.0"

# which accompanies this distribution, and is available

# at the URL "http://www.eclipse.org/legal/epl-v10.html".

#

# Initial Contributors:

# Nokia Corporation - initial contribution.

#

# Contributors:

#

# Description:  

#

#

# Initial Contributors:

# Nokia Corporation - initial contribution.

#

# Contributors:

#

# Description:

#

package Symbian::StatAPI;

require 5.000;

use Win32::API;

use Win32::TieRegistry(Delimiter=>"/");

use IO::File;

use File::Basename;

use LWP::Simple;

use LWP::UserAgent;

use HTTP::Request;

use HTTP::Response;

use Exporter;

use vars qw (@ISA @EXPORT $VERSION);

@ISA		= qw(Exporter);

@EXPORT		= qw(

				&set_dll_folder

				&set_working_folder

				&initialise

				&get_version

				&set_connection_logging

				&close_connection_logging

				&get_device_log_file

				&set_screenshot_dir

				&get_last_error

				&connect_to_target

				&connect_to_target_multithreaded

				&disconnect_from_target

				&set_command_delay

				&set_image_verification

				&set_command_logging

				&get_screenshot

				&get_device_info

				&touch_screen

				&start_application

				&start_program

				&open_application

				&close_application

				&basic_key_sequence

				&control_keystroke

				&combination_keystroke

				&pause

				&start_eshell

				&stop_eshell

				&copy_commonfile_to_target

				&copy_testfile_to_target

				&copy_buildfile_to_target

				&move_from_target

				&copy_from_target

				&remove_unwanted_file

				&send_command_file

				&send_raw_command

				&hold_key

				&remove_file

				&create_folder

				&remove_folder);

##########################################################################

# AUTO-GENERATED BLOCK - DO NOT MODIFY

##########################################################################

$VERSION = 3.3;

##########################################################################

# global variables

my $FUNCTION;			# dll function entrypoint

my $dllname;			# dll to call

my $def_connection_type;	# default (global) connection type

my $def_codetype;		# default (global) code type

my $lasterror;			# last error thrown

my $imagedir;			# image retrieve location

my $logfile;			# log file to write to

my $senddir;			# temp send directory

my $recvdir;			# temp receive directory

my $workdir;			# stat working directory

my $statdir;			# stat dll location

my $loglevel;			# internal logging level

#TMS required vars

my $httpserver;  		# http server for downloading files

my $runno;			# needed to obtain build location to download files

my $commondir;			# common files temp dir

my $builddir;			# build files location

################################################################

# exported functions

# Come in 2 levels: Global - apply to all connections, 

#                   Local - apply to individual connections

################################################################

################################################################

# GLOBAL ENTRYPOINTS

# Apply to all connections

################################################################

################################################################

# 	set_dll_folder(<dll folder>);

#

# 	Required parameters:

#	$statdir 	e.g. "C:\epoc32\tools\STAT";

#

################################################################

sub set_dll_folder

{

	my @cmdline = @_;

	my $cmdref = \@cmdline;

	my $dir = $cmdref->[0];

	$statdir = $dir;

	return 1;

}

################################################################

# 	set_working_folder(<working folder>);

#

# 	Required parameters:

#	$statdir 	e.g. "C:\apps\STAT";

#

################################################################

sub set_working_folder

{

	my @cmdline = @_;

	my $cmdref = \@cmdline;

	my $dir = $cmdref->[0];

	$workdir = $dir;

	return 1;

}

################################################################

# Must be the first function called

# 	initialise(@ARGV);

# 	initialise(<dll name>, <connection type>, <code type>, <log level>, <log file>, <send dir>, <recv dir>, <common dir>, <httpserver>, <runno>, <builddir>);

#

# 	Required parameters:

#	$dllname 	e.g. STAT.DLL;

#

#	Needed only if connection/code types won't change throughout the script

#	$def_connection_type	e.g. 2 (Symbian Serial)

#	$def_codetype		e.g. COM2

#

#	Needed only for logging

#	$loglevel 	# internal logging level:

			# 0 = terse

			# 1 = noraml

			# 2 = verbose

			# 3 = Perl output redirected to log file

#	$logfile 	e.g. C:\Apps\Stat\LogFiles\StatPerl.log;

#

#	Needed only for sending/receiving files (must end in 'slash')

#	$senddir 	e.g. auto/12267/send/

#	$recvdir 	e.g. auto/12267/recv/

#

#	Needed only for sending common files to target (TMS only - must end in 'slash')

#	$commondir 	e.g. auto/12267/common/

#	Needed only for sending build files to target (TMS only)

#	$httpserver e.g. http://lon-adminpool01:8080/AutoTest

#	$runno	e.g. 150

#	$builddir 	e.g. auto/12267/build/	(must end in 'slash')

#

################################################################

sub initialise

{

	my @cmdline = @_;

	my $cmdref = \@cmdline;

	$dllname = $cmdref->[0];

	$def_connection_type = $cmdref->[1];

	$def_codetype = $cmdref->[2];

	$loglevel = $cmdref->[3];

	$logfile = $cmdref->[4];

	$senddir = $cmdref->[5];

	$recvdir = $cmdref->[6];

	$commondir = $cmdref->[7];

	$httpserver = $cmdref->[8];

	$runno = $cmdref->[9];

	$builddir = $cmdref->[10];

	# required parameter

	if (!$dllname)

	{

		$lasterror = "DLL name not supplied!";

		Line(get_last_error());

		return 0;

	}

	# adjust log level if necessary

	if ($loglevel < 0)

	{

		$loglevel = 0;

	}

	if ($loglevel > 3)

	{

		$loglevel = 3;

	}

	# redirect output to log file if we've supplied one, else will go to screen

	if ($logfile and ($loglevel eq 3))

	{

		print "Redirecting output to [$logfile]...\n";

		open(STDOUT, ">> $logfile");

		open(STDERR, ">> $logfile");

	}

	# reverse '/' to '\\' in filenames

	$senddir =~ s/\//\\/g;

	$recvdir =~ s/\//\\/g;

	$commondir =~ s/\//\\/g;

	$builddir =~ s/\//\\/g;

	if (!$workdir)

	{

		$workdir = "C:\\apps\\stat";

	}

	Line("Working directory: $workdir\n");

	if (!$statdir)

	{

		$statdir = "C:\\epoc32\\tools\\STAT";

	}

	Line("Stat directory: $statdir\n");

	Line("Initialising STAT API:\n  DLLName [$dllname]\n  Default Connection [$def_connection_type]\n  Default Code Type [$def_codetype]\n  Log Level [$loglevel]\n  LogFile [$logfile]\n  Send [$senddir]\n  Recv [$recvdir]\n  Common [$commondir]\n  HTTPServer [$httpserver]\n  Run No [$runno]\n  Build [$builddir]\n");

	return 1;

}

################################################################

# Get the version of the dll

################################################################

sub get_version

{

	$FUNCTION = new Win32::API("$statdir/$dllname", "StdVersion", [V], P);

	if (defined($FUNCTION))

	{

		$ret = $FUNCTION->Call();

		if ($ret)

		{

			return $ret;

		}

		else

		{

			$lasterror = "Version could not be established\n";

		}

	}

	else

	{

		$lasterror = "Function StdVersion not found\n";

	}

	Line(get_last_error());

	return 0;

}

################################################################

# Set logging of stat connection attempts

# param0: logfile

################################################################

sub set_connection_logging

{

	Line("Setting connection logging...");

	if ($loglevel and $logfile)

	{

		$FUNCTION = new Win32::API("$statdir/$dllname", "StdSetConnectionLogging", [P], I);

		if (defined($FUNCTION))

		{

			Line("Logging to $logfile");

			$ret = $FUNCTION->Call($logfile);

			if ($ret)

			{

				return 1;

			}

			else

			{

				GetDllError(0);

			}

		}

		else

		{

			$lasterror = "Function StdSetConnectionLogging not found\n";

		}

	}

	else

	{

		$lasterror = "Logging disabled or logfile not supplied";

	}

	Line(get_last_error());

	return 0;

}

################################################################

# Set logging of stat connection attempts

# param0: logfile

################################################################

sub close_connection_logging

{

	Line("Closing connection logging...");

	if ($loglevel and $logfile)

	{

		$FUNCTION = new Win32::API("$statdir/$dllname", "StdCloseConnectionLogging", [], V);

		if (defined($FUNCTION))

		{

			Line("Stopping logging to $logfile");

			$FUNCTION->Call();

			return 1;

		}

		else

		{

			$lasterror = "Function StdCloseConnectionLogging not found\n";

		}

	}

	else

	{

		$lasterror = "Logging disabled or logfile not supplied";

	}

	Line(get_last_error());

	return 0;

}

################################################################

# Retrieve the device log file to our log and truncate it at that point on the device

################################################################

sub get_device_log_file

{

	Line("Retrieving log file...");

	my @cmdline = @_;

	my $cmdref = \@cmdline;

	my $hndl = $cmdref->[0];

	if ($loglevel and $logfile)

	{

		if ($hndl)

		{

			if (SendCommand($hndl, "<B><G><E>"))

			{

				return 1;

			}

		}

		else

		{

			$lasterror = "Handle not supplied";

		}

	}

	else

	{

		$lasterror = "Logging disabled or logfile not supplied";

	}

	Line(get_last_error());

	return 0;

}

################################################################

# Set the output directory for screenshots

################################################################

sub set_screenshot_dir

{

	Line("Setting screenshot dir...");

	my @cmdline = @_;

	my $cmdref = \@cmdline;

	my $dir = $cmdref->[0];

	if ($dir)

	{

		$imagedir = $dir;

		# reverse '/' to '\\' for DOS

		$imagedir =~ s/\//\\/g;

		Line("Directory ($imagedir)");

		return 1;

	}

	$lasterror = "Directory not supplied";

	Line(get_last_error());

	return 0;

}

################################################################

# Get the last error that occurred

################################################################

sub get_last_error

{

	# add prefix if not one already	

	if (!(substr($lasterror, 0, 8) =~ "ERROR : "))

	{

		$lasterror = "ERROR : $lasterror";

	}

	return $lasterror;

}

################################################################

# LOCAL ENTRYPOINTS

# Apply to individual connection

################################################################

################################################################

# Connect to the target device

################################################################

sub connect_to_target

{

	Line("Connecting to $statdir/$dllname...");

	my @cmdline = @_;

	my $cmdref = \@cmdline;

	my $connection_type = $cmdref->[0];

	my $codetype = $cmdref->[1];

	# if we haven't supplied a connection type through here, maybe it was defined during initialise()

	if (!$connection_type)

	{

		$connection_type = $def_connection_type;

	}

	# if we haven't supplied a code type through here, maybe it was defined during initialise()

	if (!$codetype)

	{

		$codetype = $def_codetype;

	}

	if ($connection_type)

	{

		if ($codetype)

		{

			$FUNCTION = new Win32::API("$statdir/$dllname", "StdConnect", [I, P, P, P], I);

			if (defined($FUNCTION))

			{

				Line("Connecting ($connection_type, $codetype)...");

				my $hndl = $FUNCTION->Call($connection_type, $codetype, 0, 0);

				if ($hndl)

				{

					return $hndl;

				}

				else

				{

					GetDllError(0);

				}

			}

			else

			{

				$lasterror = "Function StdConnect not found";

			}

		}

		else

		{

			$lasterror = "Code type not supplied";

		}

	}

	else

	{

		$lasterror = "Connection type not supplied";

	}

	Line(get_last_error());

	return 0;

}

################################################################

# Connect to the target device in a multithreaded environment

################################################################

sub connect_to_target_multithreaded

{

	Line("Connecting to $statdir/$dllname (" . get_version() . ")...");

	my @cmdline = @_;

	my $cmdref = \@cmdline;

	my $connection_type = $cmdref->[0];

	my $codetype = $cmdref->[1];

	# if we haven't supplied a connection type through here, maybe it was defined during initialise()

	if (!$connection_type)

	{

		$connection_type = $def_connection_type;

	}

	# if we haven't supplied a code type through here, maybe it was defined during initialise()

	if (!$codetype)

	{

		$codetype = $def_codetype;

	}

	if ($connection_type)

	{

		if ($codetype)

		{

			$FUNCTION = new Win32::API("$statdir/$dllname", "StdConnectMT", [I, P], I);

			if (defined($FUNCTION))

			{

				Line("Connecting ($connection_type, $codetype)...");

				my $hndl = $FUNCTION->Call($connection_type, $codetype);

				if ($hndl)

				{

					return $hndl;