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         $dom->loadXML($xml);
  57         $xrd_element = $dom->getElementsByTagName('XRD')->item(0);
  58
  59         // Check for host-meta host
  60         $host = $xrd_element->getElementsByTagName('Host')->item(0)->nodeValue;
  61         if ($host) {
  62             $xrd->host = $host;
  63         }
  64
  65         // Loop through other elements
  66         foreach ($xrd_element->childNodes as $node) {
  67             switch ($node->tagName) {
  68             case 'Expires':
  69                 $xrd->expires = $node->nodeValue;
  70                 break;
  71             case 'Subject':
  72                 $xrd->subject = $node->nodeValue;
  73                 break;
  74
  75             case 'Alias':
  76                 $xrd->alias[] = $node->nodeValue;
  77                 break;
  78
  79             case 'Link':
  80                 $xrd->links[] = $xrd->parseLink($node);
  81                 break;
  82
  83             case 'Type':
  84                 $xrd->types[] = $xrd->parseType($node);
  85                 break;
  86
  87             }
  88         }
  89         return $xrd;
  90     }
  91
  92     public function toXML()
  93     {
  94         $dom = new DOMDocument('1.0', 'UTF-8');
  95         $dom->formatOutput = true;
  96
  97         $xrd_dom = $dom->createElementNS(XRD::XRD_NS, 'XRD');
  98         $dom->appendChild($xrd_dom);
  99
 100         if ($this->host) {
 101             $host_dom = $dom->createElement('hm:Host', $this->host);
 102             $xrd_dom->setAttributeNS(XRD::XML_NS, 'xmlns:hm', XRD::HOST_META_NS);
 103             $xrd_dom->appendChild($host_dom);
 104         }
 105
 106                 if ($this->expires) {
 107                         $expires_dom = $dom->createElement('Expires', $this->expires);
 108                         $xrd_dom->appendChild($expires_dom);
 109                 }
 110
 111                 if ($this->subject) {
 112                         $subject_dom = $dom->createElement('Subject', $this->subject);
 113                         $xrd_dom->appendChild($subject_dom);
 114                 }
 115
 116                 foreach ($this->alias as $alias) {
 117                         $alias_dom = $dom->createElement('Alias', $alias);
 118                         $xrd_dom->appendChild($alias_dom);
 119                 }
 120
 121                 foreach ($this->types as $type) {
 122                         $type_dom = $dom->createElement('Type', $type);
 123                         $xrd_dom->appendChild($type_dom);
 124                 }
 125
 126                 foreach ($this->links as $link) {
 127                         $link_dom = $this->saveLink($dom, $link);
 128                         $xrd_dom->appendChild($link_dom);
 129                 }
 130
 131         return $dom->saveXML();
 132     }
 133
 134     function parseType($element)
 135     {
 136         return array();
 137     }
 138
 139     function parseLink($element)
 140     {
 141         $link = array();
 142         $link['rel'] = $element->getAttribute('rel');
 143         $link['type'] = $element->getAttribute('type');
 144         $link['href'] = $element->getAttribute('href');
 145         $link['template'] = $element->getAttribute('template');
 146         foreach ($element->childNodes as $node) {
 147             switch($node->tagName) {
 148             case 'Title':
 149                 $link['title'][] = $node->nodeValue;
 150             }
 151         }
 152
 153         return $link;
 154     }
 155
 156     function saveLink($doc, $link)
 157     {
 158         $link_element = $doc->createElement('Link');
 159         if ($link['rel']) {
 160             $link_element->setAttribute('rel', $link['rel']);
 161         }
 162         if ($link['type']) {
 163             $link_element->setAttribute('type', $link['type']);
 164         }
 165         if ($link['href']) {
 166             $link_element->setAttribute('href', $link['href']);
 167         }
 168         if ($link['template']) {
 169             $link_element->setAttribute('template', $link['template']);
 170         }
 171
 172         if (is_array($link['title'])) {
 173             foreach($link['title'] as $title) {
 174                 $title = $doc->createElement('Title', $title);
 175                 $link_element->appendChild($title);
 176             }
 177         }
 178
 179
 180         return $link_element;
 181     }
 182 }
 183