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)
423 $this->_garbage_collection();
427 * With this method you can decide whether to use the normal cache and dynamic display Options or to use a static cache.
429 * 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.
430 * In this case you can not modify the display settings.
431 * processing time: ( 1.4792) --> remote file
432 * processing time: ( 0.0313) --> using 'normal cache' with display Modification turned on.
433 * processing time: ( 0.0019) --> using 'fast cache'
436 * @author Stefan Saasen <s@fase4.com>
437 * @param string $rdf RDF File (Location)
438 * @return string Displays RDF Content ( using _display() )
439 * @see _remote_file, cache()
441 function use_dynamic_display( $bool )
443 $this->_use_dynamic_display = $bool;
448 * This Method avtually parses the XML data.
451 * @author Stefan Saasen <s@fase4.com>
452 * @param string $data RDF File XML Data
453 * @see _clear_Items()
455 function _parse_xRDF( $data )
457 $this->_clear_Items();
458 $xml_parser = xml_parser_create();
459 xml_set_object($xml_parser,$this);
460 xml_parser_set_option($xml_parser,XML_OPTION_CASE_FOLDING,0);
461 xml_set_element_handler($xml_parser, '_startElement', '_endElement');
462 xml_set_character_data_handler($xml_parser, '_parseData');
463 if (!xml_parse($xml_parser, trim($data))) {
464 $this->_throw_exception(sprintf("XML error: %s at line %d",
465 xml_error_string(xml_get_error_code($xml_parser)),
466 xml_get_current_line_number($xml_parser)).'<br /><br />Exception in function parse_RDF().');
468 xml_parser_free($xml_parser);
473 * This Methods allows you to set the Refresh Time
476 * @author Stefan Saasen <s@fase4.com>
477 * @param int $seconds time files will be cached (in seconds).
481 function set_refresh( $seconds )
483 $this->_refresh = (time() - $seconds);
487 function set_salt( $saltPara )
489 $this->salt = $saltPara;
494 * This Methods allows you to set the No. of <item>s to display
497 * @param int $int No of max <item>s
498 * @author Stefan Saasen <s@fase4.com>
500 * @see _max_count, _endElement()
502 function set_max_item( $int )
504 $this->_max_count = $int;
509 * This Methods allows you to set the Cache Directory
512 * @author Stefan Saasen <s@fase4.com>
513 * @param string $dir Path to Directory.
517 function set_CacheDir( $dir )
519 if(substr($dir, -1) != '/') {
522 $this->_cache_dir = $dir;
526 * This Method displays Error Messages and terminates the Execution of the Script
529 * @param string $msg Message to display on failure
530 * @author Stefan Saasen <s@fase4.com>
532 function _throw_exception( $msg )
534 $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>";
539 * This Method clears the Array containig the Items.
542 * @author Stefan Saasen <s@fase4.com>
545 function _clear_Items( ) {
546 $this->_item = array(
553 'lastBuildDate' => '',
559 * This Method clears the Array containig the Channel Items.
562 * @author Stefan Saasen <s@fase4.com>
565 function _clear_cItems( ) {
566 $this->_citem = array(
573 'managingEditor' => '',
576 'lastBuildDate' => '',
593 * XML Parser Start Element Handler
596 * @author Stefan Saasen <s@fase4.com>
597 * @param mixed $parser a reference to the XML parser calling the handler.
598 * @param string $name contains the name of the element for which this handler is called.
599 * @param string $attrs contains an associative array with the element's attributes (if any).
600 * @see _get_ChannelData(), _clear_Items(), _type, _parse_mode, _depth, _tags, _cdepth, _ctags
602 function _startElement($parser, $name, $attrs) {
603 // We have to determine, which type of xml data we have to parse
605 $this->_type = 'rss';
606 } elseif($name == 'rdf:RDF' OR $name == 'rdf') {
607 $this->_type = 'rdf';
611 if ( $name == 'channel' AND $this->_type != 'rdf' ) {
612 $this->_parse_mode = 'channel';
613 } elseif ( ($name=='item')
615 ||($name=='textinput')
616 ||(($name=='channel') && ($this->_type != 'rss')) ) {
617 if($this->_parse_mode=='channel') {
618 $this->_get_ChannelData( $parser );
620 $this->_parse_mode = 'all';
623 if( !isset( $this->_depth[$this->get_parser_id($parser)] ) ) {
624 $this->_depth[$this->get_parser_id($parser)] = '0';
626 $this->_depth[$this->get_parser_id($parser)]++;
627 array_push($this->_tags, $name);
629 if( !isset( $this->_cdepth[$this->get_parser_id($parser)] ) ) {
630 $this->_cdepth[$this->get_parser_id($parser)] = '0';
632 $this->_cdepth[$this->get_parser_id($parser)]++;
633 array_push($this->_ctags, $name);
634 } // END _startElement()
637 * Retrives the Channel Data in <rss> File
640 * @author Stefan Saasen <s@fase4.com>
641 * @param mixed $parser a reference to the XML parser calling the handler.
642 * @see _output, _display_opt, _citem
644 function _get_ChannelData( $parser )
646 $this->_citem['link'] = trim($this->_citem['link']);
647 if (($this->_display_opt['sitelink'] == $this->_citem['link']) && (!empty($this->_display_opt['reflink'])) && (!empty($this->_display_opt['refid'])))
649 $this->_citem['link'] .= $this->_display_opt['reflink'].$this->_display_opt['refid'];
652 if( empty($this->_display_opt['channel']) OR
653 $this->_display_opt['channel'] != 'hidden') {
654 $this->_output .= "<tr><td>\n";
655 $this->_output .= "<table border=\"0\" width=\"100%\" class=\"fase4_rdf_meta\" cellspacing=\"5\" cellpadding=\"2\">\n";
656 $this->_output .= "<tr><td class=\"fase4_rdf_main_title\"><div class=\"fase4_rdf_main_title\">".htmlspecialchars($this->_citem['title'])."</div></td></tr>\n";
657 $this->_output .= "<tr><td class=\"fase4_rdf\">".strip_tags($this->_citem['description'], '<a>, <img>')."</td></tr>\n";
658 $this->_output .= "<tr><td> </td></tr>\n";
659 $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
660 if(isset($this->_display_opt['build']) && $this->_display_opt['build'] != 'hidden') {
661 if($this->_citem['lastBuildDate']){$this->_output .= 'build: '. $this->_citem['lastBuildDate'].'<br />';}
663 if(isset($this->_display_opt['cache_update']) && $this->_display_opt['cache_update'] != 'hidden' && ( $_update = $this->get_cache_update_time()) ) {
664 $this->_output .= 'cache update: '.$_update."<br />\n";
666 $this->_output .= "<a href=\"".$this->_citem['link']."\" ";
667 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
668 $this->_output .= ">".$this->_cut_string($this->_citem['link'])."</a>";
669 $this->_output .= "</td></tr>\n";
670 $this->_output .= "<tr><td><hr noshade width=\"100%\" size=\"1\"></td></tr>\n";
671 $this->_output .= "</table></td></tr>";
673 $this->_array_channel = array(
674 'title' => $this->_citem['title'],
675 'link' => $this->_citem['link'],
676 'description' => $this->_citem['description'],
677 'lastBuildDate' => $this->_citem['lastBuildDate']);
681 * XML Parser End Element Handler
684 * @author Stefan Saasen <s@fase4.com>
685 * @param mixed $parser a reference to the XML parser calling the handler.
686 * @param string $name contains the name of the element for which this handler is called.
687 * @see _clear_Items(), _type, _parse_mode, _depth, _tags, _cdepth, _ctags, _item, _output, _display_opt
689 function _endElement($parser, $name) {
690 array_pop($this->_tags);
691 $this->_depth[$this->get_parser_id($parser)]--;
692 array_pop($this->_ctags);
693 $this->_cdepth[$this->get_parser_id($parser)]--;
694 $this->_item['link'] = trim($this->_item['link']);
695 if ((!empty($this->_display_opt['refid'])) && (!empty($this->_item['link'])))
697 if (!ereg('refid=', $this->_item['link'])) $this->_item['link'] .= '?refid=' . $this->_display_opt['refid'];
701 if(empty($this->_max_count) OR $this->_item_count < $this->_max_count) {
702 if($this->_item['title'] != $this->_item['description']
703 AND $this->_item['description']) {
705 // word-wrapping added by Roland Haeder <webmaster@mxchange.org>
706 if (($this->_word_wrap > 0) && (strlen($this->_item['description']) > $this->_word_wrap))
708 // Switch off _use_nl2br
709 $this->_use_nl2br = false;
710 // First remove all \n
711 $this->_item['description'] = str_replace('\n', ' ', $this->_item['description']);
712 // Wrap with <br />\n
713 $this->_item['description'] = wordwrap($this->_item['description'], $this->_word_wrap, "*<br>\n");
715 elseif (($this->_word_wrap == '0') && (!$this->_use_nl2br))
717 // Strip tags out instead when word-wrap is disabled
718 $this->_item['description'] = strip_tags($this->_item['description'], '<a>, <img>');
721 // nl2br added by Roland Haeder <webmaster@mxchange.org>
722 if ($this->_use_nl2br) $this->_item['description'] = nl2br($this->_item['description']);
724 $this->_output .= "<tr><td class=\"fase4_rdf_title\"><div class=\"fase4_rdf_title\"><a class=\"fase4_rdf_title\" href=\"".$this->_item['link']."\" ";
725 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
726 $this->_output .= ">".strip_tags($this->_item['title'], '<a>, <img>').'</a> ('.$this->_item['pubDate'].")</div></td></tr>\n";
727 $this->_output .= "<tr><td class=\"fase4_rdf\">".$this->_item['description']."</td></tr>\n";
728 // we just display the <hr> if there is a description
729 $this->_output .= "<tr><td><hr noshade=\"noshade\" size=\"1\" /></td></tr>\n";
731 $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
732 $this->_output .= "<a href=\"".$this->_item["link"]."\" ";
733 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
734 $this->_output .= ">".$this->_item["title"]."</a></td></tr>\n";
737 $this->_array_item[] = array(
738 'title' => $this->_item['title'],
739 'link' => $this->_item['link'],
740 'description' => $this->_item['description']
743 ++$this->_item_count;
745 $this->_clear_Items();
749 if(isset($this->_display_opt['image']) && ($this->_display_opt['image'] != 'hidden') && $this->_item['url']) {
750 $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
751 $this->_output .= "<a href=\"".$this->_item['link']."\" ";
752 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
753 $this->_output .= "><img src=\"".$this->_item['url']."\"";
754 if(isset($this->_item['width']) && isset($this->_item['height'])) {
755 $this->_output .= " width=\"".$this->_item['width']."\" height=\"".$this->_item['height']."\"";
757 $this->_output .= " alt=\"".$this->_item['title']."\" border=\"0\" /></a></td></tr>\n";
759 $this->_array_image[] = array(
760 'url' => $this->_item['url'],
761 'link' => $this->_item['link'],
762 'width' => $this->_item['width'],
763 'height' => $this->_item['height']
765 $this->_clear_Items();
766 } elseif( isset($this->_display_opt['image'] ) && ($this->_display_opt['image'] == 'hidden') ) {
767 $this->_clear_Items();
773 if(isset($this->_display_opt['channel']) AND $this->_display_opt['channel'] != 'hidden' AND $this->_item['title'] != '') {
774 $this->_output .= "<tr><td>\n";
775 $this->_output .= "<table border=\"0\" width=\"100%\" class=\"fase4_rdf_meta\" cellspacing=\"5\" cellpadding=\"2\">\n";
776 $this->_output .= "<tr><td class=\"fase4_rdf\"><div class=\"fase4_rdf_title\">".htmlspecialchars($this->_item['title'])."</div></td></tr>\n";
777 $this->_output .= "<tr><td class=\"fase4_rdf\">".strip_tags($this->_item['description'], '<a>, <img>')."</td></tr>\n";
778 $this->_output .= "<tr><td> </td></tr>\n";
779 $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
780 if($this->_display_opt['build'] != 'hidden') {
781 if($this->_item['lastBuildDate']){$this->_output .= 'build: '. $this->_item['lastBuildDate'].'<br />';}
783 if($this->_display_opt['cache_update'] != 'hidden' && ( $_update = $this->get_cache_update_time()) ) {
784 $this->_output .= 'cache update: '.$_update."<br />\n";
786 $this->_output .= "<a href=\"".$this->_item['link']."\" ";
787 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
788 $this->_output .= ">".$this->_cut_string($this->_item['link'])."</a>\n";
789 $this->_output .= "</td></tr>\n";
790 $this->_output .= "</table></td></tr>\n";
792 $this->_array_channel = array(
793 'title' => $this->_item['title'],
794 'link' => $this->_item['link'],
795 'description' => $this->_item['description'],
796 'lastBuildDate' => $this->_item['lastBuildDate']
798 $this->_clear_Items();
799 $this->_clear_cItems();
803 if(isset($this->_display_opt['textinput']) && ($this->_display_opt['textinput'] != 'hidden') && $this->_item['name'] && $this->_item['link']) {
804 $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
805 $this->_output .= "<form accept-charset=\"utf-8\" action=\"".$this->_item['link']."\" ";
806 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
807 $this->_output .= "method=\"get\">\n";
808 $this->_output .= "<div class=\"fase4_rdf_title\">".$this->_item['title']."</div>";
809 $this->_output .= strip_tags($this->_item['description'], '<a>, <img>')."<br><br>\n";
810 $this->_output .= "<input class=\"fase4_rdf_input\" type=\"text\" name=\"".$this->_item['name']."\"> \n";
811 $this->_output .= "<input class=\"fase4_rdf_input\" type=\"submit\" value=\"go\">";
812 $this->_output .= "</form>\n";
813 $this->_output .= "</td></tr>\n";
814 $this->_array_textinput = array(
815 'title' => $this->_item['title'],
816 'name' => $this->_item['name'],
817 'link' => $this->_item['link'],
818 'description' => $this->_item['description']
820 $this->_clear_Items();
821 } elseif( isset($this->_display_opt['textinput']) && ($this->_display_opt['textinput'] == 'hidden') ) {
822 $this->_clear_Items();
830 * This Method returns the data from the <channel /> paragraph.
833 * @author Stefan Saasen <s@fase4.com>
835 * @see _array_channel
837 function get_array_channel( )
839 return $this->_array_channel;
843 * This Method returns the data from each <item /> paragraph.
846 * @author Stefan Saasen <s@fase4.com>
850 function get_array_item( )
852 return $this->_array_item;
856 * This Method returns the data from <textinput />.
859 * @author Stefan Saasen <s@fase4.com>
861 * @see _array_textinput
863 function get_array_textinput( )
865 return $this->_array_textinput;
869 * Getter for parser id from resource
872 * @author Roland Haeder <webmaster@mxchange.org>
875 function get_parser_id ($parser) {
880 if (is_resource($parser)) {
881 // Cast the resource into id
890 * This Method returns the data from <image />.
893 * @author Stefan Saasen <s@fase4.com>
897 function get_array_image( )
899 return $this->_array_image;
903 * XML Parser Data Handler
906 * @author Stefan Saasen <s@fase4.com>
907 * @param mixed $parser a reference to the XML parser calling the handler.
908 * @param string $text contains the character data as a string.
909 * @see _parse_mode, _item, _tags, _depth, _citem, _ctags, _cdepth
911 function _parseData($parser, $text)
913 // Deocing mode added by Roland Haeder <webmaster@mxchange.org>
914 switch ($this->_decoding_mode)
917 $text = utf8_decode($text);
921 $text = htmlentities($text);
925 $clean = preg_replace("/\s/", "", $text);
927 $text = preg_replace("/^\s+/", "", $text)."\n";
928 if($this->_parse_mode == 'all') {
929 if ( isset($this->_item[$this->_tags[$this->_depth[$this->get_parser_id($parser)]]]) &&
930 $this->_item[$this->_tags[$this->_depth[$this->get_parser_id($parser)]]] ) {
931 $this->_item[$this->_tags[$this->_depth[$this->get_parser_id($parser)]]] .= $text;
933 $this->_item[$this->_tags[$this->_depth[$this->get_parser_id($parser)]]] = $text;
935 } elseif (isset($this->_parse_mode) && $this->_parse_mode == 'channel') {
936 if ( isset($this->_citem[$this->_ctags[$this->_cdepth[$this->get_parser_id($parser)]]]) ) {
937 $this->_citem[$this->_ctags[$this->_cdepth[$this->get_parser_id($parser)]]] .= $text;
939 $this->_citem[$this->_ctags[$this->_cdepth[$this->get_parser_id($parser)]]] = $text;
946 * This Method allows you to choose if specific Parameters are displayed or not. These are:
947 * image, channel, textinput, build and cache_update. If set to "hidden" those elements won't be displayed.
950 * @author Stefan Saasen <s@fase4.com>
951 * @param array $options
954 function set_Options( $options = '' )
956 if(is_array( $options )) {
957 $this->_display_opt = $options;
960 unset($this->_display_opt);
966 * This Method allows you to define the width of the table that holds the representation of the rdf/rss file.
969 * @author Stefan Saasen <s@fase4.com>
970 * @param int $width attribute width in tag <table>
973 function set_table_width( $width = 400 )
975 $this->_table_width = $width;
980 * This Method returns an assocative Array with available Options.
982 * The Keys are the Name of the Options to be set.
983 * The Values are short Description of available Options.
986 * @author Stefan Saasen <s@fase4.com>
987 * @return array $options
990 function get_Options() {
992 'image' => "If 'image' is set to \"hidden\" no image provided by the RDF Publisher will be displayed.",
993 '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",
994 'textinput' => "If set to \"hidden\" no Input Form will be displayed",
995 'build' => "If set to \"hidden\" the Build Date (if provided) of the RDF File will not be displayed",
996 'cache_update' => "If set to \"hidden\" the Update Date/Time of the cached Rdf File will not be displayed"
1002 * This Method returns the Content of the RDF File in one string. The String actually holds the whole XML Document.
1005 * @author Stefan Saasen <s@fase4.com>
1006 * @param string $rdf RDF File (Location)
1007 * @return string XML Presentation of parsed RDF File
1008 * @see _cached_file, _remote_file, _cache_dir, _refresh, _update_cache()
1012 // checks if the cache directory already exists
1013 // if not, the cache directory will be created
1014 if(!$this->_cache_dir_ok) {
1015 $this->_create_cache_dir();
1017 if($this->_use_dynamic_display == true) {
1018 $this->_cached_file = md5('dynamic'.$this->salt.$this->_remote_file) . '.cache';
1019 $this->_cache_type = 'normal';
1021 $this->_cached_file = md5($this->salt.$this->_remote_file) . '.cache';
1022 $this->_cache_type = 'fast';
1025 $_cache_f = $this->_cache_dir.$this->_cached_file;
1027 if ( (!file_exists($_cache_f)) || (filemtime($_cache_f) < $this->_refresh) || (filesize($_cache_f) == '0')) {
1028 // We have to parse the remote file
1029 $this->_use_cached_file = false;
1030 // --> we want to provide proper Information for Use in
1031 // get_cache_update_time()
1033 if($this->_use_dynamic_display == true) {
1034 $_rdf = @implode(' ', $this->_rdf_data()); // -> proxy
1036 $this->_throw_exception( $this->_remote_file.' is not available' );
1038 $this->_parse_xRDF( $_rdf );
1039 $this->_update_cache( $_rdf );
1040 $data = $this->_output;
1042 $_rdf = @implode(' ', $this->_rdf_data()); // -> proxy
1044 $this->_throw_exception( $this->_remote_file.' is not available' );
1046 $this->_parse_xRDF( $_rdf );
1047 $this->_update_cache( $this->_output );
1048 $data = $this->_output;
1051 // we can use the cached file
1052 $this->_use_cached_file = true;
1053 if($this->_use_dynamic_display == true) {
1054 $this->_parse_xRDF( implode(' ', file($_cache_f)) );
1055 $data = $this->_output;
1057 $data = @implode(' ', file($_cache_f));
1064 * This Methods creates the Cache Directory if the specified Directory does not exist.
1067 * @author Stefan Saasen <s@fase4.com>
1068 * @param string $dir Path to Directory.
1070 * @see _cache_dir, _cache_dir_ok
1072 function _create_cache_dir()
1075 if(!@is_dir($this->_cache_dir)) {
1076 $arr = explode('/', $this->_cache_dir);
1081 for($i = '0';$i<$c;$i++)
1084 $path .= $arr[$i].'/';
1085 if(!@is_dir($path)) {
1086 if(!@mkdir($path, 0777)) {
1087 $this->_throw_exception("failed to create directory:<b>".$this->_cache_dir."</b>.<br /><br />Exception on Line: ".__LINE__);
1093 $this->_cache_dir_ok = true;
1096 $this->_cache_dir_ok = true;
1099 } // END _create_cache_dir()
1102 * This Method updates the cached RDF Files and synchronises them with their remote Counterparts.
1105 * @author Stefan Saasen <s@fase4.com>
1106 * @param string $rdf RDF File (Location)
1107 * @see _cache_dir, _cached_file, _throw_exception()
1109 function _update_cache( $content = '' )
1111 $_local = @fopen( $this->_cache_dir.$this->_cached_file, 'w' );
1113 $this->_throw_exception( 'Cannot open '.$this->_cached_file.'<br /><br />Exception at Line: '.__LINE__ );
1116 if (fwrite( $_local, $content) === false) {
1117 $this->_throw_exception( 'Cannot write to '.$this->_cached_file.'<br /<br />Exeception at Line: '.__LINE__);
1121 @chmod( $this->_cache_dir.$this->_cached_file, 0666);
1123 } // END _update_cache()
1126 * This Method returns the Date/Time of last Cache Update of the actually parsed RDF File.
1129 * @author Stefan Saasen <s@fase4.com>
1130 * @return string Date/Time of last Update
1131 * @see _cache_dir, _cached_file
1133 function get_cache_update_time()
1135 return (file_exists($this->_cache_dir.$this->_cached_file))?date('d.m.Y H:i:s', filemtime($this->_cache_dir.$this->_cached_file)):'Cachemiss';
1136 } // END get_cache_update_time()
1139 * This Method returns the Type of Cache that was used ('normal' or 'fast')
1142 * @author Stefan Saasen <s@fase4.com>
1143 * @param string $rdf RDF File (Location)
1144 * @return string Displays RDF Content ( using _display() )
1145 * @see _remote_file, cache()
1147 function get_CacheType()
1149 return $this->_cache_type;
1153 * Returns true if cached file was used, otherwise false
1156 * @author Stefan Saasen <s@fase4.com>
1157 * @return array $options
1158 * @see _use_cached_file
1160 function is_cachedFile()
1162 return $this->_use_cached_file;
1166 * This Method deletes all the cached Files.
1168 * Please keep in mind to use this method just as a 'manual garbage collection'
1169 * You should cache the rss/rdf files locally to avoid unnecessary traffic.
1170 * (Both for your visitors and the Publisher)
1173 * @author Stefan Saasen <s@fase4.com>
1176 function clear_cache()
1178 $dir = dir($this->_cache_dir);
1179 while($file=$dir->read()) {
1180 // Exclude directories
1181 if (is_file($dir->path.$file) && substr($file, -6, 6) != '.cache' && substr($file, -4, 4) != '.log') {
1182 if(!@unlink($dir->path.$file)) {
1183 $this->_throw_exception("Unable to unlink ".$dir->path.$file."<br />\n<br />\nException at Line: ".__LINE__ );
1190 } // END clear_cache()
1193 * Cuts the String $string after $str_len and adds '... '
1196 * @param string $string String to be shortened
1197 * @param int $str_len length of the returned String (overall length including '... ')
1198 * @return string Cut String
1200 function _cut_string( $string, $str_len = '30' )
1202 if(strlen(trim($string))>$str_len) {
1203 $string = substr( trim($string) , 0, $str_len - 4);
1207 } // END _cut_string()
1210 * this Method implements simple Garbage Collection
1213 * @author Stefan Saasen <s@fase4.com>
1214 * @see _cache_dir, gc_probability, gc_maxlifetime
1216 function _garbage_collection()
1218 srand((double) microtime() * 1000000);
1219 if (mt_rand(1, 100) <= $this->gc_probability) {
1220 $dir = dir($this->_cache_dir);
1221 while($file=$dir->read()) {
1222 if (is_file($dir->path.$file) && substr($file, -6, 6) != '.cache' && substr($file, -4, 4) != '.log' && filemtime($dir->path.$file) <= time() - $this->_refresh ) {
1223 @unlink($dir->path.$file);
1230 /* ==== Proxy/Auth methods ==== */
1233 * this method sets a proxy server
1236 * @param string $phost Proxy Host
1237 * @param string $pport Prox Port
1238 * @author Marco Kraus <marco.kraus@siemens.com>
1240 function set_proxy($phost, $pport)
1242 $this->_use_proxy = true;
1245 $this->_phost = $phost;
1248 $this->_pport = $pport;
1252 * this method sets a proxy server authentification
1255 * @param string $pname Username
1256 * @param string $ppaswd Password
1257 * @author Marco Kraus <marco.kraus@siemens.com>
1259 function set_proxy_auth( $pname, $ppasswd )
1261 $this->_use_proxy_auth = true;
1264 $this->_pname = $pname;
1267 $this->_ppasswd = $ppasswd;
1272 * gets _remote_file into an array
1274 * needed, cause if you use a proxy, you have to open
1275 * a raw-tcp-socket to get the data
1278 * @author Marco Kraus <Marco.Kraus@siemens.com>
1280 * @see _use_proxy, cache()
1282 function _rdf_data()
1284 if ( $this->_use_proxy == true )
1286 // we need a raw socket here to connect to proxy
1287 $fp = fsockopen($this->_phost,$this->_pport);
1290 $this->_throw_exception( $this->_remote_file.' is not available with proxy' );
1292 if ( $this->_use_proxy_auth == true ) {
1293 fputs($fp, "GET ".$this->_remote_file." HTTP/1.0\r\nUser-Agent: Fase4 RDF-Reader/1.40 modified by Quix0r\r\n\r\n");
1295 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");
1300 for ( $i = '0'; !feof ($fp) ; $i++)
1302 $usable_data[$i] = "";
1303 $usable_data[$i] = fgets($fp,4096);
1305 // PARSE HEADER ---- first line has to be <?xml, second rdf or rss, and third is blank
1307 // strstr did not fit (ask Rasmus why), so we compare each character
1308 if ( ($usable_data[$i][0] == '<' ) &&
1309 ($usable_data[$i][1] == '?' ) &&
1310 ($usable_data[$i][2] == 'x' ) &&
1311 ($usable_data[$i][3] == 'm' ) &&
1312 ($usable_data[$i][4] == 'l' ) ) {
1313 $usable_data[0] = $usable_data[$i]; // save current field
1314 $i = 1; // just reset array to start
1317 // there seems to be proxystuff after the <?xml....we delete this
1319 ($usable_data[$i][0] == '<' ) &&
1320 ($usable_data[$i][1] == 'r' ) &&
1321 ($usable_data[$i][2] == 'd' ) &&
1322 ($usable_data[$i][3] == 'f' ) &&
1323 ($usable_data[$i][4] == ':' )
1327 ($usable_data[$i][0] == '<' ) &&
1328 ($usable_data[$i][1] == 'r' ) &&
1329 ($usable_data[$i][2] == 's' ) &&
1330 ($usable_data[$i][3] == 's' )
1334 $usable_data[1] = $usable_data[$i]; // save current field
1335 $usable_data[2] = "\n";
1336 $i = 2; // just reset array to start
1341 return $usable_data;
1343 if (substr($this->_remote_file, 0, 7) != 'http://') {
1344 $this->_throw_exception( 'Cannot find http:// in '.$this->_remote_file.'!' );
1347 // Extract host information
1348 $host = substr($this->_remote_file, 7);
1349 // Extract the GET part
1351 if (strpos($host, '/') > 0) {
1352 $get = substr($host, strpos($host, '/'));
1353 $host = substr($host, 0, strpos($host, '/'));
1357 if (strpos($host, ':') > 0) {
1358 $port = substr($host, (strpos($host, ':') + 1));
1359 $host = substr($host, 0, (strpos($host, ':') - 1));
1362 // Start connection to server
1363 $fp = fsockopen($host, $port);
1365 $this->_throw_exception( $this->_remote_file.' is maybe not available.' );
1368 // Repare request line
1369 $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);
1371 fputs($fp, $request);
1372 $reply = ''; $isContent = false; $dummy = '';
1375 while ( !feof($fp) ) {
1376 $read = trim(fgets($fp, 4096));
1377 if (substr($read, 0, 5) == '<?xml' || $isContent) {
1387 if ((count($dummy) > 0) && (count($reply) == '0') && (!$isContent)) {
1388 // Transfer content from dummy
1392 //die(htmlentities($reply));
1396 } // END _rdf_data()