RemoteControl - Revision history

C schmitz: Text replacement - " enclose="div"" to ""

2022-02-16T13:10:13Z

Text replacement - " enclose="div"" to ""

← Older revision		Revision as of 15:10, 16 February 2022
Line 80:		Line 80:
	* '''ATTENTION:''' Just set the Variable $lsrcOverSSL = true; in lsrc.config.php. After that, initialize your client like shown below, a wsdl file with correct URL will be generated automaticly for you:		* '''ATTENTION:''' Just set the Variable $lsrcOverSSL = true; in lsrc.config.php. After that, initialize your client like shown below, a wsdl file with correct URL will be generated automaticly for you:

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">

	new SoapClient('https://localhost/limesurvey/admin/lsrc.server.php?wsdl',		new SoapClient('https://localhost/limesurvey/admin/lsrc.server.php?wsdl',
Line 93:		Line 93:
	<nowiki>:</nowiki> 1. On the client side, when you call the SOAP-Server over wsdl. For 'https' do it like that:		<nowiki>:</nowiki> 1. On the client side, when you call the SOAP-Server over wsdl. For 'https' do it like that:

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">

	new SoapClient('https://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,		new SoapClient('https://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,
Line 103:		Line 103:
	<nowiki>:</nowiki> for 'http' like that:		<nowiki>:</nowiki> for 'http' like that:

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">

	new SoapClient('http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,		new SoapClient('http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl', array('soap_version' => SOAP_1_1,
Line 115:		Line 115:
	<nowiki>:</nowiki> 2. Here is the most important Step to SSL. At the End of the lsrc.wsdl file, last block, same procedure:		<nowiki>:</nowiki> 2. Here is the most important Step to SSL. At the End of the lsrc.wsdl file, last block, same procedure:

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">

	<port name='LsrcPort' binding='tns:LsrcBinding'>		<port name='LsrcPort' binding='tns:LsrcBinding'>
Line 127:		Line 127:
	<nowiki>:</nowiki> or for normal http mode:		<nowiki>:</nowiki> or for normal http mode:

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">

	<port name='LsrcPort' binding='tns:LsrcBinding'>		<port name='LsrcPort' binding='tns:LsrcBinding'>
Line 153:		Line 153:
	Example:		Example:

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">

	<?php		<?php
Line 229:		Line 229:
	In PHP you would initiate the Client-object and call a function from the Webservice with code like e.g.:		In PHP you would initiate the Client-object and call a function from the Webservice with code like e.g.:

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">

	$wsdl="http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl";		$wsdl="http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl";
Line 511:		Line 511:
	for example:		for example:

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">

	"fieldname","type","sid","gid","qid","aid","title","question","group_name","lid","lid1"		"fieldname","type","sid","gid","qid","aid","title","question","group_name","lid","lid1"
Line 573:		Line 573:
	* this Line:		* this Line:

	<syntaxhighlight lang="php~~" enclose="div~~">		<syntaxhighlight lang="php">

	$limeUrl='https://localhost/limesource/limesurvey';		$limeUrl='https://localhost/limesource/limesurvey';

C schmitz: Text replace - "Limesurvey" to "LimeSurvey"

2013-06-06T13:21:53Z

Text replace - "Limesurvey" to "LimeSurvey"

C schmitz: Text replace - "
" to "
"

2013-05-23T07:12:02Z

Text replace - "<br/>" to "<br />"

← Older revision		Revision as of 09:12, 23 May 2013
Line 249:		Line 249:
	{		{

	$sOutput .= " <br/><br/>SOAP Error: ".$fault->faultcode." : ".$fault->faultstring;		$sOutput .= " <br /><br />SOAP Error: ".$fault->faultcode." : ".$fault->faultstring;

	}		}

C schmitz at 15:34, 14 November 2012

2012-11-14T15:34:52Z

← Older revision		Revision as of 17:34, 14 November 2012
Line 6:		Line 6:
	<span style='color:#F00'>The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2. The RemoteControl features exist in LS 1.90 and 1.91 but is considered to be obsolete and we don't give any support for it.</span>		<span style='color:#F00'>The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2. The RemoteControl features exist in LS 1.90 and 1.91 but is considered to be obsolete and we don't give any support for it.</span>

	<div class="simplebox">In LimeSurvey 2.x and higher there ~~will be~~ a fully supported new API named [[RemoteControl 2 API]] based on XML-RPC/JSON-RPC.		<div class="simplebox">In LimeSurvey 2.x and higher there is a fully supported new API named [[RemoteControl 2 API]] based on XML-RPC/JSON-RPC.

	</div>		</div>

C schmitz at 14:00, 10 July 2012

2012-07-10T14:00:42Z

← Older revision		Revision as of 16:00, 10 July 2012
Line 4:		Line 4:
	=Before you start...=		=Before you start...=

	<span style='color:#F00'>The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2.		<span style='color:#F00'>The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2. The RemoteControl features exist in LS 1.90 and 1.91 but is considered to be obsolete and we don't give any support for it.</span>

	~~The RemoteControl features exists in LS 1~~.90 and 1.~~91 but we can't give any support for this.</span>~~		<div class="simplebox">In LimeSurvey 2.x and higher there will be a fully supported new API named [[RemoteControl 2 API]] based on XML-RPC/JSON-RPC.

	~~In LimeSurvey 2.x and higher there will be a new version named [[RemoteControl 2]] based on XML-RPC.~~		</div>

	=Introduction=		=Introduction=

Mazi at 10:44, 6 February 2012

2012-02-06T10:44:28Z

← Older revision		Revision as of 12:44, 6 February 2012
Line 4:		Line 4:
	=Before you start...=		=Before you start...=

	''~~'''~~The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2.		<span style='color:#F00'>The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2.

	The RemoteControl features exists in LS 1.90 and 1.91 but we can't give any support for this.~~'''''~~		The RemoteControl features exists in LS 1.90 and 1.91 but we can't give any support for this.</span>

	In LimeSurvey 2.x and higher there will be a new version named [[RemoteControl 2]] based on XML-RPC.		In LimeSurvey 2.x and higher there will be a new version named [[RemoteControl 2]] based on XML-RPC.

Mazi at 10:43, 6 February 2012

2012-02-06T10:43:10Z

← Older revision		Revision as of 12:43, 6 February 2012
(No difference)

Mazi at 10:42, 6 February 2012

2012-02-06T10:42:51Z

← Older revision		Revision as of 12:42, 6 February 2012
Line 4:		Line 4:
	=Before you start...=		=Before you start...=

	The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2.		'''''The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2.

	The RemoteControl features exists in LS 1.90 and 1.91 but we can't give any support for this.		The RemoteControl features exists in LS 1.90 and 1.91 but we can't give any support for this.'''''

	In LimeSurvey 2.x and higher there will be a new version named [[RemoteControl 2]] based on XML-RPC.		In LimeSurvey 2.x and higher there will be a new version named [[RemoteControl 2]] based on XML-RPC.

C schmitz at 09:32, 18 October 2011

2011-10-18T09:32:16Z

← Older revision		Revision as of 11:32, 18 October 2011
Line 2:		Line 2:
	__TOC__		__TOC__

	=~~General~~=		=Before you start...=

	The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2.		The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2.

	The RemoteControl features exists in LS 1.90 and 1.91 but we ~~do not~~ give any support for this.		The RemoteControl features exists in LS 1.90 and 1.91 but we can't give any support for this.

	In LimeSurvey 2.x and higher there will be a new version named [[RemoteControl 2]] based on XML-RPC.		In LimeSurvey 2.x and higher there will be a new version named [[RemoteControl 2]] based on XML-RPC.

C schmitz at 09:30, 18 October 2011

2011-10-18T09:30:17Z

← Older revision		Revision as of 11:30, 18 October 2011
Line 2:		Line 2:
	__TOC__		__TOC__

	=~~Notice~~=		=General=

	The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2. ~~Efforts are underway to bring LSRC up to date with the current release~~ and this ~~page~~ will be ~~updated when that has happened. Until that time please continue reporting bugs via the~~ [~~http://bugs.limesurvey~~.~~org bugtracker] and please be patient with us!~~		The latest stable release of Lime Survey Remote Control is 1.87 running on PHP 5.2.

			The RemoteControl features exists in LS 1.90 and 1.91 but we do not give any support for this.

			In LimeSurvey 2.x and higher there will be a new version named [[RemoteControl 2]] based on XML-RPC.

	=Introduction=		=Introduction=

← Older revision		Revision as of 15:21, 6 June 2013
Line 14:		Line 14:
	LimeSurvey RemoteControl is a PHP:SOAP based Web service application.		LimeSurvey RemoteControl is a PHP:SOAP based Web service application.

	The LSRC makes it possible for developers to control specific functionality of ~~Limesurvey~~ from any other Application, without beeing restricted to PHP as a Programming language.		The LSRC makes it possible for developers to control specific functionality of LimeSurvey from any other Application, without beeing restricted to PHP as a Programming language.

	You can start a predefined survey (change titles and things), add predefined groups or questions to this coresurvey. Activate the survey, restrict it to start and endtime, make it closed, add Participant data or just tokens when you need them (your customer just bought a book and now you want to invite him to a closed survey automatically), return the unused tokens to the main application, delete a survey, get a fieldmap for a survey, invite or remind the participants of your survey, etc...		You can start a predefined survey (change titles and things), add predefined groups or questions to this coresurvey. Activate the survey, restrict it to start and endtime, make it closed, add Participant data or just tokens when you need them (your customer just bought a book and now you want to invite him to a closed survey automatically), return the unused tokens to the main application, delete a survey, get a fieldmap for a survey, invite or remind the participants of your survey, etc...
Line 25:		Line 25:
	* lsrc.config.php (configuration variables)		* lsrc.config.php (configuration variables)
	* lsrc.server.php (the logical SOAP:Server brain. Programm logic is mainly in here )		* lsrc.server.php (the logical SOAP:Server brain. Programm logic is mainly in here )
	* lsrc.helper.php (class LsrcHelper, this Class does the work. Mainly copied and customized from ~~Limesurvey~~ files. Especially for import tasks)		* lsrc.helper.php (class LsrcHelper, this Class does the work. Mainly copied and customized from LimeSurvey files. Especially for import tasks)
	* lsrc_orig.wsdl (wsdl definition for SOAP messages. From this file the lsrc.wsdl is generated with correct paths)		* lsrc_orig.wsdl (wsdl definition for SOAP messages. From this file the lsrc.wsdl is generated with correct paths)
	* lsrc.testclient.php (to test the environment and functionality of the webservice on the fly)		* lsrc.testclient.php (to test the environment and functionality of the webservice on the fly)
Line 71:		Line 71:
	** (optional) set $export4lsrc = true; if you want to export surveys, groups and questions to remotecontrol folders for importing remotely. They must be writeable.		** (optional) set $export4lsrc = true; if you want to export surveys, groups and questions to remotecontrol folders for importing remotely. They must be writeable.
	* the script needs rights to write files to the folder "admin/remotecontrol/" (lsrc.log, if logging is used and lsrc.wsdl). if(you cannot or don't want to set the directory rights to 777){create those two files(lsrc.log and lsrc.wsdl)in the lsrc dir with the permission to write them(777))		* the script needs rights to write files to the folder "admin/remotecontrol/" (lsrc.log, if logging is used and lsrc.wsdl). if(you cannot or don't want to set the directory rights to 777){create those two files(lsrc.log and lsrc.wsdl)in the lsrc dir with the permission to write them(777))
	* If you want to save Survey, group or question csv's directly from ~~Limesurvey~~ into the lsrc Folders, you need to set them to 777, too. (Option can be enabled by adding $export4lsrc = true; to ~~Limesurveys~~ config.php)		* If you want to save Survey, group or question csv's directly from LimeSurvey into the lsrc Folders, you need to set them to 777, too. (Option can be enabled by adding $export4lsrc = true; to LimeSurveys config.php)
	* You may have to generate a wsdl file if you need a static one. Run lsrc.server.php?wsdl and the script will make a lsrc.wsdl with the correct server url included in the lsrc directory.		* You may have to generate a wsdl file if you need a static one. Run lsrc.server.php?wsdl and the script will make a lsrc.wsdl with the correct server url included in the lsrc directory.
	* If auto wsdl generation do not work properly (maybe virtual hosts make Problems, please report back, if so or not so, can't test at the moment) You have to set the url of the lsrc.server.php script in the last block of the wsdl		* If auto wsdl generation do not work properly (maybe virtual hosts make Problems, please report back, if so or not so, can't test at the moment) You have to set the url of the lsrc.server.php script in the last block of the wsdl
Line 145:		Line 145:
	'''NOTE on PHP 5.3:''' setting the path2wsdl to http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl worked with all prior 5.3 version of PHP. With PHP 5.3 the client will not recognize the wsdl lsrc.server.php?wsdl gives back. You have to call lsrc.server.php?wsdl once to generate the lsrc.wsdl file and then point your client to http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl instead.		'''NOTE on PHP 5.3:''' setting the path2wsdl to http://localhost/limesurvey/admin/remotecontrol/lsrc.server.php?wsdl worked with all prior 5.3 version of PHP. With PHP 5.3 the client will not recognize the wsdl lsrc.server.php?wsdl gives back. You have to call lsrc.server.php?wsdl once to generate the lsrc.wsdl file and then point your client to http://localhost/limesurvey/admin/remotecontrol/lsrc.wsdl instead.

	There is a PHPclient (from version 1.86) in the remotecontrol folder. You can use this ClientClass to control ~~Limesurvey~~ from within your PHP Applications with ease.		There is a PHPclient (from version 1.86) in the remotecontrol folder. You can use this ClientClass to control LimeSurvey from within your PHP Applications with ease.

	Take a look at lsrc.testclient-new.php to get an impression of how it can be implemented.		Take a look at lsrc.testclient-new.php to get an impression of how it can be implemented.
Line 286:		Line 286:
	** '''Note''':		** '''Note''':
	*** Goto line 714 in lsrc.helper.php to see what can be done and customized while importing.		*** Goto line 714 in lsrc.helper.php to see what can be done and customized while importing.
	*** If you want ~~Limesurvey~~ to give your Survey a random Number if the given ID exist (because you do not need a specific identification for your surveys), just go into the function sCreateSurvey in lsrc.server.php and delete or comment out the if($lsrcHelper->surveyExists($iVid)) clause. In Result, ~~Limesurvey~~ will give your survey a random ID when the given ID exists.		*** If you want LimeSurvey to give your Survey a random Number if the given ID exist (because you do not need a specific identification for your surveys), just go into the function sCreateSurvey in lsrc.server.php and delete or comment out the if($lsrcHelper->surveyExists($iVid)) clause. In Result, LimeSurvey will give your survey a random ID when the given ID exists.

	==sActivateSurvey==		==sActivateSurvey==
Line 540:		Line 540:
	** '''Purpose''': sends an Statistic File as Attachment		** '''Purpose''': sends an Statistic File as Attachment
	** '''Parameters'''		** '''Parameters'''
	*** user: ~~Limesurvey~~ user		*** user: LimeSurvey user
	*** password: ~~Limesurvey~~ Password		*** password: LimeSurvey Password
	*** surveyId: ID of the survey from which statistics should be generated		*** surveyId: ID of the survey from which statistics should be generated
	*** email: the adress to which the statistic file is send		*** email: the adress to which the statistic file is send
Line 579:		Line 579:
	</syntaxhighlight>		</syntaxhighlight>

	At the beginning of lsrc.client.php (used by lsrc.testclient.php) set the target ~~Limesurvey~~ Installation Dir. localhost for servername is always wrong in this testcase, 127.0.0.1, too.		At the beginning of lsrc.client.php (used by lsrc.testclient.php) set the target LimeSurvey Installation Dir. localhost for servername is always wrong in this testcase, 127.0.0.1, too.

	'''NOTES''':		'''NOTES''':
Line 586:		Line 586:

	=Notes=		=Notes=
	* Security is enhanced: no action without permission (as good as ~~Limesurveys~~ Security itself --> very good)		* Security is enhanced: no action without permission (as good as LimeSurveys Security itself --> very good)
	* No headers or "Quick and Dirtys" anymore, no Scripts, just functions and a class.		* No headers or "Quick and Dirtys" anymore, no Scripts, just functions and a class.
	* All configuration Variables are stored in lsrc.config.php by now		* All configuration Variables are stored in lsrc.config.php by now
Line 620:		Line 620:
	* New sImportFreetext: imports a Freetext question and changes the title and question to the Strings given. Previously, this function was called sImportQuestion.		* New sImportFreetext: imports a Freetext question and changes the title and question to the Strings given. Previously, this function was called sImportQuestion.
	* Changed sAvailableModules: type can be core, mod or que. "que" is new and gives back the names of all the questions available.		* Changed sAvailableModules: type can be core, mod or que. "que" is new and gives back the names of all the questions available.
	* New sSendEmail: send invitations, reminders and custom mails to participants of a survey over ~~Limesurvey~~.		* New sSendEmail: send invitations, reminders and custom mails to participants of a survey over LimeSurvey.

	=ToDo / ToCome=		=ToDo / ToCome=
Line 636:		Line 636:
	* instead of setting the remotecontrol folder to 777, just create an empty file lsrc.wsdl with the rights 777		* instead of setting the remotecontrol folder to 777, just create an empty file lsrc.wsdl with the rights 777
	* disable the lsrc.log in lsrc.config.php		* disable the lsrc.log in lsrc.config.php
	* Do not set the survey, groups, questions folders to 777 for saving lsrc templates directly within ~~Limesurvey~~, instead, save the .csv on your local PC and upload them via ftp to the folders.		* Do not set the survey, groups, questions folders to 777 for saving lsrc templates directly within LimeSurvey, instead, save the .csv on your local PC and upload them via ftp to the folders.
	* delete lsrc.testclient.php, when in productive use. Lsrc.testclient.php could be used from unauthorized people to perform portscanning on other machines. The attacked webserver would be seeing your webserver as attacker, altough you did not perform any attack by yourself. This is not so serious, as this bahaviour of the testclient is not much valuable for any serious hacker.		* delete lsrc.testclient.php, when in productive use. Lsrc.testclient.php could be used from unauthorized people to perform portscanning on other machines. The attacked webserver would be seeing your webserver as attacker, altough you did not perform any attack by yourself. This is not so serious, as this bahaviour of the testclient is not much valuable for any serious hacker.