svg-scanner.php File Reference

Go to the source code of this file.

Functions
	sysexit ( $results, $status)

Variables
global	$argv
	$results
	$files_to_scan = $argv
if(empty( $files_to_scan))	$sanitizer = new enshrined\svgSanitize\Sanitizer()

Function Documentation

sysexit()

sysexit	(		$results,
			$status
	)

Definition at line 24 of file svg-scanner.php.

References $results, and exit.

  {
        echo json_encode(
                $results,
                JSON_PRETTY_PRINT
        );

        exit( $status );
}


/*
 * Main part begins
 */

global $argv;

/*
 * Set up results array, to
 * be printed on exit.
 */
$results = array(
        'totals' => array(
                'errors' => 0,
        ),

        'files' => array(
        ),
);


/*
 * Catch files to scan from $argv.
 */

$files_to_scan = $argv;
unset( $files_to_scan[0] );

$files_to_scan = array_values(
        $files_to_scan
);

/*
 * Catch no file specified.
 */

if ( empty( $files_to_scan ) ) {
        $results['totals']['errors']++;
        $results['messages'] = array(
                array( 'No files to scan specified' ),
        );

        sysexit(
                $results,
                1
        );
}

/*
 * Initialize the SVG scanner.
 *
 * Make sure to allow custom attributes,
 * and to remove remote references.
 */
$sanitizer = new enshrined\svgSanitize\Sanitizer();

$sanitizer->removeRemoteReferences( true );

/*
 * Scan each file specified to be scanned.
 */

foreach( $files_to_scan as $file_name ) {
        /*
         * Read SVG file.
         */
        $svg_file = @file_get_contents( $file_name );

        /*
         * If not found, report that and continue.
         */
        if ( false === $svg_file ) {
                $results['totals']['errors']++;

                $results['files'][ $file_name ][] = array(
                        'errors' => 1,
                        'messages' => array(
                                array(
                                        'message' => 'File specified could not be read (' . $file_name . ')',
                                        'line' => null,
                                ),
                        ),
                );

                continue;
        }

        /*
         * Sanitize file and get issues found.
         */
        $sanitize_status = $sanitizer->sanitize( $svg_file );

        $xml_issues = $sanitizer->getXmlIssues();

        /*
         * If we find no issues, simply note that.
         */
        if ( empty( $xml_issues ) && ( false !== $sanitize_status ) ) {
                $results['files'][ $file_name ] = array(
                        'errors' => 0,
                        'messages' => array()
                );
        }

        /*
         * Could not sanitize the file.
         */
        else if (
                ( '' === $sanitize_status ) ||
                ( false === $sanitize_status )
        ) {
                $results['totals']['errors']++;

                $results['files'][ $file_name ] = array(
                        'errors' => 1,
                        'messages' => array(
                                array(
                                        'message' => 'Unable to sanitize file \'' . $file_name . '\'' ,
                                        'line' => null,
                                )
                        ),
                );
        }

        /*
         * If we find issues, note it and update statistics.
         */

        else {
                $results['totals']['errors'] += count( $xml_issues );

                $results['files'][ $file_name ] = array(
                        'errors' => count( $xml_issues ),
                        'messages' => $xml_issues,
                );
        }

        unset( $svg_file );
        unset( $xml_issues );
        unset( $sanitize_status );
}

Variable Documentation

$argv

global $argv

Definition at line 41 of file svg-scanner.php.

Referenced by convert(), Enviro\initialize(), and showHelp().

$files_to_scan

$files_to_scan = $argv

Definition at line 61 of file svg-scanner.php.

$results

$results

Initial value:

= array(
        'totals' => array(
                'errors' => 0,
        ),

        'files' => array(
        ),
)

Definition at line 47 of file svg-scanner.php.

Referenced by SAML2\ArtifactResolve\__construct(), ilObjLearningModuleAccess\_getCommands(), sspmod_statistics_Aggregator\aggregate(), ilTestPlayerAbstractGUI\archiveParticipantSubmission(), ilTestSubmissionReviewGUI\buildUserReviewOutput(), assFormulaQuestionResult\calculateFormula(), ilContainerAccess\canBeDelivered(), ilObjBlogAccess\canBeDelivered(), ilObjExerciseAccess\canBeDelivered(), ilObjPollAccess\canBeDelivered(), ilPortfolioAccessHandler\canBeDelivered(), sspmod_statistics_LogCleaner\clean(), ilObjTestGUI\createUserResults(), ilSurveySkill\determineSkillLevelsForAppraisee(), ilSurveyEvaluationGUI\evaluation(), sspmod_core_Storage_SQLPermanentStorage\exists(), ilSCORM2004Asset\exportPDF(), ilObjSCORM2004LearningModule\exportPDF(), ilNotificationDatabaseHandler\fillPlaceholders(), assFormulaQuestionResult\findValidRandomVariables(), sspmod_core_Storage_SQLPermanentStorage\get(), ilObjTest\getAggregatedResultsData(), ilObjTest\getAllTestResults(), ilBasicSkill\getCommonSkillIdForImportId(), ilObjTest\getCustomStyles(), ilObjTest\getDetailedTestResults(), sspmod_core_Storage_SQLPermanentStorage\getKeys(), ilChatroom\getLastMessages(), ilBasicSkill\getLevelIdForImportId(), sspmod_core_Storage_SQLPermanentStorage\getList(), assFormulaQuestionResult\getReachedPoints(), ilDatabaseAtomRunTest\getResultFromDB(), assFormulaQuestionResult\getResultInfo(), SurveyMatrixQuestionEvaluation\getResults(), SurveyQuestionEvaluation\getResults(), ilObjTest\getTestResult(), ilDclTokenizer\getTokens(), ilTestService\getVirtualSequenceUserResults(), ilObjTestGUI\importVerifiedFileObject(), ilTestImporter\importXmlRepresentation(), ilObjPollGUI\initEditCustomForm(), ilObjSurveyGUI\initPropertiesForm(), sspmod_core_Storage_SQLPermanentStorage\insert(), assFormulaQuestionResult\isCorrect(), assFormulaQuestionGUI\isSaveCommand(), ilLOTestQuestionAdapter\lookupRelevantObjectiveIdsForTest(), ilLTIDataConnector\lookupResourcesForAllUsersSinceDate(), ilScoringAdjustmentGUI\outputAdjustQuestionForm(), ilAdvancedMDValues\queryForRecords(), SAML2\SOAP\receive(), sspmod_core_Storage_SQLPermanentStorage\remove(), GuzzleHttp\Psr7\UriResolver\removeDotSegments(), ilTestArchiveService\renderOverviewContent(), SimpleSAML_Auth_LDAP\searchformultiple(), ilDclRecordEditGUI\searchObjects(), ilObjectCopyGUI\searchSource(), assFormulaQuestionTest\simpleRatedCalculationsData(), statistics_hook_cron(), sspmod_statistics_Aggregator\store(), assFormulaQuestionResult\substituteFormula(), assFormulaQuestionResult\suggestRange(), sysexit(), sspmod_core_Storage_SQLPermanentStorage\update(), and SAML2\Utils\xpQuery().

$sanitizer

if (empty($files_to_scan)) $sanitizer = new enshrined\svgSanitize\Sanitizer()

Definition at line 90 of file svg-scanner.php.

Referenced by ilObjFolder\recurseFolder(), and ilMediaSvgSanitizer\sanitizeFile().