]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/activity.php
Inline attachment layout improvement
[quix0rs-gnu-social.git] / lib / activity.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * An activity
6  *
7  * PHP version 5
8  *
9  * LICENCE: This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU Affero General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Affero General Public License for more details.
18  *
19  * You should have received a copy of the GNU Affero General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  * @category  Feed
23  * @package   StatusNet
24  * @author    Evan Prodromou <evan@status.net>
25  * @author    Zach Copley <zach@status.net>
26  * @copyright 2010 StatusNet, Inc.
27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
28  * @link      http://status.net/
29  */
30
31 if (!defined('STATUSNET')) {
32     exit(1);
33 }
34
35 /**
36  * An activity in the ActivityStrea.ms world
37  *
38  * An activity is kind of like a sentence: someone did something
39  * to something else.
40  *
41  * 'someone' is the 'actor'; 'did something' is the verb;
42  * 'something else' is the object.
43  *
44  * @category  OStatus
45  * @package   StatusNet
46  * @author    Evan Prodromou <evan@status.net>
47  * @copyright 2010 StatusNet, Inc.
48  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
49  * @link      http://status.net/
50  */
51 class Activity
52 {
53     const SPEC   = 'http://activitystrea.ms/spec/1.0/';
54     const SCHEMA = 'http://activitystrea.ms/schema/1.0/';
55     const MEDIA  = 'http://purl.org/syndication/atommedia';
56
57     const VERB       = 'verb';
58     const OBJECT     = 'object';
59     const ACTOR      = 'actor';
60     const SUBJECT    = 'subject';
61     const OBJECTTYPE = 'object-type';
62     const CONTEXT    = 'context';
63     const TARGET     = 'target';
64
65     const ATOM = 'http://www.w3.org/2005/Atom';
66
67     const AUTHOR    = 'author';
68     const PUBLISHED = 'published';
69     const UPDATED   = 'updated';
70
71     const RSS = null; // no namespace!
72
73     const PUBDATE     = 'pubDate';
74     const DESCRIPTION = 'description';
75     const GUID        = 'guid';
76     const SELF        = 'self';
77     const IMAGE       = 'image';
78     const URL         = 'url';
79
80     const DC = 'http://purl.org/dc/elements/1.1/';
81
82     const CREATOR = 'creator';
83
84     const CONTENTNS = 'http://purl.org/rss/1.0/modules/content/';
85     const ENCODED = 'encoded';
86
87     public $actor;   // an ActivityObject
88     public $verb;    // a string (the URL)
89     public $objects = array();  // an array of ActivityObjects
90     public $target;  // an ActivityObject
91     public $context; // an ActivityObject
92     public $time;    // Time of the activity
93     public $link;    // an ActivityObject
94     public $entry;   // the source entry
95     public $feed;    // the source feed
96
97     public $summary; // summary of activity
98     public $content; // HTML content of activity
99     public $id;      // ID of the activity
100     public $title;   // title of the activity
101     public $categories = array(); // list of AtomCategory objects
102     public $enclosures = array(); // list of enclosure URL references
103     public $attachments = array(); // list of attachments
104
105     public $extra = array(); // extra elements as array(tag, attrs, content)
106     public $source;  // ActivitySource object representing 'home feed'
107     public $selfLink; // <link rel='self' type='application/atom+xml'>
108     public $editLink; // <link rel='edit' type='application/atom+xml'>
109     public $generator; // ActivityObject representing the generating application
110     /**
111      * Turns a regular old Atom <entry> into a magical activity
112      *
113      * @param DOMElement $entry Atom entry to poke at
114      * @param DOMElement $feed  Atom feed, for context
115      */
116     function __construct($entry = null, $feed = null)
117     {
118         if (is_null($entry)) {
119             return;
120         }
121
122         // Insist on a feed's root DOMElement; don't allow a DOMDocument
123         if ($feed instanceof DOMDocument) {
124             throw new ClientException(
125                 // TRANS: Client exception thrown when a feed instance is a DOMDocument.
126                 _('Expecting a root feed element but got a whole XML document.')
127             );
128         }
129
130         $this->entry = $entry;
131         $this->feed  = $feed;
132
133         if ($entry->namespaceURI == Activity::ATOM &&
134             $entry->localName == 'entry') {
135             $this->_fromAtomEntry($entry, $feed);
136         } else if ($entry->namespaceURI == Activity::RSS &&
137                    $entry->localName == 'item') {
138             $this->_fromRssItem($entry, $feed);
139         } else if ($entry->namespaceURI == Activity::SPEC &&
140                    $entry->localName == 'object') {
141             $this->_fromAtomEntry($entry, $feed);
142         } else {
143             // Low level exception. No need for i18n.
144             throw new Exception("Unknown DOM element: {$entry->namespaceURI} {$entry->localName}");
145         }
146     }
147
148     function _fromAtomEntry($entry, $feed)
149     {
150         $pubEl = $this->_child($entry, self::PUBLISHED, self::ATOM);
151
152         if (!empty($pubEl)) {
153             $this->time = strtotime($pubEl->textContent);
154         } else {
155             // XXX technically an error; being liberal. Good idea...?
156             $updateEl = $this->_child($entry, self::UPDATED, self::ATOM);
157             if (!empty($updateEl)) {
158                 $this->time = strtotime($updateEl->textContent);
159             } else {
160                 $this->time = null;
161             }
162         }
163
164         $this->link = ActivityUtils::getPermalink($entry);
165
166         $verbEl = $this->_child($entry, self::VERB);
167
168         if (!empty($verbEl)) {
169             $this->verb = trim($verbEl->textContent);
170         } else {
171             $this->verb = ActivityVerb::POST;
172             // XXX: do other implied stuff here
173         }
174
175         // get immediate object children
176
177         $objectEls = ActivityUtils::children($entry, self::OBJECT, self::SPEC);
178
179         if (count($objectEls) > 0) {
180             foreach ($objectEls as $objectEl) {
181                 // Special case for embedded activities
182                 $objectType = ActivityUtils::childContent($objectEl, self::OBJECTTYPE, self::SPEC);
183                 if (!empty($objectType) && $objectType == ActivityObject::ACTIVITY) {
184                     $this->objects[] = new Activity($objectEl);
185                 } else {
186                     $this->objects[] = new ActivityObject($objectEl);
187                 }
188             }
189         } else {
190             // XXX: really?
191             $this->objects[] = new ActivityObject($entry);
192         }
193
194         $actorEl = $this->_child($entry, self::ACTOR);
195
196         if (!empty($actorEl)) {
197             // Standalone <activity:actor> elements are a holdover from older
198             // versions of ActivityStreams. Newer feeds should have this data
199             // integrated straight into <atom:author>.
200
201             $this->actor = new ActivityObject($actorEl);
202
203             // Cliqset has bad actor IDs (just nickname of user). We
204             // work around it by getting the author data and using its
205             // id instead
206
207             if (!preg_match('/^\w+:/', $this->actor->id)) {
208                 $authorEl = ActivityUtils::child($entry, 'author');
209                 if (!empty($authorEl)) {
210                     $authorObj = new ActivityObject($authorEl);
211                     $this->actor->id = $authorObj->id;
212                 }
213             }
214         } else if ($authorEl = $this->_child($entry, self::AUTHOR, self::ATOM)) {
215
216             // An <atom:author> in the entry overrides any author info on
217             // the surrounding feed.
218             $this->actor = new ActivityObject($authorEl);
219
220         } else if (!empty($feed) &&
221                    $subjectEl = $this->_child($feed, self::SUBJECT)) {
222
223             // Feed subject is used for things like groups.
224             // Should actually possibly not be interpreted as an actor...?
225             $this->actor = new ActivityObject($subjectEl);
226
227         } else if (!empty($feed) && $authorEl = $this->_child($feed, self::AUTHOR,
228                                                               self::ATOM)) {
229
230             // If there's no <atom:author> on the entry, it's safe to assume
231             // the containing feed's authorship info applies.
232             $this->actor = new ActivityObject($authorEl);
233         }
234
235         $contextEl = $this->_child($entry, self::CONTEXT);
236
237         if (!empty($contextEl)) {
238             $this->context = new ActivityContext($contextEl);
239         } else {
240             $this->context = new ActivityContext($entry);
241         }
242
243         $targetEl = $this->_child($entry, self::TARGET);
244
245         if (!empty($targetEl)) {
246             $this->target = new ActivityObject($targetEl);
247         } elseif (ActivityUtils::compareTypes($this->verb, array(ActivityVerb::FAVORITE))) {
248             // StatusNet didn't send a 'target' for their Favorite atom entries
249             $this->target = clone($this->objects[0]);
250         }
251
252         $this->summary = ActivityUtils::childContent($entry, 'summary');
253         $this->id      = ActivityUtils::childContent($entry, 'id');
254         $this->content = ActivityUtils::getContent($entry);
255
256         $catEls = $entry->getElementsByTagNameNS(self::ATOM, 'category');
257         if ($catEls) {
258             for ($i = 0; $i < $catEls->length; $i++) {
259                 $catEl = $catEls->item($i);
260                 $this->categories[] = new AtomCategory($catEl);
261             }
262         }
263
264         foreach (ActivityUtils::getLinks($entry, 'enclosure') as $link) {
265             $this->enclosures[] = $link->getAttribute('href');
266         }
267
268         // From APP. Might be useful.
269
270         $this->selfLink = ActivityUtils::getLink($entry, 'self', 'application/atom+xml');
271         $this->editLink = ActivityUtils::getLink($entry, 'edit', 'application/atom+xml');
272     }
273
274     function _fromRssItem($item, $channel)
275     {
276         $verbEl = $this->_child($item, self::VERB);
277
278         if (!empty($verbEl)) {
279             $this->verb = trim($verbEl->textContent);
280         } else {
281             $this->verb = ActivityVerb::POST;
282             // XXX: do other implied stuff here
283         }
284
285         $pubDateEl = $this->_child($item, self::PUBDATE, self::RSS);
286
287         if (!empty($pubDateEl)) {
288             $this->time = strtotime($pubDateEl->textContent);
289         }
290
291         if ($authorEl = $this->_child($item, self::AUTHOR, self::RSS)) {
292             $this->actor = ActivityObject::fromRssAuthor($authorEl);
293         } else if ($dcCreatorEl = $this->_child($item, self::CREATOR, self::DC)) {
294             $this->actor = ActivityObject::fromDcCreator($dcCreatorEl);
295         } else if ($posterousEl = $this->_child($item, ActivityObject::AUTHOR, ActivityObject::POSTEROUS)) {
296             // Special case for Posterous.com
297             $this->actor = ActivityObject::fromPosterousAuthor($posterousEl);
298         } else if (!empty($channel)) {
299             $this->actor = ActivityObject::fromRssChannel($channel);
300         } else {
301             // No actor!
302         }
303
304         $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, self::RSS);
305
306         $contentEl = ActivityUtils::child($item, self::ENCODED, self::CONTENTNS);
307
308         if (!empty($contentEl)) {
309             // <content:encoded> XML node's text content is HTML; no further processing needed.
310             $this->content = $contentEl->textContent;
311         } else {
312             $descriptionEl = ActivityUtils::child($item, self::DESCRIPTION, self::RSS);
313             if (!empty($descriptionEl)) {
314                 // Per spec, <description> must be plaintext.
315                 // In practice, often there's HTML... but these days good
316                 // feeds are using <content:encoded> which is explicitly
317                 // real HTML.
318                 // We'll treat this following spec, and do HTML escaping
319                 // to convert from plaintext to HTML.
320                 $this->content = htmlspecialchars($descriptionEl->textContent);
321             }
322         }
323
324         $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, self::RSS);
325
326         // @fixme enclosures
327         // @fixme thumbnails... maybe
328
329         $guidEl = ActivityUtils::child($item, self::GUID, self::RSS);
330
331         if (!empty($guidEl)) {
332             $this->id = $guidEl->textContent;
333
334             if ($guidEl->hasAttribute('isPermaLink') && $guidEl->getAttribute('isPermaLink') != 'false') {
335                 // overwrites <link>
336                 $this->link = $this->id;
337             }
338         }
339
340         $this->objects[] = new ActivityObject($item);
341         $this->context   = new ActivityContext($item);
342     }
343
344     /**
345      * Returns an Atom <entry> based on this activity
346      *
347      * @return DOMElement Atom entry
348      */
349
350     function toAtomEntry()
351     {
352         return null;
353     }
354
355     /**
356      * Returns an array based on this activity suitable
357      * for encoding as a JSON object
358      *
359      * @return array $activity
360      */
361
362     function asArray()
363     {
364         $activity = array();
365
366         // actor
367         $activity['actor'] = $this->actor->asArray();
368
369         // content
370         $activity['content'] = $this->content;
371
372         // generator
373
374         if (!empty($this->generator)) {
375             $activity['generator'] = $this->generator->asArray();
376         }
377
378         // icon <-- possibly a mini object representing verb?
379
380         // id
381         $activity['id'] = $this->id;
382
383         // object
384
385         if (count($this->objects) == 0) {
386             common_log(LOG_ERR, "Can't save " . $this->id);
387         } else {
388             if (count($this->objects) > 1) {
389                 common_log(LOG_WARNING, "Ignoring " . (count($this->objects) - 1) . " extra objects in JSON output for activity " . $this->id);
390             }
391             $object = $this->objects[0];
392
393             if ($object instanceof Activity) {
394                 // Sharing a post activity is more like sharing the original object
395                 if (ActivityVerb::canonical($this->verb) == ActivityVerb::canonical(ActivityVerb::SHARE) &&
396                     ActivityVerb::canonical($object->verb) == ActivityVerb::canonical(ActivityVerb::POST)) {
397                     // XXX: Here's one for the obfuscation record books
398                     $object = $object->objects[0];
399                 }
400             }
401
402             $activity['object'] = $object->asArray();
403
404             if ($object instanceof Activity) {
405                 $activity['object']['objectType'] = 'activity';
406             }
407
408             foreach ($this->attachments as $attachment) {
409                 if (empty($activity['object']['attachments'])) {
410                     $activity['object']['attachments'] = array();
411                 }
412                 $activity['object']['attachments'][] = $attachment->asArray();
413             }
414         }
415         
416         // Context stuff.
417
418         if (!empty($this->context)) {
419
420             if (!empty($this->context->location)) {
421                 $loc = $this->context->location;
422
423                 $activity['location'] = array(
424                     'objectType' => 'place',
425                     'position' => sprintf("%+02.5F%+03.5F/", $loc->lat, $loc->lon),
426                     'lat' => $loc->lat,
427                     'lon' => $loc->lon
428                 );
429
430                 $name = $loc->getName();
431
432                 if ($name) {
433                     $activity['location']['displayName'] = $name;
434                 }
435                     
436                 $url = $loc->getURL();
437
438                 if ($url) {
439                     $activity['location']['url'] = $url;
440                 }
441             }
442
443             $activity['to']      = $this->context->getToArray();
444
445             $ctxarr = $this->context->asArray();
446
447             if (array_key_exists('inReplyTo', $ctxarr)) {
448                 $activity['object']['inReplyTo'] = $ctxarr['inReplyTo'];
449                 unset($ctxarr['inReplyTo']);
450             }
451
452             if (!array_key_exists('status_net', $activity)) {
453                 $activity['status_net'] = array();
454             }
455
456             foreach ($ctxarr as $key => $value) {
457                 $activity['status_net'][$key] = $value;
458             }
459         }
460
461         // published
462         $activity['published'] = self::iso8601Date($this->time);
463
464         // provider
465         $provider = array(
466             'objectType' => 'service',
467             'displayName' => common_config('site', 'name'),
468             'url' => common_root_url()
469         );
470
471         $activity['provider'] = $provider;
472
473         // target
474         if (!empty($this->target)) {
475             $activity['target'] = $this->target->asArray();
476         }
477
478         // title
479         $activity['title'] = $this->title;
480
481         // updated <-- Optional. Should we use this to indicate the time we r
482         //             eceived a remote notice? Probably not.
483
484         // verb
485
486         $activity['verb'] = ActivityVerb::canonical($this->verb);
487
488         // url
489         if ($this->link) {
490             $activity['url'] = $this->link;
491         }
492
493         /* Purely extensions hereafter */
494
495         if ($activity['verb'] == 'post') {
496             $tags = array();
497             foreach ($this->categories as $cat) {
498                 if (mb_strlen($cat->term) > 0) {
499                     // Couldn't figure out which object type to use, so...
500                     $tags[] = array('objectType' => 'http://activityschema.org/object/hashtag',
501                                     'displayName' => $cat->term);
502                 }
503             }
504             if (count($tags) > 0) {
505                 $activity['object']['tags'] = $tags;
506             }
507         }
508
509         // XXX: a bit of a hack... Since JSON isn't namespaced we probably
510         // shouldn't be using 'statusnet:notice_info', but this will work
511         // for the moment.
512
513         foreach ($this->extra as $e) {
514             list($objectName, $props, $txt) = $e;
515             if (!empty($objectName)) {
516                 $parts = explode(":", $objectName);
517                 if (count($parts) == 2 && $parts[0] == "statusnet") {
518                     if (!array_key_exists('status_net', $activity)) {
519                         $activity['status_net'] = array();
520                     }
521                     $activity['status_net'][$parts[1]] = $props;
522                 } else {
523                     $activity[$objectName] = $props;
524                 }
525             }
526         }
527
528         return array_filter($activity);
529     }
530
531     function asString($namespace=false, $author=true, $source=false)
532     {
533         $xs = new XMLStringer(true);
534         $this->outputTo($xs, $namespace, $author, $source);
535         return $xs->getString();
536     }
537
538     function outputTo($xs, $namespace=false, $author=true, $source=false, $tag='entry')
539     {
540         if ($namespace) {
541             $attrs = array('xmlns' => 'http://www.w3.org/2005/Atom',
542                            'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
543                            'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
544                            'xmlns:georss' => 'http://www.georss.org/georss',
545                            'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
546                            'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
547                            'xmlns:media' => 'http://purl.org/syndication/atommedia',
548                            'xmlns:statusnet' => 'http://status.net/schema/api/1/');
549         } else {
550             $attrs = array();
551         }
552
553         $xs->elementStart($tag, $attrs);
554
555         if ($tag != 'entry') {
556             $xs->element('activity:object-type', null, ActivityObject::ACTIVITY);
557         }
558
559         if ($this->verb == ActivityVerb::POST && count($this->objects) == 1 && $tag == 'entry') {
560
561             $obj = $this->objects[0];
562                         $obj->outputTo($xs, null);
563
564         } else {
565             $xs->element('id', null, $this->id);
566
567             if ($this->title) {
568                 $xs->element('title', null, $this->title);
569             } else {
570                 // Require element
571                 $xs->element('title', null, "");
572             }
573
574             $xs->element('content', array('type' => 'html'), $this->content);
575
576             if (!empty($this->summary)) {
577                 $xs->element('summary', null, $this->summary);
578             }
579
580             if (!empty($this->link)) {
581                 $xs->element('link', array('rel' => 'alternate',
582                                            'type' => 'text/html'),
583                              $this->link);
584             }
585
586         }
587
588         $xs->element('activity:verb', null, $this->verb);
589
590         $published = self::iso8601Date($this->time);
591
592         $xs->element('published', null, $published);
593         $xs->element('updated', null, $published);
594
595         if ($author) {
596             $this->actor->outputTo($xs, 'author');
597         }
598
599         if ($this->verb != ActivityVerb::POST || count($this->objects) != 1 || $tag != 'entry') {
600             foreach($this->objects as $object) {
601                 if ($object instanceof Activity) {
602                     $object->outputTo($xs, false, true, true, 'activity:object');
603                 } else {
604                     $object->outputTo($xs, 'activity:object');
605                 }
606             }
607         }
608
609         if (!empty($this->context)) {
610
611             if (!empty($this->context->replyToID)) {
612                 if (!empty($this->context->replyToUrl)) {
613                     $xs->element('thr:in-reply-to',
614                                  array('ref' => $this->context->replyToID,
615                                        'href' => $this->context->replyToUrl));
616                 } else {
617                     $xs->element('thr:in-reply-to',
618                                  array('ref' => $this->context->replyToID));
619                 }
620             }
621
622             if (!empty($this->context->replyToUrl)) {
623                 $xs->element('link', array('rel' => 'related',
624                                            'href' => $this->context->replyToUrl));
625             }
626
627             if (!empty($this->context->conversation)) {
628                 $xs->element('link', array('rel' => ActivityContext::CONVERSATION,
629                                            'href' => $this->context->conversation));
630             }
631
632             foreach ($this->context->attention as $attnURI=>$type) {
633                 $xs->element('link', array('rel' => ActivityContext::MENTIONED,
634                                            ActivityContext::OBJECTTYPE => $type,  // FIXME: undocumented 
635                                            'href' => $attnURI));
636             }
637
638             if (!empty($this->context->location)) {
639                 $loc = $this->context->location;
640                 $xs->element('georss:point', null, $loc->lat . ' ' . $loc->lon);
641             }
642         }
643
644         if ($this->target) {
645             $this->target->outputTo($xs, 'activity:target');
646         }
647
648         foreach ($this->categories as $cat) {
649             $cat->outputTo($xs);
650         }
651
652         // can be either URLs or enclosure objects
653
654         foreach ($this->enclosures as $enclosure) {
655             if (is_string($enclosure)) {
656                 $xs->element('link', array('rel' => 'enclosure',
657                                            'href' => $enclosure));
658             } else {
659                 $attributes = array('rel' => 'enclosure',
660                                     'href' => $enclosure->url,
661                                     'type' => $enclosure->mimetype,
662                                     'length' => $enclosure->size);
663                 if ($enclosure->title) {
664                     $attributes['title'] = $enclosure->title;
665                 }
666                 $xs->element('link', $attributes);
667             }
668         }
669
670         // Info on the source feed
671
672         if ($source && !empty($this->source)) {
673             $xs->elementStart('source');
674
675             $xs->element('id', null, $this->source->id);
676             $xs->element('title', null, $this->source->title);
677
678             if (array_key_exists('alternate', $this->source->links)) {
679                 $xs->element('link', array('rel' => 'alternate',
680                                            'type' => 'text/html',
681                                            'href' => $this->source->links['alternate']));
682             }
683
684             if (array_key_exists('self', $this->source->links)) {
685                 $xs->element('link', array('rel' => 'self',
686                                            'type' => 'application/atom+xml',
687                                            'href' => $this->source->links['self']));
688             }
689
690             if (array_key_exists('license', $this->source->links)) {
691                 $xs->element('link', array('rel' => 'license',
692                                            'href' => $this->source->links['license']));
693             }
694
695             if (!empty($this->source->icon)) {
696                 $xs->element('icon', null, $this->source->icon);
697             }
698
699             if (!empty($this->source->updated)) {
700                 $xs->element('updated', null, $this->source->updated);
701             }
702
703             $xs->elementEnd('source');
704         }
705
706         if (!empty($this->selfLink)) {
707             $xs->element('link', array('rel' => 'self',
708                                        'type' => 'application/atom+xml',
709                                        'href' => $this->selfLink));
710         }
711
712         if (!empty($this->editLink)) {
713             $xs->element('link', array('rel' => 'edit',
714                                        'type' => 'application/atom+xml',
715                                        'href' => $this->editLink));
716         }
717
718         // For throwing in extra elements; used for statusnet:notice_info
719
720         foreach ($this->extra as $el) {
721             list($tag, $attrs, $content) = $el;
722             $xs->element($tag, $attrs, $content);
723         }
724
725         $xs->elementEnd($tag);
726
727         return;
728     }
729
730     private function _child($element, $tag, $namespace=self::SPEC)
731     {
732         return ActivityUtils::child($element, $tag, $namespace);
733     }
734
735     /**
736      * For consistency, we'll always output UTC rather than local time.
737      * Note that clients *should* accept any timezone we give them as long
738      * as it's properly formatted.
739      *
740      * @param int $tm Unix timestamp
741      * @return string
742      */
743     static function iso8601Date($tm)
744     {
745         $dateStr = date('d F Y H:i:s', $tm);
746         $d = new DateTime($dateStr, new DateTimeZone('UTC'));
747         return $d->format('c');
748     }
749 }