5 // +----------------------------------------------------------------------+
7 // | Copyright (c) 2001 Stefan Saasen |
8 // +----------------------------------------------------------------------+
9 // | The contents of this file are subject to the Mozilla Public License |
10 // | Version 1.1 (the "License"); you may not use this file except in |
11 // | compliance with the License. You may obtain a copy of the License at |
12 // | http://www.mozilla.org/MPL/ |
14 // | Software distributed under the License is distributed on an "AS IS" |
15 // | basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See |
16 // | the License for the specific language governing rights and |
17 // | limitations under the License. |
18 // +----------------------------------------------------------------------+
20 // | Maintainer and initial developer: |
21 // | Stefan Saasen <s@fase4.com> |
23 // | Proxy and authentication methods added by: |
24 // | Marco Kraus <marco.kraus@siemens.com> |
26 // | Decoding of data by htmlentities or utf8_decode added by: |
27 // | Roland Haeder <webmaster@mxchange.org> |
29 // +----------------------------------------------------------------------+
31 // | @link http://www.fase4.com/rdf/ Latest release |
32 // +----------------------------------------------------------------------+
37 * This class offers methods to parse RSS Files
39 * @link http://www.fase4.com/rdf/ Latest release of this class
41 * @copyright Copyright (c) 2001 fase4.com. All rights reserved.
42 * @author Stefan Saasen <s@fase4.com>
43 * @author Roland Haeder <webmaster@mxchange.org>
44 * @version 1.7 ($Date$Revision: 856 $
51 * Word-wrapping mode for description, set it to 0 do disable this feature! Ommits _use_nl2br!
56 var $_word_wrap = '0';
59 * Wether to recode \n -> <br /> or not in description
64 var $_use_nl2br = true;
67 * Sets the decoding mode of the read data (UTF8 scrambles some german umlauts here!)
69 * "htmlentities" - Use the function htmlentities()
70 * "utf8_decode" - Use the function ut8_decode() when you have UTF8 encoded text
75 var $_decoding_mode = 'utf8_decode';
78 * If $_link_target is set a target='xxx' attribute in each <a /> and <form accept-charset="utf-8" /> html tag will be added
80 * Possible values are "_blank", "_content", "_parent", "_self", "_top"
85 var $_link_target = '_blank';
88 * vars for proxy settings - Prox Host
96 * vars for proxy settings - Prox Port
104 * vars for proxy settings - Prox Username
112 * vars for proxy settings - Prox Password
120 * just a flag for checking if proxy-support should be enabled
121 * set default to false (will be enabled if set_proxy is called)
127 var $_use_proxy = false;
130 * just a flag for checking if proxy-support with authentication
132 * set default to false (will be enabled if set_proxy is called)
138 var $_use_proxy_auth = false;
141 * The time the Files will be cached (in seconds).
146 var $_refresh = 60; // int
149 * The Name of the cached File.
154 var $_cached_file = ''; // String
157 * Indicates whether the cached or the remote file was used.
162 var $_use_cached_file = true;
165 * (fast|normal) depends on _use_dynamic_display(). _use_dynamic_display( TRUE ) -> 'normal', otherwise 'fast'
170 var $_cache_type = 'fast';
173 * The Name of the Remote File.
178 var $_remote_file = '';
181 * Path to the Cache Directory.
186 var $_cache_dir = 'cache/'; // String
189 * Indicates whether the Creating of the Cache Directory needs to be done or not.
194 var $_cache_dir_ok = false;
197 * Type of the file to be parsed (RSS or RDF).
199 * The Type depends on the root node
204 var $_type = 'rss'; // string (rss or rdf)
207 * Array of Display Settings.
209 * Specific Parameters can be set to hidden. These are:
210 * image, channel and textinput. If set to "hidden" those elements won't be displayed.
215 var $_display_opt = array(
220 'cache_update' => '',
227 * Defines the width attribute in the table that holds the rdf/rss representation
231 * @see see_table_width()
233 var $_table_width = '100%';
236 * Indicates whether or not to use dynamic Display Settings
241 var $_use_dynamic_display = false;
249 var $_item_count = '0';
257 var $_max_count = false;
260 * Array containing the content of <channel />
265 var $_array_channel = array();
268 * Array containing the content of each <item />
273 var $_array_item = array();
276 * Array containing the content of <textinput />
281 var $_array_textinput = array();
284 * Array containing the content of <image />
289 var $_array_image = array();
292 * Array containing the Channel content. Just For internal XML Parser Purposes.
297 var $_citem = array();
300 * Array containing the Channel Parser Depth. Just For internal XML Parser Purposes.
305 var $_cdepth = array();
308 * Array containing the Channel tags. Just For internal XML Parser Purposes.
313 var $_ctags = array( 'x' );
316 * Array containing the Channel content. Just For internal XML Parser Purposes.
321 var $_item = array(); // Array
324 * Array containing the Channel Parser Depth. Just For internal XML Parser Purposes.
329 var $_depth = array(); // Array
332 * Array containing the tags. Just For internal XML Parser Purposes.
337 var $_tags = array( 'x' ); // Array
340 * Garbage collection: probability in percent
342 * @var integer 0 => never
345 var $gc_probability = 1;
358 var $_parse_mode = '';
367 * Constructor of our Class
369 * This Method checks if the Cache Directory can be found. Otherwise it tries to creat the Cache Directory at the specified Path.
370 * Additionally the Refresh Time is set to a default Value of 1200s (20 min).
373 * @author Stefan Saasen <s@fase4.com>
378 // default Value, to be overwritten in set_refresh()
379 $this->_refresh = (time() - 1200);
380 $this->_clear_cItems();
381 $this->_clear_Items();
385 * This Method starts the parsing of the specified RDF File. The File can be a local or a remote File.
388 * @author Stefan Saasen <s@fase4.com>
389 * @param string $rdf RDF File (Location)
390 * @return string Displays RDF Content ( using _display() )
391 * @see _remote_file, cache()
393 function parse_RDF( $rdf )
395 unset($this->_array_item);
396 $this->_remote_file = $rdf;
397 $this->out .= "<!-- http://www.fase4.com/rdf/ -->";
398 $this->out .= "<table width=\"".$this->_table_width."\">";
399 $this->out .= $this->cache();
400 $this->out .= "</table>";
402 $this->_item_count = '0';
407 * This Method is called when all parsing is finished to use the garbage collection
410 * @author Stefan Saasen <s@fase4.com>
411 * @param string $rdf RDF File (Location)
412 * @return string Displays RDF Content ( using _display() )
413 * @see _remote_file, cache()
415 function finish($return = false)
422 $this->_garbage_collection();
426 * With this method you can decide whether to use the normal cache and dynamic display Options or to use a static cache.
428 * In the first case the rdf/rss File will be stored locally, in the second case the html output of the specified source will be stored.
429 * In this case you can not modify the display settings.
430 * processing time: ( 1.4792) --> remote file
431 * processing time: ( 0.0313) --> using 'normal cache' with display Modification turned on.
432 * processing time: ( 0.0019) --> using 'fast cache'
435 * @author Stefan Saasen <s@fase4.com>
436 * @param string $rdf RDF File (Location)
437 * @return string Displays RDF Content ( using _display() )
438 * @see _remote_file, cache()
440 function use_dynamic_display( $bool )
442 $this->_use_dynamic_display = $bool;
447 * This Method avtually parses the XML data.
450 * @author Stefan Saasen <s@fase4.com>
451 * @param string $data RDF File XML Data
452 * @see _clear_Items()
454 function _parse_xRDF( $data )
456 $this->_clear_Items();
457 $xml_parser = xml_parser_create();
458 xml_set_object($xml_parser,$this);
459 xml_parser_set_option($xml_parser,XML_OPTION_CASE_FOLDING,0);
460 xml_set_element_handler($xml_parser, '_startElement', '_endElement');
461 xml_set_character_data_handler($xml_parser, '_parseData');
462 if (!xml_parse($xml_parser, trim($data))) {
463 $this->_throw_exception(sprintf("XML error: %s at line %d",
464 xml_error_string(xml_get_error_code($xml_parser)),
465 xml_get_current_line_number($xml_parser)).'<br /><br />Exception in function parse_RDF().');
467 xml_parser_free($xml_parser);
472 * This Methods allows you to set the Refresh Time
475 * @author Stefan Saasen <s@fase4.com>
476 * @param int $seconds time files will be cached (in seconds).
480 function set_refresh( $seconds )
482 $this->_refresh = (time() - $seconds);
486 function set_salt( $saltPara )
488 $this->salt = $saltPara;
493 * This Methods allows you to set the No. of <item>s to display
496 * @param int $int No of max <item>s
497 * @author Stefan Saasen <s@fase4.com>
499 * @see _max_count, _endElement()
501 function set_max_item( $int )
503 $this->_max_count = $int;
508 * This Methods allows you to set the Cache Directory
511 * @author Stefan Saasen <s@fase4.com>
512 * @param string $dir Path to Directory.
516 function set_CacheDir( $dir )
518 if(substr($dir, -1) != '/') {
521 $this->_cache_dir = $dir;
525 * This Method displays Error Messages and terminates the Execution of the Script
528 * @param string $msg Message to display on failure
529 * @author Stefan Saasen <s@fase4.com>
531 function _throw_exception( $msg )
533 $this->out .= "<div style=\"font-family: verdana, helvetica, arial, sans-serif;font-size:11px; color: #6699cc;margin-top:10px;margin-bottom:10px;\" align=\"center\">fase4 RDF Error: ".$msg."</div>";
538 * This Method clears the Array containig the Items.
541 * @author Stefan Saasen <s@fase4.com>
544 function _clear_Items( ) {
545 $this->_item = array(
552 'lastBuildDate' => '',
558 * This Method clears the Array containig the Channel Items.
561 * @author Stefan Saasen <s@fase4.com>
564 function _clear_cItems( ) {
565 $this->_citem = array(
572 'managingEditor' => '',
575 'lastBuildDate' => '',
592 * XML Parser Start Element Handler
595 * @author Stefan Saasen <s@fase4.com>
596 * @param mixed $parser a reference to the XML parser calling the handler.
597 * @param string $name contains the name of the element for which this handler is called.
598 * @param string $attrs contains an associative array with the element's attributes (if any).
599 * @see _get_ChannelData(), _clear_Items(), _type, _parse_mode, _depth, _tags, _cdepth, _ctags
601 function _startElement($parser, $name, $attrs) {
602 // We have to determine, which type of xml data we have to parse
604 $this->_type = 'rss';
605 } elseif($name == 'rdf:RDF' OR $name == 'rdf') {
606 $this->_type = 'rdf';
610 if ( $name == 'channel' AND $this->_type != 'rdf' ) {
611 $this->_parse_mode = 'channel';
612 } elseif ( ($name=='item')
614 ||($name=='textinput')
615 ||(($name=='channel') && ($this->_type != 'rss')) ) {
616 if($this->_parse_mode=='channel') {
617 $this->_get_ChannelData( $parser );
619 $this->_parse_mode = 'all';
622 if( !isset( $this->_depth[$this->get_parser_id($parser)] ) ) {
623 $this->_depth[$this->get_parser_id($parser)] = '0';
625 $this->_depth[$this->get_parser_id($parser)]++;
626 array_push($this->_tags, $name);
628 if( !isset( $this->_cdepth[$this->get_parser_id($parser)] ) ) {
629 $this->_cdepth[$this->get_parser_id($parser)] = '0';
631 $this->_cdepth[$this->get_parser_id($parser)]++;
632 array_push($this->_ctags, $name);
633 } // END _startElement()
636 * Retrives the Channel Data in <rss> File
639 * @author Stefan Saasen <s@fase4.com>
640 * @param mixed $parser a reference to the XML parser calling the handler.
641 * @see _output, _display_opt, _citem
643 function _get_ChannelData( $parser )
645 $this->_citem['link'] = trim($this->_citem['link']);
646 if (($this->_display_opt['sitelink'] == $this->_citem['link']) && (!empty($this->_display_opt['reflink'])) && (!empty($this->_display_opt['refid'])))
648 $this->_citem['link'] .= $this->_display_opt['reflink'].$this->_display_opt['refid'];
651 if( empty($this->_display_opt['channel']) OR
652 $this->_display_opt['channel'] != 'hidden') {
653 $this->_output .= "<tr><td>\n";
654 $this->_output .= "<table border=\"0\" width=\"100%\" class=\"fase4_rdf_meta\" cellspacing=\"5\" cellpadding=\"2\">\n";
655 $this->_output .= "<tr><td class=\"fase4_rdf_main_title\"><div class=\"fase4_rdf_main_title\">".htmlspecialchars($this->_citem['title'])."</div></td></tr>\n";
656 $this->_output .= "<tr><td class=\"fase4_rdf\">".strip_tags($this->_citem['description'], '<a>, <img>')."</td></tr>\n";
657 $this->_output .= "<tr><td> </td></tr>\n";
658 $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
659 if(isset($this->_display_opt['build']) && $this->_display_opt['build'] != 'hidden') {
660 if($this->_citem['lastBuildDate']){$this->_output .= 'build: '. $this->_citem['lastBuildDate'].'<br />';}
662 if(isset($this->_display_opt['cache_update']) && $this->_display_opt['cache_update'] != 'hidden' && ( $_update = $this->get_cache_update_time()) ) {
663 $this->_output .= 'cache update: '.$_update."<br />\n";
665 $this->_output .= "<a href=\"".$this->_citem['link']."\" ";
666 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
667 $this->_output .= ">".$this->_cut_string($this->_citem['link']) . '</a>';
668 $this->_output .= "</td></tr>\n";
669 $this->_output .= "<tr><td><hr noshade width=\"100%\" size=\"1\"></td></tr>\n";
670 $this->_output .= "</table></td></tr>";
672 $this->_array_channel = array(
673 'title' => $this->_citem['title'],
674 'link' => $this->_citem['link'],
675 'description' => $this->_citem['description'],
676 'lastBuildDate' => $this->_citem['lastBuildDate']);
680 * XML Parser End Element Handler
683 * @author Stefan Saasen <s@fase4.com>
684 * @param mixed $parser a reference to the XML parser calling the handler.
685 * @param string $name contains the name of the element for which this handler is called.
686 * @see _clear_Items(), _type, _parse_mode, _depth, _tags, _cdepth, _ctags, _item, _output, _display_opt
688 function _endElement($parser, $name) {
689 array_pop($this->_tags);
690 $this->_depth[$this->get_parser_id($parser)]--;
691 array_pop($this->_ctags);
692 $this->_cdepth[$this->get_parser_id($parser)]--;
693 $this->_item['link'] = trim($this->_item['link']);
694 if ((!empty($this->_display_opt['refid'])) && (!empty($this->_item['link'])))
696 if (!isInString('refid=', $this->_item['link'])) $this->_item['link'] .= '?refid=' . $this->_display_opt['refid'];
700 if(empty($this->_max_count) OR $this->_item_count < $this->_max_count) {
701 if($this->_item['title'] != $this->_item['description']
702 AND $this->_item['description']) {
704 // word-wrapping added by Roland Haeder <webmaster@mxchange.org>
705 if (($this->_word_wrap > 0) && (strlen($this->_item['description']) > $this->_word_wrap))
707 // Switch off _use_nl2br
708 $this->_use_nl2br = false;
709 // First remove all \n
710 $this->_item['description'] = str_replace('\n', ' ', $this->_item['description']);
711 // Wrap with <br />\n
712 $this->_item['description'] = wordwrap($this->_item['description'], $this->_word_wrap, "*<br />\n");
714 elseif (($this->_word_wrap == '0') && (!$this->_use_nl2br))
716 // Strip tags out instead when word-wrap is disabled
717 $this->_item['description'] = strip_tags($this->_item['description'], '<a>, <img>');
720 // nl2br added by Roland Haeder <webmaster@mxchange.org>
721 if ($this->_use_nl2br) $this->_item['description'] = nl2br($this->_item['description']);
723 $this->_output .= "<tr><td class=\"fase4_rdf_title\"><div class=\"fase4_rdf_title\"><a class=\"fase4_rdf_title\" href=\"".$this->_item['link']."\" ";
724 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
725 $this->_output .= ">".strip_tags($this->_item['title'], '<a>, <img>').'</a> ('.$this->_item['pubDate'].")</div></td></tr>\n";
726 $this->_output .= "<tr><td class=\"fase4_rdf\">".$this->_item['description']."</td></tr>\n";
727 // we just display the <hr> if there is a description
728 $this->_output .= "<tr><td><hr noshade=\"noshade\" size=\"1\" /></td></tr>\n";
730 $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
731 $this->_output .= "<a href=\"".$this->_item["link"]."\" ";
732 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
733 $this->_output .= ">".$this->_item["title"]."</a></td></tr>\n";
736 $this->_array_item[] = array(
737 'title' => $this->_item['title'],
738 'link' => $this->_item['link'],
739 'description' => $this->_item['description']
742 ++$this->_item_count;
744 $this->_clear_Items();
748 if(isset($this->_display_opt['image']) && ($this->_display_opt['image'] != 'hidden') && $this->_item['url']) {
749 $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
750 $this->_output .= "<a href=\"".$this->_item['link']."\" ";
751 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
752 $this->_output .= "><img src=\"".$this->_item['url']."\"";
753 if(isset($this->_item['width']) && isset($this->_item['height'])) {
754 $this->_output .= " width=\"".$this->_item['width']."\" height=\"".$this->_item['height']."\"";
756 $this->_output .= " alt=\"".$this->_item['title']."\" border=\"0\" /></a></td></tr>\n";
758 $this->_array_image[] = array(
759 'url' => $this->_item['url'],
760 'link' => $this->_item['link'],
761 'width' => $this->_item['width'],
762 'height' => $this->_item['height']
764 $this->_clear_Items();
765 } elseif( isset($this->_display_opt['image'] ) && ($this->_display_opt['image'] == 'hidden') ) {
766 $this->_clear_Items();
772 if(isset($this->_display_opt['channel']) AND $this->_display_opt['channel'] != 'hidden' AND $this->_item['title'] != '') {
773 $this->_output .= "<tr><td>\n";
774 $this->_output .= "<table border=\"0\" width=\"100%\" class=\"fase4_rdf_meta\" cellspacing=\"5\" cellpadding=\"2\">\n";
775 $this->_output .= "<tr><td class=\"fase4_rdf\"><div class=\"fase4_rdf_title\">".htmlspecialchars($this->_item['title'])."</div></td></tr>\n";
776 $this->_output .= "<tr><td class=\"fase4_rdf\">".strip_tags($this->_item['description'], '<a>, <img>')."</td></tr>\n";
777 $this->_output .= "<tr><td> </td></tr>\n";
778 $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
779 if($this->_display_opt['build'] != 'hidden') {
780 if($this->_item['lastBuildDate']){$this->_output .= 'build: '. $this->_item['lastBuildDate'].'<br />';}
782 if($this->_display_opt['cache_update'] != 'hidden' && ( $_update = $this->get_cache_update_time()) ) {
783 $this->_output .= 'cache update: '.$_update."<br />\n";
785 $this->_output .= "<a href=\"".$this->_item['link']."\" ";
786 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
787 $this->_output .= ">".$this->_cut_string($this->_item['link'])."</a>\n";
788 $this->_output .= "</td></tr>\n";
789 $this->_output .= "</table></td></tr>\n";
791 $this->_array_channel = array(
792 'title' => $this->_item['title'],
793 'link' => $this->_item['link'],
794 'description' => $this->_item['description'],
795 'lastBuildDate' => $this->_item['lastBuildDate']
797 $this->_clear_Items();
798 $this->_clear_cItems();
802 if(isset($this->_display_opt['textinput']) && ($this->_display_opt['textinput'] != 'hidden') && $this->_item['name'] && $this->_item['link']) {
803 $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
804 $this->_output .= "<form accept-charset=\"utf-8\" action=\"".$this->_item['link']."\" ";
805 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
806 $this->_output .= "method=\"get\">\n";
807 $this->_output .= "<div class=\"fase4_rdf_title\">".$this->_item['title']."</div>";
808 $this->_output .= strip_tags($this->_item['description'], '<a>, <img>')."<br /><br />\n";
809 $this->_output .= "<input class=\"fase4_rdf_input\" type=\"text\" name=\"".$this->_item['name']."\"> \n";
810 $this->_output .= "<input class=\"fase4_rdf_input\" type=\"submit\" value=\"go\">";
811 $this->_output .= "</form>\n";
812 $this->_output .= "</td></tr>\n";
813 $this->_array_textinput = array(
814 'title' => $this->_item['title'],
815 'name' => $this->_item['name'],
816 'link' => $this->_item['link'],
817 'description' => $this->_item['description']
819 $this->_clear_Items();
820 } elseif( isset($this->_display_opt['textinput']) && ($this->_display_opt['textinput'] == 'hidden') ) {
821 $this->_clear_Items();
829 * This Method returns the data from the <channel /> paragraph.
832 * @author Stefan Saasen <s@fase4.com>
834 * @see _array_channel
836 function get_array_channel( )
838 return $this->_array_channel;
842 * This Method returns the data from each <item /> paragraph.
845 * @author Stefan Saasen <s@fase4.com>
849 function get_array_item( )
851 return $this->_array_item;
855 * This Method returns the data from <textinput />.
858 * @author Stefan Saasen <s@fase4.com>
860 * @see _array_textinput
862 function get_array_textinput( )
864 return $this->_array_textinput;
868 * Getter for parser id from resource
871 * @author Roland Haeder <webmaster@mxchange.org>
874 function get_parser_id ($parser) {
879 if (is_resource($parser)) {
880 // Cast the resource into id
889 * This Method returns the data from <image />.
892 * @author Stefan Saasen <s@fase4.com>
896 function get_array_image( )
898 return $this->_array_image;
902 * XML Parser Data Handler
905 * @author Stefan Saasen <s@fase4.com>
906 * @param mixed $parser a reference to the XML parser calling the handler.
907 * @param string $text contains the character data as a string.
908 * @see _parse_mode, _item, _tags, _depth, _citem, _ctags, _cdepth
910 function _parseData($parser, $text)
912 // Deocing mode added by Roland Haeder <webmaster@mxchange.org>
913 switch ($this->_decoding_mode)
916 $text = utf8_decode($text);
920 $text = htmlentities($text);
924 $clean = preg_replace("/\s/", "", $text);
926 $text = preg_replace("/^\s+/", "", $text)."\n";
927 if($this->_parse_mode == 'all') {
928 if ( isset($this->_item[$this->_tags[$this->_depth[$this->get_parser_id($parser)]]]) &&
929 $this->_item[$this->_tags[$this->_depth[$this->get_parser_id($parser)]]] ) {
930 $this->_item[$this->_tags[$this->_depth[$this->get_parser_id($parser)]]] .= $text;
932 $this->_item[$this->_tags[$this->_depth[$this->get_parser_id($parser)]]] = $text;
934 } elseif (isset($this->_parse_mode) && $this->_parse_mode == 'channel') {
935 if ( isset($this->_citem[$this->_ctags[$this->_cdepth[$this->get_parser_id($parser)]]]) ) {
936 $this->_citem[$this->_ctags[$this->_cdepth[$this->get_parser_id($parser)]]] .= $text;
938 $this->_citem[$this->_ctags[$this->_cdepth[$this->get_parser_id($parser)]]] = $text;
945 * This Method allows you to choose if specific Parameters are displayed or not. These are:
946 * image, channel, textinput, build and cache_update. If set to "hidden" those elements won't be displayed.
949 * @author Stefan Saasen <s@fase4.com>
950 * @param array $options
953 function set_Options( $options = '' )
955 if(is_array( $options )) {
956 $this->_display_opt = $options;
959 unset($this->_display_opt);
965 * This Method allows you to define the width of the table that holds the representation of the rdf/rss file.
968 * @author Stefan Saasen <s@fase4.com>
969 * @param int $width attribute width in tag <table>
972 function set_table_width( $width = 400 )
974 $this->_table_width = $width;
979 * This Method returns an assocative Array with available Options.
981 * The Keys are the Name of the Options to be set.
982 * The Values are short Description of available Options.
985 * @author Stefan Saasen <s@fase4.com>
986 * @return array $options
989 function get_Options() {
991 'image' => "If 'image' is set to \"hidden\" no image provided by the RDF Publisher will be displayed.",
992 'channel' => "If 'channel' is set to \"hidden\" the Channel Meta Data (i.e the Title and the short description regarding the RDF Publisher will not be displayed",
993 'textinput' => "If set to \"hidden\" no Input Form will be displayed",
994 'build' => "If set to \"hidden\" the Build Date (if provided) of the RDF File will not be displayed",
995 'cache_update' => "If set to \"hidden\" the Update Date/Time of the cached Rdf File will not be displayed"
1001 * This Method returns the Content of the RDF File in one string. The String actually holds the whole XML Document.
1004 * @author Stefan Saasen <s@fase4.com>
1005 * @param string $rdf RDF File (Location)
1006 * @return string XML Presentation of parsed RDF File
1007 * @see _cached_file, _remote_file, _cache_dir, _refresh, _update_cache()
1011 // checks if the cache directory already exists
1012 // if not, the cache directory will be created
1013 if(!$this->_cache_dir_ok) {
1014 $this->_create_cache_dir();
1016 if($this->_use_dynamic_display == true) {
1017 $this->_cached_file = md5('dynamic'.$this->salt.$this->_remote_file) . '.cache';
1018 $this->_cache_type = 'normal';
1020 $this->_cached_file = md5($this->salt.$this->_remote_file) . '.cache';
1021 $this->_cache_type = 'fast';
1024 $_cache_f = $this->_cache_dir.$this->_cached_file;
1026 if ( (!file_exists($_cache_f)) || (filemtime($_cache_f) < $this->_refresh) || (filesize($_cache_f) == '0')) {
1027 // We have to parse the remote file
1028 $this->_use_cached_file = false;
1029 // --> we want to provide proper Information for Use in
1030 // get_cache_update_time()
1032 if($this->_use_dynamic_display == true) {
1033 $_rdf = @implode(' ', $this->_rdf_data()); // -> proxy
1035 $this->_throw_exception( $this->_remote_file.' is not available' );
1037 $this->_parse_xRDF( $_rdf );
1038 $this->_update_cache( $_rdf );
1039 $data = $this->_output;
1041 $_rdf = @implode(' ', $this->_rdf_data()); // -> proxy
1043 $this->_throw_exception( $this->_remote_file.' is not available' );
1045 $this->_parse_xRDF( $_rdf );
1046 $this->_update_cache( $this->_output );
1047 $data = $this->_output;
1050 // we can use the cached file
1051 $this->_use_cached_file = true;
1052 if($this->_use_dynamic_display == true) {
1053 $this->_parse_xRDF( implode(' ', file($_cache_f)) );
1054 $data = $this->_output;
1056 $data = @implode(' ', file($_cache_f));
1063 * This Methods creates the Cache Directory if the specified Directory does not exist.
1066 * @author Stefan Saasen <s@fase4.com>
1067 * @param string $dir Path to Directory.
1069 * @see _cache_dir, _cache_dir_ok
1071 function _create_cache_dir()
1074 if(!@is_dir($this->_cache_dir)) {
1075 $arr = explode('/', $this->_cache_dir);
1080 for($i = '0';$i<$c;$i++)
1083 $path .= $arr[$i].'/';
1084 if(!@is_dir($path)) {
1085 if(!@mkdir($path, 0777)) {
1086 $this->_throw_exception("failed to create directory:<b>".$this->_cache_dir."</b>.<br /><br />Exception on Line: ".__LINE__);
1092 $this->_cache_dir_ok = true;
1095 $this->_cache_dir_ok = true;
1098 } // END _create_cache_dir()
1101 * This Method updates the cached RDF Files and synchronises them with their remote Counterparts.
1104 * @author Stefan Saasen <s@fase4.com>
1105 * @param string $rdf RDF File (Location)
1106 * @see _cache_dir, _cached_file, _throw_exception()
1108 function _update_cache( $content = '' )
1110 $_local = @fopen( $this->_cache_dir.$this->_cached_file, 'w' );
1112 $this->_throw_exception( 'Cannot open '.$this->_cached_file.'<br /><br />Exception at Line: '.__LINE__ );
1115 if (fwrite( $_local, $content) === false) {
1116 $this->_throw_exception( 'Cannot write to '.$this->_cached_file.'<br /<br />Exeception at Line: '.__LINE__);
1120 @chmod( $this->_cache_dir.$this->_cached_file, 0666);
1122 } // END _update_cache()
1125 * This Method returns the Date/Time of last Cache Update of the actually parsed RDF File.
1128 * @author Stefan Saasen <s@fase4.com>
1129 * @return string Date/Time of last Update
1130 * @see _cache_dir, _cached_file
1132 function get_cache_update_time()
1134 return (file_exists($this->_cache_dir.$this->_cached_file))?date('d.m.Y H:i:s', filemtime($this->_cache_dir.$this->_cached_file)):'Cachemiss';
1135 } // END get_cache_update_time()
1138 * This Method returns the Type of Cache that was used ('normal' or 'fast')
1141 * @author Stefan Saasen <s@fase4.com>
1142 * @param string $rdf RDF File (Location)
1143 * @return string Displays RDF Content ( using _display() )
1144 * @see _remote_file, cache()
1146 function get_CacheType()
1148 return $this->_cache_type;
1152 * Returns true if cached file was used, otherwise false
1155 * @author Stefan Saasen <s@fase4.com>
1156 * @return array $options
1157 * @see _use_cached_file
1159 function is_cachedFile()
1161 return $this->_use_cached_file;
1165 * This Method deletes all the cached Files.
1167 * Please keep in mind to use this method just as a 'manual garbage collection'
1168 * You should cache the rss/rdf files locally to avoid unnecessary traffic.
1169 * (Both for your visitors and the Publisher)
1172 * @author Stefan Saasen <s@fase4.com>
1175 function clear_cache()
1177 $dir = dir($this->_cache_dir);
1178 while($file=$dir->read()) {
1179 // Exclude directories
1180 if (is_file($dir->path.$file) && substr($file, -6, 6) != '.cache' && substr($file, -4, 4) != '.log') {
1181 if(!@unlink($dir->path.$file)) {
1182 $this->_throw_exception("Unable to unlink ".$dir->path.$file."<br />\n<br />\nException at Line: ".__LINE__ );
1189 } // END clear_cache()
1192 * Cuts the String $string after $str_len and adds '... '
1195 * @param string $string String to be shortened
1196 * @param int $str_len length of the returned String (overall length including '... ')
1197 * @return string Cut String
1199 function _cut_string( $string, $str_len = '30' )
1201 if(strlen(trim($string))>$str_len) {
1202 $string = substr( trim($string) , 0, $str_len - 4);
1206 } // END _cut_string()
1209 * this Method implements simple Garbage Collection
1212 * @author Stefan Saasen <s@fase4.com>
1213 * @see _cache_dir, gc_probability, gc_maxlifetime
1215 function _garbage_collection()
1217 srand((double) microtime() * 1000000);
1218 if (mt_rand(1, 100) <= $this->gc_probability) {
1219 $dir = dir($this->_cache_dir);
1220 while($file=$dir->read()) {
1221 if (is_file($dir->path.$file) && substr($file, -6, 6) != '.cache' && substr($file, -4, 4) != '.log' && filemtime($dir->path.$file) <= time() - $this->_refresh ) {
1222 @unlink($dir->path.$file);
1229 /* ==== Proxy/Auth methods ==== */
1232 * this method sets a proxy server
1235 * @param string $phost Proxy Host
1236 * @param string $pport Prox Port
1237 * @author Marco Kraus <marco.kraus@siemens.com>
1239 function set_proxy($phost, $pport)
1241 $this->_use_proxy = true;
1244 $this->_phost = $phost;
1247 $this->_pport = $pport;
1251 * this method sets a proxy server authentification
1254 * @param string $pname Username
1255 * @param string $ppaswd Password
1256 * @author Marco Kraus <marco.kraus@siemens.com>
1258 function set_proxy_auth( $pname, $ppasswd )
1260 $this->_use_proxy_auth = true;
1263 $this->_pname = $pname;
1266 $this->_ppasswd = $ppasswd;
1271 * gets _remote_file into an array
1273 * needed, cause if you use a proxy, you have to open
1274 * a raw-tcp-socket to get the data
1277 * @author Marco Kraus <Marco.Kraus@siemens.com>
1279 * @see _use_proxy, cache()
1281 function _rdf_data()
1283 if ( $this->_use_proxy == true )
1285 // we need a raw socket here to connect to proxy
1286 $fp = fsockopen($this->_phost,$this->_pport);
1289 $this->_throw_exception( $this->_remote_file.' is not available with proxy' );
1291 if ( $this->_use_proxy_auth == true ) {
1292 fputs($fp, "GET ".$this->_remote_file." HTTP/1.0\r\nUser-Agent: Fase4 RDF-Reader/1.40 modified by Quix0r\r\n\r\n");
1294 fputs($fp, "GET ".$this->_remote_file." HTTP/1.0\r\nUser-Agent: Fase4 RDF-Reader/1.40 modified by Quix0r\r\nProxy-Authorization: Basic ".base64_encode("$this->_pname:$this->_ppasswd") ."\r\n\r\n");
1299 for ( $i = '0'; !feof ($fp) ; $i++)
1301 $usable_data[$i] = "";
1302 $usable_data[$i] = fgets($fp,4096);
1304 // PARSE HEADER ---- first line has to be <?xml, second rdf or rss, and third is blank
1306 // strstr did not fit (ask Rasmus why), so we compare each character
1307 if ( ($usable_data[$i][0] == '<' ) &&
1308 ($usable_data[$i][1] == '?' ) &&
1309 ($usable_data[$i][2] == 'x' ) &&
1310 ($usable_data[$i][3] == 'm' ) &&
1311 ($usable_data[$i][4] == 'l' ) ) {
1312 $usable_data[0] = $usable_data[$i]; // save current field
1313 $i = 1; // just reset array to start
1316 // there seems to be proxystuff after the <?xml....we delete this
1318 ($usable_data[$i][0] == '<' ) &&
1319 ($usable_data[$i][1] == 'r' ) &&
1320 ($usable_data[$i][2] == 'd' ) &&
1321 ($usable_data[$i][3] == 'f' ) &&
1322 ($usable_data[$i][4] == ':' )
1326 ($usable_data[$i][0] == '<' ) &&
1327 ($usable_data[$i][1] == 'r' ) &&
1328 ($usable_data[$i][2] == 's' ) &&
1329 ($usable_data[$i][3] == 's' )
1333 $usable_data[1] = $usable_data[$i]; // save current field
1334 $usable_data[2] = "\n";
1335 $i = 2; // just reset array to start
1340 return $usable_data;
1342 if (substr($this->_remote_file, 0, 7) != 'http://') {
1343 $this->_throw_exception( 'Cannot find http:// in '.$this->_remote_file.'!' );
1346 // Extract host information
1347 $host = substr($this->_remote_file, 7);
1348 // Extract the GET part
1350 if (strpos($host, '/') > 0) {
1351 $get = substr($host, strpos($host, '/'));
1352 $host = substr($host, 0, strpos($host, '/'));
1356 if (strpos($host, ':') > 0) {
1357 $port = substr($host, (strpos($host, ':') + 1));
1358 $host = substr($host, 0, (strpos($host, ':') - 1));
1361 // Start connection to server
1362 $fp = fsockopen($host, $port);
1364 $this->_throw_exception( $this->_remote_file.' is maybe not available.' );
1367 // Repare request line
1368 $request = sprintf("GET %s HTTP/1.0\r\nHost: %s\r\nUser-Agent: Fase4 RDF-Reader/1.40 modified by Quix0r\r\n\r\n", $get, $host);
1370 fputs($fp, $request);
1371 $reply = ''; $isContent = false; $dummy = '';
1374 while ( !feof($fp) ) {
1375 $read = trim(fgets($fp, 4096));
1376 if (substr($read, 0, 5) == '<?xml' || $isContent) {
1386 if ((count($dummy) > 0) && (count($reply) == '0') && (!$isContent)) {
1387 // Transfer content from dummy
1391 //die(htmlentities($reply));
1395 } // END _rdf_data()