ERROR - cache_remote_file tag - The required url parameter is missing in your tag
'; $lang_sourceoffline = 'ERROR - cache_remote_file tag - The source url is offline or incorrect, can not create cache file
'; /* Check if the cache directory is available. If not, create it */ if (! is_dir($cache_directory) ) { @mkdir($cache_directory); if ( isset($cache_directory) && !file_exists($cache_directory.'/index.html') ) { file_put_contents($cache_directory.'/index.html', ''); } if ( isset($cache_directory) && is_dir($cache_directory) && file_exists($cache_directory.'/index.html')) { /* put mention into the admin log */ audit('','cache_remote_file tag','Created cache directory: '. $cache_directory); } else { echo $lang_cantcreatedir; return false; } } /* Check for the url parameter in the cache_remote_file tag */ if ( isset($source_url) && $source_url == '' ) { echo $lang_urlparammissing; return false; } /* Depending on the presence of the cache file do some actions... */ if (!file_exists($cache_file)) { /* Cache file is not present */ @fopen($source_url,'r'); if ( strpos($http_response_header[0], '404') == false ) { file_put_contents( $cache_file, (file_get_contents($source_url)) ); } else { echo $lang_sourceoffline; return false; } } else { /* Cache file is present */ $time_left = ( (@filemtime($cache_file)) - (time() - 3600 * $time) ); if ( $time_left < 0 ) { @fopen($source_url,'r'); if ( strpos($http_response_header[0], '404') == false ) { file_put_contents( $cache_file, (file_get_contents($source_url)) ); } else { touch($cache_file); } @fclose($source_url); } } return file_get_contents($cache_file); } // End Function /** * Help text */ function smarty_cms_help_function_cache_remote_file() { ?>This plugin is an extented, but more reliable version of the PHP file_get_contents function.
Change the content at one site and the others will follow when the buffer time has elapsed.
At first the tag will create automaticly a new folder named (by default): /tmp/cache_remote_file.
Because the tag caches the content for one hour, it won't waste any bandwidth. The tag has several reliability checks, so even when the master website is offline for a long period the content in the client website remains available.
The clear cache function of CMSMS will not delete these cached files! The files can only be removed manually in the File Manager!
Some examples where to use this tag:
This plugin requires write permission in the CMSMS /tmp folder. If necessary you can change the directory path in the top of the code of the file function.cache_remote_file.php at the default parameter settings. Change the value for the parameter $cache_directory.
In the server settings "allow_url_fopen" should be allowed.
Create at the master website a HTML template (named i.e. blank) with only the {content} tag in it.
Put the text or code you want to share between websites in a hidden page (this means not in the menu) with the blank template attached.
Perhaps it is necessary to switch off the WYSIWYG editor in the page options tab.
Opening the page will only show the text or code with no styling.
You can retrieve and cache this text or code from the master website just by adding in your page or template:
{cache_remote_file url="http://www.website.com/index.php?page=page_alias"} Don't use a pretty url in the url parameter!
Note: All image or page paths in the content need to have the masters root url in it! Otherwise you will get an Error 404.
url="" (Required)
The url of the source file/page at the master website.
time=""
Number of hours the remote content will be stored in a local cache file. When this period has elapsed the tag will try to renew the cache file with the content present in the source file. Default value is 1.
Plugin author: Rolf Tjassens <rolf [at] cmsmadesimple [dot] org>
Version: 1.0
Change History:
03-08-2012 - Rolf Tjassens - Initial release