api_export_survey.patch (7,413 bytes)
--- application/helpers/remotecontrol/remotecontrol_handle.php.org 2020-02-13 16:39:43.137157937 +0100
+++ application/helpers/remotecontrol/remotecontrol_handle.php 2020-05-26 17:19:04.892983689 +0200
@@ -255,6 +255,146 @@
}
/**
+ * RPC Routine to export a survey archive (LSA).
+ *
+ * @access public
+ * @param string $sSessionKey Auth credentials
+ * @param int $iSurveyID_org Id of the survey
+ * @return string|array in case of success : Base64 encoded string of the .lsa file. On failure array with error information.
+ * */
+ public function export_survey_archive ($sSessionKey, $iSurveyID_org)
+ {
+ $iSurveyID = (int) $iSurveyID_org;
+ if (!$this->_checkSessionKey($sSessionKey)) {
+ return array('status' => 'Invalid session key');
+ }
+ $aData['bFailed'] = false; // Put a var for continue
+ if (!$iSurveyID) {
+ $aData['sErrorMessage'] = "No survey ID has been provided. Cannot export survey";
+ $aData['bFailed'] = true;
+ } elseif (!Survey::model()->findByPk($iSurveyID)) {
+ $aData['sErrorMessage'] = "Invalid survey ID";
+ $aData['bFailed'] = true;
+ } elseif (!Permission::model()->hasSurveyPermission($iSurveyID, 'surveycontent', 'export') && !Permission::model()->hasSurveyPermission($iSurveyID, 'surveycontent', 'export')) {
+ $aData['sErrorMessage'] = "You don't have sufficient permissions.";
+ $aData['bFailed'] = true;
+ } else {
+ $aExcludes = array();
+ $aExcludes['dates'] = true;
+ $btranslinksfields = true;
+ Yii::app()->loadHelper('export');
+
+ /* START CODE DUPLICATION
+ * taken from application/controllers/admin/export.php:_exportarchive
+ * This is ugly.
+ * Sorry, I am just a sysadmin, no PHP dev
+ * The mentioned function would somehow need to be public to actually use it
+ * However, I barely understand OO programming
+ *
+ * I also added addToZip to export_helper.php and made it non-private
+ * to be able to use it here. Ugly as well.
+ *
+ * Still, it works, so the concept should be clear.
+ */
+ $survey = Survey::model()->findByPk($iSurveyID);
+
+ // $aSurveyInfo = getSurveyInfo($iSurveyID); // unused, even in export.php
+
+ $sTempDir = Yii::app()->getConfig("tempdir");
+
+ $aZIPFileName = $sTempDir.DIRECTORY_SEPARATOR.randomChars(30);
+ $sLSSFileName = $sTempDir.DIRECTORY_SEPARATOR.randomChars(30);
+ $sLSRFileName = $sTempDir.DIRECTORY_SEPARATOR.randomChars(30);
+ $sLSTFileName = $sTempDir.DIRECTORY_SEPARATOR.randomChars(30);
+ $sLSIFileName = $sTempDir.DIRECTORY_SEPARATOR.randomChars(30);
+
+ Yii::import('application.libraries.admin.pclzip', true);
+ $zip = new PclZip($aZIPFileName);
+
+ file_put_contents($sLSSFileName, surveyGetXMLData($iSurveyID));
+
+ addToZip($zip, $sLSSFileName, 'survey_'.$iSurveyID.'.lss');
+
+ unlink($sLSSFileName);
+
+ if ($survey->isActive) {
+ getXMLDataSingleTable($iSurveyID, 'survey_'.$iSurveyID, 'Responses', 'responses', $sLSRFileName, false);
+ addToZip($zip, $sLSRFileName, 'survey_'.$iSurveyID.'_responses.lsr');
+ unlink($sLSRFileName);
+ }
+
+ if ($survey->hasTokensTable) {
+ getXMLDataSingleTable($iSurveyID, 'tokens_'.$iSurveyID, 'Tokens', 'tokens', $sLSTFileName);
+ addToZip($zip, $sLSTFileName, 'survey_'.$iSurveyID.'_tokens.lst');
+ unlink($sLSTFileName);
+ }
+
+ if (isset($survey->hasTimingsTable) && $survey->hasTimingsTable == 'Y') {
+ getXMLDataSingleTable($iSurveyID, 'survey_'.$iSurveyID.'_timings', 'Timings', 'timings', $sLSIFileName);
+ addToZip($zip, $sLSIFileName, 'survey_'.$iSurveyID.'_timings.lsi');
+ unlink($sLSIFileName);
+ }
+
+ if (is_file($aZIPFileName)) {
+ /* END CODE DUPLICATION */
+
+ $sResult = file_get_contents($aZIPFileName);
+ unlink($aZIPFileName);
+ } else {
+ $aData['bFailed'] = true;
+ $aData['sErrorMessage'] = 'Error creating lsa archive';
+ }
+ }
+ if ($aData['bFailed']) {
+ return array('status' => 'Export failed', 'error'=> $aData['sErrorMessage']);
+ } else {
+ return base64_encode($sResult);
+ }
+ }
+ /**
+ * RPC Routine to export a survey structure (LSS).
+ *
+ * @access public
+ * @param string $sSessionKey Auth credentials
+ * @param int $iSurveyID_org Id of the survey
+ * @return string|array in case of success : Base64 encoded string of the .lss file. On failure array with error information.
+ * */
+ public function export_survey_structure ($sSessionKey, $iSurveyID_org)
+ {
+ $iSurveyID = (int) $iSurveyID_org;
+ if (!$this->_checkSessionKey($sSessionKey)) {
+ return array('status' => 'Invalid session key');
+ }
+ $aData['bFailed'] = false; // Put a var for continue
+ if (!$iSurveyID) {
+ $aData['sErrorMessage'] = "No survey ID has been provided. Cannot export survey";
+ $aData['bFailed'] = true;
+ } elseif (!Survey::model()->findByPk($iSurveyID)) {
+ $aData['sErrorMessage'] = "Invalid survey ID";
+ $aData['bFailed'] = true;
+ } elseif (!Permission::model()->hasSurveyPermission($iSurveyID, 'surveycontent', 'export') && !Permission::model()->hasSurveyPermission($iSurveyID, 'surveycontent', 'export')) {
+ $aData['sErrorMessage'] = "You don't have sufficient permissions.";
+ $aData['bFailed'] = true;
+ } else {
+ $aExcludes = array();
+ $aExcludes['dates'] = true;
+ $btranslinksfields = true;
+ Yii::app()->loadHelper('export');
+ $exportsurveystructuredata = surveyGetXMLData($iSurveyID, $aExcludes);
+ if ($exportsurveystructuredata) {
+ $sResult = $exportsurveystructuredata;
+ } else {
+ $aData['bFailed'] = true;
+ }
+ }
+ if ($aData['bFailed']) {
+ return array('status' => 'Export failed', 'error'=> $aData['sErrorMessage']);
+ } else {
+ return base64_encode($sResult);
+ }
+ }
+
+ /**
* Copy survey (RPC function)
*
* @access public
--- application/helpers/export_helper.php.org 2020-05-26 17:22:50.808991768 +0200
+++ application/helpers/export_helper.php 2020-05-26 17:07:19.924958477 +0200
@@ -13,6 +13,26 @@
*/
/**
+ * CODE DUPLICATION! This is also part of export.php
+ * Sorry I can't solve this any better...
+ * @param PclZip $zip
+ * @param string $name
+ * @param string $full_name
+ */
+
+function addToZip($zip, $name, $full_name)
+{
+ $zip->add(
+ array(
+ array(
+ PCLZIP_ATT_FILE_NAME => $name,
+ PCLZIP_ATT_FILE_NEW_FULL_NAME => $full_name
+ )
+ )
+ );
+}
+
+/**
* Strips html tags and replaces new lines
*
* @param $string
