metarefresh.php File Reference

Go to the source code of this file.

Functions
	printHelp ()
	This function prints the help output. More...

Variables
	$baseDir = dirname(dirname(dirname(dirname(__FILE__))))
if(!SimpleSAML\Module::isModuleEnabled('metarefresh'))	$configdir = SimpleSAML\Utils\Config::getConfigDir()
	$outputDir = $baseDir . '/metadata-generated'
	$toStdOut = FALSE
	$certificates = NULL
	$validateFingerprint = NULL
	$files = array()
	$progName = array_shift($argv)
foreach( $argv as $a) if(count($files)===0)	$metaloader = new sspmod_metarefresh_MetaLoader()
foreach( $files as $f) if($toStdOut)	else

Function Documentation

printHelp()

printHelp

(

)

This function prints the help output.

Definition at line 149 of file metarefresh.php.

                     {
        global $progName;
 
        /*   '======================================================================' */
        echo('Usage: ' . $progName . ' [options] [files]' . "\n");
        echo("\n");
        echo('This program parses a SAML metadata files and output pieces that can' . "\n");
        echo('be added to the metadata files in metadata/.' . "\n");
        echo("\n");
        echo('Options:' . "\n");
        echo(' --certificate=<FILE>         The certificate which should be used' . "\n");
        echo('                              to check the signature of the metadata.' . "\n");
        echo('                              The file are stored in the cert dir.' . "\n");
        echo('                              It is possibility to add multiple' . "\n");
        echo('                              --certificate options to handle' . "\n");
        echo('                              key rollover.' . "\n");
        echo(' --validate-fingerprint=<FINGERPRINT>' . "\n");
        echo('                              Check the signature of the metadata,' . "\n");
        echo('                              and check the fingerprint of the' . "\n");
        echo('                              certificate against <FINGERPRINT>.' . "\n");
        echo(' -h, --help                   Print this help.' . "\n");
        echo(' -o=<DIR>, --out-dir=<DIR>    Write the output to this directory. The' . "\n");
        echo('                              default directory is metadata-generated/.' . "\n");
        echo('                              Path will be relative to the SimpleSAMLphp' . "\n");
        echo('                              base directory.' . "\n");
        echo(' -s, --stdout                 Write the output to stdout instead of' . "\n");
        echo('                              seperate files in the output directory.' . "\n");
        echo("\n");
}

References $progName.

Variable Documentation

$baseDir

$baseDir = dirname(dirname(dirname(dirname(__FILE__))))

Definition at line 11 of file metarefresh.php.

$certificates

$certificates = NULL

Definition at line 39 of file metarefresh.php.

Referenced by sspmod_saml_Message\checkSign(), sspmod_saml_Message\findCertificate(), SAML2\Assertion\getCertificates(), SAML2\Message\getCertificates(), SAML2\SignedElementHelper\getCertificates(), ilCertificateLearningHistoryProvider\getEntries(), ilPCVerificationGUI\initForm(), SAML2\Utils\insertSignature(), ilCertificateUserForObjectPreloader\isPreloaded(), ilCertificateObjectsForUserPreloader\isPreloaded(), ilCertificateObjectsForUserPreloader\preLoad(), ilCertificateUserForObjectPreloader\preLoadDownloadableCertificates(), ilCertificateMigrationJob\run(), SAML2\Assertion\setCertificates(), SAML2\Message\setCertificates(), SAML2\SignedElementHelper\setCertificates(), and SimpleSAML_Metadata_SAMLParser\validateSignature().

$configdir

if (!SimpleSAML\Module::isModuleEnabled( 'metarefresh')) $configdir = SimpleSAML\Utils\Config::getConfigDir()

Definition at line 24 of file metarefresh.php.

$files

$files = array()

Definition at line 49 of file metarefresh.php.

Referenced by ilSCORMResourceGUI\__construct(), ilForum\__deletePostFiles(), ilUploadFiles\_checkUploadFile(), ilExport\_getLastExportFileDate(), ilExport\_getLastExportFileInformation(), ilUploadFiles\_getUploadFiles(), phpseclib\Net\SFTP\_nlist_helper(), ilCourseFile\_readFilesByCourse(), ilSessionFile\_readFilesByEvent(), ilExerciseManagementCollectFilesJob\addCriteriaToExcel(), ilPCFileListGUI\addFileItem(), ilExAssignmentGUI\addFiles(), ZipStreamTest\ZipStreamTest\addLargeFileFileFromPath(), ilExAssignmentGUI\addSubmissionFeedback(), ilExcCriteriaFile\addToPeerReviewForm(), ilObjFileBasedLMGUI\afterSave(), ilPCFileList\beforePageDelete(), HTMLPurifier_ConfigSchema_InterchangeBuilder\buildDir(), ilPortfolioHTMLExport\buildExportFile(), ilDclPropertyFormGUI\cleanupTempFiles(), ilDownloadFilesBackgroundTask\collectFiles(), ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilAppointmentPresentationExerciseGUI\collectPropertiesAndActions(), ilAssFileUploadUploadsExporter\collectUploadedFiles(), ilMailAttachmentGUI\confirmDeleteAttachments(), ilExSubmissionFileGUI\confirmDeleteDeliveredObject(), ilAdvancedMDSettingsGUI\confirmDeleteFiles(), ilExSubmissionTeamGUI\confirmRemoveTeamMemberObject(), assLongMenu\createArrayFromFile(), ilMailFormGUI\decodeAttachmentFiles(), ilUpdateUtilsMailMigration\delDir(), ilUpdateUtils\delDir(), ilUtil\delDir(), ilPageObject\delete(), ilExSubmission\deleteAllFiles(), ilIndividualAssessmentFileStorage\deleteCurrentFile(), ilPCFileList\deleteFileItems(), ilAdvancedMDSettingsGUI\deleteFiles(), assFileUpload\deletePreviewFileUploads(), assFileUpload\deleteUploadedFiles(), ilFileDataMail\deliverAttachmentsAsZip(), ilSetupGUI\displayDeleteConfirmation(), ilExSubmissionGUI\downloadFeedbackFileObject(), ilAdvancedMDSettingsGUI\downloadFile(), ilPageObjectGUI\downloadFile(), ilExSubmissionGUI\downloadFileObject(), ilExSubmission\downloadFiles(), ilExSubmission\downloadMultipleFiles(), ilExSubmissionTextGUI\editAssignmentTextObject(), ilMailFormGUI\editAttachments(), ilObjCourseGUI\editInfoObject(), ilScormExportUtil\exportContentCSS(), ilObjContentObject\exportHTML(), ilFileSystemGUI\extCommand(), ilExAssignment\fixInstructionFileOrdering(), ilFileDataMail\getAttachmentPathAndFilenameByMd5Hash(), Symfony\Component\Yaml\Tests\ParserTest\getDataFormSpecifications(), ilUpdateUtilsMailMigration\getDir(), ilUpdateUtils\getDir(), ilUtil\getDir(), ilExSubmission\getDownloadedFilesInfoForTableGUIS(), ilDclExportTableGUI\getExportFiles(), ilExportTableGUI\getExportFiles(), ilScormAiccDataSet\getExtendedXmlRepresentation(), ilFSStorageExercise\getFeedbackFiles(), ilFSStorageExercise5069\getFeedbackFiles(), ilFileDataForum\getFileDataByMD5Filename(), ilFileDataForumDrafts\getFileDataByMD5Filename(), ilPCFileList\getFileList(), ilIndividualAssessmentFileStorage\getFilePath(), ilUploadDirFilesTableGUI\getFiles(), Gettext\Extractors\Extractor\getFiles(), ilFSStorageExercise\getFiles(), ilFSWebStorageExercise\getFiles(), ilAdvancedMDRecordExportFiles\getFiles(), ilAppointmentCourseFileHandler\getFiles(), ilAppointmentExerciseFileHandler\getFiles(), ilAppointmentSessionFileHandler\getFiles(), ilFSStorageExercise5069\getFiles(), ilFSStorageExc5242\getFiles(), ilObjMediaObject\getFilesOfDirectory(), ilExcCriteriaFile\getHTML(), ilPageObject\getLastUpdateOfIncludedElements(), ilFileDataCourse\getMemberExportFiles(), ilFSStorageCourse\getMemberExportFiles(), ilFSStorageGroup\getMemberExportFiles(), ilExAssignment\getMultiFeedbackFiles(), ilMobMultiSrtUpload\getMultiSrtFiles(), ilObjMediaObject\getMultiSrtFiles(), ilPCIIMOverlaysTableGUI\getOverlays(), assFileUploadGUI\getPreview(), ZipStreamTest\ZipStreamTest\getRecursiveFileList(), PhpOffice\PhpSpreadsheet\Helper\Sample\getSamples(), ilExSubmission\getSelectedObject(), assFileUploadGUI\getSolutionOutput(), assFileUploadGUI\getTestOutput(), ilCOPageExporter\getXmlExportHeadDependencies(), ilExerciseXMLWriter\handleAssignmentFiles(), assKprimChoice\handleFileUploads(), ilObjCourseGUI\infoScreen(), ilExAssignmentEditorGUI\initAssignmentForm(), ilForumThreadFormGUI\initForm(), ilObjSAHSLearningModuleGUI\initUploadForm(), ilIndividualAssessmentFileStorage\isEmpty(), ilFileSystemGUI\listFiles(), ilObjSurvey\locateImportFiles(), ilObjSCORMLearningModuleGUI\newModuleVersion(), GuzzleHttp\Psr7\ServerRequest\normalizeFiles(), GuzzleHttp\Psr7\ServerRequest\normalizeNestedFileSpec(), phpseclib\Net\SFTP\rawlist(), ilIndividualAssessmentFileStorage\readDir(), ilLoggerCronCleanErrorFiles\run(), ilMailAttachmentGUI\saveAttachments(), ilMailFormGUI\saveDraft(), ilMailFormGUI\saveMailBeforeSearch(), ilMailFormGUI\searchUsers(), ilMailFormGUI\sendMessage(), ilFileXMLParser\setFileContents(), ilExSubmissionTextGUI\showAssignmentTextObject(), ilMailAttachmentGUI\showAttachments(), ilAdvancedMDSettingsGUI\showFiles(), ilFileDataForum\storeUploadedFile(), ilFileDataForumDrafts\storeUploadedFile(), ZipStreamTest\ZipStreamTest\testAddFile(), ZipStreamTest\ZipStreamTest\testAddFileFromPath(), ZipStreamTest\ZipStreamTest\testAddFileFromPsr7Stream(), ZipStreamTest\ZipStreamTest\testAddFileFromPsr7StreamWithFileSizeSet(), ZipStreamTest\ZipStreamTest\testAddFileFromStream(), ZipStreamTest\ZipStreamTest\testAddFileUtf8NameComment(), ZipStreamTest\ZipStreamTest\testCreateArchiveWithFlushOptionSet(), ILIAS\FileUpload\FileUploadImplTest\testHasUploadsWithMultipleUploadedFile(), Symfony\Component\Yaml\Tests\DumperTest\testSpecifications(), ilFileDataForum\unlinkFilesByMD5Filenames(), ilFileDataForumDrafts\unlinkFilesByMD5Filenames(), ilExSubmission\updateTextSubmission(), ilObjFileGUI\uploadFiles(), ilObjHelpSettings\uploadHelpModule(), ilSCORMResourceGUI\view(), and assKprimChoiceGUI\writeAnswerSpecificPostData().

$metaloader

foreach($argv as $a) if (count( $files)===0) $metaloader = new sspmod_metarefresh_MetaLoader()

Definition at line 131 of file metarefresh.php.

Referenced by metarefresh_hook_cron().

$outputDir

$outputDir = $baseDir . '/metadata-generated'

Definition at line 28 of file metarefresh.php.

Referenced by clean(), and metarefresh_hook_cron().

$progName

$progName = array_shift($argv)

Definition at line 53 of file metarefresh.php.

Referenced by printHelp().

$toStdOut

$toStdOut = FALSE

Definition at line 34 of file metarefresh.php.

$validateFingerprint

$validateFingerprint = NULL

Definition at line 45 of file metarefresh.php.

else

foreach($files as $f) if ( $toStdOut) else

Initial value:

{
        $metaloader->writeMetadataFiles($outputDir)

Definition at line 142 of file metarefresh.php.