fwInstallation
8.4.1
|
Functions | |
int | fwInstallation_getComponentFilesForHashCalculation (string component, dyn_string &componentFiles) |
int | fwInstallation_calculateComponentSourceFilesHashes (string component) |
int | fwInstallation_storeComponentSourceFilesHashes (string component, dyn_string fileNames, dyn_string baseFileHashes, dyn_string alternativeFileHashes) |
string | fwInstallation_formatComponentSourceFileHashString (string fileName, string baseFileHash, string alternativeFileHash="") |
int | fwInstallation_getComponentSourceFilesHashes (string component, dyn_string &fileNames, dyn_string &baseFileHashes, dyn_string &alternativeFileHashes) |
int | fwInstallation_setAlternativeComponentFileHash (string component, string fileName, string directory="") |
int | fwInstallation_resetAlternativeComponentFileHash (string component, string fileName) |
int | fwInstallation_getComponentFilesWithAlternativeHash (string component, dyn_string &filesWithAlternativeHash) |
int | fwInstallation_getProjectFileIssues (dyn_dyn_mixed &fileIssues) |
int | fwInstallation_getComponentFilesIssues (string component, dyn_mapping &errorFiles, bool getOverparameterized=true, bool getHash=true, bool getHashCompNotPossible=true, bool useAlternativeHash=true) |
int | fwInstallation_installComponentSet (dyn_string componentFiles, string &dontRestartProject) |
int | fwInstallation_deleteComponentSet (dyn_string dynComponentsNames, bool deleteFiles) |
int | fwInstallation_stopManagersForInstallation () |
int | fwInstallation_parseHostPortConfigEntry (string configHostEntry, dyn_dyn_string &hostAliases, dyn_dyn_int &ports) |
void | _fwInstallation_parseDistPeer (string distPeer, string &host, string &reduHost, string &port) |
int | fwInstallation_deleteProjectPaths (dyn_string paths) |
int | fwInstallation_addProjectPaths (dyn_string dbPaths) |
dyn_string | fwInstallation_getHostPvssVersions () |
private dyn_string | fwInstallation_getPvssVersionsFromWinRegKey (string key) |
string | fwInstallation_getWinRegKey (string key) |
dyn_string | fwInstallation_getComponentPendingPostInstalls (string component, int reduHostNum=0) |
dyn_string | fwInstallation_getProjectPendingPostInstalls (int reduHostNum=0) |
void | fwInstallation_resetLog () |
string | fwInstallation_getWCCOAExecutable (string type) |
void | fwInstallation_appendLog (string msg, string severity) |
bool | fwInstallation_isPatchInstalled (string patch) |
int | fwInstallation_checkPvssVersion (string reqVersion) |
int | fwInstallation_checkToolVersion (string reqVersion) |
float | fwInstallation_pvssVersionAsFloat (string reqVersion, int &major, int &minor, int &sp) |
int | fwInstallation_getPvssSystemProperties (string systemName, dyn_mixed &pvssSystem) |
void | fwInstallation_throw (string msg, string severity="ERROR", int code=1) |
string | fwInstallation_getAfterInitRestartNeededDpElem () |
string | fwInstallation_getAfterInitRestartRequesterDpElem () |
int | fwInstallation_requestProjectRestartAfterInit (string requester) |
int | fwInstallation_clearProjectRestartAfterInit () |
int | fwInstallation_isProjectRestartAfterInitPending () |
dyn_string | fwInstallation_orderDplFiles (dyn_string files, dyn_int attribs) |
int | fwInstallation_closePanel (bool closeIfConnected=false) |
string | fwInstallation_getHostname (string hostName="") |
string | fwInstallation_getInstallationDp () |
string | fwInstallation_getFileIssuesSyncDpElem () |
bool | fwInstallation_deleteFromConfigFile () |
void | fwInstallation_flagDeprecated (string deprecated, string toBeUsed="") |
string | fwInstallation_findFileForPvssVersion (string baseFileName, dyn_string targetVersions=makeDynString(), bool considerSpLevel=FALSE) |
int | _fwInstallation_getStringFromSystemCommand (string command, string &systemExecResult, bool trim=false) |
int | fwInstallation_getHostMemorySize (string &memSizeInBytes) |
int | fwInstallation_getHostCpuInfo (string &cpuInfo) |
int | fwInstallation_getLinuxInstalledPackages (string grepExpression, string &packages) |
int | fwInstallation_getFMCInstalledPackages (string &packages) |
int | fwInstallation_getWCCOAInstalledPackages (string &packages) |
int | fwInstallation_getHostProperties (string hostname, dyn_mixed &pvssHostInfo) |
int | fwInstallation_sendToTrash (string filename, string trashPath="") |
int | fwInstallation_emptyTrash (string path="") |
int | fwInstallation_moveFile (string source, string target, bool overwriteFile=false) |
bool | fwInstallation_fileCompareBinary (string filename1, string filename2) |
int | fwInstallation_safeFileOverwrite (string source, string destination, string trashPath="", bool compare=true) |
int | fwInstallation_copyFile (string source, string destination, string trashPath="", bool compare=true) |
private int | fwInstallation_copyFile_handleFileOverwriting (string source, string destination, string trashPath="") |
private int | fwInstallation_copyFile_windowsCmd (string source, string target) |
int | fwInstallation_registerProjectPath (string sPath) |
string | fwInstallation_getComponentVersion (string component, int reduHostNum=0) |
bool | fwInstallation_isComponentInstalled (string component, string &version, int reduHostNum=0) |
int | fwInstallation_getComponentSourceDir (string component, string &sourceDir) |
string | fwInstallation_dp2name (string dp) |
void | fwInstallation_setToolStatus (bool status) |
int | fwInstallation_executePostInstallScripts () |
int | fwInstallation_createTrash (string sourceDir) |
int | fwInstallation_getToolVersion (string &version, string systemName="") |
void | fwInstallation_getToolVersionLocal (string &version) |
int | fwInstallation_getToolVersionFromDp (string &version, string systemName="") |
string | fwInstallation_getAgentDp () |
string | fwInstallation_getAgentRequestsDp (int localReduHostNum=0) |
int | fwInstallation_getProjPaths (dyn_string &projPaths, bool adjustScattered=false) |
private int | fwInstallation_getProjPathsRaw (dyn_string &projPathsRaw) |
int | fwInstallation_getPathMappingForScattered (string &nativePathToReplace, string &scatteredPathReplacement) |
string | _fwInstallation_getWCCOAApplicationDpName (string app) |
int | fwInstallation_getWCCOAApplications (dyn_dyn_mixed &wccoaApplications) |
int | fwInstallation_backupProjectConfigFile () |
int | fwInstallation_setProjPaths (dyn_string projPaths) |
int | fwInstallation_isPathInConfigFile (string projPath, bool &isPathInConfig) |
synchronized int | fwInstallation_addProjPath (string projPath, int position) |
synchronized int | fwInstallation_removeProjPath (string projPathToRemove) |
string | fwInstallation_getComponentDp (string componentName, int reduHostNum=0) |
int | fwInstallation_getComponentInfo (string componentName, string componentProperty, dyn_anytype &componentInfo, int reduHostNum=0) |
dyn_string | fwInstallation_getInstalledComponentDps (int reduHostNum=0) |
int | fwInstallation_getInstalledComponents (dyn_dyn_string &componentsInfo, int reduHostNum=0) |
int | fwInstallation_getAvailableComponents (dyn_string componentPaths, dyn_dyn_string &componentsInfo, string component="*", bool scanRecursively=false) |
int | fwInstallation_popup (string popupText, string popupTitle=FW_INSTALLATION_POPUP_TITLE_ERROR) |
string | paGetProjName () |
void | fwInstallation_getApplicationSystem (string applicationName, dyn_string &systemNames) |
string | fwInstallation_getPvssVersion (dyn_string &patches) |
fwInstallation_showHelpFile (string componentName, string systemName="") | |
fwInstallation_showHelpForPanel (string panelFilePath) | |
int | _fwInstallation_getConfigFile (dyn_string &configLines) |
int | fwInstallation_saveFile (dyn_string &configLines, string filename) |
void | _fwInstallation_GetComponentsWithPendingPostInstall (dyn_string &components, dyn_string &scripts) |
void | _fwInstallation_DeleteComponentFromConfig (string componentName) |
dyn_string | _fwInstallation_proposeInstallationDirs () |
int | fwInstallation_getComponentsInfo (string tableName, string sourceWidget, string systemName="", bool scanRecursively=false) |
void | fwInstallation_componentInstalled (string componentName, string requestedComponentVersion, int &result, string systemName="", bool beStrict=false, bool caseSensitive=false, bool compareOnlyVersionNumber=false) |
void | fwInstallation_showFileIssues (string componentName, bool isSubComponent) |
fwInstallation_showMessage (dyn_string message) | |
fwInstallation_evalScriptFile (string componentInitFile, int &iReturn) | |
private | _fwInstallation_CompareVersions_parseVersionParts (string versionString, string &versionNumber, string &preReleaseTag, string &preReleaseNumber) |
private int | _fwInstallation_CompareVersions_compareVersionNumbers (string instCompVersionNumber, string reqCompVersionNumber) |
private int | _fwInstallation_CompareVersions_compareVersionNumberPart (string instCompVersionNumberPart, string reqCompVersionNumberPart) |
private int | _fwInstallation_CompareVersions_parseNumberAndModifierString (string versionNumberPart, string &modifierString) |
private int | _fwInstallation_CompareVersions_compareVersionStrings (string instCompVersionString, string reqCompVersionString) |
int | _fwInstallation_CompareVersions (string installedComponentVersion, string requestedComponentVersion, bool beStrict=false, bool caseSensitive=false, bool compareOnlyVersionNumber=false) |
int | fwInstallation_deleteFiles (const dyn_string &componentFiles, string installationDirectory) |
int | fwInstallation_uninstallBinaryFile (string binaryFilePath) |
void | fwInstallation_writeToMainLog (string message, bool addTimestamp=true) |
private void | fwInstallation_writeToLogFile (string logPath, string message, bool addTimestamp=true) |
string | fwInstallation_timestampString () |
string | _fwInstallation_baseDir (string filePath) |
string | _fwInstallation_fileName (string filePath) |
int | fwInstallation_putComponentsInOrder_Install (dyn_string &componentsNames, dyn_string &componentsVersions, dyn_string &componentFiles, dyn_string &componentFilesInOrder) |
fwInstallation_readComponentRequirements (string descFile, dyn_string &dynRequiredComponents) | |
fwInstallation_readSubcomponents (string descFile, dyn_string &dynSubcomponents) | |
int | fwInstallation_getPmonInfo (string &user, string &pwd) |
int | fwInstallation_forceProjectRestart () |
string | fwInstallation_getComponentPath (string componentFile) |
int | fwInstallation_getRegisterOnly (string destinationDir, string componentName, bool forceOverwriteFiles, bool isSilent) |
private int | fwInstallation_overwriteComponentFilesDialog (string componentName, string installedVersion) |
private int | fwInstallation_acceptComponentInstallationPathChangeDialog (string componentName, string installedVersion) |
int | fwInstallation_installRequiredComponents (string componentName, dyn_string dynRequiredComponents, string sourceDir, bool forceInstallRequired, bool forceOverwriteFiles, bool isSilent, int &requiredInstalled, bool &actionAborted) |
int | fwInstallation_verifyDestinationDirAndSourceFiles (string componentName, string sourceDir, string subPath, string destinationDir, const dyn_string &dynFileNames, const dyn_string &dynBinFiles, bool registerOnly, int isSilent, bool &actionAborted) |
int | fwInstallation_copyComponentFiles (string componentName, string sourceDir, string subPath, string destinationDir, const dyn_string &dynFileNames, bool registerOnly) |
string | fwInstallation_getImportAsciiManagerCommand (string inputFile, dyn_string extraOptions=makeDynString(), string stdoutFile="", string stderrFile="") |
private string | fwInstallation_getPathWithinQuotationMarks (const string &path) |
private bool | fwInstallation_doesPathContainSpace (const string &path) |
private int | fwInstallation_importComponentSingleAsciiFile (string componentName, string dplFilePath, string asciiImportCmd, string logFile, bool updateTypes=true, bool isSilent=true) |
int | fwInstallation_importComponentAsciiFiles (string componentName, string sourceDir, string subPath, dyn_string dynDpListFiles, bool updateTypes=true, bool isSilent=true) |
int | fwInstallation_importConfigFiles (string componentName, string sourceDir, string subPath, dyn_string dynConfigFiles_general, dyn_string dynConfigFiles_linux, dyn_string dynConfigFiles_windows) |
int | fwInstallation_importConfigFilesOfType (string componentName, string sourceDir, string subPath, const dyn_string &dynConfigFiles, string typeLabel) |
int | fwInstallation_copyComponentBinaries (string componentName, string sourceDir, string subPath, string destinationDir, const dyn_string &binaryFiles, dyn_string &componentFileList, bool registerOnly) |
int | fwInstallation_isDirNameMatchingWinccoaVersion (string dirPath, string winccoaVersion=VERSION_DISP) |
int | fwInstallation_executeComponentInitScripts (string componentName, string sourceDir, string subPath, dyn_string dynInitFiles, int isSilent) |
int | fwInstallation_storeComponentPostInstallScripts (const string &component, const dyn_string &dynPostInstallFiles_current) |
int | fwInstallation_createComponentInternalDp (string componentName, string componentVersion, string descFile, int isItSubComponent, string sourceDir, string date, string helpFile, dyn_string qtHelpFiles, string destinationDir, dyn_string dynComponentFiles, dyn_string dynConfigFiles_general, dyn_string dynConfigFiles_linux, dyn_string dynConfigFiles_windows, dyn_string dynInitFiles, dyn_string dynPostInstallFiles, dyn_string dynDeleteFiles, dyn_string dynPostDeleteFiles, dyn_string dynDplistFiles, dyn_string dynRequiredComponents, dyn_string dynSubComponents, dyn_string dynScriptsToBeAdded, int requiredInstalled, dyn_string comments, string description) |
int | fwInstallation_checkComponentBrokenDependencies () |
int | fwInstallation_installComponent (string descFile, string sourceDir, bool isItSubComponent, string &componentName, bool &componentInstalled, string &dontRestartProject, string subPath="", bool forceInstallRequired=false, bool forceOverwriteFiles=false, bool isSilent=false, bool installSubComponents=true) |
int | fwInstallation_setComponentInstallationStatus (string componentName, bool ok) |
fwInstallation_getNotInstalledComponentsFromRequiredComponents (dyn_string &dynRequiredComponents, string &strNotInstalledNames) | |
fwInstallation_AddComponentIntoConfig (string componentConfigFile, string componentName, bool addToReduConfig=false) | |
int | fwInstallation_loadFileLines (string filePath, dyn_string &fileLines) |
void | fwInstallation_deleteComponentConfigEntries (dyn_string &configLines, string componentName) |
int | fwInstallation_parseConfigLine (string configLine, string &key, dyn_string &keyValues) |
void | fwInstallation_parseConfigFileLines (const dyn_string &configLines, dyn_string &configSections, dyn_dyn_string &configKeysArray, dyn_dyn_mixed &configValuesArray) |
bool | fwInstallation_config_entryExistsInMemory (string key, string value, const dyn_string &configKeys, const dyn_mixed &configValues) |
void | fwInstallation_config_addEntryIntoMemory (string key, dyn_string keyValues, dyn_string &configKeys, dyn_mixed &configValues) |
int | fwInstallation_config_setSectionInMemory (string section, dyn_string &configSections, dyn_dyn_string &configKeysArray, dyn_dyn_mixed &configValuesArray) |
bool | fwInstallation_config_isCommentLine (string configLine) |
bool | fwInstallation_config_isSectionDefinition (string configLine) |
string | fwInstallation_config_trimComment (string configLine) |
int | fwInstallation_config_getKeyValue (string configLine, string &key, dyn_string &values) |
string | fwInstallation_config_getConfigEntryParser (string key) |
dyn_string | fwInstallation_config_parse (string valueString) |
dyn_string | fwInstallation_config_parseLoadCtrlLibs (string valueString) |
fwInstallation_mergeComponentConfigIntoProject (dyn_string &projectConfigLines, const dyn_string &componentConfigLines, string componentName) | |
int | fwInstallation_config_getSectionLineNum (const dyn_string &configLines, string sectionName) |
void | fwInstallation_config_insertComponentTag (dyn_string &configLines, int lineNumber, string componentName, string tagTypePattern) |
int | fwInstallation_addLinesIntoSection (dyn_string &configLines, string currentSection, dyn_string linesToAdd) |
int | fwInstallation_changeProjPaths (dyn_string projPaths) |
int | fwInstallation_createPath (string sPath, bool createDirectory=true) |
fwInstallation_getComponentDescriptionPVSSDB (string componentName, int reduHostNum=0) | |
FVR: 29/03/2006. More... | |
fwInstallation_putComponentsInOrder_Delete (dyn_string componentsNames, dyn_string &componentsNamesInOrder) | |
fwInstallation_getListOfDependentComponents (string componentName, dyn_string &dependentComponentsList) | |
fwInstallation_parseRequiredComponentNameVersion (string requiredComponentNameVersion, string &requiredComponentName, string &requiredComponentVersion) | |
int | fwInstallation_deleteComponent (string componentName, bool &componentDeleted, bool deleteAllFiles=TRUE, bool deleteSubComponents=true, bool &deletionAborted) |
int | fwInstallation_storePostDeleteScripts (const dyn_string &dynPostDeleteFiles_current) |
int | fwInstallation_checkDistribution (string sourceDir, const dyn_string &requiredComponents, dyn_string &dsFileComponentName, dyn_string &dsFileVersions, dyn_string &dsFileComponent) |
int | fwInstallation_checkInstalledComponent (string componentName, string version="") |
int | fwInstallation_checkTargetDirectory (string destinationDir, string componentName, string &versionInstalled) |
dyn_string | fwInstallation_getFileNamesRec (string dir=".", string pattern="*") |
fwInstallation_recurserFileNames (string dir, string pattern, dyn_string &fileNames) | |
int | fwInstallation_getDescriptionFile (string componentName, string componentVersion, string sourceDir, string &descriptionFile, bool &isItSubComponent) |
int | fwInstallation_isSubComponent (string xmlFile, bool &isSubComponent) |
int | fwInstallation_getDistPort () |
int | fwInstallation_getReduPort () |
int | fwInstallation_getSplitPort () |
string | fwInstallation_getPmonUser () |
string | fwInstallation_getPmonPwd () |
string | fwInstallation_getPmonHostname () |
int | fwInstallation_getProjectProperties (dyn_mixed &projectInfo) |
int | fwInstallation_createDbInitFile () |
int | fwInstallation_isPmonProtected () |
int | fwInstallation_postInstallToRun (dyn_string &allPostInstallFiles) |
int | fwInstallation_getSections (dyn_string &dsSectionList, string sPattern="") |
int | fwInstallation_getSection (string section, dyn_string &configEntry) |
int | fwInstallation_setSection (string section, dyn_string configEntry) |
int | fwInstallation_clearSection (string section) |
int | fwInstallation_addToSection (string section, dyn_string configEntry) |
void | fwInstallationXml_getComponentDescription (string descFile) |
int | fwInstallation_normalizePath (string &projPath, bool addTrailingSlash=false) |
int | fwInstallation_normalizePathList (dyn_string &projPaths, bool addTrailingSlash=false) |
dyn_string | fwInstallation_splitLines (string s) |
string | fwInstallation_formatPowershellCommandForWinCmd (string powershellCommand) |
string | fwInstallation_getVersionString (string version, string versionTag) |
void | fwInstallation_cleanupObsoleteFiles (string componentName, const dyn_string &obsoleteFiles, bool recursive=false) |
void | fwInstallation_cleanupObsoleteFilesFromPath (string componentName, string path, const dyn_string &obsoleteFiles, bool recursive=false) |
int | fwInstallation_removeEmptyDirectory (string dirPath) |
dyn_string | fwInstallation_getSubdirectories (string dir, string pattern="*") |
int | fwInstallation_trackDependency_register (string triggeringComponent, string requiredComponent) |
void | fwInstallation_trackDependency_unregister (string triggeringComponent) |
fwInstallation_trackDependency_clear () | |
bool | fwInstallation_trackDependency_isCircular (string triggeringComponent, string requiredComponent) |
private bool | fwInstallation_trackDependency_findCircularRecursively (string triggeringComponent, string requiredComponent, dyn_string &recursiveChain) |
string | _fwInstallation_getDevicesDpPattern (string deviceType, string &devicesDpt) |
string | fwInstallation_getDeviceNameFromDp (string deviceDp, string deviceType) |
string | fwInstallation_getAdditionalPlcInfo (string plcDp) |
int | fwInstallation_getDevices (string deviceType, string application, dyn_dyn_mixed &devices) |
private int | fwInstallation_ui_getInstalledComponentsInfo (dyn_dyn_mixed &installedComponentsToDisplay, bool &componentsIncorrectlyInstalled, bool &componentsBrokenDependencies, int reduHostNum) |
private void | fwInstallation_ui_getInstalledComponentsInfoRecursively (dyn_dyn_mixed &installedComponentsToDisplay, string componentDp, string parentComponent, int &index, dyn_string &pendingSubcomponents, bool &componentsIncorrectlyInstalled, bool &componentsBrokenDependencies, int reduHostNum) |
private void | fwInstallation_ui_updateInstalledComponentsStatusInfo (shape fileIssueLabelShape, shape fileIssueArrowShape, bool componentsIncorrectlyInstalled, bool componentsBrokenDependencies) |
synchronized void | fwInstallation_ui_displayInstalledComponents (shape tableShape, shape fileIssueLabelShape, shape fileIssueArrowShape, bool subcomponentsVisible, int reduHostNum=0) |
private int | fwInstallation_ui_getAvailableComponentsInfo (dyn_dyn_anytype &availableComponentsToDisplay, string sourceDirectory, bool scanRecursively=false, string systemName="") |
void | fwInstallation_ui_displayAvailableComponents (shape tableShape, string sourceDir, bool scanRecursively, bool subcomponentsVisible, bool hiddenComponentsVisible, string systemName="") |
void | fwInstallation_ui_filterComponentsTable (shape tableShape, bool subcomponentsVisible, bool hiddenComponentsVisible) |
fwInstallation_ui_getMarkedComponentsData (shape tableShape, const dyn_string &markLabels, const dyn_string &columnsToGet, dyn_dyn_mixed &componentsInfo) | |
dyn_mixed | fwInstallation_ui_getColumnsInRow (shape tableShape, int row, const dyn_string &columnsToGet) |
fwInstallation_ui_componentsTableRightClickPopupMenu (shape tableShape, int row, string column) | |
private void | fwInstallation_ui_copyComponentsListToClipboard (shape tableShape) |
string | fwInstallation_ui_getTableColumnsAsString (shape tableShape, dyn_string columns, bool addHeader=true, string colSeparator="\t", bool onlyVisible=true) |
void | fwInstallation_ui_setTableAlternatingRowColors (shape table) |
void | fwInstallation_ui_openReleaseNotes () |
void | fwInstallation_reportInit (shape sh) |
void | fwInstallation_reportTeardown () |
private | fwInstallation_reportSetReportShape (shape sh) |
shape | fwInstallation_reportGetReportShape () |
bool | fwInstallation_reportReportShapeExists () |
private void | fwInstallation_updateReport (string messageType, anytype value) |
fwInstallation_reportInstallationStartTime () | |
fwInstallation_reportSetTotalComponentsNumber (int componentsNumber) | |
fwInstallation_reportUpdateTotalComponentsNumber (int additionalComponentsNumber) | |
fwInstallation_reportComponentInstallationProgress (string componentName, int stage) | |
fwInstallation_reportComponentInstallationFinished (string componentName) | |
fwInstallation_reportInstallationMessage (errClass message) | |
Variables | |
const string | csFwInstallationToolVersion = "8.4.1" |
const string | csFwInstallationToolTag = "" |
const string | csFwInstallationLibVersion = "8.4.1" |
const string | FW_INSTALLATION_SUPPORT_ADDRESS = "icecontrols.support@cern.ch" |
EN-ICE support line: | |
const string | gFwInstallationComponentName = "fwInstallation" |
const string | gFwInstallationConfigFile = "fwInstallation.config" |
const string | gFwInstallationInitFile = "fwInstallationInit.config" |
const int | gFwInstallationError = -1 |
const int | gFwInstallationOK = 0 |
bool | gFwInstallationErrorShown = FALSE |
bool | gFwYesToAll = FALSE |
string | fwInstallation_VERSION_KEYWORD = "%VERSION%" |
const string | gFwTrashPath = PROJ_PATH + "/fwTrash/" |
const string | FW_INSTALLATION_RELEASE_NOTES = "fwInstallation/fwInstallationReleaseNotes.txt" |
const string | FW_INSTALLATION_LOG_FILE = "fwInstallation.log" |
const string | FW_INSTALLATION_REPORT_VARIABLE_INSTALATION_INFO_COMPONENT = "componentName" |
const string | FW_INSTALLATION_REPORT_MESSAGE_INSTALLATION_STARTED = "installationStarted" |
const int | FW_INSTALLATION_REPORT_STEP_STARTING_INSTALLATION = 1 |
fwInstallation.ctl: Definition of variables | |
The following variables are used by the fwInstallationManager.ctl library | |
dyn_bool | gButtonsEnabled |
string | gUserName |
string | gPassword |
string | gDebugFlag |
int | gSelectedMan |
int | gManShifted |
bool | gRefreshManagerList |
int | gRefreshSec |
int | gRefreshMilli |
int | gRefreshTime |
string | gTcpHostName |
int | gTcpPortNumber |
int | gTcpFileDescriptor |
int | gTcpFileDescriptor2 |
string | gTcpFifo |
string | gTestVariable |
bool | gShowLicenseWarning |
int | gErrorCounter |
bool | gCloseEnabled |
dyn_string | gParams |
global string | gFwInstallationPmonUser = "N/A" |
global string | gFwInstallationPmonPwd = "N/A" |
global dyn_dyn_string | gFwInstallationLog |
global string | gFwInstallationLogPost |
mapping | gFwInstallationTrackDependency |
global string | gFwInstallationCurrentComponent |
global int | gInstallationAgentUiNum |
This package contains general functions of the FW Component Installation tool
int fwInstallation_getComponentFilesForHashCalculation | ( | string | component, |
dyn_string & | componentFiles | ||
) |
Gets the list of component files for which hash calclulation should be done. It retreives list of all component files from internal component dp and filters out files for which hash calculation should not be performed.
component | (in) Component name, when subcomponent then must be provided without leading underscore |
componentFiles | (out) List of component files for which hash calculation should be done |
int fwInstallation_calculateComponentSourceFilesHashes | ( | string | component | ) |
This function calculates and stores sources files hashes. It gets list of component files, calculates their hashes and write them to a component installation dp: fwInstallation[componentName].sourceFilesHashes Data is stored as a list of formatted strings. Single string contains information about particular file, it has the following pattern: [baseHashValue]|[alternativeHashValue]|[relativePathToComponentFile].
component | (in) Component name, when subcomponent then must be provided without leading underscore |
int fwInstallation_storeComponentSourceFilesHashes | ( | string | component, |
dyn_string | fileNames, | ||
dyn_string | baseFileHashes, | ||
dyn_string | alternativeFileHashes | ||
) |
Store list of component files and list of corresponding hash values for given component in the component dp.
component | (in) Component name, when subcomponent then must be provided without leading underscore |
fileNames | (in) List of relative paths of component files for which the hash was calculated |
baseFileHashes | (in) List of base hash values of component files |
alternativeFileHashes | (in) List of alternative hash values of component files |
string fwInstallation_formatComponentSourceFileHashString | ( | string | fileName, |
string | baseFileHash, | ||
string | alternativeFileHash = "" |
||
) |
This function formats string that contains information about particular component file, its hash value and hash comparison status
fileName | (in) Relative path to a component file |
baseFileHash | (in) Base hash value for component file (should be the one calculated for file in component source directory) |
alternativeFileHash | (in) Alternative hash value for component file, when empty (default) then baseFileHash is used here |
int fwInstallation_getComponentSourceFilesHashes | ( | string | component, |
dyn_string & | fileNames, | ||
dyn_string & | baseFileHashes, | ||
dyn_string & | alternativeFileHashes | ||
) |
Retrieves list of component files and list of corresponding hash values for given component.
component | (in) Component name, when subcomponent then must be provided without leading underscore |
fileNames | (out) List of relative paths of component files for which the hash was calculated |
baseFileHashes | (out) List of base hash values of component files |
alternativeFileHashes | (out) List of alternative hash values of component files |
int fwInstallation_setAlternativeComponentFileHash | ( | string | component, |
string | fileName, | ||
string | directory = "" |
||
) |
This function allows to set alternative hash value for file. It can be used to hide 'hash mismatch' file issues for given file.
component | (in) Component name, when subcomponent then must be provided without leading underscore |
fileName | (in) Relative path to a component file |
directory | (in) Flag that indicates if hash comparison should be enabled (true - default) or disabled |
int fwInstallation_resetAlternativeComponentFileHash | ( | string | component, |
string | fileName | ||
) |
This function resets alternative hash value for given file (set alternative hash same as base hash)
component | (in) Component name, when subcomponent then must be provided without leading underscore |
fileName | (in) Relative path to a component file |
int fwInstallation_getComponentFilesWithAlternativeHash | ( | string | component, |
dyn_string & | filesWithAlternativeHash | ||
) |
This function retrieves list of files that have set alternative hash value different than base hash value
component | (in) Component name, when subcomponent then must be provided without leading underscore |
filesWithAlternativeHash | (out) List of files that have set alternative hash value different than base hash value |
int fwInstallation_getProjectFileIssues | ( | dyn_dyn_mixed & | fileIssues | ) |
Gets all the file issues for the project
fileIssues | (out) array of all file issues |
int fwInstallation_getComponentFilesIssues | ( | string | component, |
dyn_mapping & | errorFiles, | ||
bool | getOverparameterized = true , |
||
bool | getHash = true , |
||
bool | getHashCompNotPossible = true , |
||
bool | useAlternativeHash = true |
||
) |
Gets all the file issues for a particular component in the project
component | (in) Name of the component, when subcomponent then must be provided without leading underscore |
errorFiles | (out) Array of all file issues. Each file issue is represented by a mapping with following fields: 'name' (absolute path to a file), 'error' (file issue type), 'size' (file size), 'time' (file modification time) |
getOverparameterized | (in) Indicates whether the method should include the overparameterized files in the result, default value is true |
getHash | (in) Indicates whether the method should include the files with hash issue in the result, default value is true |
getHashCompNotPossible | (in) Indicates whether the method should include the files for which hash comparasion is not possible in the result, default value is true |
useAlternativeHash | (in) Indicates whether file hash should be compared to the alternative hash value (true - default) or base hash value (false) |
int fwInstallation_installComponentSet | ( | dyn_string | componentFiles, |
string & | dontRestartProject | ||
) |
fwInstallation_installComponentSet installs a set of components in the local project.
componentNames | (in) array of string containing the names of the components to be installed. |
dontRestartProject | (out) overall flag that specifies if project restart can be skipped at the end of the installation, "yes" means the project restart can be skipped and the post-installation scripts are launched. |
end of components intallation
int fwInstallation_deleteComponentSet | ( | dyn_string | dynComponentsNames, |
bool | deleteFiles | ||
) |
fwInstallation_deleteComponentSet removes a set of components in the local project.
dynComponentsNames | (in) Array of string containing the names of the components to be removed. |
deleteFiles | (in) Indicates whether component files should be removed from the installation directory. |
int fwInstallation_stopManagersForInstallation | ( | ) |
This function stops managers for the period of installation of components.
int fwInstallation_parseHostPortConfigEntry | ( | string | configHostEntry, |
dyn_dyn_string & | hostAliases, | ||
dyn_dyn_int & | ports | ||
) |
This function parses the config entries that contains host name and port ('data', 'event', part of 'distPeer' within quotes). For redundant systems and in case of redundant connections it returns all host aliases and ports. Example entries: "host1[:port1]" "host1[:port1]$host2[:port2]" // redundant system "host1-1[:port1],host1-2[:port1]" // redundant network connections "host1-1[:port1],host1-2[:port1]$host2-1[:port2],host2-2[:port2]" // redundant system with redundant network connection
configHostEntry | (in) Config file entry as given in the above examples |
hostAliases | (out) Array of parsed hostnames/aliases |
ports | (out) List of corresponding ports, when port is not specified in config entry then it has value 0 |
void _fwInstallation_parseDistPeer | ( | string | distPeer, |
string & | host, | ||
string & | reduHost, | ||
string & | port | ||
) |
This function parses the distPeer entry in order to retrieve the host and the distPort.
distPeer | (in) distPeer entry, as found in the config file |
host | (out) |
reduHost | (out) |
distPort | (out) |
int fwInstallation_deleteProjectPaths | ( | dyn_string | paths | ) |
This function removes the given project paths from the config file.
(in) | paths array of strings that contains the project paths to be removed from the config file. |
int fwInstallation_addProjectPaths | ( | dyn_string | dbPaths | ) |
This function adds the given project paths to the config file.
(in) | dbPaths array of strings that contains the project paths to be added to the config file. |
dyn_string fwInstallation_getHostPvssVersions | ( | ) |
This function returns the list of all installed WinCC OA versions on current machine.
private dyn_string fwInstallation_getPvssVersionsFromWinRegKey | ( | string | key | ) |
This function returns the WinCC OA versions that are under given Windows registry key
key | (in) Windows registry key |
string fwInstallation_getWinRegKey | ( | string | key | ) |
This function returns the next tier of subkeys of the specified key in the Windows registry.
key | (in) registry key that will be queried |
dyn_string fwInstallation_getComponentPendingPostInstalls | ( | string | component, |
int | reduHostNum = 0 |
||
) |
This function returns the list of pending postInstall scripts of the given component.
component | (in) Name of the component. |
reduHostNum | (in) Local host redu number, default value (0) indicates that the number will be obtained automatically. |
dyn_string fwInstallation_getProjectPendingPostInstalls | ( | int | reduHostNum = 0 | ) |
This function returns the list of pending postInstall scripts in the project.
reduHostNum | (in) Local host redu number, default value (0) indicates that the number will be obtained automatically. |
void fwInstallation_resetLog | ( | ) |
This function clears the global array of stings that contains fwInstallation log messages.
string fwInstallation_getWCCOAExecutable | ( | string | type | ) |
This function returns the name of WinCC OA manager executable file. Consider removing support for PVSS version older than 3.11 (PVSS00)
type | (in) Type of manager (UI, CTRL, dist, etc., case insensitive) |
void fwInstallation_appendLog | ( | string | msg, |
string | severity | ||
) |
This function append a new log message to the fwInstallation log. Logs are appended to the global array of logs and, if there is a connection, stored in the DB
msg | (in) Log message |
severity | (in) Severity of the message |
bool fwInstallation_isPatchInstalled | ( | string | patch | ) |
This function deploys the crashAction script for the restart of the DB-Agent of the Installation Tool when it gets blocked
filename | name of the crash action script as expected by PMON, including the full path |
fw_installation_filename | name of the crash action script delievered with this version of the Installation Tool, including the full name |
filename | name of the file containing the crash action script |
patch | patch name |
int fwInstallation_checkPvssVersion | ( | string | reqVersion | ) |
Check if the PVSS version is equal or newer than the required PVSS version passed as argument
reqVersion | required PVSS version |
int fwInstallation_checkToolVersion | ( | string | reqVersion | ) |
Checks if the version of the FW Component Installation Tool is equal or newer than the required PVSS version passed as argument
reqVersion | required version of the FW Component Installation Tool |
float fwInstallation_pvssVersionAsFloat | ( | string | reqVersion, |
int & | major, | ||
int & | minor, | ||
int & | sp | ||
) |
Converts a PVSS version from string to float for easy comparison
reqVersion | - (in) name of the pvss version |
major | - (out) number corresponding to the major version of the release |
minor | - (out) number corresponding to the minor version of the release |
sp | - (out) number corresponding to the Service Pack of the release |
int fwInstallation_getPvssSystemProperties | ( | string | systemName, |
dyn_mixed & | pvssSystem | ||
) |
Gets the properties of a particular PVSS system as a dyn_mixed
systemName | - (in) name of the pvss system |
pvssSystem | - (out) properties of the system |
void fwInstallation_throw | ( | string | msg, |
string | severity = "ERROR" , |
||
int | code = 1 |
||
) |
Throws a PVSS error in the log
msg | - error message |
severity | - severity of the message: "ERROR", "WARNING", "INFO" |
code | - code of the error message in the fwInstallation catalog |
string fwInstallation_getAfterInitRestartNeededDpElem | ( | ) |
Return data point for value indicating if restart is needed before running post install scripts.
string fwInstallation_getAfterInitRestartRequesterDpElem | ( | ) |
Return data point for value containing component that requested project restart. Data point contains only the last component requesting the restart.
int fwInstallation_requestProjectRestartAfterInit | ( | string | requester | ) |
Request project restart after component installation, but before running postInstall scripts.
This function will set requester to a datapoint which later be used to issue a project request.
requester | (string) IN component requesting project restart. |
int fwInstallation_clearProjectRestartAfterInit | ( | ) |
Clear data point that will cause project restart after init scripts (before post install scripts).
int fwInstallation_isProjectRestartAfterInitPending | ( | ) |
Return if project should be restarted after init scripts were executed.
dyn_string fwInstallation_orderDplFiles | ( | dyn_string | files, |
dyn_int | attribs | ||
) |
Order the dpl files of a component according to the attributes defined in the XML file
files | - (in) files to the ordered as a dyn_string |
attribs | - (int) XML attributes for the files ordered as the 'files' argument |
int fwInstallation_closePanel | ( | bool | closeIfConnected = false | ) |
This functions is to be called from the close event of a panel. It checks whether the connection with the event manager is established or not. If the connection is down, the function will call exit() to close the actual panel. If the connection is to the event manager is still up, the calling code can decide whether the panel must closed or not. This is done through the argument closeIfConnected. Typically the argument will be set to false in the cases where the developer wants to prevent that the user closes the panel by clicking on the top-right 'x' of the window.
closeIfConnected,: | (boolean) Defines whether the current panel has to be close if the connection to the event manager is still up. The default value is false (i.e. the function will not close the panel) |
string fwInstallation_getHostname | ( | string | hostName = "" | ) |
Retrieves the name of a host without network domain
hostName | name of the host to parse; when empty - the local host |
string fwInstallation_getInstallationDp | ( | ) |
Gets the name of the internal datapoint of the Installation Tool
string fwInstallation_getFileIssuesSyncDpElem | ( | ) |
Get file issues sychronization enable/disable data point element.
bool fwInstallation_deleteFromConfigFile | ( | ) |
Returns wether the DB-agent must delete or not from the project config file during synchronization with the System Configuration DB
void fwInstallation_flagDeprecated | ( | string | deprecated, |
string | toBeUsed = "" |
||
) |
Function used to flag deprecated functions in the library
deprecated | name of the deprecated function |
toBeUsed | name of the function to be used instaed. If an empty argument is passed, a different message will be shown, telling that the user must report its usage. |
string fwInstallation_findFileForPvssVersion | ( | string | baseFileName, |
dyn_string | targetVersions = makeDynString() , |
||
bool | considerSpLevel = FALSE |
||
) |
Function during the installation of the components to resolve the right name for a file depending on the current PVSS version
baseFileName | (in) base name of the file |
targetVersions | (in) name of the target PVSS version |
considerSpLevel | (in) argument that defines whether the Service Pack level has to be also taken into account |
int _fwInstallation_getStringFromSystemCommand | ( | string | command, |
string & | systemExecResult, | ||
bool | trim = false |
||
) |
Execute command and read the output.
command | (in) System command to execute |
systemExecResult | (out) Contains output from command execution. |
trim | (in) Flag that indicates if the leading and trailing whitespaces should be removed from output (by default no). |
int fwInstallation_getHostMemorySize | ( | string & | memSizeInBytes | ) |
Return memory size in bytes.
memSizeInBytes | - return value, memory size in bytes. |
int fwInstallation_getHostCpuInfo | ( | string & | cpuInfo | ) |
Return CPU information.
cpuInfo | - return CPU information, ex. "". |
int fwInstallation_getLinuxInstalledPackages | ( | string | grepExpression, |
string & | packages | ||
) |
Returns packages installed on an RPM based Linux system. Note that an argument (grepExpression) is passed to filter out interesting packages out of all installed packages, filter is case insensitive.
grepExpression | grep expression to filter out packages. |
packages | output string receiving comma separated list of packages. |
int fwInstallation_getFMCInstalledPackages | ( | string & | packages | ) |
Get list of installed FMC.
packages | variable to receive comma separated list of FMC packages. |
int fwInstallation_getWCCOAInstalledPackages | ( | string & | packages | ) |
Get list of installed WinCC OA packages (also inclused PVSS packages).
packages | variable to recieve comma separated list of WinCC OA/PVSS packages. |
int fwInstallation_getHostProperties | ( | string | hostname, |
dyn_mixed & | pvssHostInfo | ||
) |
Function to retrieve host properties as a dyn_mixed array
hostname | (int) name of the host |
pvssHostInfo | (out) host properties |
int fwInstallation_sendToTrash | ( | string | filename, |
string | trashPath = "" |
||
) |
Function to move files into the trash
filename | (in) name of the file to be moved |
trashPath | (in) path to the trash. Empty path means use the default path |
int fwInstallation_emptyTrash | ( | string | path = "" | ) |
Empty the trash of the FW Component Installation Tool
path | (in) path to the trash. Empty path means use the default path |
int fwInstallation_moveFile | ( | string | source, |
string | target, | ||
bool | overwriteFile = false |
||
) |
Moves file/directory to the target directory. This is a wrapper of WinCC OA moveFile() function that allows also to overwrite existing file while moving.
source | (in) Path to file or a directory to be moved |
target | (in) Target directory or target path |
overwriteFile | (in) Indicates whether moved file can overwrite the one that exists in target path, by default false |
bool fwInstallation_fileCompareBinary | ( | string | filename1, |
string | filename2 | ||
) |
Function to make a binary comparison of two files. Contribution from TOTEM.
filename1 | (in) name of the first file for comparison |
filename2 | (in) name of the second file for comparison |
int fwInstallation_safeFileOverwrite | ( | string | source, |
string | destination, | ||
string | trashPath = "" , |
||
bool | compare = true |
||
) |
This function unlinks a file under Linux and then overwrites it.
source | (in) name of the file to be copied |
destination | (in) target file name including full path |
trashPath | (in) path to trash |
compare | (in) argument used to compare files before copying. If files are identical the file is not re-copied. |
int fwInstallation_copyFile | ( | string | source, |
string | destination, | ||
string | trashPath = "" , |
||
bool | compare = true |
||
) |
Function to copy files. If blind copy fails (e.g. an executable is in used) and file exists already in target path, then it tries to perform additional actions in order to successfully copy file.
source | (in) name of the file to be copied |
destination | (in) target file name including full path |
trashPath | (in) path to trash (when not specify, then default one is used (PROJ_PATH/fwTrash/)) |
compare | (in) argument used to compare files before copying. If files are identical the file is not re-copied. |
private int fwInstallation_copyFile_handleFileOverwriting | ( | string | source, |
string | destination, | ||
string | trashPath = "" |
||
) |
Function to be called from fwInstallation_copyFile(). Provides functionality to handle cases, when overwriting file in target directory failed at first attempt. It either tries to overwrite file using native system copy function or move the file from target path to project trash directory.
source | (in) Path to file to be copied |
destination | (in) Target path for file |
trashPath | (in) path to trash |
private int fwInstallation_copyFile_windowsCmd | ( | string | source, |
string | target | ||
) |
This function copies the file from the source to target path using Windows 'copy' command. To be used only in Windows and to copy files (not directories).
source | (in) Path to file to be copied |
target | (in) Target path for file |
int fwInstallation_registerProjectPath | ( | string | sPath | ) |
This function registers a PVSS project path
sPath,: | (in) path to be registered as string |
string fwInstallation_getComponentVersion | ( | string | component, |
int | reduHostNum = 0 |
||
) |
This function retrieves the version of an installed component
component | (in) name of the component |
bool fwInstallation_isComponentInstalled | ( | string | component, |
string & | version, | ||
int | reduHostNum = 0 |
||
) |
This function checks if a component is installed in the current project. Returns true if component is installed and its version is succesfully retrieved. If component is not installed or retrieving component version failed, "version" is set to empty.
component | (in) Name of the component |
version | (out) Current version of the installed component |
reduHostNum | (in) |
int fwInstallation_getComponentSourceDir | ( | string | component, |
string & | sourceDir | ||
) |
This function retrieves the source directory from which a component was installed
component | (in) name of the component |
sourceDir | (out) source directory |
string fwInstallation_dp2name | ( | string | dp | ) |
This function returns the name of a component correspoding to an internal dp of the installation tool
dp | (in) name of the dp of the installation tool |
void fwInstallation_setToolStatus | ( | bool | status | ) |
Sets the status of the installation tool
status | true if OK, false if error |
int fwInstallation_executePostInstallScripts | ( | ) |
This function lauches the pending post-installation of scripts of installed components (if any)
int fwInstallation_createTrash | ( | string | sourceDir | ) |
This function creates the trash for the installation tool
sourceDir | (in) path where to create the trash as string |
int fwInstallation_getToolVersion | ( | string & | version, |
string | systemName = "" |
||
) |
This function retrieves the current version of the installation tool used in a particular PVSS system.
version | (out) version of the tool |
systemName | (int) name the pvss system where to read the installation tool version from |
void fwInstallation_getToolVersionLocal | ( | string & | version | ) |
Retrieves the current version of installation tool in the local project.
version | (out) Version of the tool (format: X.X.X[-tag[-tagId]]) Example: 8.2.0 (stable release, tag is empty), 8.3.0-SNAPSHOT-20181015090802, 9.0.0-beta-02 |
int fwInstallation_getToolVersionFromDp | ( | string & | version, |
string | systemName = "" |
||
) |
Retrieves the current version of installation tool used in given WinCC OA system from internal installation tool datapoint.
version | (out) Version of the tool (format: X.X.X[-tag[-tagId]]) Example: 8.2.0 (stable release, tag is empty), 8.3.0-SNAPSHOT-20181015090802, 9.0.0-beta-02 |
systemName | (in) Name of WinCC OA system where to read installation tool version from. Local system when empty (default) |
string fwInstallation_getAgentDp | ( | ) |
This function retrieves name of the internal dp holding the parameterization of the DB-agent
string fwInstallation_getAgentRequestsDp | ( | int | localReduHostNum = 0 | ) |
This function retrieves name of the internal dp holding the pending installation requests to be executed by the DB-Agent
int fwInstallation_getProjPaths | ( | dyn_string & | projPaths, |
bool | adjustScattered = false |
||
) |
The function reads all project paths from the config file, normalizes them and adds to a dyn_string list. Project paths have the same order as in the config file.
projPaths | (out) dyn_string which will be filled with the project paths from the config file |
adjustScattered | (in) Flag that indicates if projPaths should be adjusted when it is a scattered project (default = false) |
private int fwInstallation_getProjPathsRaw | ( | dyn_string & | projPathsRaw | ) |
The function reads all project paths from the config file into a dyn_string list. Paths are exactly as in config file.
projPaths | (out) dyn_string which will be filled with the project paths from the config file |
int fwInstallation_getPathMappingForScattered | ( | string & | nativePathToReplace, |
string & | scatteredPathReplacement | ||
) |
When running a scattered project, function returns the part of the project path that should be replaced and the replacement to be put instead in order to create a valid path to the project directories from scattered project. Use case: Accessing component installation directory when running on Scattered project. Example: When path of the main project is: /opt/user/PVSS_projects/mainProject/mainProject and path to the main project from scattered project is: //scatteredProjectHost/PVSS_projects/mainProject/mainProject then /opt/user/ should be replaced by //scatteredProjectHost/ whenever main project directories needs to be accessed from Scattered.
nativePathToReplace | (out) Part of the project path (as it is in original config file) that should be replaced. |
scatteredPathReplacement | (out) Part of the path that should be put instead the original one (remote path to the project from Scattered). |
string _fwInstallation_getWCCOAApplicationDpName | ( | string | app | ) |
Helper function to convert data point name (remove blank spaces, etc.).
app | (string) IN WCCOA application name to convert (may contain blanks, etc.) |
int fwInstallation_getWCCOAApplications | ( | dyn_dyn_mixed & | wccoaApplications | ) |
Retrieve existing WinCC OA (UNICOS) applications on this system
wccoaApplications | variable to receive info about currently installed WinCC OA applications. |
: Currently only 'Default_Panel' field is filled. 'Info_URL', 'Comment_text', 'Status', 'Responsible' and 'Alarm_Overview_Panel' are missed.
int fwInstallation_backupProjectConfigFile | ( | ) |
This function backs up the project config file. It is intendended to be called before component installation/uninstallation
int fwInstallation_setProjPaths | ( | dyn_string | projPaths | ) |
This functions writes all project paths given in a dyn_string to the config file and overwrites existing paths exept the main project path.
projPaths,: | dyn_string with the project paths for the config file |
int fwInstallation_isPathInConfigFile | ( | string | projPath, |
bool & | isPathInConfig | ||
) |
This function checks if given path exists in config file
projPath,: | Project path (in) |
isPathInConfig,: |
synchronized int fwInstallation_addProjPath | ( | string | projPath, |
int | position | ||
) |
This function add a project path to the config file.
projPath,: | string that contains the project path to be added to the config file |
position,: | position of the added path in the list (n = specified position, try 999 for last before main project path) |
synchronized int fwInstallation_removeProjPath | ( | string | projPathToRemove | ) |
This function removes the given project path from the config file.
projPath,: | string that contains the project path to be removed from the config file |
string fwInstallation_getComponentDp | ( | string | componentName, |
int | reduHostNum = 0 |
||
) |
This function retrieves name of the internal dp associated with an installed component.
componentName | name of the component |
reduHostNum | number of redundant host |
int fwInstallation_getComponentInfo | ( | string | componentName, |
string | componentProperty, | ||
dyn_anytype & | componentInfo, | ||
int | reduHostNum = 0 |
||
) |
This function returns the following property of the installed component: list of files for this component
componentName,: | string with the name of the component |
componentProperty,: | name of the requested property |
componentInfo,: | variable that contains the property of the component |
dyn_string fwInstallation_getInstalledComponentDps | ( | int | reduHostNum = 0 | ) |
This function returns the name of the internal dps correspoding to all components installed in the local project. In redundant system peer number can be specified.
reduHostNum | (in) Redu peer number (1 or 2), if 0 (default) then local peer number is used. Note that in non-redu system local peer is always 1. |
int fwInstallation_getInstalledComponents | ( | dyn_dyn_string & | componentsInfo, |
int | reduHostNum = 0 |
||
) |
This function gets the information about all installed components into a dyn_dyn_string structure: [n][1] component name [n][2] component version [n][3] path to the installation
[n][4] description file
componentsInfo,: | dyn_dyn_string that will contain all installed components and their respective version numbers |
int fwInstallation_getAvailableComponents | ( | dyn_string | componentPaths, |
dyn_dyn_string & | componentsInfo, | ||
string | component = "*" , |
||
bool | scanRecursively = false |
||
) |
This function gets the information about all available components in the specified paths into a dyn_dyn_string structure: - component name - component version - subcomponent [yes/no] - path to the description file
componentPaths | (in) dyn_string with the paths to description files |
componentsInfo | (out) dyn_dyn_string that will contain all installed components and their respective version numbers and their paths |
component | (in) component pattern |
scanRecursively | (in) flag indicating if the search must recurse over subdirectories |
int fwInstallation_popup | ( | string | popupText, |
string | popupTitle = FW_INSTALLATION_POPUP_TITLE_ERROR |
||
) |
This function opens a timed out popup with title and test provided as parameter.
popupText | text to be shown in popup window |
popupTitle | title of the popup window, the default one is "Installation Error". It is possible to use predefined titles: FW_INSTALLATION_POPUP_TITLE_ERROR - "Installation Error" FW_INSTALLATION_POPUP_TITLE_INFORMATION - "Information" FW_INSTALLATION_POPUP_TITLE_WARNING - "Warning" |
string paGetProjName | ( | ) |
This function returns the project name
void fwInstallation_getApplicationSystem | ( | string | applicationName, |
dyn_string & | systemNames | ||
) |
This function retrieves the system name(s) on which a certain
"application" = component is installed.
applicationName | name of the application/component to be found |
systemNames | name(s) of the system(s) with the application/component installed |
string fwInstallation_getPvssVersion | ( | dyn_string & | patches | ) |
This function retrieves the PVSS version number as well as the installed patches
patches | (out) dyn_string array with all installed patches |
fwInstallation_showHelpFile | ( | string | componentName, |
string | systemName = "" |
||
) |
This function shows the help file associated to a component
componentName | (in) name of the component in the database |
systemName | (in) name of the system where to look for the component |
fwInstallation_showHelpForPanel | ( | string | panelFilePath | ) |
This function shows the help file for fwInstallation panels.
panelFilePath | (in) Relative path to a panel file from panels/ directory |
int _fwInstallation_getConfigFile | ( | dyn_string & | configLines | ) |
This function gets all entries from the config file into string structures
configLines,: | dyn_string containing the lines from the config file |
int fwInstallation_saveFile | ( | dyn_string & | configLines, |
string | filename | ||
) |
this function saves the dyn_string into PVSS project confg file
configLines,: | the dyn_string containing the lines from the file |
filename,: | the name of a file |
void _fwInstallation_GetComponentsWithPendingPostInstall | ( | dyn_string & | components, |
dyn_string & | scripts | ||
) |
This function returns the list of pending pending post-install scripts and their components
components | (out) list of components corresponding to the scripts |
scripts | (out) list of pending post-install scripts |
void _fwInstallation_DeleteComponentFromConfig | ( | string | componentName | ) |
This function deletes the information for the component from the project config file.
componentName,: | the name of a component |
dyn_string _fwInstallation_proposeInstallationDirs | ( | ) |
This function returns proposals of the component installation directory. List contains paths from config file appearing in reverse order excluding main project path or if there are no such paths in config file then a set of default locations.
int fwInstallation_getComponentsInfo | ( | string | tableName, |
string | sourceWidget, | ||
string | systemName = "" , |
||
bool | scanRecursively = false |
||
) |
This function gets the components data from the directory specified in the textBox and fills the graphic table with it.
tableName | (in) the name of a graphic table to be filled with data |
sourceWidget | (in) the name of a widget containing the directory from which the data about the components is taken |
systemName | (in) name of the pvss system where to look for components |
scanRecursively | (in) flag indicating if the search must recurse over subdirectories |
TODO: check if it is always the same as subcomponent as ds array is not cleared
void fwInstallation_componentInstalled | ( | string | componentName, |
string | requestedComponentVersion, | ||
int & | result, | ||
string | systemName = "" , |
||
bool | beStrict = false , |
||
bool | caseSensitive = false , |
||
bool | compareOnlyVersionNumber = false |
||
) |
This function checks if the component is installed in version equal or higher than requested.
componentName | (in) The name of a component to be checked |
requestedComponentVersion | (in) Requested version of the component |
result | (out) Returned value indicating if component in requested version is installed (1) or not (0) |
systemName | (in) System where to check if the component is installed |
beStrict | (in) Flag to indicate an exact match of the versions installed and required |
caseSensitive | (in) Indicates if comparison of alphabetical characters should be case-sensitive (by default false) |
compareOnlyVersionNumber | (in) If true then only version number are compared (pre-release tag and number are not taken into account) (by default false) Note: if beStrict and compareOnlyVersionNumber are both true then comparison results is 1 when version numbers are identical |
void fwInstallation_showFileIssues | ( | string | componentName, |
bool | isSubComponent | ||
) |
Displays information about component file issues in installed components table. Note: UI function. Requires that the table shape "tblInstalledComponents" exists in a panel.
componentName | (in) Name of the component |
isSubComponent | (in) Flag that indicates if component is a subcomponent |
fwInstallation_showMessage | ( | dyn_string | message | ) |
this functions outputs the message into the log textarea of a panel
message,: | the message to be displayed |
fwInstallation_evalScriptFile | ( | string | componentInitFile, |
int & | iReturn | ||
) |
This function executes a script from the component .init file
componentInitFile,: | the .init file with the functions to be executed |
iReturn,: | -1 if error calling the script, otherwise, it returns the error code of the user script |
|
private |
Parse parts of componet version sequence ([versionNumber]-[preReleaseTag]-[preReleaseNumber]). All parts are optional, however, if present, they must appear in the presented order. Any characters after third '-' delimiter are discarded. Used in version comparison (_fwInstallation_CompareVersions())
versionString | (in) String containing component version sequence. |
versionNumber | (out) Main version number (first part of component version sequence) |
preReleaseTag | (out) Pre-release tag (second part of component version sequence) |
preReleaseNumber | (out) Pre-release number (third part of component version sequence) |
|
private |
Compares given parts of version strings as sequence of version number strings ([major].[minor].[...]...). Version number strings can contain non-numerical character. Used in version comparison (_fwInstallation_CompareVersions())
instCompVersionNumber | (in) Part of version string of installed component |
reqCompVersionNumber | (in) Part of version string of requested component |
|
private |
Compares given strings containing particular number (string) eg. [major] from the sequence of version numbers strings ([major].[minor].[...]...) Used in version comparison (_fwInstallation_CompareVersions_compareVersionNumbers())
instCompVersionNumberPart | (in) Single number from the sequence of version numbers of installed component version |
reqCompVersionNumberPart | (in) Single number from the sequence of version numbers of required component version, must be on the same position in the sequence of version numbers as instCompVersionNumberPart |
|
private |
Parses number (integer value) and modifier string (string of alphanumeric characters that appears after the integer value) from given part of version numbers string sequence. Used in version comparison (_fwInstallation_CompareVersions_compareVersionNumberPart())
versionNumberPart | (in) Part of the sequence of version numbers strings ([major].[minor].[...]...) |
modifierString | (out) Modifier string for the retrieved numeric value. |
|
private |
This function compares two version strings as a string of characters. Higher string is the one with character with higher ASCII code on the first position that differs in both string. If one string is longer than the other and the common parts are equal then the longer string is higher. An exception is a situation when one string is empty - then it is considered to be higher as string version should be used to indicate pre-release versions. Used in version comparison (_fwInstallation_CompareVersions_compareVersionNumberPart(), _fwInstallation_CompareVersions())
instCompVersionString | (in) Part of installed component version identifier that should be compared as a string |
reqCompVersionString | (in) Part of requested component version identifier corresponding to the same part of instCompVersionString |
int _fwInstallation_CompareVersions | ( | string | installedComponentVersion, |
string | requestedComponentVersion, | ||
bool | beStrict = false , |
||
bool | caseSensitive = false , |
||
bool | compareOnlyVersionNumber = false |
||
) |
This function compares two component versions. The following version format is supported: [versionNumber]-[preReleaseTag]-preReleaseNumber. preReleaseTag and preReleaseNumber are not mandatory and they are used for indicating the pre-release version of component (eg. beta).
installedComponentVersion | (in) Version name as string of the installed component |
requestedComponentVersion | (in) Required component version |
beStrict | (in) If set to true, the comparison will required that both component versions as identical |
caseSensitive | (in) Indicates if comparison of alphabetical characters should be case-sensitive (by default false) |
compareOnlyVersionNumber | (in) If true then only version number are compared (pre-release tag and number are not taken into account) (by default false) Note: if beStrict and compareOnlyVersionNumber are both true then comparison results in 1 when version numbers are identical |
int fwInstallation_deleteFiles | ( | const dyn_string & | componentFiles, |
string | installationDirectory | ||
) |
this function deletes the component files
componentFiles,: | the dyn_string with the names of the files to be deleted |
installationDirectory,: | the name of the installation directory |
int fwInstallation_uninstallBinaryFile | ( | string | binaryFilePath | ) |
Uninstalls binary file. On Linux it does the unlink. On Windows it attempts to remove file and if it fails then tries to move file to the project trash directory.
binaryFilePath | (in) Absolute path to the binary file. |
void fwInstallation_writeToMainLog | ( | string | message, |
bool | addTimestamp = true |
||
) |
This function writes to the main log
message | (in) Message to be written in the main log |
addTimestamp | (in) Flag that indicates if timestamp should be prepended to the message (default = true) |
private void fwInstallation_writeToLogFile | ( | string | logPath, |
string | message, | ||
bool | addTimestamp = true |
||
) |
Writes log message to given file.
logPath | (in) Path to the log file |
message | (in) Message to be written in the given log file |
addTimestamp | (in) Flag that indicates if timestamp should be prepended to the message (default = true) |
string fwInstallation_timestampString | ( | ) |
Returns current time in timestamp format.
string _fwInstallation_baseDir | ( | string | filePath | ) |
This function retrieves the path from a full filename
filePath | (in) full file name (basedir + filename) |
string _fwInstallation_fileName | ( | string | filePath | ) |
This function retrieves the name of a file from the full path to the file
filePath | (in) full file name (basedir + filename) |
int fwInstallation_putComponentsInOrder_Install | ( | dyn_string & | componentsNames, |
dyn_string & | componentsVersions, | ||
dyn_string & | componentFiles, | ||
dyn_string & | componentFilesInOrder | ||
) |
This function puts the components to be installed in order in which they should be installed
The algorithm is similar to that used during deleting the components (see fwInstallation_putComponentsInOrder_Delete() function btn_ApplyDelete())
componentsNames,: | the names of the components to be installed |
componentsVersions,: | the versions of components to be installed |
componentFiles,: | the file names with the description of the components |
componentFilesInOrder,: | the file names with the description of the components |
fwInstallation_readComponentRequirements | ( | string | descFile, |
dyn_string & | dynRequiredComponents | ||
) |
This function reads the requirements from the component description file
descFile | (in) the file with the description of a component |
dynRequiredComponents | (out) the dyn_string of requiredComponents |
fwInstallation_readSubcomponents | ( | string | descFile, |
dyn_string & | dynSubcomponents | ||
) |
This function reads the sub components from the component description file
descFile | (in) the file with the description of a component |
dynSubcomponents | (out) the dyn_string of the subcomponents |
int fwInstallation_getPmonInfo | ( | string & | user, |
string & | pwd | ||
) |
This function resolves the Pmon Information (i.e. user name and password)
user | (out) user |
pwd | (out) password |
int fwInstallation_forceProjectRestart | ( | ) |
This function forces the restart of the whole project
string fwInstallation_getComponentPath | ( | string | componentFile | ) |
This function resolves the source path from the component description file
componentFile | (out) full path to the XML file of the component |
int fwInstallation_getRegisterOnly | ( | string | destinationDir, |
string | componentName, | ||
bool | forceOverwriteFiles, | ||
bool | isSilent | ||
) |
This function retrieves whether the component can be registered only or if all component files have to be copied during installation
destinationDir | (in) target directory for installation. Note that a previous installtion of the component may exist in there. |
componentName | (in) name of the component being installed |
forceOverwriteFiles | (in) flag to force overwriting of existing files |
isSilent | (in) flag to specify if the installation is silent (no windows will be pop up even during interactive installation) |
private int fwInstallation_overwriteComponentFilesDialog | ( | string | componentName, |
string | installedVersion | ||
) |
Asks user in a dialog window whether to overwrite existing component files in a destination directory and returns its choice.
componentName | (in) Name of the component being installed |
installedVersion | (in) Version of component that currently exists in destination directory |
private int fwInstallation_acceptComponentInstallationPathChangeDialog | ( | string | componentName, |
string | installedVersion | ||
) |
Asks user in a dialog window whether to install component in a different directory, than the one, where previous version of this component was installed.
componentName | (in) Name of the component being installed |
installedVersion | (in) Version of component currently installed 1 when user selected to proceed with installation in a different directory, -1 when user decided to abort component installation. |
int fwInstallation_installRequiredComponents | ( | string | componentName, |
dyn_string | dynRequiredComponents, | ||
string | sourceDir, | ||
bool | forceInstallRequired, | ||
bool | forceOverwriteFiles, | ||
bool | isSilent, | ||
int & | requiredInstalled, | ||
bool & | actionAborted | ||
) |
This function forces all required components to be installed prior to the installation of a given component if available in the distribution
componentName | (in) name of the component being installed |
dynRequiredComponents | (in) array of required components |
sourceDir | (in) source directory for installation |
forceInstallRequired | (in) flag to force installation of required components |
forceOverwriteFiles | (in) flag to force all existing files to be overwritten |
isSilent | (in) flag to define if the installation is silent, i.e. no pop-ups |
requiredInstalled | (out) returned argument indicating if the required components have been successfully installed or not |
actionAborted | (out) flag that indicates if the action was aborted by the user |
int fwInstallation_verifyDestinationDirAndSourceFiles | ( | string | componentName, |
string | sourceDir, | ||
string | subPath, | ||
string | destinationDir, | ||
const dyn_string & | dynFileNames, | ||
const dyn_string & | dynBinFiles, | ||
bool | registerOnly, | ||
int | isSilent, | ||
bool & | actionAborted | ||
) |
This function verifies if destination (installation) directory is writeable and if files in the component package are accessible.
componentName | (in) name of the component being installed |
sourceDir | (in) source directory for installation |
subPath | (in) path to be appended to the sourceDir |
destinationDir | (in) target directory for installation |
dynFileNames | (in) component files |
dynBinFiles | (in) component binary files |
registerOnly | (in) flag indicating whether file copying can be avoided or not if the files already exist |
isSilent | (in) flag to define if the installation is silent, i.e. no pop-ups |
actionAborted | (out) flag that indicates if the action was aborted by the user |
int fwInstallation_copyComponentFiles | ( | string | componentName, |
string | sourceDir, | ||
string | subPath, | ||
string | destinationDir, | ||
const dyn_string & | dynFileNames, | ||
bool | registerOnly | ||
) |
This function copies all component files
componentName | (in) name of the component being installed |
sourceDir | (in) source directory for installation |
subPath | (in) path to be appended to the sourceDir |
destinationDir | (in) target directory for installation |
dynFileNames | (in) component files |
registerOnly | (in) flag indicating whether file copying can be avoided or not if the files already exist |
string fwInstallation_getImportAsciiManagerCommand | ( | string | inputFile, |
dyn_string | extraOptions = makeDynString() , |
||
string | stdoutFile = "" , |
||
string | stderrFile = "" |
||
) |
Returns the shell command to execute the WCCOAascii manager to import given dpl file.
inputFile | (in) Path to the input dpl file |
extraOptions | (in) List of additional WCCOAascii manager command line options (default - empty) |
stdoutFile | (in) Path to the file where to redirect standard output stream. If empty (default) then stdout is not redirected to the file. |
stderrFile | (in) Path to the file where to redirect standard error stream. If empty (default) then stderr is not redirected to the file. |
private string fwInstallation_getPathWithinQuotationMarks | ( | const string & | path | ) |
Returns the given path with qoutation marks added at the beggining and end.
path | (in) Path |
private bool fwInstallation_doesPathContainSpace | ( | const string & | path | ) |
Checks if given path contains space character.
path | (in) Path to be checked |
private int fwInstallation_importComponentSingleAsciiFile | ( | string | componentName, |
string | dplFilePath, | ||
string | asciiImportCmd, | ||
string | logFile, | ||
bool | updateTypes = true , |
||
bool | isSilent = true |
||
) |
Performs ASCII import of a component single dpl file.
componentName | (in) Name of the component |
dplFilePath | (in) Path to the dpl file to import |
asciiImportCmd | (in) Command to call ASCII manager, it must have embedded "%s" format specifier to be replaced by dplFilePath |
logFile | (in) Path the the stderr log file |
updateTypes | (in) flag to indicate if existing types have to be updated (true - default) or not |
isSilent | (in) Flag to indicate if installation is performed in silent mode (true - default) or in interactive mode |
int fwInstallation_importComponentAsciiFiles | ( | string | componentName, |
string | sourceDir, | ||
string | subPath, | ||
dyn_string | dynDpListFiles, | ||
bool | updateTypes = true , |
||
bool | isSilent = true |
||
) |
This function imports the dpl files of a component
componentName | (in) name of the component being installed |
sourceDir | (in) source directory for installation |
subPath | (in) path to be appended to the sourceDir |
dynDplistFiles | (in) list of dpl files to be imported |
updateTypes | (in) flag to indicate if existing types have to be updated (true - default) or not |
isSilent | (in) Flag to indicate if installation is performed in silent mode (true - default) or in interactive mode |
int fwInstallation_importConfigFiles | ( | string | componentName, |
string | sourceDir, | ||
string | subPath, | ||
dyn_string | dynConfigFiles_general, | ||
dyn_string | dynConfigFiles_linux, | ||
dyn_string | dynConfigFiles_windows | ||
) |
This function imports the config files of a component.
componentName | (in) name of the component being installed |
sourceDir | (in) source directory for installation |
subPath | (in) path to be appended to the sourceDir |
dynConfigFiles_general | (in) list of config files to be imported |
dynConfigFiles_linux | (in) list of config files to be imported (linux only) |
dynConfigFiles_windows | (in) list of config files to be imported (windows only) |
int fwInstallation_importConfigFilesOfType | ( | string | componentName, |
string | sourceDir, | ||
string | subPath, | ||
const dyn_string & | dynConfigFiles, | ||
string | typeLabel | ||
) |
This function imports the component config files of particular given type.
componentName | (in) name of the component being installed |
sourceDir | (in) source directory for installation |
subPath | (in) path to be appended to the sourceDir |
dynConfigFiles | (in) list of config files to be imported |
typeLabel | (in) Config files type label ["windows", "linux", "general"] to be displayed |
int fwInstallation_copyComponentBinaries | ( | string | componentName, |
string | sourceDir, | ||
string | subPath, | ||
string | destinationDir, | ||
const dyn_string & | binaryFiles, | ||
dyn_string & | componentFileList, | ||
bool | registerOnly | ||
) |
This function copies component binary files and appends their location in the installation directory to the list of component files. It copies the binaries from source directory to the bin/ directory in component installation path. Only binaries for current WinCC OA version and not-versioned binaries are copied. Binary is versioned if is placed in the directory named as WinCC OA version (e.g. 3.15/)
componentName | (in) Name of the component |
sourceDir | (in) Component source directory |
subPath | (in) Path to be appended to the sourceDir |
destinationDir | (in) Component installation directory |
binaryFiles | (in) List of binary files to be copied (relative paths to sourceDir + subPath) |
componentFileList | (in/out) List of all component files to be updated with copied binaries |
registerOnly | (in) flag indicating whether file copying can be avoided or not if the files already exist |
int fwInstallation_isDirNameMatchingWinccoaVersion | ( | string | dirPath, |
string | winccoaVersion = VERSION_DISP |
||
) |
This function checks if directory name, in the given directory path, matches pattern of a WinCC OA version and if it is equal to given version.
dirPath | (in) Path to the directory |
winccoaVersion | (in) WinCC OA version as a string, default: current WinCC OA version |
int fwInstallation_executeComponentInitScripts | ( | string | componentName, |
string | sourceDir, | ||
string | subPath, | ||
dyn_string | dynInitFiles, | ||
int | isSilent | ||
) |
This function executes the component init scripts
componentName | (in) name of the component being installed |
sourceDir | (in) source directory for installation |
subPath | (in) path to be appended to the sourceDir |
dynInitFiles | (in) list of init files to be executed |
isSilent | (in) flag to define if the installation is silent, i.e. no pop-ups |
int fwInstallation_storeComponentPostInstallScripts | ( | const string & | component, |
const dyn_string & | dynPostInstallFiles_current | ||
) |
This function stores in the component internal dp of the installation tool the list of post install scripts to be run with names of the components from which they came in following format "<component>|<postInstallScript>"
component | (in) components corresponding to post-install scripts |
dynPostInstallFiles_current | (in) list of post-install files to be stored |
int fwInstallation_createComponentInternalDp | ( | string | componentName, |
string | componentVersion, | ||
string | descFile, | ||
int | isItSubComponent, | ||
string | sourceDir, | ||
string | date, | ||
string | helpFile, | ||
dyn_string | qtHelpFiles, | ||
string | destinationDir, | ||
dyn_string | dynComponentFiles, | ||
dyn_string | dynConfigFiles_general, | ||
dyn_string | dynConfigFiles_linux, | ||
dyn_string | dynConfigFiles_windows, | ||
dyn_string | dynInitFiles, | ||
dyn_string | dynPostInstallFiles, | ||
dyn_string | dynDeleteFiles, | ||
dyn_string | dynPostDeleteFiles, | ||
dyn_string | dynDplistFiles, | ||
dyn_string | dynRequiredComponents, | ||
dyn_string | dynSubComponents, | ||
dyn_string | dynScriptsToBeAdded, | ||
int | requiredInstalled, | ||
dyn_string | comments, | ||
string | description | ||
) |
This function creates the internal dp for the installed component
componentName | (in) name of the component being installed |
componentVersion | (in) component version |
descFile | (in) component description file |
isItSubComponent | (in) component description file |
sourceDir | (in) source directory for installation |
date | (in) source directory for installation |
helpFile | (in) source directory for installation |
qtHelpFiles | (in) list of relative paths to component QCH files |
destinationDir | (in) source directory for installation |
dynComponentFiles | (in) source directory for installation |
dynConfigFiles_general | (in) list of dpl files to be imported |
dynConfigFiles_linux | (in) list of dpl files to be imported (linux only) |
dynConfigFiles_windows | (in) list of dpl files to be imported (windows only) |
dynInitFiles | (in) list of init scripts |
dynPostInstallFiles | (in) list of post install scritps |
dynDeleteFiles | (in) list of delete scripts |
dynPostDeleteFiles | (in) list of post-delete scripts |
dynDplistFiles | (in) list of dpl files |
dynRequiredComponents | (in) list of required components |
dynSubComponents | (in) list of subcomponents |
dynScriptsToBeAdded | (in) list of scritps |
requiredInstalled | (in) flag to indicated if the required component were installed |
comments | (in) component comments |
description | (in) component description |
int fwInstallation_checkComponentBrokenDependencies | ( | ) |
This function checks if there is any dependency broken among the installed components and sets the values of the internal dps accordingly
int fwInstallation_installComponent | ( | string | descFile, |
string | sourceDir, | ||
bool | isItSubComponent, | ||
string & | componentName, | ||
bool & | componentInstalled, | ||
string & | dontRestartProject, | ||
string | subPath = "" , |
||
bool | forceInstallRequired = false , |
||
bool | forceOverwriteFiles = false , |
||
bool | isSilent = false , |
||
bool | installSubComponents = true |
||
) |
This function installs the component. It copies the files, imports the component DPs, DPTs, updates the project config file
descFile,: | the file with the description of a component |
sourceDir,: | the root directory with the component files |
isItSubComponent,: | it is false - if it is the master component; it is true if it is the sub component |
componentName,: | it is the return value - the name of the installed component |
componentInstalled,: | set to 1 if the component is properly installed |
dontRestartProject,: | indicates whether the project has to be restarted after installations or not |
subPath,: | path to be appended to the source directory |
forceInstallRequired | this flag indicates whether all required components must be installed provided that they correct versions are found in the distribution. This is a optional parameter. The default value is false to keep the tool backwards compatible. Note that the value of this parameter is set to the default value (TRUE) when a silent installation is chosen. |
forceOverwriteFiles | this flag indicates whether the files of the component must be overwritten if a previous installation of the component is detected in the target directory This is a optional parameter. The default value is false to keep the tool backwards compatible. Note that the value of this parameter is set to the default value (FALSE) when a silent installation is chosen. |
isSilent | flag indicating whether we are dealing with a silent installation of the packages or not. The default value is false. |
installSubComponents | flag indicating whether subcomponents have to also be installed |
int fwInstallation_setComponentInstallationStatus | ( | string | componentName, |
bool | ok | ||
) |
This function sets the internal dpes of the component dp according to the status of the installation
componentName | component name |
ok | status of installation |
fwInstallation_getNotInstalledComponentsFromRequiredComponents | ( | dyn_string & | dynRequiredComponents, |
string & | strNotInstalledNames | ||
) |
This function checks if all the required components are installed. It returns a string of components that are not
installed and required.
dynRequiredComponents,: | the name of a componentConfigFile |
strNotInstalledNames,: | the name of a component |
fwInstallation_AddComponentIntoConfig | ( | string | componentConfigFile, |
string | componentName, | ||
bool | addToReduConfig = false |
||
) |
This function reads the component config file and copies its entries to the project config file (if they are not yet there).
componentConfigFile | (in) Path of the component config file |
componentName | (in) Name of the component |
addToReduConfig | (in) Flag that indicates if component entries should be added to the project redu config file (by default false) |
int fwInstallation_loadFileLines | ( | string | filePath, |
dyn_string & | fileLines | ||
) |
Reads the given file and loads it into memory as a list of lines.
filePath | (in) Path of the file to be read |
fileLines | (out) List of the file lines |
void fwInstallation_deleteComponentConfigEntries | ( | dyn_string & | configLines, |
string | componentName | ||
) |
Removes all lines containing component parametrization from the list of config lines.
configLines | (in/out) List of the config lines |
componentName | (in) Name of the component |
int fwInstallation_parseConfigLine | ( | string | configLine, |
string & | key, | ||
dyn_string & | keyValues | ||
) |
Parses key-values pair from config file line.
configLine | (in) Config file line |
key | (out) Config entry key/section name/comment |
keyValues | (out) List of config entry values |
void fwInstallation_parseConfigFileLines | ( | const dyn_string & | configLines, |
dyn_string & | configSections, | ||
dyn_dyn_string & | configKeysArray, | ||
dyn_dyn_mixed & | configValuesArray | ||
) |
Parses config lines into memory representation: list of sections ([section]), array of keys ([section][key]), array of values ([section][key][value]).
configLines | (in) List of config file lines |
configSections | (out) List of config sections ([section]) |
configKeysArray | (out) Array of config entry keys ([section][key]) |
configValuesArray | (out) Array of config entry keys values ([section][key][value]) |
bool fwInstallation_config_entryExistsInMemory | ( | string | key, |
string | value, | ||
const dyn_string & | configKeys, | ||
const dyn_mixed & | configValues | ||
) |
Checks if config entry (key-value pair) exists in memory representation of the particular section of config file
key | (in) Key to be searched |
value | (in) Value of given key to be searched |
configKeys | (in/out) List of config keys (of particular section) |
configValues | (in/out) Array of config values ([key][value]) (of particular section) |
void fwInstallation_config_addEntryIntoMemory | ( | string | key, |
dyn_string | keyValues, | ||
dyn_string & | configKeys, | ||
dyn_mixed & | configValues | ||
) |
Adds config entry (key-values pair) into memory representation of the particular section of config file.
key | (in) Key to be added |
keyValues | (in) Values to be added under given key |
configKeys | (in/out) List of config keys (of particular section) |
configValues | (in/out) Array of config values ([key][value]) (of particular section) |
int fwInstallation_config_setSectionInMemory | ( | string | section, |
dyn_string & | configSections, | ||
dyn_dyn_string & | configKeysArray, | ||
dyn_dyn_mixed & | configValuesArray | ||
) |
Retrieves ID of the section in the memory representation of config file. If section is not yet there, appends it and initializes corresponding indexes in configKeysArray and configValuesArray.
section | (in) Name of the section |
configSections | (in/out) List of the sections in config file ([section]) |
configKeysArray | (in/out) Array of config entry keys ([section][key]) |
configValuesArray | (in/out) Array of config entry keys values ([section][key][value]) |
bool fwInstallation_config_isCommentLine | ( | string | configLine | ) |
Checks if the config line is a line that contains only comment (starts with '#' symbol).
configLine | (in) Single line of a config file |
bool fwInstallation_config_isSectionDefinition | ( | string | configLine | ) |
Checks if the config line is a line that defines a config file section (e.g. [ui], [general])
configLine | (in) Single line of a config file |
string fwInstallation_config_trimComment | ( | string | configLine | ) |
Returns the config line with any comments removed. : Currently it doesn't take into account that '#' might occur inside quotes "[...]" and then should not be treated as a character that starts comment. Now this function is used only for section definition lines where quotes are not used.
configLine | (in) Single line of a config file |
int fwInstallation_config_getKeyValue | ( | string | configLine, |
string & | key, | ||
dyn_string & | values | ||
) |
Parses key-values pair in a config line.
configLine | (in) Single line of a config file |
key | (out) Config key |
values | (out) The values of a config key |
string fwInstallation_config_getConfigEntryParser | ( | string | key | ) |
Returns the name of the function that should be used to parse config entry with specific key. It is possible to define custom parser functions for specific config keys. Name of such function must have the following pattern: fwInstallation_config_parse[key](). For example: fwInstallation_config_parseLoadCtrlLibs() for LoadCtrlLibs config key. If custom function for the config key is not defined then default parser function is returned: fwInstallation_config_parse()
key | (in) Config entry key |
dyn_string fwInstallation_config_parse | ( | string | valueString | ) |
Default parser function, returns the provided value as a one-element list, without any further processing.
valueString | (in) Config key string value |
dyn_string fwInstallation_config_parseLoadCtrlLibs | ( | string | valueString | ) |
Parser function for LoadCtrlLibs entries. Splits provided string into a list of library files.
valueString | (in) LoadCtrlLibs key value (string contains library files delimited with comma) List of ctrl library files |
fwInstallation_mergeComponentConfigIntoProject | ( | dyn_string & | projectConfigLines, |
const dyn_string & | componentConfigLines, | ||
string | componentName | ||
) |
Adds component config lines into project config lines if not yet there.
projectConfigLines | (in/out) Project config lines |
componentConfigLines | (in) Component config lines |
componentName | (in) Name of the component |
int fwInstallation_config_getSectionLineNum | ( | const dyn_string & | configLines, |
string | sectionName | ||
) |
Returns the config line number where the given section is defined.
configLines | (in) List of the config lines |
sectionName | (in) Name of the section to look for |
0 | when section was not found in the config file, otherwise number of the line where section is defined (>0) |
void fwInstallation_config_insertComponentTag | ( | dyn_string & | configLines, |
int | lineNumber, | ||
string | componentName, | ||
string | tagTypePattern | ||
) |
This function inserts the component tag into the config lines (information where the component parametrization starts/ends).
configLines | (in/out) Config file lines |
lineNumber | (in) Line number where the tag should be inserted |
componentName | (in) Name of the component |
tagTypePattern | (in) Pattern with the config component tag, only FW_INSTALLATION_CONFIG_COMPONENT_TAG_BEGIN_PATTERN or FW_INSTALLATION_CONFIG_COMPONENT_TAG_END_PATTERN should be used |
int fwInstallation_addLinesIntoSection | ( | dyn_string & | configLines, |
string | currentSection, | ||
dyn_string | linesToAdd | ||
) |
This function adds the lines from linesToAdd into the configLines under the section specified by currentSection
configLines,: | the dyn_string with file lines |
currentSection,: | the name of a currentSection |
linesToAdd,: | the lines to be added |
int fwInstallation_changeProjPaths | ( | dyn_string | projPaths | ) |
This function saves the new order of project paths into the config file.
Provided list of paths must contain all paths that were previously in config file. If PROJ_PATH is not at the last position in the list (or is missing) it will be automatically moved/added at the end of the provided list.
projPaths | (in) List of project paths in choosen order |
int fwInstallation_createPath | ( | string | sPath, |
bool | createDirectory = true |
||
) |
This function creates a project path, either creates the directory or just adds the path
sPath,: | project path to be created |
createDirectory | flag to indicate if the directory has to be created if it does not exist (default value is true) |
fwInstallation_getComponentDescriptionPVSSDB | ( | string | componentName, |
int | reduHostNum = 0 |
||
) |
FVR: 29/03/2006.
This function retrieves the component information from the PVSS DB and displays it in the panel
componentName | the name of a file with component description |
fwInstallation_putComponentsInOrder_Delete | ( | dyn_string | componentsNames, |
dyn_string & | componentsNamesInOrder | ||
) |
This function puts the components to be deleted in order in which they should be deleted
The function only checks if the component chosen for deleting depend on each other. The function operates on the component information contained in the PVSS DB
algorithm: suppose we have the following components to delete: com1, com2, com3 the dependencies are following: com1: is required by com2 com2: is required by com3 com3: is nor required by them We can first delete the com3 because it is not required by com1 i com3 the dependencies are following: com1: is required by com2 com2: is not required by any component If there is a loop: com1 is required by com2 and com2 is required by com1 the components can not be ordered
componentsNames,: | the dyn_string of the components to be put in order before deleting |
componentsNamesInOrder,: | the dyn_string of the ordered components to be deleted |
fwInstallation_getListOfDependentComponents | ( | string | componentName, |
dyn_string & | dependentComponentsList | ||
) |
This function gets the list of dependent components. This functions from the list of all installed components
retrieves the list of components that require strComponentName
componentName,: | the name of the component for which we would like to find dependent components |
dependentComponentsList,: | the dyn_string of components that require the strComponentName component |
fwInstallation_parseRequiredComponentNameVersion | ( | string | requiredComponentNameVersion, |
string & | requiredComponentName, | ||
string & | requiredComponentVersion | ||
) |
Parses required component name and version from requirement string
requiredComponentNameVersion | (in) Requirement string with component name and minimal required version separated with '=' (eg. fwComponent=8.0.0) |
requiredComponentName | (out) Parsed required component name |
requiredComponentVersion | (out) Parsed required version, empty if requirement string contains only component name |
int fwInstallation_deleteComponent | ( | string | componentName, |
bool & | componentDeleted, | ||
bool | deleteAllFiles = TRUE , |
||
bool | deleteSubComponents = true , |
||
bool & | deletionAborted | ||
) |
this function deletes the component files, the component information from the config file and the internal DP created by the installation tool with the description of a component. This function does not delete the component data point types ( ETM is planning to add the functionality of deleting the DPT, DP from the ASCII Manager ).
componentName | (in) the name of a component to be deleted |
componentDeleted | (out) result of the operation |
deleteAllFiles | (in) flag indicating if the components files must also be deleted. Default value is true. |
deleteSubComponents | flag indicating if the subcomponent must also be deleted. Default value is true. |
int fwInstallation_storePostDeleteScripts | ( | const dyn_string & | dynPostDeleteFiles_current | ) |
This function stores in the component internal dp of the installation tool the list of post delete scripts to be run
dynPostDeleteFiles_current | (in) list of post-delete files to be stored |
int fwInstallation_checkDistribution | ( | string | sourceDir, |
const dyn_string & | requiredComponents, | ||
dyn_string & | dsFileComponentName, | ||
dyn_string & | dsFileVersions, | ||
dyn_string & | dsFileComponent | ||
) |
This function resolves the XML files and versions of the components required for installation during the installation of a particular component
sourceDir | (in) Source directory |
requiredComponents | (in) List of required components, each element must have format <componentName>=<minVersionRequired> |
dsFileComponentName | (out) List of available component names, element from particular index corresponds to the same index in requiredComponents list, when required component is not available in source directory, element contains empty string |
dsFileVersions | (out) List of available component versions, each version correspond to the component on the same index in dsFileComponentName, if component is not available in source directory, version is an empty string |
dsFileComponent | (out) list of available component XML files, each XML path correspond to the component on the same index in dsFileComponentName, when component is not available or in version lower than required, the XML file is an empty string |
int fwInstallation_checkInstalledComponent | ( | string | componentName, |
string | version = "" |
||
) |
This function checks if a given component is correctly installed
componentName,: | Name of the component to be checked |
version,: | Version of the component to be checked. Optional parameter: if emtpy it checks for any version. |
int fwInstallation_checkTargetDirectory | ( | string | destinationDir, |
string | componentName, | ||
string & | versionInstalled | ||
) |
This function checks if a previous installation of a particular directory exists in the target directiory
destinationDir | (in) target directory |
componentName | (in) name of the component to be checked |
versionInstalled | (in) version of the component installed, if any |
dyn_string fwInstallation_getFileNamesRec | ( | string | dir = "." , |
string | pattern = "*" |
||
) |
This function retrieves the files in a directory recursing over sub-directories
dir | (in) directory where to look for files |
pattern | (in) search pattern |
fwInstallation_recurserFileNames | ( | string | dir, |
string | pattern, | ||
dyn_string & | fileNames | ||
) |
Helper function used by fwInstallation_getFileNamesRec
dir | (in) directory where to look for files |
pattern | (in) search pattern |
fileNames | (out) names of the files found |
int fwInstallation_getDescriptionFile | ( | string | componentName, |
string | componentVersion, | ||
string | sourceDir, | ||
string & | descriptionFile, | ||
bool & | isItSubComponent | ||
) |
This function retrieves the full path to the XML description file of a component
componentName | (in) name of the component |
componentVersion | (in) version of the component (legacy, not used) |
sourceDir | (in) source directory |
descriptionFile | (out) XML description file |
isItSubComponent | (out) indicates if it is a subcomponent or not |
int fwInstallation_isSubComponent | ( | string | xmlFile, |
bool & | isSubComponent | ||
) |
This function parses the xml file of a coponent to find out if it is a sub-component
xmlFile | (in) XML file name |
isSubComponent | (out) indicates if it is a subcomponent or not |
int fwInstallation_getDistPort | ( | ) |
This function returns the port used by the distribution manager of the local project
int fwInstallation_getReduPort | ( | ) |
This function returns the redundancy port of the local project
int fwInstallation_getSplitPort | ( | ) |
This function returns the split port of the local project
string fwInstallation_getPmonUser | ( | ) |
This function returns the pmon user (not yet implemented)
string fwInstallation_getPmonPwd | ( | ) |
This function returns the pmon pwd (not yet implemented)
string fwInstallation_getPmonHostname | ( | ) |
This function returns hostname 'localhost'
int fwInstallation_getProjectProperties | ( | dyn_mixed & | projectInfo | ) |
This function returns the properties of the local project as a dyn_mixed array
projectInfo | (in) Project properties |
int fwInstallation_createDbInitFile | ( | ) |
Saves DB connection configuration stored in internal dp to fwInstallationInit.config file.
int fwInstallation_isPmonProtected | ( | ) |
This function checks if pmon is protected with a username and a pwd
int fwInstallation_postInstallToRun | ( | dyn_string & | allPostInstallFiles | ) |
This function returns post install files that are scheduled to run
allPostInstallFiles,: | dyn_string to contain the list of post install files |
int fwInstallation_getSections | ( | dyn_string & | dsSectionList, |
string | sPattern = "" |
||
) |
This function gets list of sections in config file into a dyn_string
dsSectionList | (out) dyn_string that will contain names of the all configs' sections |
sPattern | (in) string to define the pattern |
int fwInstallation_getSection | ( | string | section, |
dyn_string & | configEntry | ||
) |
This function gets a specified section into a dyn_string
section,: | string to define the section |
configEntry,: | dyn_string that will contain the lines for the section |
int fwInstallation_setSection | ( | string | section, |
dyn_string | configEntry | ||
) |
This function sets a specified section from a dyn_string
section,: | string to define the section to where the data has to written |
configEntry,: | dyn_string that contains the lines for the section |
int fwInstallation_clearSection | ( | string | section | ) |
This function will delete all entries of the specified section as well as all but the first header.
section,: | string to define the section which will be cleared (first header will stay) |
int fwInstallation_addToSection | ( | string | section, |
dyn_string | configEntry | ||
) |
This function adds the given lines to a section in the config file.
section,: | string to define the section where the data has to be added (will be created if not existing) |
configEntry,: | dyn_string containing the lines to be added |
void fwInstallationXml_getComponentDescription | ( | string | descFile | ) |
This function retrieves the component information from the xml file and displays it in the panel
descFile,: | the name of a file with component description |
int fwInstallation_normalizePath | ( | string & | projPath, |
bool | addTrailingSlash = false |
||
) |
This function normalises the path. After execution of the function the given argument is normalised - all backslashes in path are replaced with slashes. Note: Leading "./" is removed from path.
projPath,: | Project path (in/out) |
int fwInstallation_normalizePathList | ( | dyn_string & | projPaths, |
bool | addTrailingSlash = false |
||
) |
Normalize list of paths. Replaces all backslashes with slashes.
projPaths | - list of project paths |
dyn_string fwInstallation_splitLines | ( | string | s | ) |
Returns a list of lines in given string, breaking at line boundaries. New line characters (LF or CR+LF) are removed and don't occur in the returned list. If string contains n new line characters then the returned list has size n+1. However if the last new line character is also the last character of the string then last empty substring is ignored and returned list has size n.
s | (in) String to be splitted. |
string fwInstallation_formatPowershellCommandForWinCmd | ( | string | powershellCommand | ) |
Returns a given Powershell command, formatted to be run from Windows Command Prompt (in system() function call)
powershellCommand | (in) PowerShell command |
string fwInstallation_getVersionString | ( | string | version, |
string | versionTag | ||
) |
Returns the version string from given version and tag.
version | (in) Version (pattern: X.X.X) |
versionTag | (in) Tag (eg. "beta-01", "SNAPSHOT-201810140930", "") |
void fwInstallation_cleanupObsoleteFiles | ( | string | componentName, |
const dyn_string & | obsoleteFiles, | ||
bool | recursive = false |
||
) |
This function removes given files or folders from the installation directory of specified component. It is intended for performing cleanup of component obsolete files in component installation script (init [recommended] or post-install). If component is not installed, function returns immediately. If file does not exist already, it is skipped.
componentName | (in) Name of the component |
obsoleteFiles | (in) List of files or folders to be removed (relative paths from component installation directory); note that folder-removal is not recursive unless 'recursive' parameter is set to true |
recursive | (in) Remove folders recursively if set to true; default=false |
void fwInstallation_cleanupObsoleteFilesFromPath | ( | string | componentName, |
string | path, | ||
const dyn_string & | obsoleteFiles, | ||
bool | recursive = false |
||
) |
This function removes given files or folders from the specified path if they exists.
componentName | (in) Name of the component |
path | (in) Common part of the path to obsolete files |
obsoleteFiles | (in) List of files or folders to be removed (relative paths); note that folder-removal is not recursive unless 'recursive' parameter is set to true |
recursive | (in) Remove folders recursively if set to true; default=false |
int fwInstallation_removeEmptyDirectory | ( | string | dirPath | ) |
This function removes specified directory only if it is empty - it does not contain any files nor subfolders.
dirPath | (in) Path to the directory that should be removed. |
dyn_string fwInstallation_getSubdirectories | ( | string | dir, |
string | pattern = "*" |
||
) |
Returns the list of subdirectories in the given directory that match the pattern. The list does not contain current "." and parent ".." directory.
dir | (in) Path to the directory where to look for subdirectories |
pattern | (in) Subdirectory name pattern, when not provided then all subdirectories are returned ("*") |
int fwInstallation_trackDependency_register | ( | string | triggeringComponent, |
string | requiredComponent | ||
) |
Registers components pair (component and its required component) for dependency tracking during components installation. It is registered in global mapping variable gFwInstallationTrackDependency.
triggeringComponent | (in) Component requiring another component to be installed |
requiredComponent | (in) Component that is required |
void fwInstallation_trackDependency_unregister | ( | string | triggeringComponent | ) |
Unregisters component and all its required components from dependency tracking.
triggeringComponent | (in) Component to be unregistered along with its dependencies. |
fwInstallation_trackDependency_clear | ( | ) |
Clears all dependency tracking entries.
bool fwInstallation_trackDependency_isCircular | ( | string | triggeringComponent, |
string | requiredComponent | ||
) |
Checks if given components pair (component and its required component) creates circular dependency chain with already tracked dependencies.
triggeringComponent | (in) Component requiring another component to be installed |
requiredComponent | (in) Component that is required |
private bool fwInstallation_trackDependency_findCircularRecursively | ( | string | triggeringComponent, |
string | requiredComponent, | ||
dyn_string & | recursiveChain | ||
) |
Checks for occurence of circular dependency chain in given components pair and tracked dependencies recursively.
triggeringComponent | (in) Component requiring another component to be installed |
requiredComponent | (in) Component that is required |
recursiveChain | (out) List of components checked recursively |
string _fwInstallation_getDevicesDpPattern | ( | string | deviceType, |
string & | devicesDpt | ||
) |
This functions returns the dp pattern and dp type for given device type.
deviceType | Device type name. |
devicesDpt | (out) Datapoint type of given device type name. |
string fwInstallation_getDeviceNameFromDp | ( | string | deviceDp, |
string | deviceType | ||
) |
This functions gets the device name from device datapoint.
deviceDp | Device datapoint. |
deviceType | Device type name. |
string fwInstallation_getAdditionalPlcInfo | ( | string | plcDp | ) |
This function gets additional PLC info for the Schneider and Siemens PLCs.
plcDp | (in) PLC datapoint |
int fwInstallation_getDevices | ( | string | deviceType, |
string | application, | ||
dyn_dyn_mixed & | devices | ||
) |
Retrieve existing devices of given type in given application on this system.
deviceType | Device type name. |
application | Application name, when it is empty string then all devices will of given type will be retrieved. |
devices | Variable to receive info about devices. |
: Currently only information from 'Comment' field are filled, 'Info_URL' and 'Status' are missed. The 'Moon_Info' will be updated from MOON project.
private int fwInstallation_ui_getInstalledComponentsInfo | ( | dyn_dyn_mixed & | installedComponentsToDisplay, |
bool & | componentsIncorrectlyInstalled, | ||
bool & | componentsBrokenDependencies, | ||
int | reduHostNum | ||
) |
Retrieves information about components installed in the project.
installedComponentsToDisplay | (out) Array of installed components information, note indexing: [information_type][component] |
componentsIncorrectlyInstalled | (out) Flag that indicates if there are components installed incorrectly |
componentsBrokenDependencies | (out) Flag that indicates if there are components with missing dependencies |
reduHostNum | (in) Local host redu number, in non-redundant system it is always 1. |
private void fwInstallation_ui_getInstalledComponentsInfoRecursively | ( | dyn_dyn_mixed & | installedComponentsToDisplay, |
string | componentDp, | ||
string | parentComponent, | ||
int & | index, | ||
dyn_string & | pendingSubcomponents, | ||
bool & | componentsIncorrectlyInstalled, | ||
bool & | componentsBrokenDependencies, | ||
int | reduHostNum | ||
) |
Retrieves information about particular installed component from datapoint. Note: Does recursive call for subcomponents of current component.
installedComponentsToDisplay | (out) Array of installed components information, note indexing: [information_type][component] |
componentDp | (in) Component datapoint name |
parentComponent | (in) Name of the parent component, when empty then component doesn't have a parent |
index | (in/out) Number of elements in installedComponentsToDisplay array |
pendingSubcomponents | (out) List of subcomponents that could not be added as their parent is not in the array. |
componentsIncorrectlyInstalled | (out) Flag that indicates if there are components installed incorrectly |
componentsBrokenDependencies | (out) Flag that indicates if there are components with missing dependencies |
reduHostNum | (in) Local host redu number, in non-redundant system it is always 1. |
private void fwInstallation_ui_updateInstalledComponentsStatusInfo | ( | shape | fileIssueLabelShape, |
shape | fileIssueArrowShape, | ||
bool | componentsIncorrectlyInstalled, | ||
bool | componentsBrokenDependencies | ||
) |
Displays status info of installed components (incorrect installation/missing dependencies).
fileIssueLabelShape | (in) Shape of label where to put status info |
fileIssueArrowShape | (in) Shape of array to be displayed in case of component issues |
componentsIncorrectlyInstalled | (in) Flag that indicates if there are components installed incorrectly |
componentsBrokenDependencies | (in) Flag that indicates if there are components with missing dependencies |
synchronized void fwInstallation_ui_displayInstalledComponents | ( | shape | tableShape, |
shape | fileIssueLabelShape, | ||
shape | fileIssueArrowShape, | ||
bool | subcomponentsVisible, | ||
int | reduHostNum = 0 |
||
) |
Searches for components installed in project and displays them in 'Installed components' table.
tableShape | (in) Installed components table shape |
fileIssueLabelShape | (in) Shape of label where to put status info |
fileIssueArrowShape | (in) Shape of array to be displayed in case of component issues |
subcomponentsVisible | (in) Flag that indicates if subcomponents should be shown (true) or hidden |
reduHostNum | (in) Local host redu number, default value (0) indicates that the number will be obtained automatically. |
private int fwInstallation_ui_getAvailableComponentsInfo | ( | dyn_dyn_anytype & | availableComponentsToDisplay, |
string | sourceDirectory, | ||
bool | scanRecursively = false , |
||
string | systemName = "" |
||
) |
Retrieves information about available components in given source directory
availableComponentsToDisplay | (out) Array of available components information, note indexing: [information_type][component] |
sourceDir | (in) Path to look for available components |
scanRecursively | (in) Flag that indicates if components are searched also in subdirectories |
systemName | (in) System where it is checked if component is already installed, if empty (default) then local system |
void fwInstallation_ui_displayAvailableComponents | ( | shape | tableShape, |
string | sourceDir, | ||
bool | scanRecursively, | ||
bool | subcomponentsVisible, | ||
bool | hiddenComponentsVisible, | ||
string | systemName = "" |
||
) |
Searches for available components in given source directory and displays them in 'Available components' table.
tableShape | (in) Available components table shape |
sourceDir | (in) Path to look for components |
scanRecursively | (in) Flag that indicates if components are searched also in subdirectories |
subcomponentsVisible | (in) Flag that indicates if subcomponents should be shown (true) or hidden |
hiddenComponentsVisible | (in) Flag that indicates if hidden components should be shown (true) or hidden |
systemName | (in) System where it is checked if component is already installed, if empty (default) then local system |
void fwInstallation_ui_filterComponentsTable | ( | shape | tableShape, |
bool | subcomponentsVisible, | ||
bool | hiddenComponentsVisible | ||
) |
Show/hide rows with subcomponents and hidden component in components table according to given parameters.
tableShape | (in) Components table shape |
subcomponentsVisible | (in) Flag that indicates if subcomponents should be shown (true) or hidden |
hiddenComponentsVisible | (in) Flag that indicates if hidden components should be shown (true) or hidden |
fwInstallation_ui_getMarkedComponentsData | ( | shape | tableShape, |
const dyn_string & | markLabels, | ||
const dyn_string & | columnsToGet, | ||
dyn_dyn_mixed & | componentsInfo | ||
) |
This function retrieves from a table requested data of components that have specific labels set in colum "colStatus". Retrieving data of components that are selected in a table for installation or removal.
tableShape | (in) Shape of a table |
markLabels | (in) List of labels - components that have these labels in "colStatus" column will be retrieved |
columnsToGet | (in) List of table columns from which the information are read. |
componentsInfo | (out) Retrieved marked components info. Columns are indexed corresponding to the columnsToGet list, each row contains one component data. |
dyn_mixed fwInstallation_ui_getColumnsInRow | ( | shape | tableShape, |
int | row, | ||
const dyn_string & | columnsToGet | ||
) |
Retrieves values from table cells in a given row and given columns.
tableShape | (in) Shape of a table |
row | (in) Table row number |
columnsToGet | (in) List of table columns from which the information are read. |
fwInstallation_ui_componentsTableRightClickPopupMenu | ( | shape | tableShape, |
int | row, | ||
string | column | ||
) |
Shows and handles the right click pop-up menu in components table.
tableShape | (in) Components' table shape |
row | (in) Row number |
column | (in) Name of a column (currently unused) |
private void fwInstallation_ui_copyComponentsListToClipboard | ( | shape | tableShape | ) |
Copies to clipboard a list of components and their versions as a string.
tableShape | (in) Components' table shape |
string fwInstallation_ui_getTableColumnsAsString | ( | shape | tableShape, |
dyn_string | columns, | ||
bool | addHeader = true , |
||
string | colSeparator = "\t" , |
||
bool | onlyVisible = true |
||
) |
Reads all rows of the given table's columns as a string.
tableShape | (in) Shape of a table |
columns | (in) List of table columns |
addHeader | (in) Flag that indicates if columns headers should be added at the beginning (true - default) |
colSeparator | (in) String that separates fields of different columns (default is TAB character) |
onlyVisible | (in) Flag that indicates if only content of visible rows should be read |
void fwInstallation_ui_setTableAlternatingRowColors | ( | shape | table | ) |
Enables alternating row colors for a given table.
table | (in) Table shape |
void fwInstallation_ui_openReleaseNotes | ( | ) |
Opens fwInstallation Release Notes in text editor (read only mode)
void fwInstallation_reportInit | ( | shape | sh | ) |
Creates/updates global variable that stores provided shape of a 'Installation Info' reference panel and therefore enables reporting of component installation process. This function is called in fwInstallation_installationInfo.pnl panel with its own shape as an argument when user-defined event eventStartReporting() occurs.
sh | (in) Shape of 'Installation Info' reference panel on main installation panel. |
void fwInstallation_reportTeardown | ( | ) |
Removes global variable with shape of a 'Installation Info' reference panel. This disables reporting of reporting of component installation process. This function is called in fwInstallation_installationInfo.pnl panel when user-defined event eventStopReporting() occurs.
private fwInstallation_reportSetReportShape | ( | shape | sh | ) |
Sets the shape stored by 'reportShape' global variable.
sh | (in) Shape that is assigned to 'reportShape' global variable |
shape fwInstallation_reportGetReportShape | ( | ) |
Returns the shape stored in 'reportShape' global variable.
bool fwInstallation_reportReportShapeExists | ( | ) |
Checks if global variable 'reportShape' exists.
private void fwInstallation_updateReport | ( | string | messageType, |
anytype | value | ||
) |
Sends installation report messages to the 'Installation Info' panel. This function invokes 'updateReport' public function in fwInstallation_installationInfo.pnl, with message type and parameter value provided as an arguments.
messageType | (in) Type of the message |
value | (in) Parameter value for given message type |
fwInstallation_reportInstallationStartTime | ( | ) |
This function sends installation start time. Start time is the current time.
fwInstallation_reportSetTotalComponentsNumber | ( | int | componentsNumber | ) |
This function sends number of components to be installed.
componentsNumber | (in) Number of components to be installed |
fwInstallation_reportUpdateTotalComponentsNumber | ( | int | additionalComponentsNumber | ) |
This function sends number of additional components to be installed (this number is added to the current number of components to be installed).
additionalComponentsNumber | (in) Number of additional components to be installed |
fwInstallation_reportComponentInstallationProgress | ( | string | componentName, |
int | stage | ||
) |
This function sends installation progress of given component
componentName | (in) Name of the component being installed |
stage | (in) Current component installation step number |
fwInstallation_reportComponentInstallationFinished | ( | string | componentName | ) |
This function sends information that installation of given component is finished
componentName | (in) Name of the component which installation is finished |
fwInstallation_reportInstallationMessage | ( | errClass | message | ) |
This function sends installation log messages ()
message | (in) Log message of errClass type |
const string csFwInstallationToolVersion = "8.4.1" |
Version of this tool. Used to determine the coherency of all libraries of the installation tool Please do not edit it manually
const string csFwInstallationToolTag = "" |
Tool version tag. In repository it has a value "devel", when snapshot/beta is built it is replaced by pre-release tag. In final relase this global is an empty string. Used to determine the coherency of all libraries of the installation tool Please do not edit it manually
const string csFwInstallationLibVersion = "8.4.1" |
Version of this library. Used to determine the coherency of all libraries of the installtion tool Please do not edit it manually
const string gFwInstallationComponentName = "fwInstallation" |
Error codes that can be ignored while doing ASCII import Name of this component.
const string gFwInstallationConfigFile = "fwInstallation.config" |
Name of the config file of the tool.
const string gFwInstallationInitFile = "fwInstallationInit.config" |
Name of the init file loaded at start up of the tool.
const int gFwInstallationError = -1 |
Returned error code in case of problems
const int gFwInstallationOK = 0 |
Returned error code in case everything is OK
bool gFwInstallationErrorShown = FALSE |
Constant that stores a particular error has already been shown
bool gFwYesToAll = FALSE |
Constant that stores if the user has clicked in the Yes to All button during installations
string fwInstallation_VERSION_KEYWORD = "%VERSION%" |
keyword used to replace by the current version name
const string gFwTrashPath = PROJ_PATH + "/fwTrash/" |
Path to the trash folder
const string FW_INSTALLATION_RELEASE_NOTES = "fwInstallation/fwInstallationReleaseNotes.txt" |
Relative path from help/en_US.utf8/ directory to the fwInstallation release notes file
const string FW_INSTALLATION_LOG_FILE = "fwInstallation.log" |
fwInstallation main log file name.
const string FW_INSTALLATION_REPORT_VARIABLE_INSTALATION_INFO_COMPONENT = "componentName" |
Elements of mapping, that stores information about installation of particular component
const string FW_INSTALLATION_REPORT_MESSAGE_INSTALLATION_STARTED = "installationStarted" |
Definition of report message types and functions that sends them
const int FW_INSTALLATION_REPORT_STEP_STARTING_INSTALLATION = 1 |
Definition of component installation steps