Class cUpdateNotifier

This class contains function for the update notifier.

Package: Core\Security
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Dominik Ziegler
Located at classes/class.update.notifier.php

Methods summary
`public`	# `__construct( array $aCfg, cApiUser $oUser, cPermission $oPerm, cSession $oSession, string $sBackendLanguage )` Constructor of Contenido_UpdateNotifier Constructor of Contenido_UpdateNotifier Parameters `$aCfg` `array` $aCfg `$oUser` `cApiUser` $oUser `$oPerm` `cPermission` $oPerm `$oSession` `cSession` $oSession `$sBackendLanguage` `string` $sBackendLanguage
`protected`	# `setRSSFile( )` Sets the actual RSS file for the reader Sets the actual RSS file for the reader
`protected`	# `updateSystemProperty( string $sAction )` Updates the system property for activation/deactivation requests Updates the system property for activation/deactivation requests Parameters `$sAction` `string` $sAction
`protected`	# `setCachePath( )` Sets the cache path Sets the cache path
`protected`	# `checkUpdateNecessity( )` Checks if the xml files must be loaded from the vendor host or local cache Checks if the xml files must be loaded from the vendor host or local cache
`protected`	# `detectMinorRelease( )` Detects and converts the minor release of the system version Detects and converts the minor release of the system version
`protected`	# `readVendorContent( )` Reads the xml files from vendor host or cache and checks for file manipulations Reads the xml files from vendor host or cache and checks for file manipulations
`protected`	# `handleVendorUpdate( array $aXMLContent )` Handles the update of files coming per vendor host Handles the update of files coming per vendor host Parameters `$aXMLContent` `array` $aXMLContent
`protected array`	# `getVendorHostFiles( )` Connects with vendor host and gets the xml files Connects with vendor host and gets the xml files Returns `array`
`protected`	# `updateCacheFiles( array $aRSSContent )` Updates the files in cache Updates the files in cache Parameters `$aRSSContent` `array` $aRSSContent
`protected string`	# `getHashProperty( )` Gets the xml file hash from the property table Gets the xml file hash from the property table Returns `string`
`protected`	# `updateHashProperty( array $aXMLContent )` Updates the xml file hash in the property table Updates the xml file hash in the property table Parameters `$aXMLContent` `array` $aRSSContent
`protected string`	# `checkPatchLevel( )` Checks the patch level of system and vendor version Checks the patch level of system and vendor version Returns `string`
`protected string`	# `getDownloadURL( )` Generates the download URL Generates the download URL Returns `string`
`protected string`	# `renderOutput( string $sMessage )` Generates the output for the backend Generates the output for the backend Parameters `$sMessage` `string` $sMessage Returns `string`
`protected cTemplate`	# `renderRss( cTemplate $oTpl )` Generates the output for the rss informations Generates the output for the rss informations Parameters `$oTpl` `cTemplate` $oTpl Returns `cTemplate` CONTENIDO template object
`private string\|boolean`	# `fetchUrl( string $sUrl )` fetches given url for vendorfiles fetches given url for vendorfiles Parameters `$sUrl` `string` $sUrl Returns `string\|boolean` Todo add a retry counter and a deathpoint with warning in errorlog
`public string`	# `displayOutput( )` Displays the rendered output Displays the rendered output Returns `string`

Properties summary
`protected string`	`$sMinorRelease`	`""`	# Minor release for the simplexml xpath() method Minor release for the simplexml xpath() method
`protected string`	`$sVendorHost`	`"www.contenido.org"`	# Host for vendor XML Host for vendor XML
`protected string`	`$sVendorHostPath`	`"con_version_check_feeds/"`	# Path to files Path to files
`protected string`	`$sVendorXMLFile`	`"vendor.xml"`	# Vendor XML file Vendor XML file
`protected string`	`$sVendorRssDeFile`	`"rss_de.xml"`	# German Vendor RSS file German Vendor RSS file
`protected string`	`$sVendorRssEnFile`	`"rss_en.xml"`	# English Vendor RSS file English Vendor RSS file
`protected string`	`$sRSSFile`	`""`	# Language specific RSS file Language specific RSS file
`protected string`	`$sTimestampCacheFile`	`"update.txt"`	# Timestamp cache file Timestamp cache file
`protected string`	`$sXMLContent`	`""`	# Content of the XML file Content of the XML file
`protected string`	`$sRSSContent`	`""`	# Content of the language specific RSS file Content of the language specific RSS file
`protected string`	`$sVendorVersion`	`""`	# Current available vendor version Current available vendor version
`protected string`	`$sVendorURL`	`"http://www.contenido.org/de/redir"`	# Download URL Download URL
`protected string`	`$sBackendLanguage`	`""`	# Current backend language Current backend language
`protected string`	`$sCacheDirectory`	`""`	# Contains the cache path. Contains the cache path.
`protected object`	`$oXML`	`NULL`	# SimpleXML object SimpleXML object
`protected object`	`$oProperties`	`NULL`	# Properties object Properties object
`protected object`	`$oSession`	`NULL`	# Session object Session object
`protected integer`	`$iConnectTimeout`	`3`	# Timeout for the fsockopen connection Timeout for the fsockopen connection
`protected integer`	`$iCacheDuration`	`60`	# Cache duration in minutes Cache duration in minutes
`protected boolean`	`$bEnableCheck`	`false`	# Check for system setting Check for system setting
`protected boolean`	`$bEnableCheckRss`	`false`	# Check for system setting Rss Check for system setting Rss
`protected boolean`	`$bNoWritePermissions`	`false`	# If true CONTENIDO displays a special error message due to missing write permissions. If true CONTENIDO displays a special error message due to missing write permissions.
`protected boolean`	`$bEnableView`	`false`	# Display update notification based on user rights (sysadmin only) Display update notification based on user rights (sysadmin only)
`protected boolean`	`$bUpdateNecessity`	`false`	# Update necessity Update necessity
`private boolean`	`$bVendorHostReachable`	`true`	# Vendor host reachability. Vendor host reachability.
`protected array`	`$aPropConf`	`array( "itemType" => "update", "itemID" => 1, "type" => "file_check", "name" => "xml" )`	# Property configuration array Property configuration array
`protected array`	`$aSysPropConf`	`array( "type" => "update", "name" => "check" )`	# System property configuration array for update notification System property configuration array for update notification
`protected array`	`$aSysPropConfRss`	`array( "type" => "update", "name" => "news_feed" )`	# System property configuration array for rss notification System property configuration array for rss notification
`protected array`	`$aSysPropConfPeriod`	`array( "type" => "update", "name" => "check_period" )`	# System property configuration array for update period System property configuration array for update period
`protected array`	`$aCfg`	`array()`	# CONTENIDO configuration array CONTENIDO configuration array

Packages

Classes

Class cUpdateNotifier

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Todo

Returns