plugins/OStatus/lib/xrd.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * A sample module to show best practices for StatusNet plugins
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @package   StatusNet
  24  * @author    James Walker <james@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  27  * @link      http://status.net/
  28  */
  29
  30
  31 class XRD
  32 {
  33     const XML_NS = 'http://www.w3.org/2000/xmlns/';
  34
  35     const XRD_NS = 'http://docs.oasis-open.org/ns/xri/xrd-1.0';
  36
  37     const HOST_META_NS = 'http://host-meta.net/xrd/1.0';
  38
  39     public $expires;
  40
  41     public $subject;
  42
  43     public $host;
  44
  45     public $alias = array();
  46
  47     public $types = array();
  48
  49     public $links = array();
  50
  51     public static function parse($xml)
  52     {
  53         $xrd = new XRD();
  54
  55         $dom = new DOMDocument();
  56
  57         // Don't spew XML warnings to output
  58         $old = error_reporting();
  59         error_reporting($old & ~E_WARNING);
  60         $ok = $dom->loadXML($xml);
  61         error_reporting($old);
  62
  63         if (!$ok) {
  64             throw new Exception("Invalid XML");
  65         }
  66         $xrd_element = $dom->getElementsByTagName('XRD')->item(0);
  67         if (!$xrd_element) {
  68             throw new Exception("Invalid XML, missing XRD root");
  69         }
  70
  71         // Check for host-meta host
  72         $host = $xrd_element->getElementsByTagName('Host')->item(0);
  73         if ($host) {
  74             $xrd->host = $host->nodeValue;
  75         }
  76
  77         // Loop through other elements
  78         foreach ($xrd_element->childNodes as $node) {
  79             if (!($node instanceof DOMElement)) {
  80                 continue;
  81             }
  82             switch ($node->tagName) {
  83             case 'Expires':
  84                 $xrd->expires = $node->nodeValue;
  85                 break;
  86             case 'Subject':
  87                 $xrd->subject = $node->nodeValue;
  88                 break;
  89
  90             case 'Alias':
  91                 $xrd->alias[] = $node->nodeValue;
  92                 break;
  93
  94             case 'Link':
  95                 $xrd->links[] = $xrd->parseLink($node);
  96                 break;
  97
  98             case 'Type':
  99                 $xrd->types[] = $xrd->parseType($node);
 100                 break;
 101
 102             }
 103         }
 104         return $xrd;
 105     }
 106
 107     public function toXML()
 108     {
 109         $xs = new XMLStringer();
 110
 111         $xs->startXML();
 112         $xs->elementStart('XRD', array('xmlns' => XRD::XRD_NS));
 113
 114         if ($this->host) {
 115             $xs->element('hm:Host', array('xmlns:hm' => XRD::HOST_META_NS), $this->host);
 116         }
 117
 118         if ($this->expires) {
 119             $xs->element('Expires', null, $this->expires);
 120         }
 121
 122         if ($this->subject) {
 123             $xs->element('Subject', null, $this->subject);
 124         }
 125
 126         foreach ($this->alias as $alias) {
 127             $xs->element('Alias', null, $alias);
 128         }
 129
 130         foreach ($this->links as $link) {
 131             $titles = array();
 132             if (isset($link['title'])) {
 133                 $titles = $link['title'];
 134                 unset($link['title']);
 135             }
 136             $xs->elementStart('Link', $link);
 137             foreach ($titles as $title) {
 138                 $xs->element('Title', null, $title);
 139             }
 140             $xs->elementEnd('Link');
 141         }
 142
 143         $xs->elementEnd('XRD');
 144
 145         return $xs->getString();
 146     }
 147
 148     function parseType($element)
 149     {
 150         return array();
 151     }
 152
 153     function parseLink($element)
 154     {
 155         $link = array();
 156         $link['rel'] = $element->getAttribute('rel');
 157         $link['type'] = $element->getAttribute('type');
 158         $link['href'] = $element->getAttribute('href');
 159         $link['template'] = $element->getAttribute('template');
 160         foreach ($element->childNodes as $node) {
 161             if ($node instanceof DOMElement) {
 162                 switch($node->tagName) {
 163                 case 'Title':
 164                     $link['title'][] = $node->nodeValue;
 165                 }
 166             }
 167         }
 168
 169         return $link;
 170     }
 171 }
 172