redirection of invalid or deleted mail orders improved, several code conventions...
[mailer.git] / inc / rdf.class.php
1 <?php
2 /* $Id: rdf.class.php,v 1.40 2003/07/06 20:33:58 sts Exp $ */
3
4 //
5 // +----------------------------------------------------------------------+
6 // | rss Parser                                                           |
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/                                          |
13 // |                                                                      |
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 // +----------------------------------------------------------------------+
19 // |                                                                      |
20 // | Maintainer and initial developer:                                    |
21 // | Stefan Saasen <s@fase4.com>                                          |
22 // |                                                                      |
23 // | Proxy and authentication methods added by:                           |
24 // | Marco Kraus <marco.kraus@siemens.com>                                |
25 // |                                                                      |
26 // | Decoding of data by htmlentities or utf8_decode added by:            |
27 // | Roland Haeder <webmaster@mxchange.org>                               |
28 // |                                                                      |
29 // +----------------------------------------------------------------------+
30 // | Ref:                                                                 |
31 // |   @link http://www.fase4.com/rdf/                   Latest release   |
32 // +----------------------------------------------------------------------+
33
34 /**
35 * Class RSS Parser
36 *
37 * This class offers methods to parse RSS Files
38 *
39 * @link      http://www.fase4.com/rdf/ Latest release of this class
40 * @package   rss
41 * @copyright Copyright (c) 2001 fase4.com. All rights reserved.
42 * @author    Stefan Saasen <s@fase4.com>
43 * @version   1.7 ($Date: 2003/07/06 20:33:58 $) $Revision: 1.40 $
44 * @access    public
45 */
46
47 class fase4_rdf {
48
49     /**
50     * Word-wrapping mode for description, set it to 0 do disable this feature! Ommits _use_nl2br!
51     *
52     * @access private
53     * @var    integer
54     */
55     var $_word_wrap = 0;
56
57     /**
58     * Wether to recode \n -> <br /> or not in description
59     *
60     * @access private
61     * @var    boolean
62     */
63     var $_use_nl2br = true;
64
65     /**
66     * Sets the decoding mode of the read data (UTF8 scrambles some german umlauts here!)
67     *
68     * "htmlentities" - Use the function htmlentities()
69     * "utf8_decode"  - Use the function ut8_decode() when you have UTF8 encoded text
70     *
71     * @access private
72     * @var    string
73     */
74     var $_decoding_mode = "utf8_decode";
75
76     /**
77     * If $_link_target is set a target='xxx' attribute in each <a /> and <form /> html tag will be added
78     *
79     * Possible values are "_blank", "_content", "_parent", "_self", "_top"
80     *
81     * @access private
82     * @var    string
83     */
84     var $_link_target = "_blank";
85
86     /**
87     * vars for proxy settings - Prox Host
88     *
89     * @access private
90     * @var      string
91     */
92     var $_phost = "";
93
94     /**
95     * vars for proxy settings - Prox Port
96     *
97     * @access private
98     * @var      string
99     */
100     var $_pport = "";
101
102     /**
103     * vars for proxy settings - Prox Username
104     *
105     * @access private
106     * @var      string
107     */
108     var $_pname = "";
109
110     /**
111     * vars for proxy settings - Prox Password
112     *
113     * @access private
114     * @var      string
115     */
116     var $_ppasswd = "";
117
118     /**
119     * just a flag for checking if proxy-support should be enabled
120     * set default to false (will be enabled if set_proxy is called)
121     *
122     * @access   private
123     * @see      set_proxy()
124     * @var      bool
125     */
126     var $_use_proxy = false;
127
128     /**
129     * just a flag for checking if proxy-support with authentication
130     * should be enabled
131     * set default to false (will be enabled if set_proxy is called)
132     *
133     * @access   private
134     * @see      set_proxy()
135     * @var      boolean
136     */
137     var $_use_proxy_auth = false;
138
139     /**
140     * The time the Files will be cached (in seconds).
141     *
142     * @access private
143     * @var    int
144     */
145     var $_refresh = 60;   // int
146
147     /**
148     * The Name of the cached File.
149     *
150     * @access private
151     * @var    string
152     */
153     var $_cached_file = "";   // String
154
155     /**
156     * Indicates whether the cached or the remote file was used.
157     *
158     * @access private
159     * @var    boolean
160     */
161     var $_use_cached_file = true;
162
163     /**
164     * (fast|normal) depends on _use_dynamic_display(). _use_dynamic_display( TRUE ) -> 'normal', otherwise 'fast'
165     *
166     * @access private
167     * @var    string
168     */
169     var $_cache_type = "fast";
170
171     /**
172     * The Name of the Remote File.
173     *
174     * @access private
175     * @var    string
176     */
177     var $_remote_file = "";
178
179     /**
180     * Path to the Cache Directory.
181     *
182     * @access private
183     * @var    string
184     */
185     var $_cache_dir = "cache/";  // String
186
187     /**
188     * Indicates whether the Creating of the Cache Directory needs to be done or not.
189     *
190     * @access private
191     * @var    boolean
192     */
193     var $_cache_dir_ok = false;
194
195     /**
196     * Type of the file to be parsed (RSS or RDF).
197     *
198     * The Type depends on the root node
199     *
200     * @access private
201     * @var    string
202     */
203     var $_type = "rss"; // string (rss or rdf)
204
205     /**
206     * Array of Display Settings.
207     *
208     * Specific Parameters can be set to hidden. These are:
209     * image, channel and textinput. If set to "hidden" those elements won't be displayed.
210     *
211     * @access private
212     * @var    array
213     */
214     var $_display_opt = array(
215                 'build' => "",
216                 'image' => "",
217                 'channel' => "",
218                 'textinput' => "",
219                 'cache_update' => "",
220                 'sitelink' => "",
221                 'refid' => "",
222                 'reflink' => "",
223     );
224
225     /**
226     * Defines the width attribute in the table that holds the rdf/rss representation
227     *
228     * @access private
229     * @var    int
230     * @see    see_table_width()
231     */
232     var $_table_width = "100%";
233
234     /**
235     * Indicates whether or not to use dynamic Display Settings
236     *
237     * @access private
238     * @var    array
239     */
240     var $_use_dynamic_display = false;
241
242     /**
243     * <item> count
244     *
245     * @access private
246     * @var    int
247     */
248     var $_item_count = 0;
249
250     /**
251     * No of max <item>s
252     *
253     * @access private
254     * @var    boolean
255     */
256     var $_max_count = false;
257
258     /**
259     * Array containing the content of <channel />
260     *
261     * @access private
262     * @var    array
263     */
264     var $_array_channel = array();
265
266     /**
267     * Array containing the content of each <item />
268     *
269     * @access private
270     * @var    array
271     */
272     var $_array_item = array();
273
274     /**
275     * Array containing the content of <textinput />
276     *
277     * @access private
278     * @var    array
279     */
280     var $_array_textinput = array();
281
282     /**
283     * Array containing the content of <image />
284     *
285     * @access private
286     * @var    array
287     */
288     var $_array_image = array();
289
290     /**
291     * Array containing the Channel content. Just For internal XML Parser Purposes.
292     *
293     * @access private
294     * @var    array
295     */
296     var $_citem = array();
297
298     /**
299     * Array containing the Channel Parser Depth. Just For internal XML Parser Purposes.
300     *
301     * @access private
302     * @var    array
303     */
304     var $_cdepth = array();
305
306     /**
307     * Array containing the Channel tags. Just For internal XML Parser Purposes.
308     *
309     * @access private
310     * @var    array
311     */
312     var $_ctags = array( "x" );
313
314     /**
315     * Array containing the Channel content. Just For internal XML Parser Purposes.
316     *
317     * @access private
318     * @var    array
319     */
320     var $_item = array();   // Array
321
322     /**
323     * Array containing the Channel Parser Depth. Just For internal XML Parser Purposes.
324     *
325     * @access private
326     * @var    array
327     */
328     var $_depth = array();  // Array
329
330     /**
331     * Array containing the tags. Just For internal XML Parser Purposes.
332     *
333     * @access private
334     * @var    array
335     */
336     var $_tags = array( "x" );  // Array
337
338     /**
339     * Garbage collection: probability in percent
340     *
341     * @var      integer     0 => never
342     * @access   public
343     */
344     var $gc_probability = 1;
345
346     /**
347     * HTML Output
348     *
349     * @var      string
350     * @access   private
351     */
352     var $_output = "";
353
354     /**
355     * @var  string
356     */
357     var $_parse_mode = "";
358
359     // Output variable
360     var $out = "";
361
362     // Salt for hashing
363     var $salt = "";
364
365     /**
366     * Constructor of our Class
367     *
368     * This Method checks if the Cache Directory can be found. Otherwise it tries to creat the Cache Directory at the specified Path.
369     * Additionally the Refresh Time is set to a default Value of 1200s (20 min).
370         *
371     * @access    public
372         * @author    Stefan Saasen <s@fase4.com>
373         * @see           _refresh
374     */
375     function fase4_rdf()
376     {
377         // default Value, to be overwritten in set_refresh()
378         $this->_refresh = (time() - 1200);
379         $this->_clear_cItems();
380         $this->_clear_Items();
381     }
382
383     /**
384     * This Method starts the parsing of the specified RDF File. The File can be a local or a remote File.
385     *
386     * @access    public
387         * @author    Stefan Saasen <s@fase4.com>
388     * @param     string $rdf    RDF File (Location)
389     * @return    string Displays RDF Content ( using _display() )
390         * @see           _remote_file, cache()
391     */
392     function parse_RDF( $rdf )
393     {
394         unset($this->_array_item);
395         $this->_remote_file = $rdf;
396         $this->out .= "<!-- http://www.fase4.com/rdf/ -->";
397         $this->out .= "<table width=\"".$this->_table_width."\">";
398         $this->out .= $this->cache();
399         $this->out .= "</table>";
400         $this->_output = "";
401         $this->_item_count = 0;
402         return true;
403     }
404
405     /**
406     * This Method is called when all parsing is finished to use the garbage collection
407     *
408     * @access    public
409         * @author    Stefan Saasen <s@fase4.com>
410     * @param     string $rdf    RDF File (Location)
411     * @return    string Displays RDF Content ( using _display() )
412         * @see           _remote_file, cache()
413     */
414     function finish($return = false)
415     {
416                 if (!$return) {
417                         echo $this->out;
418                 } else {
419                         return $this->out;
420                 }
421         flush();
422         $this->_garbage_collection();
423     }
424
425     /**
426     * With this method you can decide whether to use the normal cache and dynamic display Options or to use a static cache.
427     *
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'
433     *
434     * @access    public
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()
439     */
440     function use_dynamic_display( $bool )
441     {
442         $this->_use_dynamic_display = $bool;
443         return true;
444     }
445
446     /**
447     * This Method avtually parses the XML data.
448     *
449     * @access    private
450         * @author    Stefan Saasen <s@fase4.com>
451     * @param     string $data    RDF File XML Data
452         * @see           _clear_Items()
453     */
454     function _parse_xRDF( $data )
455     {
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().");
466             }
467         xml_parser_free($xml_parser);
468     }
469
470
471     /**
472     * This Methods allows you to set the Refresh Time
473     *
474     * @access    public
475         * @author    Stefan Saasen <s@fase4.com>
476     * @param     int $seconds time files will be cached (in seconds).
477         * @return        boolean
478         * @see           _refresh
479     */
480     function set_refresh( $seconds )
481     {
482         $this->_refresh = (time() - $seconds);
483         return true;
484     }
485
486     function set_salt( $saltPara )
487     {
488         $this->salt = $saltPara;
489         return true;
490     }
491
492     /**
493     * This Methods allows you to set the No. of <item>s to display
494     *
495     * @access    public
496     * @param     int $int No of max <item>s
497         * @author    Stefan Saasen <s@fase4.com>
498         * @return        boolean
499         * @see           _max_count, _endElement()
500     */
501     function set_max_item( $int )
502     {
503         $this->_max_count = $int;
504         return true;
505     }
506
507     /**
508     * This Methods allows you to set the Cache Directory
509     *
510     * @access    public
511         * @author    Stefan Saasen <s@fase4.com>
512     * @param     string $dir Path to Directory.
513         * @return        boolean
514         * @see           _cache_dir
515     */
516     function set_CacheDir( $dir )
517     {
518         if(substr($dir, -1) != "/") {
519             $dir = $dir."/";
520         }
521         $this->_cache_dir = $dir;
522     }
523
524     /**
525     * This Method displays Error Messages and terminates the Execution of the Script
526     *
527     * @access    private
528     * @param     string $msg Message to display on failure
529         * @author    Stefan Saasen <s@fase4.com>
530     */
531     function _throw_exception( $msg )
532     {
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>";
534         return true;
535     }
536
537     /**
538     * This Method clears the Array containig the Items.
539     *
540     * @access    private
541         * @author    Stefan Saasen <s@fase4.com>
542     * @see       _item
543     */
544     function _clear_Items( ) {
545         $this->_item = array(
546             'title'=>"",
547             'link'=>"",
548             'description'=>"",
549             'url'=>"",
550             'language'=>"",
551             'pubDate'=>"",
552             'lastBuildDate'=>"",
553             'width'=>"",
554             'height'=>""
555         );
556     }
557     /**
558     * This Method clears the Array containig the Channel Items.
559     *
560     * @access    private
561         * @author    Stefan Saasen <s@fase4.com>
562     * @see       _item
563     */
564     function _clear_cItems( ) {
565         $this->_citem = array(
566             'title'=>"",
567             'link'=>"",
568             'description'=>"",
569             'url'=>"",
570             'language'=>"",
571             'copyright'=>"",
572             'managingEditor'=>"",
573             'webMaster'=>"",
574             'pubDate'=>"",
575             'lastBuildDate'=>"",
576             'category'=>"",
577             'generator'=>"",
578             'docs'=>"",
579             'cloud'=>"",
580             'ttl'=>"",
581             'image'=>"",
582             'textinput'=>"",
583             'skipHours'=>"",
584             'skipDays' =>"",
585             'sitelink'=>"",
586             'refid'=>"",
587             'reflink'=>"",
588         );
589     }
590
591     /**
592     * XML Parser Start Element Handler
593     *
594     * @access    private
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
600     */
601     function _startElement($parser, $name, $attrs) {
602         // We have to determine, which type of xml data we have to parse
603         if($name == "rss") {
604             $this->_type = "rss";
605         } elseif($name == "rdf:RDF" OR $name == "rdf") {
606             $this->_type = "rdf";
607         }
608
609
610         if ( $name == "channel" AND $this->_type != "rdf" ) {
611             $this->_parse_mode = "channel";
612         } elseif ( ($name=="item")
613                     ||($name=="image")
614                     ||($name=="textinput")
615                     ||(($name=="channel") && ($this->_type != "rss")) ) {
616             if($this->_parse_mode=="channel") {
617                 $this->_get_ChannelData( $parser );
618             }
619             $this->_parse_mode = "all";
620         }
621
622         if( !isset( $this->_depth[$parser] ) ) {
623             $this->_depth[$parser] = 0;
624         }
625         $this->_depth[$parser]++;
626         array_push($this->_tags, $name);
627
628         if( !isset( $this->_cdepth[$parser] ) ) {
629             $this->_cdepth[$parser] = 0;
630         }
631         $this->_cdepth[$parser]++;
632         array_push($this->_ctags, $name);
633     }   // END _startElement()
634
635     /**
636     * Retrives the Channel Data in <rss> File
637     *
638     * @access    private
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
642     */
643     function _get_ChannelData( $parser )
644     {
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"])))
647                 {
648                     $this->_citem["link"] .= $this->_display_opt["reflink"].$this->_display_opt["refid"];
649                 }
650
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>&nbsp;</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 />";}
661                 }
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";
664                 }
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>";
671                 }
672                     $this->_array_channel = array(  "title"=>$this->_citem["title"],
673                                                     "link"=>$this->_citem["link"],
674                                                     "description"=>$this->_citem["description"],
675                                                     "lastBuildDate"=>$this->_citem["lastBuildDate"]);
676     }
677
678     /**
679     * XML Parser End Element Handler
680     *
681     * @access    private
682         * @author    Stefan Saasen <s@fase4.com>
683     * @param     mixed  $parser a reference to the XML parser calling the handler.
684     * @param     string $name contains the name of the element for which this handler is called.
685         * @see           _clear_Items(), _type, _parse_mode, _depth, _tags, _cdepth, _ctags, _item, _output, _display_opt
686     */
687     function _endElement($parser, $name) {
688         array_pop($this->_tags);
689         $this->_depth[$parser]--;
690         array_pop($this->_ctags);
691         $this->_cdepth[$parser]--;
692         $this->_item["link"] = trim($this->_item["link"]);
693            if ((!empty($this->_display_opt["refid"])) && (!empty($this->_item["link"])))
694            {
695             if (!ereg("refid=", $this->_item["link"])) $this->_item["link"] .= "?refid=" . $this->_display_opt["refid"];
696            }
697         switch ($name) {
698             case "item":
699                 if(empty($this->_max_count) OR $this->_item_count < $this->_max_count) {
700                     if($this->_item["title"] != $this->_item["description"]
701                                             AND $this->_item["description"]) {
702
703                         // word-wrapping added by Roland Haeder <webmaster@mxchange.org>
704                            if (($this->_word_wrap > 0) && (strlen($this->_item["description"]) > $this->_word_wrap))
705                         {
706                             // Switch off _use_nl2br
707                             $this->_use_nl2br = false;
708                             // First remove all \n
709                             $this->_item["description"] = str_replace('\n', ' ', $this->_item["description"]);
710                             // Wrap with <br />\n
711                             $this->_item["description"] = wordwrap($this->_item["description"], $this->_word_wrap, "*<br>\n");
712                         }
713                          elseif (($this->_word_wrap == 0) && (!$this->_use_nl2br))
714                         {
715                             // Strip tags out instead when word-wrap is disabled
716                             $this->_item["description"] = strip_tags($this->_item["description"], "<a>, <img>");
717                         }
718
719                         // nl2br added by Roland Haeder <webmaster@mxchange.org>
720                         if ($this->_use_nl2br) $this->_item["description"] = nl2br($this->_item["description"]);
721
722                         $this->_output .= "<tr><td class=\"fase4_rdf_title\"><div class=\"fase4_rdf_title\"><a class=\"fase4_rdf_title\" href=\"".$this->_item["link"]."\" ";
723                         if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
724                         $this->_output .= ">".strip_tags($this->_item["title"], "<a>, <img>")."</a> (".$this->_item["pubDate"].")</div></td></tr>\n";
725                                         $this->_output .= "<tr><td class=\"fase4_rdf\">".$this->_item["description"]."</td></tr>\n";
726                         // we just display the <hr> if there is a description
727                         $this->_output .= "<tr><td><hr noshade=\"noshade\" size=\"1\" /></td></tr>\n";
728                     } else {
729                         $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
730                         $this->_output .= "<a href=\"".$this->_item["link"]."\" ";
731                         if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
732                         $this->_output .= ">".$this->_item["title"]."</a></td></tr>\n";
733                     }
734                         $this->_array_item[] = array(   "title"=>$this->_item["title"],
735                                                         "link"=>$this->_item["link"],
736                                                         "description"=>$this->_item["description"]);
737                         ++$this->_item_count;
738                 }
739                     $this->_clear_Items();
740             break;
741             case "image":
742                 if(isset($this->_display_opt["image"]) && ($this->_display_opt["image"] != "hidden") && $this->_item["url"]) {
743                     $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
744                     $this->_output .= "<a href=\"".$this->_item["link"]."\" ";
745                     if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
746                     $this->_output .= "><img src=\"".$this->_item["url"]."\"";
747                 if(isset($this->_item["width"]) && isset($this->_item["height"])) {
748                     $this->_output .= " width=\"".$this->_item["width"]."\" height=\"".$this->_item["height"]."\"";
749                 }
750                 $this->_output .= " alt=\"".$this->_item["title"]."\" border=\"0\" /></a></td></tr>\n";
751
752                     $this->_array_image[] = array(  "url"=>$this->_item["url"],
753                                                     "link"=>$this->_item["link"],
754                                                     "width"=>$this->_item["width"],
755                                                     "height"=>$this->_item["height"]);
756                     $this->_clear_Items();
757                 } elseif( isset($this->_display_opt["image"] ) && ($this->_display_opt["image"] == "hidden") ) {
758                     $this->_clear_Items();
759                 }
760
761             break;
762             case "channel":
763                 if(isset($this->_display_opt["channel"]) AND $this->_display_opt["channel"] != "hidden" AND $this->_item["title"] != '') {
764                     $this->_output .= "<tr><td>\n";
765                     $this->_output .= '<table border="0" width="100%" class="fase4_rdf_meta" cellspacing="5" cellpadding="2">'."\n";
766                     $this->_output .= "<tr><td class=\"fase4_rdf\"><div class=\"fase4_rdf_title\">".htmlspecialchars($this->_item["title"])."</div></td></tr>\n";
767                     $this->_output .= "<tr><td class=\"fase4_rdf\">".strip_tags($this->_item["description"], "<a>, <img>")."</td></tr>\n";
768                     $this->_output .= "<tr><td>&nbsp;</td></tr>\n";
769                     $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
770                 if($this->_display_opt["build"] != "hidden") {
771                     if($this->_item["lastBuildDate"]){$this->_output .= "build: ". $this->_item["lastBuildDate"]."<br />";}
772                 }
773                 if($this->_display_opt["cache_update"] != "hidden" && ( $_update = $this->get_cache_update_time()) ) {
774                     $this->_output .= "cache update: ".$_update."<br />\n";
775                 }
776                 $this->_output .= "<a href=\"".$this->_item["link"]."\" ";
777                 if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
778                 $this->_output .= ">".$this->_cut_string($this->_item["link"])."</a>\n";
779                 $this->_output .= "</td></tr>\n";
780                 $this->_output .= "</table></td></tr>\n";
781                 }
782                     $this->_array_channel = array(  "title"=>$this->_item["title"],
783                                                     "link"=>$this->_item["link"],
784                                                     "description"=>$this->_item["description"],
785                                                     "lastBuildDate"=>$this->_item["lastBuildDate"]);
786                     $this->_clear_Items();
787                     $this->_clear_cItems();
788             break;
789                         case "textinput":
790                 if(isset($this->_display_opt["textinput"]) && ($this->_display_opt["textinput"] != "hidden") && $this->_item["name"] && $this->_item["link"]) {
791                     $this->_output .= "<tr><td class=\"fase4_rdf\">\n";
792                                 $this->_output .= "<form action=\"".$this->_item["link"]."\" ";
793                     if(isset($this->_link_target)) { $this->_output .= "target=\"".$this->_link_target."\" "; }
794                     $this->_output .= "method=\"get\">\n";
795                     $this->_output .= "<div class=\"fase4_rdf_title\">".$this->_item["title"]."</div>";
796                     $this->_output .= strip_tags($this->_item["description"], "<a>, <img>")."<br><br>\n";
797                     $this->_output .= "<input class=\"fase4_rdf_input\" type=\"text\" name=\"".$this->_item["name"]."\">&nbsp;\n";
798                     $this->_output .= "<input class=\"fase4_rdf_input\" type=\"submit\" value=\"go\">";
799                     $this->_output .= "</form>\n";
800                     $this->_output .= "</td></tr>\n";
801                     $this->_array_textinput = array(    "title"=>$this->_item["title"],
802                                                         "name"=>$this->_item["name"],
803                                                         "link"=>$this->_item["link"],
804                                                         "description"=>$this->_item["description"]);
805                     $this->_clear_Items();
806                 } elseif( isset($this->_display_opt["textinput"]) && ($this->_display_opt["textinput"] == "hidden") ) {
807                     $this->_clear_Items();
808                 }
809
810                         break;
811         }
812     }
813
814     /**
815     * This Method returns the data from the <channel /> paragraph.
816     *
817     * @access    public
818         * @author    Stefan Saasen <s@fase4.com>
819     * @return    array
820         * @see           _array_channel
821     */
822     function get_array_channel( )
823     {
824         return $this->_array_channel;
825     }
826
827     /**
828     * This Method returns the data from each <item /> paragraph.
829     *
830     * @access    public
831         * @author    Stefan Saasen <s@fase4.com>
832     * @return    array
833         * @see           _array_item
834     */
835     function get_array_item( )
836     {
837         return $this->_array_item;
838     }
839
840     /**
841     * This Method returns the data from <textinput />.
842     *
843     * @access    public
844         * @author    Stefan Saasen <s@fase4.com>
845     * @return    array
846         * @see           _array_textinput
847     */
848     function get_array_textinput( )
849     {
850         return $this->_array_textinput;
851     }
852
853     /**
854     * This Method returns the data from <image />.
855     *
856     * @access    public
857         * @author    Stefan Saasen <s@fase4.com>
858     * @return    array
859         * @see           _array_image
860     */
861     function get_array_image( )
862     {
863         return $this->_array_image;
864     }
865
866     /**
867     * XML Parser Data Handler
868     *
869     * @access    private
870         * @author    Stefan Saasen <s@fase4.com>
871     * @param     mixed  $parser a reference to the XML parser calling the handler.
872     * @param     string $text contains the character data as a string.
873         * @see           _parse_mode, _item, _tags, _depth, _citem, _ctags, _cdepth
874     */
875     function _parseData($parser, $text)
876     {
877         // Deocing mode added by Roland Haeder <webmaster@mxchange.org>
878         switch ($this->_decoding_mode)
879         {
880         case "utf8_decode":
881             $text = utf8_decode($text);
882             break;
883
884         case "htmlentities":
885             $text = htmlentities($text);
886             break;
887         }
888
889         $clean = preg_replace("/\s/", "", $text);
890         if ($clean) {
891             $text = preg_replace("/^\s+/", "", $text)."\n";
892                 if($this->_parse_mode == "all") {
893                         if ( isset($this->_item[$this->_tags[$this->_depth[$parser]]]) &&
894                             $this->_item[$this->_tags[$this->_depth[$parser]]] ) {
895                            $this->_item[$this->_tags[$this->_depth[$parser]]] .= $text;
896                         } else {
897                            $this->_item[$this->_tags[$this->_depth[$parser]]] = $text;
898                         }
899                 } elseif (isset($this->_parse_mode) && $this->_parse_mode == "channel") {
900                         if ( isset($this->_citem[$this->_ctags[$this->_cdepth[$parser]]]) ) {
901                            $this->_citem[$this->_ctags[$this->_cdepth[$parser]]] .= $text;
902                         } else {
903                            $this->_citem[$this->_ctags[$this->_cdepth[$parser]]] = $text;
904                         }
905                 }
906         }
907     }
908
909     /**
910     * This Method allows you to choose if specific Parameters are displayed or not. These are:
911     * image, channel, textinput, build and cache_update. If set to "hidden" those elements won't be displayed.
912     *
913     * @access    public
914         * @author    Stefan Saasen <s@fase4.com>
915     * @param     array  $options
916         * @see           _display_opt
917     */
918     function set_Options( $options = "" )
919     {
920         if(is_array( $options )) {
921             $this->_display_opt = $options;
922             return true;
923         } else {
924             unset($this->_display_opt);
925             return false;
926         }
927     }
928
929     /**
930     * This Method allows you to define the width of the table that holds the representation of the rdf/rss file.
931     *
932     * @access    public
933         * @author    Stefan Saasen <s@fase4.com>
934     * @param     int  $width  attribute width in tag <table>
935         * @see           _table_width
936     */
937     function set_table_width( $width = 400 )
938     {
939         $this->_table_width = $width;
940         return true;
941     }
942
943     /**
944     * This Method returns an assocative Array with available Options.
945     *
946     * The Keys are the Name of the Options to be set.
947     * The Values are  short Description of available Options.
948     *
949     * @access    public
950         * @author    Stefan Saasen <s@fase4.com>
951     * @return    array  $options
952         * @see           _display_opt
953     */
954     function get_Options()
955     {
956         $options = array(   "image"=>"If 'image' is set to \"hidden\" no image provided by the RDF Publisher will be displayed.",
957                             "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",
958                             "textinput"=>"If set to \"hidden\" no Input Form will be displayed",
959                             "build"=>"If set to \"hidden\" the Build Date (if provided) of the RDF File will not be displayed",
960                             "cache_update"=>"If set to \"hidden\" the Update Date/Time of the cached Rdf File will not be displayed");
961         return $options;
962     }
963
964     /**
965     * This Method returns the Content of the RDF File in one string. The String actually holds the whole XML Document.
966     *
967     * @access    public
968         * @author    Stefan Saasen <s@fase4.com>
969     * @param     string $rdf    RDF File (Location)
970     * @return    string XML Presentation of parsed RDF File
971         * @see           _cached_file, _remote_file, _cache_dir, _refresh, _update_cache()
972     */
973     function cache()
974     {
975         // checks if the cache directory already exists
976         // if not, the cache directory will be created
977         if(!$this->_cache_dir_ok) {
978             $this->_create_cache_dir();
979         }
980         if($this->_use_dynamic_display == true) {
981             $this->_cached_file = md5("dynamic".$this->salt.$this->_remote_file);
982             $this->_cache_type = "normal";
983         } else {
984             $this->_cached_file = md5($this->salt.$this->_remote_file);
985             $this->_cache_type = "fast";
986         }
987
988         $_cache_f = $this->_cache_dir.$this->_cached_file;
989
990         if ( (!file_exists($_cache_f)) || (filemtime($_cache_f) < $this->_refresh) || (filesize($_cache_f) == 0)) {
991         // We have to parse the remote file
992         $this->_use_cached_file = false;
993             // --> we want to provide proper Information for Use in
994             // get_cache_update_time()
995             clearstatcache();
996             if($this->_use_dynamic_display == true) {
997                 $_rdf = @implode(" ", $this->_rdf_data()); // -> proxy
998                 if(!$_rdf) {
999                     $this->_throw_exception( $this->_remote_file." is not available" );
1000                 }
1001                 $this->_parse_xRDF( $_rdf );
1002                 $this->_update_cache( $_rdf );
1003                 $data = $this->_output;
1004             } else {
1005                 $_rdf = @implode(" ", $this->_rdf_data()); // -> proxy
1006                 if(!$_rdf) {
1007                     $this->_throw_exception( $this->_remote_file." is not available" );
1008                 }
1009                 $this->_parse_xRDF( $_rdf );
1010                 $this->_update_cache( $this->_output );
1011                 $data = $this->_output;
1012             }
1013         } else {
1014         // we can use the cached file
1015         $this->_use_cached_file = true;
1016             if($this->_use_dynamic_display == true) {
1017                 $this->_parse_xRDF( implode(" ", file($_cache_f)) );
1018                 $data = $this->_output;
1019             } else {
1020                 $data = @implode(" ", file($_cache_f));
1021             }
1022         }
1023         return trim($data);
1024     }   // END cache()
1025
1026     /**
1027     * This Methods creates the Cache Directory if the specified Directory does not exist.
1028     *
1029     * @access    private
1030         * @author    Stefan Saasen <s@fase4.com>
1031     * @param     string $dir Path to Directory.
1032         * @return        boolean
1033         * @see           _cache_dir, _cache_dir_ok
1034     */
1035     function _create_cache_dir()
1036     {
1037         $path = "";
1038         if(!@is_dir($this->_cache_dir)) {
1039             $arr = explode("/", $this->_cache_dir);
1040             $c = count($arr);
1041             if($arr[0]=="") {
1042                 $path = "/";
1043             }
1044             for($i = 0;$i<$c;$i++)
1045             {
1046                 if($arr[$i]!="") {
1047                     $path .= $arr[$i]."/";
1048                     if(!@is_dir($path)) {
1049                        if(!@mkdir($path, 0777)) {
1050                             $this->_throw_exception("failed to create directory:<b>".$this->_cache_dir."</b>.<br /><br />Exception on Line: ".__LINE__);
1051                         return false;
1052                         }
1053                     }
1054                 }
1055             }
1056             $this->_cache_dir_ok = true;
1057             return true;
1058         } else {
1059             $this->_cache_dir_ok = true;
1060             return true;
1061         }
1062     }   // END _create_cache_dir()
1063
1064     /**
1065     * This Method updates the cached RDF Files and synchronises them with their remote Counterparts.
1066     *
1067     * @access    private
1068         * @author    Stefan Saasen <s@fase4.com>
1069     * @param     string $rdf    RDF File (Location)
1070         * @see           _cache_dir, _cached_file, _throw_exception()
1071     */
1072     function _update_cache( $content = "" )
1073     {
1074              $_local = @fopen( $this->_cache_dir.$this->_cached_file, 'w' );
1075              if(!$_local) {
1076                 $this->_throw_exception( "Cannot open ".$this->_cached_file."<br /><br />Exception at Line: ".__LINE__ );
1077                 return false;
1078              }
1079              if (fwrite( $_local, $content) === false) {
1080                         $this->_throw_exception( "Cannot write to ".$this->_cached_file."<br /<br />Exeception at Line: ".__LINE__);
1081                         return false;
1082                    }
1083              fclose( $_local );
1084                    @chmod( $this->_cache_dir.$this->_cached_file, 0666);
1085              return true;
1086     }   // END _update_cache()
1087
1088     /**
1089     * This Method returns the Date/Time of last Cache Update of the actually parsed RDF File.
1090         *
1091     * @access    public
1092         * @author    Stefan Saasen <s@fase4.com>
1093         * @return        string Date/Time of last Update
1094         * @see           _cache_dir, _cached_file
1095     */
1096     function get_cache_update_time()
1097     {
1098             return (file_exists($this->_cache_dir.$this->_cached_file))?date("d.m.Y H:i:s", filemtime($this->_cache_dir.$this->_cached_file)):"Cachemiss";
1099     }   // END get_cache_update_time()
1100
1101     /**
1102     * This Method returns the Type of Cache that was used ('normal' or 'fast')
1103     *
1104     * @access    public
1105         * @author    Stefan Saasen <s@fase4.com>
1106     * @param     string $rdf    RDF File (Location)
1107     * @return    string Displays RDF Content ( using _display() )
1108         * @see           _remote_file, cache()
1109     */
1110     function get_CacheType()
1111     {
1112         return $this->_cache_type;
1113     }
1114
1115     /**
1116     * Returns true if cached file was used, otherwise false
1117     *
1118     * @access    public
1119         * @author    Stefan Saasen <s@fase4.com>
1120     * @return    array  $options
1121         * @see           _use_cached_file
1122     */
1123     function is_cachedFile()
1124     {
1125         return $this->_use_cached_file;
1126     }
1127
1128     /**
1129     * This Method deletes all the cached Files.
1130     *
1131     * Please keep in mind to use this method just as a 'manual garbage collection'
1132     * You should cache the rss/rdf files locally to avoid unnecessary traffic.
1133     * (Both for your visitors and the Publisher)
1134         *
1135     * @access    public
1136         * @author    Stefan Saasen <s@fase4.com>
1137         * @see           _cache_dir
1138     */
1139     function clear_cache()
1140     {
1141         $dir = dir($this->_cache_dir);
1142         while($file=$dir->read()) {
1143             if($file!="." && $file!="..")  {
1144                 if(!@unlink($dir->path.$file)) {
1145                     $this->_throw_exception(
1146                     "Unable to unlink ".$dir->path.$file
1147                     ."<br /><br />Exception at Line: ".__LINE__ );
1148                     return false;
1149                 }
1150             }
1151         }
1152         $dir->close();
1153         return true;
1154     }   // END clear_cache()
1155
1156     /**
1157     * Cuts the String $string after $str_len and adds "... "
1158     *
1159     * @access   private
1160     * @param    string  $string String to be shortened
1161     * @param    int     $str_len length of the returned String (overall length including "... ")
1162     * @return   string  Cut String
1163     */
1164     function _cut_string( $string, $str_len = "30" )
1165     {
1166         if(strlen(trim($string))>$str_len) {
1167         $string = substr( trim($string) , 0, $str_len - 4);
1168         $string .= " ...";
1169         }
1170         return $string;
1171     }   // END _cut_string()
1172
1173     /**
1174     * this Method implements simple Garbage Collection
1175     *
1176     * @access    private
1177         * @author    Stefan Saasen <s@fase4.com>
1178         * @see           _cache_dir, gc_probability, gc_maxlifetime
1179     */
1180     function _garbage_collection()
1181     {
1182         srand((double) microtime() * 1000000);
1183         if (rand(1, 100) <= $this->gc_probability) {
1184             $dir = dir($this->_cache_dir);
1185             while($file=$dir->read()) {
1186                 if($file!="." AND $file!=".." AND filemtime($dir->path.$file) <= time() - $this->_refresh )  {
1187                 @unlink($dir->path.$file);
1188                 }
1189         }
1190         $dir->close();
1191         }   // END if
1192     }
1193
1194     /* ==== Proxy/Auth methods ==== */
1195
1196    /**
1197     * this method sets a proxy server
1198     *
1199     * @access    public
1200     * @param     string $phost Proxy Host
1201     * @param     string $pport Prox Port
1202     * @author    Marco Kraus <marco.kraus@siemens.com>
1203     */
1204     function set_proxy($phost, $pport)
1205     {
1206      $this->_use_proxy = true;
1207
1208      if ($phost != '')
1209         $this->_phost = $phost;
1210
1211      if ($pport != '')
1212         $this->_pport = $pport;
1213     }
1214
1215     /**
1216     * this method sets a proxy server authentification
1217     *
1218     * @access    public
1219     * @param     string $pname Username
1220     * @param     string $ppaswd Password
1221     * @author    Marco Kraus <marco.kraus@siemens.com>
1222     */
1223     function set_proxy_auth( $pname, $ppasswd )
1224     {
1225      $this->_use_proxy_auth = true;
1226
1227      if ($pname != '')
1228         $this->_pname = $pname;
1229
1230      if ($ppasswd != '')
1231         $this->_ppasswd = $ppasswd;
1232     }
1233
1234
1235    /**
1236     * gets _remote_file into an array
1237     *
1238     * needed, cause if you use a proxy, you have to open
1239     * a raw-tcp-socket to get the data
1240     *
1241     * @access    private
1242     * @author    Marco Kraus <Marco.Kraus@siemens.com>
1243     * @return array
1244     * @see _use_proxy, cache()
1245     */
1246     function _rdf_data()
1247     {
1248       if ( $this->_use_proxy == true )
1249       {
1250        // we need a raw socket here to connect to proxy
1251        $fp = fsockopen($this->_phost,$this->_pport);
1252
1253        if (!$fp) {
1254            $this->_throw_exception( $this->_remote_file." is not available with proxy" );
1255        } else {
1256         if ( $this->_use_proxy_auth == true ) {
1257              fputs($fp, "GET ".$this->_remote_file." HTTP/1.0\r\nUser-Agent: Fase4 RDF-Reader/1.40 modified by Quix0r\r\n\r\n");
1258            } else {
1259              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");
1260            }
1261         }
1262
1263
1264        for ( $i = 0; !feof ($fp) ; $i++)
1265        {
1266           $usable_data[$i] = "";
1267           $usable_data[$i] = fgets($fp,4096);
1268
1269         // PARSE HEADER ---- first line has to be <?xml, second rdf or rss, and third is blank
1270
1271         // strstr did not fit (ask Rasmus why), so we compare each character
1272             if ( ($usable_data[$i][0] == "<" ) &&
1273                ($usable_data[$i][1] == "?" ) &&
1274                ($usable_data[$i][2] == "x" ) &&
1275                ($usable_data[$i][3] == "m" ) &&
1276                ($usable_data[$i][4] == "l" ) ) {
1277                     $usable_data[0] = $usable_data[$i]; // save current field
1278                       $i = 1; // just reset array to start
1279               }
1280
1281         // there seems to be proxystuff after the <?xml....we delete this
1282             if ( (
1283                ($usable_data[$i][0] == "<" ) &&
1284                ($usable_data[$i][1] == "r" ) &&
1285                ($usable_data[$i][2] == "d" ) &&
1286                ($usable_data[$i][3] == "f" ) &&
1287                ($usable_data[$i][4] == ":" )
1288                )
1289                ||
1290                (
1291                ($usable_data[$i][0] == "<" ) &&
1292                ($usable_data[$i][1] == "r" ) &&
1293                ($usable_data[$i][2] == "s" ) &&
1294                ($usable_data[$i][3] == "s" )
1295                )
1296             ) {
1297
1298                 $usable_data[1] = $usable_data[$i]; // save current field
1299                 $usable_data[2] = "\n";
1300                 $i = 2; // just reset array to start
1301           }
1302        }
1303
1304        fclose($fp);
1305        return $usable_data;
1306      } else {
1307                 if (substr($this->_remote_file, 0, 7) != "http://") {
1308                         $this->_throw_exception( "Cannot find http:// in ".$this->_remote_file."!" );
1309                         return "";
1310                 } else {
1311                         // Extract host information
1312                         $host = substr($this->_remote_file, 7);
1313                         // Extract the GET part
1314                         $get = "/";
1315                         if (strpos($host, "/") > 0) {
1316                                 $get = substr($host, strpos($host, "/"));
1317                                 $host = substr($host, 0, strpos($host, "/"));
1318                         }
1319                         // Extract port
1320                         $port = "80";
1321                         if (strpos($host, ":") > 0) {
1322                                 $port = substr($host, (strpos($host, ":") + 1));
1323                                 $host = substr($host, 0, (strpos($host, ":") - 1));
1324                         }
1325
1326                         // Start connection to server
1327                         $fp = fsockopen($host, $port);
1328                         if (!$fp) {
1329                     $this->_throw_exception( $this->_remote_file." is maybe not available." );
1330                           return "";
1331                         }
1332                         // Repare request line
1333                         $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);
1334                         // Send request out
1335                         fputs($fp, $request);
1336                         $reply = ""; $isContent = false; $dummy = "";
1337                         // Read reply
1338                         while ( !feof($fp) ) {
1339                                 $read = trim(fgets($fp, 4096));
1340                                 if (substr($read, 0, 5) == "<?xml" || $isContent) {
1341                                         // Add content
1342                                         $reply[] = $read;
1343                                         $isContent = true;
1344                                 } else {
1345                                         // Put in dummy
1346                                         $dummy[] = $read;
1347                                 }
1348                                 $i++;
1349                         }
1350                         if ((count($dummy) > 0) && (count($reply) == 0) && (!$isContent)) {
1351                                 // Transfer content from dummy
1352                                 $reply = $content;
1353                         }
1354                         fclose($fp);
1355                         //die(htmlentities($reply));
1356                         return $reply;
1357                 }
1358      }
1359    }    // END _rdf_data()
1360 }   // END class
1361 ?>