summaryrefslogtreecommitdiff
path: root/extlib/libomb/plain_xrds_writer.php
blob: ba1027b611ce19c098bd20a01673d36fcbb94c61 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<?php
/**
 * This file is part of libomb
 *
 * PHP version 5
 *
 * LICENSE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @package OMB
 * @author  Adrian Lang <mail@adrianlang.de>
 * @license http://www.gnu.org/licenses/agpl.html GNU AGPL 3.0
 * @version 0.1a-20090828
 * @link    http://adrianlang.de/libomb
 */

require_once 'xrds_writer.php';

/**
 * Write OMB-specific XRDS using XMLWriter
 *
 * This class writes the XRDS file announcing the OMB server. It uses XMLWriter.
 * An instance of OMB_Plain_XRDS_Writer should be passed to
 * OMB_Service_Provider->writeXRDS.
 */
class OMB_Plain_XRDS_Writer implements OMB_XRDS_Writer
{
    /**
     * Write XRDS using XMLWriter
     *
     * Outputs a XRDS document specifying an OMB service.
     *
     * @param OMB_profile     $user   The target user for the OMB service
     * @param OMB_XRDS_Mapper $mapper An OMB_XRDS_Mapper providing endpoint URLs
     */
    public function writeXRDS($user, $mapper)
    {
        header('Content-Type: application/xrds+xml');
        $xw = new XMLWriter();
        $xw->openURI('php://output');
        $xw->setIndent(true);

        $xw->startDocument('1.0', 'UTF-8');
        $this->_writeFullElement($xw, 'XRDS', array('xmlns' => 'xri://$xrds'), array(
        array('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
                            'xml:id' => 'oauth',
                            'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
                            'version' => '2.0'), array(
          array('Type', null, 'xri://$xrds*simple'),
          array('Service', null, array(
            array('Type', null, OAUTH_ENDPOINT_REQUEST),
            array('URI', null, $mapper->getURL(OAUTH_ENDPOINT_REQUEST)),
            array('Type', null, OAUTH_AUTH_HEADER),
            array('Type', null, OAUTH_POST_BODY),
            array('Type', null, OAUTH_HMAC_SHA1),
            array('LocalID', null, $user->getIdentifierURI())
          )),
          array('Service', null, array(
            array('Type', null, OAUTH_ENDPOINT_AUTHORIZE),
            array('URI', null, $mapper->getURL(OAUTH_ENDPOINT_AUTHORIZE)),
            array('Type', null, OAUTH_AUTH_HEADER),
            array('Type', null, OAUTH_POST_BODY),
            array('Type', null, OAUTH_HMAC_SHA1)
          )),
          array('Service', null, array(
            array('Type', null, OAUTH_ENDPOINT_ACCESS),
            array('URI', null, $mapper->getURL(OAUTH_ENDPOINT_ACCESS)),
            array('Type', null, OAUTH_AUTH_HEADER),
            array('Type', null, OAUTH_POST_BODY),
            array('Type', null, OAUTH_HMAC_SHA1)
          )),
          array('Service', null, array(
            array('Type', null, OAUTH_ENDPOINT_RESOURCE),
            array('Type', null, OAUTH_AUTH_HEADER),
            array('Type', null, OAUTH_POST_BODY),
            array('Type', null, OAUTH_HMAC_SHA1)
          ))
        )),
        array('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
                           'xml:id' => 'omb',
                           'xmlns:simple' => 'http://xrds-simple.net/core/1.0',
                           'version' => '2.0'), array(
          array('Type', null, 'xri://$xrds*simple'),
          array('Service', null, array(
            array('Type', null, OMB_ENDPOINT_POSTNOTICE),
            array('URI', null, $mapper->getURL(OMB_ENDPOINT_POSTNOTICE))
          )),
          array('Service', null, array(
            array('Type', null, OMB_ENDPOINT_UPDATEPROFILE),
            array('URI', null, $mapper->getURL(OMB_ENDPOINT_UPDATEPROFILE))
          ))
        )),
        array('XRD', array('xmlns' => 'xri://$xrd*($v*2.0)',
                           'version' => '2.0'), array(
          array('Type', null, 'xri://$xrds*simple'),
          array('Service', null, array(
            array('Type', null, OAUTH_DISCOVERY),
            array('URI', null, '#oauth')
          )),
          array('Service', null, array(
            array('Type', null, OMB_VERSION),
            array('URI', null, '#omb')
          ))
        ))));
        $xw->endDocument();
        $xw->flush();
    }

    /**
     * Write a complex XML element
     *
     * Outputs a XML element with attributes and content.
     *
     * @param XMLWriter    $xw         The XMLWriter used to output the element
     * @param string       $tag        The tag name
     * @param array|null   $attributes A map of XML attributes
     * @param array|string $content    The content of the element; either an
     *                                 array of child nodes each specified by a
     *                                 three entry-array ($tag, $attributes,
     *                                 $content) or a string
     */
    private function _writeFullElement($xw, $tag, $attributes, $content)
    {
        $xw->startElement($tag);
        if (!is_null($attributes)) {
            foreach ($attributes as $name => $value) {
                $xw->writeAttribute($name, $value);
            }
        }
        if (is_array($content)) {
            foreach ($content as $val) {
                $this->_writeFullElement($xw, $val[0], $val[1], $val[2]);
            }
        } else {
            $xw->text($content);
        }
        $xw->fullEndElement();
    }
}
?>