3 * Atom Syndication Format PHP Library
6 * @link http://code.google.com/p/phpatomlib/
8 * @author Elias Torres <elias@torrez.us>
14 * Structure that store common Atom Feed Properties
30 var $categories = array();
37 var $entries = array();
41 * Structure that store Atom Entry Properties
57 var $categories = array();
61 * AtomLib Atom Parser API
67 var $NS = 'http://www.w3.org/2005/Atom';
68 var $ATOM_CONTENT_ELEMENTS = array('content','summary','title','subtitle','rights');
69 var $ATOM_SIMPLE_ELEMENTS = array('id','updated','published','draft');
76 var $ns_contexts = array();
77 var $ns_decls = array();
78 var $content_ns_decls = array();
79 var $content_ns_contexts = array();
80 var $is_xhtml = false;
83 var $skipped_div = false;
85 var $FILE = "php://input";
90 function AtomParser() {
92 $this->feed = new AtomFeed();
93 $this->current = null;
94 $this->map_attrs_func = create_function('$k,$v', 'return "$k=\"$v\"";');
95 $this->map_xmlns_func = create_function('$p,$n', '$xd = "xmlns"; if(strlen($n[0])>0) $xd .= ":{$n[0]}"; return "{$xd}=\"{$n[1]}\"";');
100 print str_repeat(" ", $this->depth * $this->indent) . $msg ."\n";
104 function error_handler($log_level, $log_text, $error_file, $error_line) {
105 $this->error = $log_text;
110 set_error_handler(array(&$this, 'error_handler'));
112 array_unshift($this->ns_contexts, array());
114 $parser = xml_parser_create_ns();
115 xml_set_object($parser, $this);
116 xml_set_element_handler($parser, "start_element", "end_element");
117 xml_parser_set_option($parser,XML_OPTION_CASE_FOLDING,0);
118 xml_parser_set_option($parser,XML_OPTION_SKIP_WHITE,0);
119 xml_set_character_data_handler($parser, "cdata");
120 xml_set_default_handler($parser, "_default");
121 xml_set_start_namespace_decl_handler($parser, "start_ns");
122 xml_set_end_namespace_decl_handler($parser, "end_ns");
128 $fp = fopen($this->FILE, "r");
129 while ($data = fread($fp, 4096)) {
130 if($this->debug) $this->content .= $data;
132 if(!xml_parse($parser, $data, feof($fp))) {
133 trigger_error(sprintf(__('XML error: %s at line %d')."\n",
134 xml_error_string(xml_get_error_code($xml_parser)),
135 xml_get_current_line_number($xml_parser)));
142 xml_parser_free($parser);
144 restore_error_handler();
149 function start_element($parser, $name, $attrs) {
151 $tag = array_pop(split(":", $name));
154 case $this->NS . ':feed':
155 $this->current = $this->feed;
157 case $this->NS . ':entry':
158 $this->current = new AtomEntry();
162 $this->_p("start_element('$name')");
163 #$this->_p(print_r($this->ns_contexts,true));
164 #$this->_p('current(' . $this->current . ')');
166 array_unshift($this->ns_contexts, $this->ns_decls);
170 if(!empty($this->in_content)) {
172 $this->content_ns_decls = array();
174 if($this->is_html || $this->is_text)
175 trigger_error("Invalid content in element found. Content must not be of type text or html if it contains markup.");
177 $attrs_prefix = array();
179 // resolve prefixes for attributes
180 foreach($attrs as $key => $value) {
181 $with_prefix = $this->ns_to_prefix($key, true);
182 $attrs_prefix[$with_prefix[1]] = $this->xml_escape($value);
185 $attrs_str = join(' ', array_map($this->map_attrs_func, array_keys($attrs_prefix), array_values($attrs_prefix)));
186 if(strlen($attrs_str) > 0) {
187 $attrs_str = " " . $attrs_str;
190 $with_prefix = $this->ns_to_prefix($name);
192 if(!$this->is_declared_content_ns($with_prefix[0])) {
193 array_push($this->content_ns_decls, $with_prefix[0]);
197 if(count($this->content_ns_decls) > 0) {
198 array_unshift($this->content_ns_contexts, $this->content_ns_decls);
199 $xmlns_str .= join(' ', array_map($this->map_xmlns_func, array_keys($this->content_ns_contexts[0]), array_values($this->content_ns_contexts[0])));
200 if(strlen($xmlns_str) > 0) {
201 $xmlns_str = " " . $xmlns_str;
205 array_push($this->in_content, array($tag, $this->depth, "<". $with_prefix[1] ."{$xmlns_str}{$attrs_str}" . ">"));
207 } else if(in_array($tag, $this->ATOM_CONTENT_ELEMENTS) || in_array($tag, $this->ATOM_SIMPLE_ELEMENTS)) {
208 $this->in_content = array();
209 $this->is_xhtml = $attrs['type'] == 'xhtml';
210 $this->is_html = $attrs['type'] == 'html' || $attrs['type'] == 'text/html';
211 $this->is_text = !in_array('type',array_keys($attrs)) || $attrs['type'] == 'text';
212 $type = $this->is_xhtml ? 'XHTML' : ($this->is_html ? 'HTML' : ($this->is_text ? 'TEXT' : $attrs['type']));
214 if(in_array('src',array_keys($attrs))) {
215 $this->current->$tag = $attrs;
217 array_push($this->in_content, array($tag,$this->depth, $type));
219 } else if($tag == 'link') {
220 array_push($this->current->links, $attrs);
221 } else if($tag == 'category') {
222 array_push($this->current->categories, $attrs);
225 $this->ns_decls = array();
228 function end_element($parser, $name) {
230 $tag = array_pop(split(":", $name));
232 $ccount = count($this->in_content);
234 # if we are *in* content, then let's proceed to serialize it
235 if(!empty($this->in_content)) {
236 # if we are ending the original content element
237 # then let's finalize the content
238 if($this->in_content[0][0] == $tag &&
239 $this->in_content[0][1] == $this->depth) {
240 $origtype = $this->in_content[0][2];
241 array_shift($this->in_content);
242 $newcontent = array();
243 foreach($this->in_content as $c) {
245 array_push($newcontent, $c[2]);
247 if($this->is_xhtml || $this->is_text) {
248 array_push($newcontent, $this->xml_escape($c));
250 array_push($newcontent, $c);
254 if(in_array($tag, $this->ATOM_CONTENT_ELEMENTS)) {
255 $this->current->$tag = array($origtype, join('',$newcontent));
257 $this->current->$tag = join('',$newcontent);
259 $this->in_content = array();
260 } else if($this->in_content[$ccount-1][0] == $tag &&
261 $this->in_content[$ccount-1][1] == $this->depth) {
262 $this->in_content[$ccount-1][2] = substr($this->in_content[$ccount-1][2],0,-1) . "/>";
264 # else, just finalize the current element's content
265 $endtag = $this->ns_to_prefix($name);
266 array_push($this->in_content, array($tag, $this->depth, "</$endtag[1]>"));
270 array_shift($this->ns_contexts);
274 if($name == ($this->NS . ':entry')) {
275 array_push($this->feed->entries, $this->current);
276 $this->current = null;
279 $this->_p("end_element('$name')");
282 function start_ns($parser, $prefix, $uri) {
283 $this->_p("starting: " . $prefix . ":" . $uri);
284 array_push($this->ns_decls, array($prefix,$uri));
287 function end_ns($parser, $prefix) {
288 $this->_p("ending: #" . $prefix . "#");
291 function cdata($parser, $data) {
292 $this->_p("data: #" . str_replace(array("\n"), array("\\n"), trim($data)) . "#");
293 if(!empty($this->in_content)) {
294 array_push($this->in_content, $data);
298 function _default($parser, $data) {
299 # when does this gets called?
303 function ns_to_prefix($qname, $attr=false) {
304 # split 'http://www.w3.org/1999/xhtml:div' into ('http','//www.w3.org/1999/xhtml','div')
305 $components = split(":", $qname);
307 # grab the last one (e.g 'div')
308 $name = array_pop($components);
310 if(!empty($components)) {
311 # re-join back the namespace component
312 $ns = join(":",$components);
313 foreach($this->ns_contexts as $context) {
314 foreach($context as $mapping) {
315 if($mapping[1] == $ns && strlen($mapping[0]) > 0) {
316 return array($mapping, "$mapping[0]:$name");
323 return array(null, $name);
325 foreach($this->ns_contexts as $context) {
326 foreach($context as $mapping) {
327 if(strlen($mapping[0]) == 0) {
328 return array($mapping, $name);
335 function is_declared_content_ns($new_mapping) {
336 foreach($this->content_ns_contexts as $context) {
337 foreach($context as $mapping) {
338 if($new_mapping == $mapping) {
346 function xml_escape($string)
348 return str_replace(array('&','"',"'",'<','>'),
349 array('&','"',''','<','>'),