[XML/HTML Outputter] General improvements and refactoring as well as some bug fixes

This commit is contained in:
Diogo Cordeiro 2019-05-06 23:58:45 +01:00
parent c03ed457a6
commit 1536d3ef29
20 changed files with 1651 additions and 1567 deletions

View File

@ -31,7 +31,9 @@
* @link http://status.net/ * @link http://status.net/
*/ */
if (!defined('GNUSOCIAL')) { exit(1); } if (!defined('GNUSOCIAL')) {
exit(1);
}
/** /**
* We don't have a rate limit, but some clients check this method. * We don't have a rate limit, but some clients check this method.
@ -47,62 +49,6 @@ if (!defined('GNUSOCIAL')) { exit(1); }
*/ */
class ApiAccountRateLimitStatusAction extends ApiBareAuthAction class ApiAccountRateLimitStatusAction extends ApiBareAuthAction
{ {
/**
* Handle the request
*
* Return some Twitter-ish data about API limits
*
* @param array $args $_REQUEST data (unused)
*
* @return void
*/
protected function handle()
{
parent::handle();
if (!in_array($this->format, array('xml', 'json'))) {
$this->clientError(
// TRANS: Client error displayed when coming across a non-supported API method.
_('API method not found.'),
404,
$this->format
);
}
$reset = new DateTime();
$reset->modify('+1 hour');
$this->initDocument($this->format);
if ($this->format == 'xml') {
$this->elementStart('hash');
$this->element('remaining-hits', array('type' => 'integer'), 150);
$this->element('hourly-limit', array('type' => 'integer'), 150);
$this->element(
'reset-time', array('type' => 'datetime'),
common_date_iso8601($reset->format('r'))
);
$this->element(
'reset_time_in_seconds',
array('type' => 'integer'),
strtotime('+1 hour')
);
$this->elementEnd('hash');
} elseif ($this->format == 'json') {
$out = array(
'reset_time_in_seconds' => strtotime('+1 hour'),
'remaining_hits' => 150,
'hourly_limit' => 150,
'reset_time' => common_date_rfc2822(
$reset->format('r')
)
);
print json_encode($out);
}
$this->endDocument($this->format);
}
/** /**
* Return true if read only. * Return true if read only.
* *
@ -112,8 +58,64 @@ class ApiAccountRateLimitStatusAction extends ApiBareAuthAction
* *
* @return boolean is read only action? * @return boolean is read only action?
*/ */
function isReadOnly($args) public function isReadOnly($args)
{ {
return true; return true;
} }
/**
* Handle the request
*
* Return some Twitter-ish data about API limits
*
* @return void
* @throws ClientException
*/
protected function handle()
{
parent::handle();
if (!in_array($this->format, ['xml', 'json'])) {
$this->clientError(
// TRANS: Client error displayed when coming across a non-supported API method.
_('API method not found.'),
404,
$this->format
);
}
$reset = new DateTime();
$reset->modify('+1 hour');
$this->initDocument($this->format);
if ($this->format == 'xml') {
$this->elementStart('hash');
$this->element('remaining-hits', ['type' => 'integer'], "150");
$this->element('hourly-limit', ['type' => 'integer'], "150");
$this->element(
'reset-time',
['type' => 'datetime'],
common_date_iso8601($reset->format('r'))
);
$this->element(
'reset_time_in_seconds',
['type' => 'integer'],
strtotime('+1 hour')
);
$this->elementEnd('hash');
} elseif ($this->format == 'json') {
$out = [
'reset_time_in_seconds' => strtotime('+1 hour'),
'remaining_hits' => 150,
'hourly_limit' => 150,
'reset_time' => common_date_rfc2822(
$reset->format('r')
)
];
print json_encode($out);
}
$this->endDocument($this->format);
}
} }

View File

@ -49,25 +49,36 @@ class NetworkpublicAction extends SitestreamAction
// Network public tag cloud? // Network public tag cloud?
} }
/**
* Output <head> elements for RSS and Atom feeds
*
* @return array
*/
function getFeeds() function getFeeds()
{ {
return array(new Feed(Feed::JSON, return [
common_local_url('ApiTimelineNetworkPublic', new Feed(Feed::ATOM,
array('format' => 'as')), common_local_url('ApiTimelinePublic',
// TRANS: Link description for the _global_ network public timeline feed. array('format' => 'atom')),
_('Network Public Timeline Feed (Activity Streams JSON)')), // TRANS: Link description for public timeline feed.
new Feed(Feed::RSS1, common_local_url('publicrss'), _('Public Timeline Feed (Atom)')
// TRANS: Link description for the _global_ network public timeline feed. ),
_('Network Public Timeline Feed (RSS 1.0)')), new Feed(Feed::JSON,
new Feed(Feed::RSS2, common_local_url('ApiTimelinePublic',
common_local_url('ApiTimelineNetworkPublic', array('format' => 'as')),
array('format' => 'rss')), // TRANS: Link description for public timeline feed.
// TRANS: Link description for the _global_ network public timeline feed. _('Public Timeline Feed (Activity Streams JSON)')
_('Network Public Timeline Feed (RSS 2.0)')), ),
new Feed(Feed::ATOM, new Feed(Feed::RSS1, common_local_url('publicrss'),
common_local_url('ApiTimelineNetworkPublic', // TRANS: Link description for public timeline feed.
array('format' => 'atom')), _('Public Timeline Feed (RSS 1.0)')
// TRANS: Link description for the _global_ network public timeline feed. ),
_('Network Public Timeline Feed (Atom)'))); new Feed(Feed::RSS2,
common_local_url('ApiTimelinePublic',
array('format' => 'rss')),
// TRANS: Link description for public timeline feed.
_('Public Timeline Feed (RSS 2.0)')
),
];
} }
} }

View File

@ -93,7 +93,7 @@ class PublicAction extends SitestreamAction
/** /**
* Output <head> elements for RSS and Atom feeds * Output <head> elements for RSS and Atom feeds
* *
* @return void * @return array
*/ */
function getFeeds() function getFeeds()
{ {

File diff suppressed because it is too large Load Diff

View File

@ -28,9 +28,11 @@
* @link http://status.net/ * @link http://status.net/
*/ */
if (!defined('GNUSOCIAL')) { exit(1); } if (!defined('GNUSOCIAL')) {
exit(1);
}
require_once(INSTALLDIR.'/lib/activitystreamjsondocument.php'); require_once(INSTALLDIR . '/lib/activitystreamjsondocument.php');
/** /**
* A noun-ish thing in the activity universe * A noun-ish thing in the activity universe
@ -51,47 +53,47 @@ require_once(INSTALLDIR.'/lib/activitystreamjsondocument.php');
*/ */
class ActivityObject class ActivityObject
{ {
const ARTICLE = 'http://activitystrea.ms/schema/1.0/article'; const ARTICLE = 'http://activitystrea.ms/schema/1.0/article';
const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry'; const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry';
const NOTE = 'http://activitystrea.ms/schema/1.0/note'; const NOTE = 'http://activitystrea.ms/schema/1.0/note';
const STATUS = 'http://activitystrea.ms/schema/1.0/status'; const STATUS = 'http://activitystrea.ms/schema/1.0/status';
const FILE = 'http://activitystrea.ms/schema/1.0/file'; const FILE = 'http://activitystrea.ms/schema/1.0/file';
const PHOTO = 'http://activitystrea.ms/schema/1.0/photo'; const PHOTO = 'http://activitystrea.ms/schema/1.0/photo';
const ALBUM = 'http://activitystrea.ms/schema/1.0/photo-album'; const ALBUM = 'http://activitystrea.ms/schema/1.0/photo-album';
const PLAYLIST = 'http://activitystrea.ms/schema/1.0/playlist'; const PLAYLIST = 'http://activitystrea.ms/schema/1.0/playlist';
const VIDEO = 'http://activitystrea.ms/schema/1.0/video'; const VIDEO = 'http://activitystrea.ms/schema/1.0/video';
const AUDIO = 'http://activitystrea.ms/schema/1.0/audio'; const AUDIO = 'http://activitystrea.ms/schema/1.0/audio';
const BOOKMARK = 'http://activitystrea.ms/schema/1.0/bookmark'; const BOOKMARK = 'http://activitystrea.ms/schema/1.0/bookmark';
const PERSON = 'http://activitystrea.ms/schema/1.0/person'; const PERSON = 'http://activitystrea.ms/schema/1.0/person';
const GROUP = 'http://activitystrea.ms/schema/1.0/group'; const GROUP = 'http://activitystrea.ms/schema/1.0/group';
const _LIST = 'http://activitystrea.ms/schema/1.0/list'; // LIST is reserved const _LIST = 'http://activitystrea.ms/schema/1.0/list'; // LIST is reserved
const PLACE = 'http://activitystrea.ms/schema/1.0/place'; const PLACE = 'http://activitystrea.ms/schema/1.0/place';
const COMMENT = 'http://activitystrea.ms/schema/1.0/comment'; const COMMENT = 'http://activitystrea.ms/schema/1.0/comment';
// ^^^^^^^^^^ tea! // ^^^^^^^^^^ tea!
const ACTIVITY = 'http://activitystrea.ms/schema/1.0/activity'; const ACTIVITY = 'http://activitystrea.ms/schema/1.0/activity';
const SERVICE = 'http://activitystrea.ms/schema/1.0/service'; const SERVICE = 'http://activitystrea.ms/schema/1.0/service';
const IMAGE = 'http://activitystrea.ms/schema/1.0/image'; const IMAGE = 'http://activitystrea.ms/schema/1.0/image';
const COLLECTION = 'http://activitystrea.ms/schema/1.0/collection'; const COLLECTION = 'http://activitystrea.ms/schema/1.0/collection';
const APPLICATION = 'http://activitystrea.ms/schema/1.0/application'; const APPLICATION = 'http://activitystrea.ms/schema/1.0/application';
// Atom elements we snarf // Atom elements we snarf
const TITLE = 'title'; const TITLE = 'title';
const SUMMARY = 'summary'; const SUMMARY = 'summary';
const ID = 'id'; const ID = 'id';
const SOURCE = 'source'; const SOURCE = 'source';
const NAME = 'name'; const NAME = 'name';
const URI = 'uri'; const URI = 'uri';
const EMAIL = 'email'; const EMAIL = 'email';
const POSTEROUS = 'http://posterous.com/help/rss/1.0'; const POSTEROUS = 'http://posterous.com/help/rss/1.0';
const AUTHOR = 'author'; const AUTHOR = 'author';
const USERIMAGE = 'userImage'; const USERIMAGE = 'userImage';
const PROFILEURL = 'profileUrl'; const PROFILEURL = 'profileUrl';
const NICKNAME = 'nickName'; const NICKNAME = 'nickName';
const DISPLAYNAME = 'displayName'; const DISPLAYNAME = 'displayName';
const MEDIA_DESCRIPTION = 'description';
public $element; public $element;
public $type; public $type;
public $id; public $id;
@ -99,21 +101,19 @@ class ActivityObject
public $summary; public $summary;
public $content; public $content;
public $owner; public $owner;
public $link; public $link; // think APP (Atom Publishing Protocol)
public $selfLink; // think APP (Atom Publishing Protocol) public $selfLink;
public $source; public $source;
public $avatarLinks = array(); public $avatarLinks = [];
public $geopoint; public $geopoint;
public $poco; public $poco;
public $displayName;
// @todo move this stuff to it's own PHOTO activity object // @todo move this stuff to it's own PHOTO activity object
const MEDIA_DESCRIPTION = 'description'; public $displayName;
public $thumbnail; public $thumbnail;
public $largerImage; public $largerImage;
public $description; public $description;
public $extra = array(); public $extra = [];
public $stream; public $stream;
@ -126,7 +126,7 @@ class ActivityObject
* *
* @param DOMElement $element DOM thing to turn into an Activity thing * @param DOMElement $element DOM thing to turn into an Activity thing
*/ */
function __construct($element = null) public function __construct($element = null)
{ {
if (empty($element)) { if (empty($element)) {
return; return;
@ -142,7 +142,7 @@ class ActivityObject
if ($element->tagName == 'author') { if ($element->tagName == 'author') {
$this->_fromAuthor($element); $this->_fromAuthor($element);
} else if ($element->tagName == 'item') { } elseif ($element->tagName == 'item') {
$this->_fromRssItem($element); $this->_fromRssItem($element);
} else { } else {
$this->_fromAtomEntry($element); $this->_fromAtomEntry($element);
@ -168,8 +168,7 @@ class ActivityObject
} }
if ($this->type == self::PHOTO) { if ($this->type == self::PHOTO) {
$this->thumbnail = ActivityUtils::getLink($element, 'preview');
$this->thumbnail = ActivityUtils::getLink($element, 'preview');
$this->largerImage = ActivityUtils::getLink($element, 'enclosure'); $this->largerImage = ActivityUtils::getLink($element, 'enclosure');
$this->description = ActivityUtils::childContent( $this->description = ActivityUtils::childContent(
@ -184,11 +183,18 @@ class ActivityObject
} }
} }
private function _childContent($element, $tag, $namespace = ActivityUtils::ATOM)
{
return ActivityUtils::childContent($element, $tag, $namespace);
}
private function _fromAuthor($element) private function _fromAuthor($element)
{ {
$this->type = $this->_childContent($element, $this->type = $this->_childContent(
Activity::OBJECTTYPE, $element,
Activity::SPEC); Activity::OBJECTTYPE,
Activity::SPEC
);
if (empty($this->type)) { if (empty($this->type)) {
$this->type = self::PERSON; // XXX: is this fair? $this->type = self::PERSON; // XXX: is this fair?
@ -231,7 +237,7 @@ class ActivityObject
$email = $this->_childContent($element, self::EMAIL); $email = $this->_childContent($element, self::EMAIL);
if (!empty($email)) { if (!empty($email)) {
// XXX: acct: ? // XXX: acct: ?
$this->id = 'mailto:'.$email; $this->id = 'mailto:' . $email;
} }
} }
@ -244,50 +250,8 @@ class ActivityObject
} }
} }
private function _fromAtomEntry($element)
{
$this->type = $this->_childContent($element, Activity::OBJECTTYPE,
Activity::SPEC);
if (empty($this->type)) {
$this->type = ActivityObject::NOTE;
}
$this->summary = ActivityUtils::childHtmlContent($element, self::SUMMARY);
$this->content = ActivityUtils::getContent($element);
// We don't like HTML in our titles, although it's technically allowed
$this->title = common_strip_html(ActivityUtils::childHtmlContent($element, self::TITLE));
$this->source = $this->_getSource($element);
$this->link = ActivityUtils::getPermalink($element);
$this->selfLink = ActivityUtils::getSelfLink($element);
$this->id = $this->_childContent($element, self::ID);
if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
$this->id = $this->link;
}
$els = $element->childNodes;
$out = array();
for ($i = 0; $i < $els->length; $i++) {
$link = $els->item($i);
if ($link->localName == ActivityUtils::LINK && $link->namespaceURI == ActivityUtils::ATOM) {
$attrs = array();
foreach ($link->attributes as $attrName=>$attrNode) {
$attrs[$attrName] = $attrNode->nodeValue;
}
$this->extra[] = [$link->localName,
$attrs,
$link->nodeValue];
}
}
}
// @todo FIXME: rationalize with Activity::_fromRssItem() // @todo FIXME: rationalize with Activity::_fromRssItem()
private function _fromRssItem($item) private function _fromRssItem($item)
{ {
if (empty($this->type)) { if (empty($this->type)) {
@ -321,6 +285,67 @@ class ActivityObject
} }
} }
private function _fromAtomEntry($element)
{
$this->type = $this->_childContent(
$element,
Activity::OBJECTTYPE,
Activity::SPEC
);
if (empty($this->type)) {
$this->type = ActivityObject::NOTE;
}
$this->summary = ActivityUtils::childHtmlContent($element, self::SUMMARY);
$this->content = ActivityUtils::getContent($element);
// We don't like HTML in our titles, although it's technically allowed
$this->title = common_strip_html(ActivityUtils::childHtmlContent($element, self::TITLE));
$this->source = $this->_getSource($element);
$this->link = ActivityUtils::getPermalink($element);
$this->selfLink = ActivityUtils::getSelfLink($element);
$this->id = $this->_childContent($element, self::ID);
if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
$this->id = $this->link;
}
$els = $element->childNodes;
for ($i = 0; $i < $els->length; $i++) {
$link = $els->item($i);
if ($link->localName == ActivityUtils::LINK && $link->namespaceURI == ActivityUtils::ATOM) {
$attrs = [];
foreach ($link->attributes as $attrName => $attrNode) {
$attrs[$attrName] = $attrNode->nodeValue;
}
$this->extra[] = [$link->localName,
$attrs,
$link->nodeValue];
}
}
}
private function _getSource($element)
{
$sourceEl = ActivityUtils::child($element, 'source');
if (empty($sourceEl)) {
return null;
} else {
$href = ActivityUtils::getLink($sourceEl, 'self');
if (!empty($href)) {
return $href;
} else {
return ActivityUtils::childContent($sourceEl, 'id');
}
}
}
public static function fromRssAuthor($el) public static function fromRssAuthor($el)
{ {
$text = $el->textContent; $text = $el->textContent;
@ -328,10 +353,10 @@ class ActivityObject
if (preg_match('/^(.*?) \((.*)\)$/', $text, $match)) { if (preg_match('/^(.*?) \((.*)\)$/', $text, $match)) {
$email = $match[1]; $email = $match[1];
$name = $match[2]; $name = $match[2];
} else if (preg_match('/^(.*?) <(.*)>$/', $text, $match)) { } elseif (preg_match('/^(.*?) <(.*)>$/', $text, $match)) {
$name = $match[1]; $name = $match[1];
$email = $match[2]; $email = $match[2];
} else if (preg_match('/.*@.*/', $text)) { } elseif (preg_match('/.*@.*/', $text)) {
$email = $text; $email = $text;
$name = null; $name = null;
} else { } else {
@ -345,11 +370,11 @@ class ActivityObject
$obj->element = $el; $obj->element = $el;
$obj->type = ActivityObject::PERSON; $obj->type = ActivityObject::PERSON;
$obj->title = $name; $obj->title = $name;
if (!empty($email)) { if (!empty($email)) {
$obj->id = 'mailto:'.$email; $obj->id = 'mailto:' . $email;
} }
return $obj; return $obj;
@ -366,7 +391,7 @@ class ActivityObject
$obj->element = $el; $obj->element = $el;
$obj->title = $text; $obj->title = $text;
$obj->type = ActivityObject::PERSON; $obj->type = ActivityObject::PERSON;
return $obj; return $obj;
} }
@ -380,8 +405,8 @@ class ActivityObject
$obj->type = ActivityObject::PERSON; // @fixme guess better $obj->type = ActivityObject::PERSON; // @fixme guess better
$obj->title = ActivityUtils::childContent($el, ActivityObject::TITLE, Activity::RSS); $obj->title = ActivityUtils::childContent($el, ActivityObject::TITLE, Activity::RSS);
$obj->link = ActivityUtils::childContent($el, ActivityUtils::LINK, Activity::RSS); $obj->link = ActivityUtils::childContent($el, ActivityUtils::LINK, Activity::RSS);
$obj->id = ActivityUtils::getLink($el, Activity::SELF); $obj->id = ActivityUtils::getLink($el, Activity::SELF);
if (empty($obj->id)) { if (empty($obj->id)) {
$obj->id = $obj->link; $obj->id = $obj->link;
@ -405,6 +430,8 @@ class ActivityObject
return $obj; return $obj;
} }
// Try to get a unique id for the source feed
public static function fromPosterousAuthor($el) public static function fromPosterousAuthor($el)
{ {
$obj = new ActivityObject(); $obj = new ActivityObject();
@ -420,93 +447,74 @@ class ActivityObject
} }
$obj->link = ActivityUtils::childContent($el, self::PROFILEURL, self::POSTEROUS); $obj->link = ActivityUtils::childContent($el, self::PROFILEURL, self::POSTEROUS);
$obj->id = $obj->link; $obj->id = $obj->link;
$obj->poco = new PoCo(); $obj->poco = new PoCo();
$obj->poco->preferredUsername = ActivityUtils::childContent($el, self::NICKNAME, self::POSTEROUS); $obj->poco->preferredUsername = ActivityUtils::childContent($el, self::NICKNAME, self::POSTEROUS);
$obj->poco->displayName = ActivityUtils::childContent($el, self::DISPLAYNAME, self::POSTEROUS); $obj->poco->displayName = ActivityUtils::childContent($el, self::DISPLAYNAME, self::POSTEROUS);
$obj->title = $obj->poco->displayName; $obj->title = $obj->poco->displayName;
return $obj; return $obj;
} }
private function _childContent($element, $tag, $namespace=ActivityUtils::ATOM) public static function fromGroup(User_group $group)
{
return ActivityUtils::childContent($element, $tag, $namespace);
}
// Try to get a unique id for the source feed
private function _getSource($element)
{
$sourceEl = ActivityUtils::child($element, 'source');
if (empty($sourceEl)) {
return null;
} else {
$href = ActivityUtils::getLink($sourceEl, 'self');
if (!empty($href)) {
return $href;
} else {
return ActivityUtils::childContent($sourceEl, 'id');
}
}
}
static function fromGroup(User_group $group)
{ {
$object = new ActivityObject(); $object = new ActivityObject();
if (Event::handle('StartActivityObjectFromGroup', array($group, &$object))) { if (Event::handle('StartActivityObjectFromGroup', [$group, &$object])) {
$object->type = ActivityObject::GROUP;
$object->id = $group->getUri();
$object->title = $group->getBestName();
$object->link = $group->getUri();
$object->type = ActivityObject::GROUP; $object->avatarLinks[] = AvatarLink::fromFilename(
$object->id = $group->getUri(); $group->homepage_logo,
$object->title = $group->getBestName(); AVATAR_PROFILE_SIZE
$object->link = $group->getUri(); );
$object->avatarLinks[] = AvatarLink::fromFilename($group->homepage_logo, $object->avatarLinks[] = AvatarLink::fromFilename(
AVATAR_PROFILE_SIZE); $group->stream_logo,
AVATAR_STREAM_SIZE
);
$object->avatarLinks[] = AvatarLink::fromFilename($group->stream_logo, $object->avatarLinks[] = AvatarLink::fromFilename(
AVATAR_STREAM_SIZE); $group->mini_logo,
AVATAR_MINI_SIZE
$object->avatarLinks[] = AvatarLink::fromFilename($group->mini_logo, );
AVATAR_MINI_SIZE);
$object->poco = PoCo::fromGroup($group); $object->poco = PoCo::fromGroup($group);
Event::handle('EndActivityObjectFromGroup', array($group, &$object)); Event::handle('EndActivityObjectFromGroup', [$group, &$object]);
} }
return $object; return $object;
} }
static function fromPeopletag($ptag) public static function fromPeopletag($ptag)
{ {
$object = new ActivityObject(); $object = new ActivityObject();
if (Event::handle('StartActivityObjectFromPeopletag', array($ptag, &$object))) { if (Event::handle('StartActivityObjectFromPeopletag', [$ptag, &$object])) {
$object->type = ActivityObject::_LIST; $object->type = ActivityObject::_LIST;
$object->id = $ptag->getUri(); $object->id = $ptag->getUri();
$object->title = $ptag->tag; $object->title = $ptag->tag;
$object->summary = $ptag->description; $object->summary = $ptag->description;
$object->link = $ptag->homeUrl(); $object->link = $ptag->homeUrl();
$object->owner = Profile::getKV('id', $ptag->tagger); $object->owner = Profile::getKV('id', $ptag->tagger);
$object->poco = PoCo::fromProfile($object->owner); $object->poco = PoCo::fromProfile($object->owner);
Event::handle('EndActivityObjectFromPeopletag', array($ptag, &$object)); Event::handle('EndActivityObjectFromPeopletag', [$ptag, &$object]);
} }
return $object; return $object;
} }
static function fromFile(File $file) public static function fromFile(File $file)
{ {
$object = new ActivityObject(); $object = new ActivityObject();
if (Event::handle('StartActivityObjectFromFile', array($file, &$object))) { if (Event::handle('StartActivityObjectFromFile', [$file, &$object])) {
$object->type = self::mimeTypeToObjectType($file->mimetype); $object->type = self::mimeTypeToObjectType($file->mimetype);
$object->id = TagURI::mint(sprintf("file:%d", $file->id)); $object->id = TagURI::mint(sprintf("file:%d", $file->id));
$object->link = $file->getAttachmentUrl(); $object->link = $file->getAttachmentUrl();
if ($file->title) { if ($file->title) {
@ -527,39 +535,73 @@ class ActivityObject
} }
switch (self::canonicalType($object->type)) { switch (self::canonicalType($object->type)) {
case 'image': case 'image':
$object->largerImage = $file->getUrl(); $object->largerImage = $file->getUrl();
break; break;
case 'video': case 'video':
case 'audio': case 'audio':
$object->stream = $file->getUrl(); $object->stream = $file->getUrl();
break; break;
} }
Event::handle('EndActivityObjectFromFile', array($file, &$object)); Event::handle('EndActivityObjectFromFile', [$file, &$object]);
} }
return $object; return $object;
} }
static function fromNoticeSource(Notice_source $source) public static function mimeTypeToObjectType($mimeType)
{
$ot = null;
// Default
if (empty($mimeType)) {
return self::FILE;
}
$parts = explode('/', $mimeType);
switch ($parts[0]) {
case 'image':
$ot = self::IMAGE;
break;
case 'audio':
$ot = self::AUDIO;
break;
case 'video':
$ot = self::VIDEO;
break;
default:
$ot = self::FILE;
}
return $ot;
}
public static function canonicalType($type)
{
return ActivityUtils::resolveUri($type, true);
}
public static function fromNoticeSource(Notice_source $source)
{ {
$object = new ActivityObject(); $object = new ActivityObject();
$wellKnown = array('web', 'xmpp', 'mail', 'omb', 'system', 'api', 'ostatus', $wellKnown = ['web', 'xmpp', 'mail', 'omb', 'system', 'api', 'ostatus',
'activity', 'feed', 'mirror', 'twitter', 'facebook'); 'activity', 'feed', 'mirror', 'twitter', 'facebook'];
if (Event::handle('StartActivityObjectFromNoticeSource', array($source, &$object))) { if (Event::handle('StartActivityObjectFromNoticeSource', [$source, &$object])) {
$object->type = ActivityObject::APPLICATION; $object->type = ActivityObject::APPLICATION;
if (in_array($source->code, $wellKnown)) { if (in_array($source->code, $wellKnown)) {
// We use one ID for all well-known StatusNet sources // We use one ID for all well-known StatusNet sources
$object->id = "tag:status.net,2009:notice-source:".$source->code; $object->id = "tag:status.net,2009:notice-source:" . $source->code;
} else if ($source->url) { } elseif ($source->url) {
// They registered with an URL // They registered with an URL
$object->id = $source->url; $object->id = $source->url;
} else { } else {
// Locally-registered, no URL // Locally-registered, no URL
$object->id = TagURI::mint("notice-source:".$source->code); $object->id = TagURI::mint("notice-source:" . $source->code);
} }
if ($source->url) { if ($source->url) {
@ -576,46 +618,61 @@ class ActivityObject
$object->date = $source->created; $object->date = $source->created;
} }
$object->extra[] = array('status_net', array('source_code' => $source->code)); $object->extra[] = ['status_net', ['source_code' => $source->code]];
Event::handle('EndActivityObjectFromNoticeSource', array($source, &$object)); Event::handle('EndActivityObjectFromNoticeSource', [$source, &$object]);
} }
return $object; return $object;
} }
static function fromMessage(Message $message) public static function fromMessage(Message $message)
{ {
$object = new ActivityObject(); $object = new ActivityObject();
if (Event::handle('StartActivityObjectFromMessage', array($message, &$object))) { if (Event::handle('StartActivityObjectFromMessage', [$message, &$object])) {
$object->type = ActivityObject::NOTE;
$object->type = ActivityObject::NOTE; $object->id = ($message->uri) ? $message->uri : (($message->url) ? $message->url : TagURI::mint(sprintf("message:%d", $message->id)));
$object->id = ($message->uri) ? $message->uri : (($message->url) ? $message->url : TagURI::mint(sprintf("message:%d", $message->id)));
$object->content = $message->rendered; $object->content = $message->rendered;
$object->date = $message->created; $object->date = $message->created;
if ($message->url) { if ($message->url) {
$object->link = $message->url; $object->link = $message->url;
} else { } else {
$object->link = common_local_url('showmessage', array('message' => $message->id)); $object->link = common_local_url('showmessage', ['message' => $message->id]);
} }
$object->extra[] = array('status_net', array('message_id' => $message->id)); $object->extra[] = ['status_net', ['message_id' => $message->id]];
Event::handle('EndActivityObjectFromMessage', array($message, &$object)); Event::handle('EndActivityObjectFromMessage', [$message, &$object]);
} }
return $object; return $object;
} }
function outputTo($xo, $tag='activity:object') /*
* Returns an array based on this Activity Object suitable for
* encoding as JSON.
*
* @return array $object the activity object array
*/
public function asString($tag = 'activity:object')
{
$xs = new XMLStringer(true);
$this->outputTo($xs, $tag);
return $xs->getString();
}
public function outputTo($xo, $tag = 'activity:object')
{ {
if (!empty($tag)) { if (!empty($tag)) {
$xo->elementStart($tag); $xo->elementStart($tag);
} }
if (Event::handle('StartActivityObjectOutputAtom', array($this, $xo))) { if (Event::handle('StartActivityObjectOutputAtom', [$this, $xo])) {
$xo->element('activity:object-type', null, $this->type); $xo->element('activity:object-type', null, $this->type);
// <author> uses URI // <author> uses URI
@ -650,7 +707,7 @@ class ActivityObject
// XXX: assuming HTML content here // XXX: assuming HTML content here
$xo->element( $xo->element(
ActivityUtils::CONTENT, ActivityUtils::CONTENT,
array('type' => 'html'), ['type' => 'html'],
common_xml_safe_str($this->content) common_xml_safe_str($this->content)
); );
} }
@ -658,45 +715,43 @@ class ActivityObject
if (!empty($this->link)) { if (!empty($this->link)) {
$xo->element( $xo->element(
'link', 'link',
array( [
'rel' => 'alternate', 'rel' => 'alternate',
'type' => 'text/html', 'type' => 'text/html',
'href' => $this->link 'href' => $this->link
), ]
null
); );
} }
if (!empty($this->selfLink)) { if (!empty($this->selfLink)) {
$xo->element( $xo->element(
'link', 'link',
array( [
'rel' => 'self', 'rel' => 'self',
'type' => 'application/atom+xml', 'type' => 'application/atom+xml',
'href' => $this->selfLink 'href' => $this->selfLink
), ]
null
); );
} }
if(!empty($this->owner)) { if (!empty($this->owner)) {
$owner = $this->owner->asActivityNoun(self::AUTHOR); $owner = $this->owner->asActivityNoun(self::AUTHOR);
$xo->raw($owner); $xo->raw($owner);
} }
if ($this->type == ActivityObject::PERSON if ($this->type == ActivityObject::PERSON
|| $this->type == ActivityObject::GROUP) { || $this->type == ActivityObject::GROUP) {
foreach ($this->avatarLinks as $alink) { foreach ($this->avatarLinks as $alink) {
$xo->element('link', $xo->element(
array( 'link',
'rel' => 'avatar', [
'type' => $alink->type, 'rel' => 'avatar',
'media:width' => $alink->width, 'type' => $alink->type,
'media:height' => $alink->height, 'media:width' => $alink->width,
'href' => $alink->url, 'media:height' => $alink->height,
), 'href' => $alink->url,
null); ]
);
} }
} }
@ -719,7 +774,7 @@ class ActivityObject
$xo->element($extraTag, $attrs, $content); $xo->element($extraTag, $attrs, $content);
} }
Event::handle('EndActivityObjectOutputAtom', array($this, $xo)); Event::handle('EndActivityObjectOutputAtom', [$this, $xo]);
} }
if (!empty($tag)) { if (!empty($tag)) {
@ -729,27 +784,11 @@ class ActivityObject
return; return;
} }
function asString($tag='activity:object') public function asArray()
{ {
$xs = new XMLStringer(true); $object = [];
$this->outputTo($xs, $tag); if (Event::handle('StartActivityObjectOutputJson', [$this, &$object])) {
return $xs->getString();
}
/*
* Returns an array based on this Activity Object suitable for
* encoding as JSON.
*
* @return array $object the activity object array
*/
function asArray()
{
$object = array();
if (Event::handle('StartActivityObjectOutputJson', array($this, &$object))) {
// XXX: attachments are added by Activity // XXX: attachments are added by Activity
// author (Add object for author? Could be useful for repeats.) // author (Add object for author? Could be useful for repeats.)
@ -762,7 +801,7 @@ class ActivityObject
if ($this->id) { if ($this->id) {
$object['id'] = $this->id; $object['id'] = $this->id;
} else if ($this->link) { } elseif ($this->link) {
$object['id'] = $this->link; $object['id'] = $this->link;
} }
@ -775,8 +814,8 @@ class ActivityObject
// XXX: Not sure what the best avatar is to use for the // XXX: Not sure what the best avatar is to use for the
// author's "image". For now, I'm using the large size. // author's "image". For now, I'm using the large size.
$imgLink = null; $imgLink = null;
$avatarMediaLinks = array(); $avatarMediaLinks = [];
foreach ($this->avatarLinks as $a) { foreach ($this->avatarLinks as $a) {
@ -798,14 +837,14 @@ class ActivityObject
} }
if (!array_key_exists('status_net', $object)) { if (!array_key_exists('status_net', $object)) {
$object['status_net'] = array(); $object['status_net'] = [];
} }
$object['status_net']['avatarLinks'] = $avatarMediaLinks; // extension $object['status_net']['avatarLinks'] = $avatarMediaLinks; // extension
// image // image
if (!empty($imgLink)) { if (!empty($imgLink)) {
$object['image'] = $imgLink->asArray(); $object['image'] = $imgLink->asArray();
} }
} }
@ -843,7 +882,7 @@ class ActivityObject
$parts = explode(":", $objectName); $parts = explode(":", $objectName);
if (count($parts) == 2 && $parts[0] == "statusnet") { if (count($parts) == 2 && $parts[0] == "statusnet") {
if (!array_key_exists('status_net', $object)) { if (!array_key_exists('status_net', $object)) {
$object['status_net'] = array(); $object['status_net'] = [];
} }
$object['status_net'][$parts[1]] = $props; $object['status_net'][$parts[1]] = $props;
} else { } else {
@ -853,16 +892,15 @@ class ActivityObject
} }
if (!empty($this->geopoint)) { if (!empty($this->geopoint)) {
list($lat, $lon) = explode(' ', $this->geopoint); list($lat, $lon) = explode(' ', $this->geopoint);
if (!empty($lat) && !empty($lon)) { if (!empty($lat) && !empty($lon)) {
$object['location'] = array( $object['location'] = [
'objectType' => 'place', 'objectType' => 'place',
'position' => sprintf("%+02.5F%+03.5F/", $lat, $lon), 'position' => sprintf("%+02.5F%+03.5F/", $lat, $lon),
'lat' => $lat, 'lat' => $lat,
'lon' => $lon 'lon' => $lon
); ];
$loc = Location::fromLatLon((float)$lat, (float)$lon); $loc = Location::fromLatLon((float)$lat, (float)$lon);
@ -887,9 +925,9 @@ class ActivityObject
if (!empty($this->thumbnail)) { if (!empty($this->thumbnail)) {
if (is_string($this->thumbnail)) { if (is_string($this->thumbnail)) {
$object['image'] = array('url' => $this->thumbnail); $object['image'] = ['url' => $this->thumbnail];
} else { } else {
$object['image'] = array('url' => $this->thumbnail->getUrl()); $object['image'] = ['url' => $this->thumbnail->getUrl()];
if ($this->thumbnail->width) { if ($this->thumbnail->width) {
$object['image']['width'] = $this->thumbnail->width; $object['image']['width'] = $this->thumbnail->width;
} }
@ -900,63 +938,32 @@ class ActivityObject
} }
switch (self::canonicalType($this->type)) { switch (self::canonicalType($this->type)) {
case 'image': case 'image':
if (!empty($this->largerImage)) { if (!empty($this->largerImage)) {
$object['fullImage'] = array('url' => $this->largerImage); $object['fullImage'] = ['url' => $this->largerImage];
} }
break; break;
case 'audio': case 'audio':
case 'video': case 'video':
if (!empty($this->stream)) { if (!empty($this->stream)) {
$object['stream'] = array('url' => $this->stream); $object['stream'] = ['url' => $this->stream];
} }
break; break;
} }
Event::handle('EndActivityObjectOutputJson', array($this, &$object)); Event::handle('EndActivityObjectOutputJson', [$this, &$object]);
} }
return array_filter($object); return array_filter($object);
} }
public function getIdentifiers() { public function getIdentifiers()
$ids = array(); {
foreach(array('id', 'link', 'url') as $id) { $ids = [];
foreach (['id', 'link', 'url'] as $id) {
if (isset($this->$id)) { if (isset($this->$id)) {
$ids[] = $this->$id; $ids[] = $this->$id;
} }
} }
return array_unique($ids); return array_unique($ids);
} }
static function canonicalType($type) {
return ActivityUtils::resolveUri($type, true);
}
static function mimeTypeToObjectType($mimeType) {
$ot = null;
// Default
if (empty($mimeType)) {
return self::FILE;
}
$parts = explode('/', $mimeType);
switch ($parts[0]) {
case 'image':
$ot = self::IMAGE;
break;
case 'audio':
$ot = self::AUDIO;
break;
case 'video':
$ot = self::VIDEO;
break;
default:
$ot = self::FILE;
}
return $ot;
}
} }

View File

@ -120,7 +120,7 @@ class ApiAction extends Action
{ {
const READ_ONLY = 1; const READ_ONLY = 1;
const READ_WRITE = 2; const READ_WRITE = 2;
public static $reserved_sources = array('web', 'omb', 'ostatus', 'mail', 'xmpp', 'api'); public static $reserved_sources = ['web', 'omb', 'ostatus', 'mail', 'xmpp', 'api'];
public $user = null; public $user = null;
public $auth_user = null; public $auth_user = null;
public $page = null; public $page = null;
@ -136,19 +136,19 @@ class ApiAction extends Action
public function twitterRelationshipArray($source, $target) public function twitterRelationshipArray($source, $target)
{ {
$relationship = array(); $relationship = [];
$relationship['source'] = $relationship['source'] =
$this->relationshipDetailsArray($source->getProfile(), $target->getProfile()); $this->relationshipDetailsArray($source->getProfile(), $target->getProfile());
$relationship['target'] = $relationship['target'] =
$this->relationshipDetailsArray($target->getProfile(), $source->getProfile()); $this->relationshipDetailsArray($target->getProfile(), $source->getProfile());
return array('relationship' => $relationship); return ['relationship' => $relationship];
} }
public function relationshipDetailsArray(Profile $source, Profile $target) public function relationshipDetailsArray(Profile $source, Profile $target)
{ {
$details = array(); $details = [];
$details['screen_name'] = $source->getNickname(); $details['screen_name'] = $source->getNickname();
$details['followed_by'] = $target->isSubscribed($source); $details['followed_by'] = $target->isSubscribed($source);
@ -195,19 +195,18 @@ class ApiAction extends Action
* See that method's documentation for more info. * See that method's documentation for more info.
* *
* @param string $tag Element type or tagname * @param string $tag Element type or tagname
* @param array $attrs Array of element attributes, as * @param array|string|null $attrs Array of element attributes, as key-value pairs
* key-value pairs * @param string|null $content string content of the element
* @param string $content string content of the element
* *
* @return void * @return void
*/ */
public function element($tag, $attrs = [], $content = "") public function element(string $tag, $attrs = null, $content = null)
{ {
if (is_bool($content)) { if (is_bool($content)) {
$content = ($content ? 'true' : 'false'); $content = ($content ? "true" : "false");
} }
return parent::element($tag, $attrs, $content); parent::element($tag, $attrs, $content);
} }
public function showSingleXmlStatus($notice) public function showSingleXmlStatus($notice)
@ -254,23 +253,23 @@ class ApiAction extends Action
$this->startXML(); $this->startXML();
$this->elementStart( $this->elementStart(
'rss', 'rss',
array( [
'version' => '2.0', 'version' => '2.0',
'xmlns:atom' => 'http://www.w3.org/2005/Atom', 'xmlns:atom' => 'http://www.w3.org/2005/Atom',
'xmlns:georss' => 'http://www.georss.org/georss' 'xmlns:georss' => 'http://www.georss.org/georss'
) ]
); );
$this->elementStart('channel'); $this->elementStart('channel');
Event::handle('StartApiRss', array($this)); Event::handle('StartApiRss', [$this]);
} }
public function initTwitterAtom() public function initTwitterAtom()
{ {
$this->startXML(); $this->startXML();
// FIXME: don't hardcode the language here! // FIXME: don't hardcode the language here!
$this->elementStart('feed', array('xmlns' => 'http://www.w3.org/2005/Atom', $this->elementStart('feed', ['xmlns' => 'http://www.w3.org/2005/Atom',
'xml:lang' => 'en-US', 'xml:lang' => 'en-US',
'xmlns:thr' => 'http://purl.org/syndication/thread/1.0')); 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0']);
} }
public function twitterStatusArray($notice, $include_user = true) public function twitterStatusArray($notice, $include_user = true)
@ -293,7 +292,7 @@ class ApiAction extends Action
{ {
$profile = $notice->getProfile(); $profile = $notice->getProfile();
$twitter_status = array(); $twitter_status = [];
$twitter_status['text'] = $notice->content; $twitter_status['text'] = $notice->content;
$twitter_status['truncated'] = false; # Not possible on StatusNet $twitter_status['truncated'] = false; # Not possible on StatusNet
$twitter_status['created_at'] = self::dateTwitter($notice->created); $twitter_status['created_at'] = self::dateTwitter($notice->created);
@ -346,9 +345,9 @@ class ApiAction extends Action
try { try {
$notloc = Notice_location::locFromStored($notice); $notloc = Notice_location::locFromStored($notice);
// This is the format that GeoJSON expects stuff to be in // This is the format that GeoJSON expects stuff to be in
$twitter_status['geo'] = array('type' => 'Point', $twitter_status['geo'] = ['type' => 'Point',
'coordinates' => array((float)$notloc->lat, 'coordinates' => [(float)$notloc->lat,
(float)$notloc->lon)); (float)$notloc->lon]];
} catch (ServerException $e) { } catch (ServerException $e) {
$twitter_status['geo'] = null; $twitter_status['geo'] = null;
} }
@ -357,12 +356,12 @@ class ApiAction extends Action
$attachments = $notice->attachments(); $attachments = $notice->attachments();
if (!empty($attachments)) { if (!empty($attachments)) {
$twitter_status['attachments'] = array(); $twitter_status['attachments'] = [];
foreach ($attachments as $attachment) { foreach ($attachments as $attachment) {
try { try {
$enclosure_o = $attachment->getEnclosure(); $enclosure_o = $attachment->getEnclosure();
$enclosure = array(); $enclosure = [];
$enclosure['url'] = $enclosure_o->url; $enclosure['url'] = $enclosure_o->url;
$enclosure['mimetype'] = $enclosure_o->mimetype; $enclosure['mimetype'] = $enclosure_o->mimetype;
$enclosure['size'] = $enclosure_o->size; $enclosure['size'] = $enclosure_o->size;
@ -385,8 +384,8 @@ class ApiAction extends Action
$twitter_status['statusnet_conversation_id'] = intval($notice->conversation); $twitter_status['statusnet_conversation_id'] = intval($notice->conversation);
// The event call to handle NoticeSimpleStatusArray lets plugins add data to the output array // The event call to handle NoticeSimpleStatusArray lets plugins add data to the output array
Event::handle('NoticeSimpleStatusArray', array($notice, &$twitter_status, $this->scoped, Event::handle('NoticeSimpleStatusArray', [$notice, &$twitter_status, $this->scoped,
array('include_user' => $include_user))); ['include_user' => $include_user]]);
return $twitter_status; return $twitter_status;
} }
@ -401,7 +400,7 @@ class ApiAction extends Action
public function twitterUserArray($profile, $get_notice = false) public function twitterUserArray($profile, $get_notice = false)
{ {
$twitter_user = array(); $twitter_user = [];
try { try {
$user = $profile->getUser(); $user = $profile->getUser();
@ -430,7 +429,7 @@ class ApiAction extends Action
$twitter_user['profile_image_url_original'] = $origurl; $twitter_user['profile_image_url_original'] = $origurl;
$twitter_user['groups_count'] = $profile->getGroupCount(); $twitter_user['groups_count'] = $profile->getGroupCount();
foreach (array('linkcolor', 'backgroundcolor') as $key) { foreach (['linkcolor', 'backgroundcolor'] as $key) {
$twitter_user[$key] = Profile_prefs::getConfigData($profile, 'theme', $key); $twitter_user[$key] = Profile_prefs::getConfigData($profile, 'theme', $key);
} }
// END introduced by qvitter API, not necessary for StatusNet API // END introduced by qvitter API, not necessary for StatusNet API
@ -489,14 +488,14 @@ class ApiAction extends Action
$twitter_user['statusnet_profile_url'] = $profile->profileurl; $twitter_user['statusnet_profile_url'] = $profile->profileurl;
// The event call to handle NoticeSimpleStatusArray lets plugins add data to the output array // The event call to handle NoticeSimpleStatusArray lets plugins add data to the output array
Event::handle('TwitterUserArray', array($profile, &$twitter_user, $this->scoped, array())); Event::handle('TwitterUserArray', [$profile, &$twitter_user, $this->scoped, []]);
return $twitter_user; return $twitter_user;
} }
public function showTwitterXmlStatus($twitter_status, $tag = 'status', $namespaces = false) public function showTwitterXmlStatus($twitter_status, $tag = 'status', $namespaces = false)
{ {
$attrs = array(); $attrs = [];
if ($namespaces) { if ($namespaces) {
$attrs['xmlns:statusnet'] = 'http://status.net/schema/api/1/'; $attrs['xmlns:statusnet'] = 'http://status.net/schema/api/1/';
} }
@ -537,7 +536,7 @@ class ApiAction extends Action
public function showTwitterXmlUser($twitter_user, $role = 'user', $namespaces = false) public function showTwitterXmlUser($twitter_user, $role = 'user', $namespaces = false)
{ {
$attrs = array(); $attrs = [];
if ($namespaces) { if ($namespaces) {
$attrs['xmlns:statusnet'] = 'http://status.net/schema/api/1/'; $attrs['xmlns:statusnet'] = 'http://status.net/schema/api/1/';
} }
@ -557,9 +556,9 @@ class ApiAction extends Action
public function showXmlAttachments($attachments) public function showXmlAttachments($attachments)
{ {
if (!empty($attachments)) { if (!empty($attachments)) {
$this->elementStart('attachments', array('type' => 'array')); $this->elementStart('attachments', ['type' => 'array']);
foreach ($attachments as $attachment) { foreach ($attachments as $attachment) {
$attrs = array(); $attrs = [];
$attrs['url'] = $attachment['url']; $attrs['url'] = $attachment['url'];
$attrs['mimetype'] = $attachment['mimetype']; $attrs['mimetype'] = $attachment['mimetype'];
$attrs['size'] = $attachment['size']; $attrs['size'] = $attachment['size'];
@ -575,7 +574,7 @@ class ApiAction extends Action
// empty geo element // empty geo element
$this->element('geo'); $this->element('geo');
} else { } else {
$this->elementStart('geo', array('xmlns:georss' => 'http://www.georss.org/georss')); $this->elementStart('geo', ['xmlns:georss' => 'http://www.georss.org/georss']);
$this->element('georss:point', null, $geo['coordinates'][0] . ' ' . $geo['coordinates'][1]); $this->element('georss:point', null, $geo['coordinates'][0] . ' ' . $geo['coordinates'][1]);
$this->elementEnd('geo'); $this->elementEnd('geo');
} }
@ -641,12 +640,12 @@ class ApiAction extends Action
public function showXmlTimeline($notice) public function showXmlTimeline($notice)
{ {
$this->initDocument('xml'); $this->initDocument('xml');
$this->elementStart('statuses', array('type' => 'array', $this->elementStart('statuses', ['type' => 'array',
'xmlns:statusnet' => 'http://status.net/schema/api/1/')); 'xmlns:statusnet' => 'http://status.net/schema/api/1/']);
if (is_array($notice)) { if (is_array($notice)) {
//FIXME: make everything calling showJsonTimeline use only Notice objects //FIXME: make everything calling showJsonTimeline use only Notice objects
$ids = array(); $ids = [];
foreach ($notice as $n) { foreach ($notice as $n) {
$ids[] = $n->getID(); $ids[] = $n->getID();
} }
@ -677,20 +676,20 @@ class ApiAction extends Action
if (!is_null($self)) { if (!is_null($self)) {
$this->element( $this->element(
'atom:link', 'atom:link',
array( [
'type' => 'application/rss+xml', 'type' => 'application/rss+xml',
'href' => $self, 'href' => $self,
'rel' => 'self' 'rel' => 'self'
) ]
); );
} }
if (!is_null($suplink)) { if (!is_null($suplink)) {
// For FriendFeed's SUP protocol // For FriendFeed's SUP protocol
$this->element('link', array('xmlns' => 'http://www.w3.org/2005/Atom', $this->element('link', ['xmlns' => 'http://www.w3.org/2005/Atom',
'rel' => 'http://api.friendfeed.com/2008/03#sup', 'rel' => 'http://api.friendfeed.com/2008/03#sup',
'href' => $suplink, 'href' => $suplink,
'type' => 'application/json')); 'type' => 'application/json']);
} }
if (!is_null($logo)) { if (!is_null($logo)) {
@ -707,7 +706,7 @@ class ApiAction extends Action
if (is_array($notice)) { if (is_array($notice)) {
//FIXME: make everything calling showJsonTimeline use only Notice objects //FIXME: make everything calling showJsonTimeline use only Notice objects
$ids = array(); $ids = [];
foreach ($notice as $n) { foreach ($notice as $n) {
$ids[] = $n->getID(); $ids[] = $n->getID();
} }
@ -729,16 +728,16 @@ class ApiAction extends Action
public function twitterRssEntryArray($notice) public function twitterRssEntryArray($notice)
{ {
$entry = array(); $entry = [];
if (Event::handle('StartRssEntryArray', array($notice, &$entry))) { if (Event::handle('StartRssEntryArray', [$notice, &$entry])) {
$profile = $notice->getProfile(); $profile = $notice->getProfile();
// We trim() to avoid extraneous whitespace in the output // We trim() to avoid extraneous whitespace in the output
$entry['content'] = common_xml_safe_str(trim($notice->getRendered())); $entry['content'] = common_xml_safe_str(trim($notice->getRendered()));
$entry['title'] = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content)); $entry['title'] = $profile->nickname . ': ' . common_xml_safe_str(trim($notice->content));
$entry['link'] = common_local_url('shownotice', array('notice' => $notice->id)); $entry['link'] = common_local_url('shownotice', ['notice' => $notice->id]);
$entry['published'] = common_date_iso8601($notice->created); $entry['published'] = common_date_iso8601($notice->created);
$taguribase = TagURI::base(); $taguribase = TagURI::base();
@ -749,12 +748,12 @@ class ApiAction extends Action
// Enclosures // Enclosures
$attachments = $notice->attachments(); $attachments = $notice->attachments();
$enclosures = array(); $enclosures = [];
foreach ($attachments as $attachment) { foreach ($attachments as $attachment) {
try { try {
$enclosure_o = $attachment->getEnclosure(); $enclosure_o = $attachment->getEnclosure();
$enclosure = array(); $enclosure = [];
$enclosure['url'] = $enclosure_o->url; $enclosure['url'] = $enclosure_o->url;
$enclosure['mimetype'] = $enclosure_o->mimetype; $enclosure['mimetype'] = $enclosure_o->mimetype;
$enclosure['size'] = $enclosure_o->size; $enclosure['size'] = $enclosure_o->size;
@ -772,7 +771,7 @@ class ApiAction extends Action
$tag = new Notice_tag(); $tag = new Notice_tag();
$tag->notice_id = $notice->id; $tag->notice_id = $notice->id;
if ($tag->find()) { if ($tag->find()) {
$entry['tags'] = array(); $entry['tags'] = [];
while ($tag->fetch()) { while ($tag->fetch()) {
$entry['tags'][] = $tag->tag; $entry['tags'][] = $tag->tag;
} }
@ -788,14 +787,14 @@ class ApiAction extends Action
$notloc = Notice_location::locFromStored($notice); $notloc = Notice_location::locFromStored($notice);
// This is the format that GeoJSON expects stuff to be in. // This is the format that GeoJSON expects stuff to be in.
// showGeoRSS() below uses it for XML output, so we reuse it // showGeoRSS() below uses it for XML output, so we reuse it
$entry['geo'] = array('type' => 'Point', $entry['geo'] = ['type' => 'Point',
'coordinates' => array((float)$notloc->lat, 'coordinates' => [(float)$notloc->lat,
(float)$notloc->lon)); (float)$notloc->lon]];
} catch (ServerException $e) { } catch (ServerException $e) {
$entry['geo'] = null; $entry['geo'] = null;
} }
Event::handle('EndRssEntryArray', array($notice, &$entry)); Event::handle('EndRssEntryArray', [$notice, &$entry]);
} }
return $entry; return $entry;
@ -813,7 +812,7 @@ class ApiAction extends Action
// RSS only supports 1 enclosure per item // RSS only supports 1 enclosure per item
if (array_key_exists('enclosures', $entry) and !empty($entry['enclosures'])) { if (array_key_exists('enclosures', $entry) and !empty($entry['enclosures'])) {
$enclosure = $entry['enclosures'][0]; $enclosure = $entry['enclosures'][0];
$this->element('enclosure', array('url' => $enclosure['url'], 'type' => $enclosure['mimetype'], 'length' => $enclosure['size']), null); $this->element('enclosure', ['url' => $enclosure['url'], 'type' => $enclosure['mimetype'], 'length' => $enclosure['size']]);
} }
if (array_key_exists('tags', $entry)) { if (array_key_exists('tags', $entry)) {
@ -843,7 +842,7 @@ class ApiAction extends Action
$this->element('title', null, $title); $this->element('title', null, $title);
$this->element('id', null, $id); $this->element('id', null, $id);
$this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null); $this->element('link', ['href' => $link, 'rel' => 'alternate', 'type' => 'text/html']);
if (!is_null($logo)) { if (!is_null($logo)) {
$this->element('logo', null, $logo); $this->element('logo', null, $logo);
@ -851,14 +850,14 @@ class ApiAction extends Action
if (!is_null($suplink)) { if (!is_null($suplink)) {
// For FriendFeed's SUP protocol // For FriendFeed's SUP protocol
$this->element('link', array('rel' => 'http://api.friendfeed.com/2008/03#sup', $this->element('link', ['rel' => 'http://api.friendfeed.com/2008/03#sup',
'href' => $suplink, 'href' => $suplink,
'type' => 'application/json')); 'type' => 'application/json']);
} }
if (!is_null($selfuri)) { if (!is_null($selfuri)) {
$this->element('link', array('href' => $selfuri, $this->element('link', ['href' => $selfuri,
'rel' => 'self', 'type' => 'application/atom+xml'), null); 'rel' => 'self', 'type' => 'application/atom+xml']);
} }
$this->element('updated', null, common_date_iso8601('now')); $this->element('updated', null, common_date_iso8601('now'));
@ -866,7 +865,7 @@ class ApiAction extends Action
if (is_array($notice)) { if (is_array($notice)) {
//FIXME: make everything calling showJsonTimeline use only Notice objects //FIXME: make everything calling showJsonTimeline use only Notice objects
$ids = array(); $ids = [];
foreach ($notice as $n) { foreach ($notice as $n) {
$ids[] = $n->getID(); $ids[] = $n->getID();
} }
@ -912,7 +911,7 @@ class ApiAction extends Action
public function twitterRssGroupArray($group) public function twitterRssGroupArray($group)
{ {
$entry = array(); $entry = [];
$entry['content'] = $group->description; $entry['content'] = $group->description;
$entry['title'] = $group->nickname; $entry['title'] = $group->nickname;
$entry['link'] = $group->permalink(); $entry['link'] = $group->permalink();
@ -934,18 +933,18 @@ class ApiAction extends Action
$this->element('title', null, common_xml_safe_str($entry['title'])); $this->element('title', null, common_xml_safe_str($entry['title']));
$this->element( $this->element(
'content', 'content',
array('type' => 'html'), ['type' => 'html'],
common_xml_safe_str($entry['content']) common_xml_safe_str($entry['content'])
); );
$this->element('id', null, $entry['id']); $this->element('id', null, $entry['id']);
$this->element('published', null, $entry['published']); $this->element('published', null, $entry['published']);
$this->element('updated', null, $entry['updated']); $this->element('updated', null, $entry['updated']);
$this->element('link', array('type' => 'text/html', $this->element('link', ['type' => 'text/html',
'href' => $entry['link'], 'href' => $entry['link'],
'rel' => 'alternate')); 'rel' => 'alternate']);
$this->element('link', array('type' => $entry['avatar-type'], $this->element('link', ['type' => $entry['avatar-type'],
'href' => $entry['avatar'], 'href' => $entry['avatar'],
'rel' => 'image')); 'rel' => 'image']);
$this->elementStart('author'); $this->elementStart('author');
$this->element('name', null, $entry['author-name']); $this->element('name', null, $entry['author-name']);
@ -961,11 +960,11 @@ class ApiAction extends Action
$this->element('title', null, common_xml_safe_str($title)); $this->element('title', null, common_xml_safe_str($title));
$this->element('id', null, $id); $this->element('id', null, $id);
$this->element('link', array('href' => $link, 'rel' => 'alternate', 'type' => 'text/html'), null); $this->element('link', ['href' => $link, 'rel' => 'alternate', 'type' => 'text/html']);
if (!is_null($selfuri)) { if (!is_null($selfuri)) {
$this->element('link', array('href' => $selfuri, $this->element('link', ['href' => $selfuri,
'rel' => 'self', 'type' => 'application/atom+xml'), null); 'rel' => 'self', 'type' => 'application/atom+xml']);
} }
$this->element('updated', null, common_date_iso8601('now')); $this->element('updated', null, common_date_iso8601('now'));
@ -988,11 +987,11 @@ class ApiAction extends Action
{ {
$this->initDocument('json'); $this->initDocument('json');
$statuses = array(); $statuses = [];
if (is_array($notice)) { if (is_array($notice)) {
//FIXME: make everything calling showJsonTimeline use only Notice objects //FIXME: make everything calling showJsonTimeline use only Notice objects
$ids = array(); $ids = [];
foreach ($notice as $n) { foreach ($notice as $n) {
$ids[] = $n->getID(); $ids[] = $n->getID();
} }
@ -1018,7 +1017,7 @@ class ApiAction extends Action
{ {
$this->initDocument('json'); $this->initDocument('json');
$groups = array(); $groups = [];
if (is_array($group)) { if (is_array($group)) {
foreach ($group as $g) { foreach ($group as $g) {
@ -1039,7 +1038,7 @@ class ApiAction extends Action
public function twitterGroupArray($group) public function twitterGroupArray($group)
{ {
$twitter_group = array(); $twitter_group = [];
$twitter_group['id'] = intval($group->id); $twitter_group['id'] = intval($group->id);
$twitter_group['url'] = $group->permalink(); $twitter_group['url'] = $group->permalink();
@ -1072,7 +1071,7 @@ class ApiAction extends Action
public function showXmlGroups($group) public function showXmlGroups($group)
{ {
$this->initDocument('xml'); $this->initDocument('xml');
$this->elementStart('groups', array('type' => 'array')); $this->elementStart('groups', ['type' => 'array']);
if (is_array($group)) { if (is_array($group)) {
foreach ($group as $g) { foreach ($group as $g) {
@ -1103,7 +1102,7 @@ class ApiAction extends Action
{ {
$this->initDocument('xml'); $this->initDocument('xml');
$this->elementStart('lists_list'); $this->elementStart('lists_list');
$this->elementStart('lists', array('type' => 'array')); $this->elementStart('lists', ['type' => 'array']);
if (is_array($list)) { if (is_array($list)) {
foreach ($list as $l) { foreach ($list as $l) {
@ -1130,7 +1129,7 @@ class ApiAction extends Action
{ {
$profile = Profile::getKV('id', $list->tagger); $profile = Profile::getKV('id', $list->tagger);
$twitter_list = array(); $twitter_list = [];
$twitter_list['id'] = $list->id; $twitter_list['id'] = $list->id;
$twitter_list['name'] = $list->tag; $twitter_list['name'] = $list->tag;
$twitter_list['full_name'] = '@' . $profile->nickname . '/' . $list->tag;; $twitter_list['full_name'] = '@' . $profile->nickname . '/' . $list->tag;;
@ -1169,7 +1168,7 @@ class ApiAction extends Action
{ {
$this->initDocument('json'); $this->initDocument('json');
$lists = array(); $lists = [];
if (is_array($list)) { if (is_array($list)) {
foreach ($list as $l) { foreach ($list as $l) {
@ -1183,13 +1182,13 @@ class ApiAction extends Action
} }
} }
$lists_list = array( $lists_list = [
'lists' => $lists, 'lists' => $lists,
'next_cursor' => $next_cursor, 'next_cursor' => $next_cursor,
'next_cursor_str' => strval($next_cursor), 'next_cursor_str' => strval($next_cursor),
'previous_cursor' => $prev_cursor, 'previous_cursor' => $prev_cursor,
'previous_cursor_str' => strval($prev_cursor) 'previous_cursor_str' => strval($prev_cursor)
); ];
$this->showJsonObjects($lists_list); $this->showJsonObjects($lists_list);
@ -1199,8 +1198,8 @@ class ApiAction extends Action
public function showTwitterXmlUsers($user) public function showTwitterXmlUsers($user)
{ {
$this->initDocument('xml'); $this->initDocument('xml');
$this->elementStart('users', array('type' => 'array', $this->elementStart('users', ['type' => 'array',
'xmlns:statusnet' => 'http://status.net/schema/api/1/')); 'xmlns:statusnet' => 'http://status.net/schema/api/1/']);
if (is_array($user)) { if (is_array($user)) {
foreach ($user as $u) { foreach ($user as $u) {
@ -1222,7 +1221,7 @@ class ApiAction extends Action
{ {
$this->initDocument('json'); $this->initDocument('json');
$users = array(); $users = [];
if (is_array($user)) { if (is_array($user)) {
foreach ($user as $u) { foreach ($user as $u) {
@ -1299,7 +1298,6 @@ class ApiAction extends Action
public function getTargetProfile($id) public function getTargetProfile($id)
{ {
if (empty($id)) { if (empty($id)) {
// Twitter supports these other ways of passing the user ID // Twitter supports these other ways of passing the user ID
if (self::is_decimal($this->arg('id'))) { if (self::is_decimal($this->arg('id'))) {
return Profile::getKV($this->arg('id')); return Profile::getKV($this->arg('id'));
@ -1322,14 +1320,16 @@ class ApiAction extends Action
// Fall back to trying the currently authenticated user // Fall back to trying the currently authenticated user
return $this->scoped; return $this->scoped;
} }
} elseif (self::is_decimal($id) && intval($id) > 0) {
return Profile::getByID($id);
} else {
// FIXME: check if isAcct to identify remote profiles and not just local nicknames
$nickname = common_canonical_nickname($id);
$user = User::getByNickname($nickname);
return $user->getProfile();
} }
if (self::is_decimal($id) && intval($id) > 0) {
return Profile::getByID($id);
}
// FIXME: check if isAcct to identify remote profiles and not just local nicknames
$nickname = common_canonical_nickname($id);
$user = User::getByNickname($nickname);
return $user->getProfile();
} }
private static function is_decimal($str) private static function is_decimal($str)
@ -1396,13 +1396,15 @@ class ApiAction extends Action
} elseif ($this->arg('group_name')) { } elseif ($this->arg('group_name')) {
return User_group::getForNickname($this->arg('group_name')); return User_group::getForNickname($this->arg('group_name'));
} }
} elseif (self::is_decimal($id)) { }
if (self::is_decimal($id)) {
return User_group::getKV('id', $id); return User_group::getKV('id', $id);
} elseif ($this->arg('uri')) { // FIXME: move this into empty($id) check? } elseif ($this->arg('uri')) { // FIXME: move this into empty($id) check?
return User_group::getKV('uri', urldecode($this->arg('uri'))); return User_group::getKV('uri', urldecode($this->arg('uri')));
} else {
return User_group::getForNickname($id);
} }
return User_group::getForNickname($id);
} }
public function getTargetList($user = null, $id = null) public function getTargetList($user = null, $id = null)
@ -1461,12 +1463,14 @@ class ApiAction extends Action
// Fall back to trying the currently authenticated user // Fall back to trying the currently authenticated user
return $this->scoped->getUser(); return $this->scoped->getUser();
} }
} elseif (self::is_decimal($id)) {
return User::getKV($id);
} else {
$nickname = common_canonical_nickname($id);
return User::getKV('nickname', $nickname);
} }
if (self::is_decimal($id)) {
return User::getKV($id);
}
$nickname = common_canonical_nickname($id);
return User::getKV('nickname', $nickname);
} }
/** /**
@ -1480,7 +1484,7 @@ class ApiAction extends Action
$action = mb_substr(get_class($this), 0, -6); // remove 'Action' $action = mb_substr(get_class($this), 0, -6); // remove 'Action'
$id = $this->arg('id'); $id = $this->arg('id');
$aargs = array('format' => $this->format); $aargs = ['format' => $this->format];
if (!empty($id)) { if (!empty($id)) {
$aargs['id'] = $id; $aargs['id'] = $id;
} }
@ -1517,8 +1521,9 @@ class ApiAction extends Action
* @param array $args Web and URL arguments * @param array $args Web and URL arguments
* *
* @return boolean false if user doesn't exist * @return boolean false if user doesn't exist
* @throws ClientException
*/ */
protected function prepare(array $args = array()) protected function prepare(array $args = [])
{ {
GNUsocial::setApi(true); // reduce exception reports to aid in debugging GNUsocial::setApi(true); // reduce exception reports to aid in debugging
parent::prepare($args); parent::prepare($args);
@ -1550,8 +1555,6 @@ class ApiAction extends Action
/** /**
* Handle a request * Handle a request
* *
* @param array $args Arguments from $_REQUEST
*
* @return void * @return void
*/ */
protected function handle() protected function handle()

View File

@ -206,7 +206,7 @@ class Atom10Feed extends XMLStringer
{ {
foreach ($this->links as $attrs) foreach ($this->links as $attrs)
{ {
$this->element('link', $attrs, null); $this->element('link', $attrs);
} }
} }

View File

@ -114,6 +114,6 @@ class AtomGroupNoticeFeed extends AtomNoticeFeed
$attrs['member_count'] = $this->group->getMemberCount(); $attrs['member_count'] = $this->group->getMemberCount();
$this->element('statusnet:group_info', $attrs, null); $this->element('statusnet:group_info', $attrs);
} }
} }

View File

@ -44,7 +44,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
*/ */
class ErrorAction extends InfoAction class ErrorAction extends InfoAction
{ {
static $status = array(); static $status = [];
var $code = null; var $code = null;
var $message = null; var $message = null;
@ -86,11 +86,11 @@ class ErrorAction extends InfoAction
/** /**
* Display content. * Display content.
* *
* @return nothing * @return void
*/ */
function showContent() function showContent()
{ {
$this->element('div', array('class' => 'error'), $this->message); $this->element('div', ['class' => 'error'], $this->message);
} }
function showNoticeForm() function showNoticeForm()
@ -102,20 +102,19 @@ class ErrorAction extends InfoAction
* *
* Goes back to the browser, where it's shown in a popup. * Goes back to the browser, where it's shown in a popup.
* *
* @param string $msg Message to show
*
* @return void * @return void
* @throws ClientException
*/ */
function ajaxErrorMsg() function ajaxErrorMsg()
{ {
$this->startHTML('text/xml;charset=utf-8', true); $this->startHTML('text/xml;charset=utf-8');
$this->elementStart('head'); $this->elementStart('head');
// TRANS: Page title after an AJAX error occurs on the send notice page. // TRANS: Page title after an AJAX error occurs on the send notice page.
$this->element('title', null, _('Ajax Error')); $this->element('title', null, _('Ajax Error'));
$this->elementEnd('head'); $this->elementEnd('head');
$this->elementStart('body'); $this->elementStart('body');
$this->element('p', array('id' => 'error'), $this->message); $this->element('p', ['id' => 'error'], $this->message);
$this->elementEnd('body'); $this->elementEnd('body');
$this->endHTML(); $this->endHTML();
} }

View File

@ -28,7 +28,9 @@
* @link http://status.net/ * @link http://status.net/
*/ */
if (!defined('GNUSOCIAL')) { exit(1); } if (!defined('GNUSOCIAL')) {
exit(1);
}
// Can include XHTML options but these are too fragile in practice. // Can include XHTML options but these are too fragile in practice.
define('PAGE_TYPE_PREFS', 'text/html'); define('PAGE_TYPE_PREFS', 'text/html');
@ -51,22 +53,22 @@ define('PAGE_TYPE_PREFS', 'text/html');
* @see Action * @see Action
* @see XMLOutputter * @see XMLOutputter
*/ */
class HTMLOutputter extends XMLOutputter class HTMLOutputter extends XMLOutputter
{ {
protected $DTD = array('doctype' => 'html', protected $DTD = ['doctype' => 'html',
'spec' => '-//W3C//DTD XHTML 1.0 Strict//EN', 'spec' => '-//W3C//DTD XHTML 1.0 Strict//EN',
'uri' => 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'); 'uri' => 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'];
/** /**
* Constructor * Constructor
* *
* Just wraps the XMLOutputter constructor. * Just wraps the XMLOutputter constructor.
* *
* @param string $output URI to output to, default = stdout * @param string $output URI to output to, default = stdout
* @param boolean $indent Whether to indent output, default true * @param boolean $indent Whether to indent output, default true
*/ */
function __construct($output='php://output', $indent=null) public function __construct($output = 'php://output', $indent = null)
{ {
parent::__construct($output, $indent); parent::__construct($output, $indent);
} }
@ -80,16 +82,17 @@ class HTMLOutputter extends XMLOutputter
* *
* @param string $type MIME type to use; default is to do negotation. * @param string $type MIME type to use; default is to do negotation.
* *
* @return void
* @throws ClientException
* @todo extract content negotiation code to an HTTP module or class. * @todo extract content negotiation code to an HTTP module or class.
* *
* @return void
*/ */
function startHTML($type=null) public function startHTML($type = null)
{ {
if (!$type) { if (!$type) {
$httpaccept = isset($_SERVER['HTTP_ACCEPT']) ? $httpaccept = isset($_SERVER['HTTP_ACCEPT']) ?
$_SERVER['HTTP_ACCEPT'] : null; $_SERVER['HTTP_ACCEPT'] : null;
// XXX: allow content negotiation for RDF, RSS, or XRDS // XXX: allow content negotiation for RDF, RSS, or XRDS
@ -100,16 +103,16 @@ class HTMLOutputter extends XMLOutputter
if (!$type) { if (!$type) {
// TRANS: Client exception 406 // TRANS: Client exception 406
throw new ClientException(_('This page is not available in a '. throw new ClientException(_('This page is not available in a ' .
'media type you accept'), 406); 'media type you accept'), 406);
} }
} }
header('Content-Type: '.$type); header('Content-Type: ' . $type);
// Output anti-framing headers to prevent clickjacking (respected by newer // Output anti-framing headers to prevent clickjacking (respected by newer
// browsers). // browsers).
if (common_config('javascript', 'bustframes')) { if (common_config('javascript', 'bustframes')) {
header('X-XSS-Protection: 1; mode=block'); // detect XSS Reflection attacks header('X-XSS-Protection: 1; mode=block'); // detect XSS Reflection attacks
header('X-Frame-Options: SAMEORIGIN'); // no rendering if origin mismatch header('X-Frame-Options: SAMEORIGIN'); // no rendering if origin mismatch
} }
@ -124,55 +127,57 @@ class HTMLOutputter extends XMLOutputter
$language = $this->getLanguage(); $language = $this->getLanguage();
$attrs = array( $attrs = [
'xmlns' => 'http://www.w3.org/1999/xhtml', 'xmlns' => 'http://www.w3.org/1999/xhtml',
'xml:lang' => $language, 'xml:lang' => $language,
'lang' => $language 'lang' => $language
); ];
if (Event::handle('StartHtmlElement', array($this, &$attrs))) { if (Event::handle('StartHtmlElement', [$this, &$attrs])) {
$this->elementStart('html', $attrs); $this->elementStart('html', $attrs);
Event::handle('EndHtmlElement', array($this, &$attrs)); Event::handle('EndHtmlElement', [$this, &$attrs]);
} }
} }
public function setDTD($doctype, $spec, $uri) /**
* To specify additional HTTP headers for the action
*
* @return void
*/
public function extraHeaders()
{ {
$this->DTD = array('doctype' => $doctype, 'spec' => $spec, 'uri' => $uri); // Needs to be overloaded
} }
protected function writeDTD() protected function writeDTD()
{ {
$this->xw->writeDTD($this->DTD['doctype'], $this->xw->writeDTD(
$this->DTD['spec'], $this->DTD['doctype'],
$this->DTD['uri']); $this->DTD['spec'],
$this->DTD['uri']
);
} }
function getLanguage() public function getLanguage()
{ {
// FIXME: correct language for interface // FIXME: correct language for interface
return common_language(); return common_language();
} }
/** public function setDTD($doctype, $spec, $uri)
* Ends an HTML document
*
* @return void
*/
function endHTML()
{ {
$this->elementEnd('html'); $this->DTD = ['doctype' => $doctype, 'spec' => $spec, 'uri' => $uri];
$this->endXML();
} }
/** /**
* To specify additional HTTP headers for the action * Ends an HTML document
* *
* @return void * @return void
*/ */
function extraHeaders() public function endHTML()
{ {
// Needs to be overloaded $this->elementEnd('html');
$this->endXML();
} }
/** /**
@ -185,24 +190,23 @@ class HTMLOutputter extends XMLOutputter
* *
* If $attrs['type'] does not exist it will be set to 'text'. * If $attrs['type'] does not exist it will be set to 'text'.
* *
* @param string $id element ID, must be unique on page * @param string $id element ID, must be unique on page
* @param string $label text of label for the element * @param string $label text of label for the element
* @param string $value value of the element, default null * @param string $value value of the element, default null
* @param string $instructions instructions for valid input * @param string $instructions instructions for valid input
* @param string $name name of the element; if null, the id will * @param string $name name of the element; if null, the id will be used
* be used * @param bool $required HTML5 required attribute (exclude when false)
* @param bool $required HTML5 required attribute (exclude when false) * @param array $attrs Initial attributes manually set in an array (overwritten by previous options)
* @param array $attrs Initial attributes manually set in an array (overwritten by previous options)
* *
* @return void
* @todo add a $maxLength parameter * @todo add a $maxLength parameter
* @todo add a $size parameter * @todo add a $size parameter
* *
* @return void
*/ */
function input($id, $label, $value=null, $instructions=null, $name=null, $required=false, array $attrs=array()) public function input($id, $label, $value = null, $instructions = null, $name = null, $required = false, array $attrs = [])
{ {
$this->element('label', array('for' => $id), $label); $this->element('label', ['for' => $id], $label);
if (!array_key_exists('type', $attrs)) { if (!array_key_exists('type', $attrs)) {
$attrs['type'] = 'text'; $attrs['type'] = 'text';
} }
@ -234,25 +238,31 @@ class HTMLOutputter extends XMLOutputter
* Note that the value is default 'true' (the string), which can * Note that the value is default 'true' (the string), which can
* be used by Action::boolean() * be used by Action::boolean()
* *
* @param string $id element ID, must be unique on page * @param string $id element ID, must be unique on page
* @param string $label text of label for the element * @param string $label text of label for the element
* @param string $checked if the box is checked, default false * @param bool $checked if the box is checked, default false
* @param string $instructions instructions for valid input * @param string $instructions instructions for valid input
* @param string $value value of the checkbox, default 'true' * @param string $value value of the checkbox, default 'true'
* @param string $disabled show the checkbox disabled, default false * @param bool $disabled show the checkbox disabled, default false
* *
* @return void * @return void
* *
* @todo add a $name parameter * @todo add a $name parameter
*/ */
function checkbox($id, $label, $checked=false, $instructions=null, public function checkbox(
$value='true', $disabled=false) $id,
$label,
$checked = false,
$instructions = null,
$value = 'true',
$disabled = false
)
{ {
$attrs = array('name' => $id, $attrs = ['name' => $id,
'type' => 'checkbox', 'type' => 'checkbox',
'class' => 'checkbox', 'class' => 'checkbox',
'id' => $id); 'id' => $id];
if ($value) { if ($value) {
$attrs['value'] = $value; $attrs['value'] = $value;
} }
@ -264,9 +274,12 @@ class HTMLOutputter extends XMLOutputter
} }
$this->element('input', $attrs); $this->element('input', $attrs);
$this->text(' '); $this->text(' ');
$this->element('label', array('class' => 'checkbox', $this->element(
'for' => $id), 'label',
$label); ['class' => 'checkbox',
'for' => $id],
$label
);
$this->text(' '); $this->text(' ');
if ($instructions) { if ($instructions) {
$this->element('p', 'form_guide', $instructions); $this->element('p', 'form_guide', $instructions);
@ -280,33 +293,42 @@ class HTMLOutputter extends XMLOutputter
* the key is the option value attribute and the value is the option * the key is the option value attribute and the value is the option
* text. (Careful on the overuse of 'value' here.) * text. (Careful on the overuse of 'value' here.)
* *
* @param string $id element ID, must be unique on page * @param string $id element ID, must be unique on page
* @param string $label text of label for the element * @param string $label text of label for the element
* @param array $content options array, value => text * @param array $content options array, value => text
* @param string $instructions instructions for valid input * @param string $instructions instructions for valid input
* @param string $blank_select whether to have a blank entry, default false * @param bool $blank_select whether to have a blank entry, default false
* @param string $selected selected value, default null * @param string $selected selected value, default null
* *
* @return void * @return void
* *
* @todo add a $name parameter * @todo add a $name parameter
*/ */
function dropdown($id, $label, $content, $instructions=null, public function dropdown(
$blank_select=false, $selected=null) $id,
$label,
$content,
$instructions = null,
$blank_select = false,
$selected = null
)
{ {
$this->element('label', array('for' => $id), $label); $this->element('label', ['for' => $id], $label);
$this->elementStart('select', array('id' => $id, 'name' => $id)); $this->elementStart('select', ['id' => $id, 'name' => $id]);
if ($blank_select) { if ($blank_select) {
$this->element('option', array('value' => '')); $this->element('option', ['value' => '']);
} }
foreach ($content as $value => $option) { foreach ($content as $value => $option) {
if ($value == $selected) { if ($value == $selected) {
$this->element('option', array('value' => $value, $this->element(
'selected' => 'selected'), 'option',
$option); ['value' => $value,
'selected' => 'selected'],
$option
);
} else { } else {
$this->element('option', array('value' => $value), $option); $this->element('option', ['value' => $value], $option);
} }
} }
$this->elementEnd('select'); $this->elementEnd('select');
@ -320,26 +342,26 @@ class HTMLOutputter extends XMLOutputter
* *
* $id is re-used as name * $id is re-used as name
* *
* @param string $id element ID, must be unique on page * @param string $id element ID, must be unique on page
* @param string $value hidden element value, default null * @param string $value hidden element value, default null
* @param string $name name, if different than ID * @param string $name name, if different than ID
* *
* @return void * @return void
*/ */
function hidden($id, $value, $name=null) public function hidden($id, $value, $name = null)
{ {
$this->element('input', array('name' => $name ?: $id, $this->element('input', ['name' => $name ?: $id,
'type' => 'hidden', 'type' => 'hidden',
'id' => $id, 'id' => $id,
'value' => $value)); 'value' => $value]);
} }
/** /**
* output an HTML password input and associated elements * output an HTML password input and associated elements
* *
* @param string $id element ID, must be unique on page * @param string $id element ID, must be unique on page
* @param string $label text of label for the element * @param string $label text of label for the element
* @param string $instructions instructions for valid input * @param string $instructions instructions for valid input
* *
* @return void * @return void
@ -347,13 +369,13 @@ class HTMLOutputter extends XMLOutputter
* @todo add a $name parameter * @todo add a $name parameter
*/ */
function password($id, $label, $instructions=null) public function password($id, $label, $instructions = null)
{ {
$this->element('label', array('for' => $id), $label); $this->element('label', ['for' => $id], $label);
$attrs = array('name' => $id, $attrs = ['name' => $id,
'type' => 'password', 'type' => 'password',
'class' => 'password', 'class' => 'password',
'id' => $id); 'id' => $id];
$this->element('input', $attrs); $this->element('input', $attrs);
if ($instructions) { if ($instructions) {
$this->element('p', 'form_guide', $instructions); $this->element('p', 'form_guide', $instructions);
@ -363,39 +385,38 @@ class HTMLOutputter extends XMLOutputter
/** /**
* output an HTML submit input and associated elements * output an HTML submit input and associated elements
* *
* @param string $id element ID, must be unique on page * @param string $id element ID, must be unique on page
* @param string $label text of the button * @param string $label text of the button
* @param string $cls class of the button, default 'submit' * @param string $cls class of the button, default 'submit'
* @param string $name name, if different than ID * @param string $name name, if different than ID
* @param string $title title text for the submit button * @param string $title title text for the submit button
* *
* @return void * @return void
* *
* @todo add a $name parameter * @todo add a $name parameter
*/ */
function submit($id, $label, $cls='submit', $name=null, $title=null) public function submit($id, $label, $cls = 'submit', $name = null, $title = null)
{ {
$this->element('input', array('type' => 'submit', $this->element('input', ['type' => 'submit',
'id' => $id, 'id' => $id,
'name' => $name ?: $id, 'name' => $name ?: $id,
'class' => $cls, 'class' => $cls,
'value' => $label, 'value' => $label,
'title' => $title)); 'title' => $title]);
} }
/** /**
* output a script (almost always javascript) tag * output a script (almost always javascript) tag
* *
* @param string $src relative or absolute script path * @param string $src relative or absolute script path
* @param string $type 'type' attribute value of the tag * @param string $type 'type' attribute value of the tag
* *
* @return void * @return void
*/ */
function script($src, $type='text/javascript') public function script($src, $type = 'text/javascript')
{ {
if (Event::handle('StartScriptElement', array($this,&$src,&$type))) { if (Event::handle('StartScriptElement', [$this, &$src, &$type])) {
$url = parse_url($src); $url = parse_url($src);
if (empty($url['scheme']) && empty($url['host']) && empty($url['query']) && empty($url['fragment'])) { if (empty($url['scheme']) && empty($url['host']) && empty($url['query']) && empty($url['fragment'])) {
@ -403,35 +424,28 @@ class HTMLOutputter extends XMLOutputter
// XXX: this seems like a big assumption // XXX: this seems like a big assumption
if (strpos($src, 'plugins/') === 0 || strpos($src, 'local/') === 0) { if (strpos($src, 'plugins/') === 0 || strpos($src, 'local/') === 0) {
$src = common_path($src, GNUsocial::isHTTPS()) . '?version=' . GNUSOCIAL_VERSION; $src = common_path($src, GNUsocial::isHTTPS()) . '?version=' . GNUSOCIAL_VERSION;
} else { } else {
if (GNUsocial::isHTTPS()) { if (GNUsocial::isHTTPS()) {
$server = common_config('javascript', 'sslserver');
$sslserver = common_config('javascript', 'sslserver'); if (empty($server)) {
if (empty($sslserver)) {
if (is_string(common_config('site', 'sslserver')) && if (is_string(common_config('site', 'sslserver')) &&
mb_strlen(common_config('site', 'sslserver')) > 0) { mb_strlen(common_config('site', 'sslserver')) > 0) {
$server = common_config('site', 'sslserver'); $server = common_config('site', 'sslserver');
} else if (common_config('site', 'server')) { } elseif (common_config('site', 'server')) {
$server = common_config('site', 'server'); $server = common_config('site', 'server');
} }
$path = common_config('site', 'path') . '/js/'; $path = common_config('site', 'path') . '/js/';
} else { } else {
$server = $sslserver; $path = common_config('javascript', 'sslpath');
$path = common_config('javascript', 'sslpath');
if (empty($path)) { if (empty($path)) {
$path = common_config('javascript', 'path'); $path = common_config('javascript', 'path');
} }
} }
$protocol = 'https'; $protocol = 'https';
} else { } else {
$path = common_config('javascript', 'path'); $path = common_config('javascript', 'path');
if (empty($path)) { if (empty($path)) {
@ -447,79 +461,55 @@ class HTMLOutputter extends XMLOutputter
$protocol = 'http'; $protocol = 'http';
} }
if ($path[strlen($path)-1] != '/') { if ($path[strlen($path) - 1] != '/') {
$path .= '/'; $path .= '/';
} }
if ($path[0] != '/') { if ($path[0] != '/') {
$path = '/'.$path; $path = '/' . $path;
} }
$src = $protocol.'://'.$server.$path.$src . '?version=' . GNUSOCIAL_VERSION; $src = $protocol . '://' . $server . $path . $src . '?version=' . GNUSOCIAL_VERSION;
} }
} }
$this->element('script', array('type' => $type, $this->element(
'src' => $src), 'script',
' '); ['type' => $type,
'src' => $src],
' '
);
Event::handle('EndScriptElement', array($this,$src,$type)); Event::handle('EndScriptElement', [$this, $src, $type]);
}
}
/**
* output a script (almost always javascript) tag with inline
* code.
*
* @param string $code code to put in the script tag
* @param string $type 'type' attribute value of the tag
*
* @return void
*/
function inlineScript($code, $type='text/javascript')
{
if(Event::handle('StartInlineScriptElement', array($this,&$code,&$type))) {
$this->elementStart('script', array('type' => $type));
if($type == 'text/javascript') {
$this->raw('/*<![CDATA[*/ '); // XHTML compat
}
$this->raw($code);
if($type == 'text/javascript') {
$this->raw(' /*]]>*/'); // XHTML compat
}
$this->elementEnd('script');
Event::handle('EndInlineScriptElement', array($this,$code,$type));
} }
} }
/** /**
* output a css link * output a css link
* *
* @param string $src relative path within the theme directory, or an absolute path * @param string $src relative path within the theme directory, or an absolute path
* @param string $theme 'theme' that contains the stylesheet * @param string $theme 'theme' that contains the stylesheet
* @param string media 'media' attribute of the tag * @param string media 'media' attribute of the tag
* *
* @return void * @return void
*/ */
function cssLink($src,$theme=null,$media=null) public function cssLink($src, $theme = null, $media = null)
{ {
if(Event::handle('StartCssLinkElement', array($this,&$src,&$theme,&$media))) { if (Event::handle('StartCssLinkElement', [$this, &$src, &$theme, &$media])) {
$url = parse_url($src); $url = parse_url($src);
if( empty($url['scheme']) && empty($url['host']) && empty($url['query']) && empty($url['fragment'])) if (empty($url['scheme']) && empty($url['host']) && empty($url['query']) && empty($url['fragment'])) {
{ if (file_exists(Theme::file($src, $theme))) {
if(file_exists(Theme::file($src,$theme))){ $src = Theme::path($src, $theme);
$src = Theme::path($src, $theme); } else {
}else{
$src = common_path($src, GNUsocial::isHTTPS()); $src = common_path($src, GNUsocial::isHTTPS());
} }
$src.= '?version=' . GNUSOCIAL_VERSION; $src .= '?version=' . GNUSOCIAL_VERSION;
} }
$this->element('link', array('rel' => 'stylesheet', $this->element('link', ['rel' => 'stylesheet',
'type' => 'text/css', 'type' => 'text/css',
'href' => $src, 'href' => $src,
'media' => $media)); 'media' => $media]);
Event::handle('EndCssLinkElement', array($this,$src,$theme,$media)); Event::handle('EndCssLinkElement', [$this, $src, $theme, $media]);
} }
} }
@ -527,87 +517,119 @@ class HTMLOutputter extends XMLOutputter
* output a style (almost always css) tag with inline * output a style (almost always css) tag with inline
* code. * code.
* *
* @param string $code code to put in the style tag * @param string $code code to put in the style tag
* @param string $type 'type' attribute value of the tag * @param string $type 'type' attribute value of the tag
* @param string $media 'media' attribute value of the tag * @param string $media 'media' attribute value of the tag
* *
* @return void * @return void
*/ */
function style($code, $type = 'text/css', $media = null) public function style($code, $type = 'text/css', $media = null)
{ {
if(Event::handle('StartStyleElement', array($this,&$code,&$type,&$media))) { if (Event::handle('StartStyleElement', [$this, &$code, &$type, &$media])) {
$this->elementStart('style', array('type' => $type, 'media' => $media)); $this->elementStart('style', ['type' => $type, 'media' => $media]);
$this->raw($code); $this->raw($code);
$this->elementEnd('style'); $this->elementEnd('style');
Event::handle('EndStyleElement', array($this,$code,$type,$media)); Event::handle('EndStyleElement', [$this, $code, $type, $media]);
} }
} }
/** /**
* output an HTML textarea and associated elements * output an HTML textarea and associated elements
* *
* @param string $id element ID, must be unique on page * @param string $id element ID, must be unique on page
* @param string $label text of label for the element * @param string $label text of label for the element
* @param string $content content of the textarea, default none * @param string $content content of the textarea, default none
* @param string $instructions instructions for valid input * @param string $instructions instructions for valid input
* @param string $name name of textarea; if null, $id will be used * @param string $name name of textarea; if null, $id will be used
* @param int $cols number of columns * @param int $cols number of columns
* @param int $rows number of rows * @param int $rows number of rows
* @param bool $required HTML5 required attribute (exclude when false) * @param bool $required HTML5 required attribute (exclude when false)
* *
* @return void * @return void
*/ */
function textarea( public function textarea(
$id, $id,
$label, $label,
$content = null, $content = null,
$instructions = null, $instructions = null,
$name = null, $name = null,
$cols = null, $cols = null,
$rows = null, $rows = null,
$required = false $required = false
) { )
$this->element('label', array('for' => $id), $label); {
$attrs = array( $this->element('label', ['for' => $id], $label);
$attrs = [
'rows' => 3, 'rows' => 3,
'cols' => 40, 'cols' => 40,
'id' => $id 'id' => $id
); ];
$attrs['name'] = is_null($name) ? $id : $name; $attrs['name'] = is_null($name) ? $id : $name;
if ($cols != null) { if ($cols != null) {
$attrs['cols'] = $cols; $attrs['cols'] = $cols;
} }
if ($rows != null) { if ($rows != null) {
$attrs['rows'] = $rows; $attrs['rows'] = $rows;
} }
if (!empty($required)) {
$attrs['required'] = 'required';
}
$this->element( $this->element(
'textarea', 'textarea',
$attrs, $attrs,
is_null($content) ? '' : $content $content
); );
if ($instructions) { if ($instructions) {
$this->element('p', 'form_guide', $instructions); $this->element('p', 'form_guide', $instructions);
} }
} }
/** /**
* Internal script to autofocus the given element on page onload. * Internal script to autofocus the given element on page onload.
* *
* @param string $id element ID, must refer to an existing element * @param string $id element ID, must refer to an existing element
* *
* @return void * @return void
* *
*/ */
function autofocus($id) public function autofocus($id)
{ {
$this->inlineScript( $this->inlineScript(
' $(document).ready(function() {'. ' $(document).ready(function() {' .
' var el = $("#' . $id . '");'. ' var el = $("#' . $id . '");' .
' if (el.length) { el.focus(); }'. ' if (el.length) { el.focus(); }' .
' });'); ' });'
);
}
/**
* output a script (almost always javascript) tag with inline
* code.
*
* @param string $code code to put in the script tag
* @param string $type 'type' attribute value of the tag
*
* @return void
*/
public function inlineScript($code, $type = 'text/javascript')
{
if (Event::handle('StartInlineScriptElement', [$this, &$code, &$type])) {
$this->elementStart('script', ['type' => $type]);
if ($type == 'text/javascript') {
$this->raw('/*<![CDATA[*/ '); // XHTML compat
}
$this->raw($code);
if ($type == 'text/javascript') {
$this->raw(' /*]]>*/'); // XHTML compat
}
$this->elementEnd('script');
Event::handle('EndInlineScriptElement', [$this, $code, $type]);
}
} }
} }

View File

@ -64,7 +64,7 @@ class InfoAction extends ManagedAction
/** /**
* Page title. * Page title.
* *
* @return page title * @return string page title
*/ */
function title() function title()
@ -81,8 +81,8 @@ class InfoAction extends ManagedAction
function showBody() function showBody()
{ {
$this->elementStart('body', array('id' => 'error')); $this->elementStart('body', ['id' => 'error']);
$this->elementStart('div', array('id' => 'wrap')); $this->elementStart('div', ['id' => 'wrap']);
$this->showHeader(); $this->showHeader();
$this->showCore(); $this->showCore();
$this->showFooter(); $this->showFooter();
@ -92,10 +92,10 @@ class InfoAction extends ManagedAction
function showCore() function showCore()
{ {
$this->elementStart('div', array('id' => 'core')); $this->elementStart('div', ['id' => 'core']);
$this->elementStart('div', array('id' => 'aside_primary_wrapper')); $this->elementStart('div', ['id' => 'aside_primary_wrapper']);
$this->elementStart('div', array('id' => 'content_wrapper')); $this->elementStart('div', ['id' => 'content_wrapper']);
$this->elementStart('div', array('id' => 'site_nav_local_views_wrapper')); $this->elementStart('div', ['id' => 'site_nav_local_views_wrapper']);
$this->showContentBlock(); $this->showContentBlock();
$this->elementEnd('div'); $this->elementEnd('div');
$this->elementEnd('div'); $this->elementEnd('div');
@ -105,7 +105,7 @@ class InfoAction extends ManagedAction
function showHeader() function showHeader()
{ {
$this->elementStart('div', array('id' => 'header')); $this->elementStart('div', ['id' => 'header']);
$this->showLogo(); $this->showLogo();
$this->showPrimaryNav(); $this->showPrimaryNav();
$this->elementEnd('div'); $this->elementEnd('div');
@ -114,11 +114,11 @@ class InfoAction extends ManagedAction
/** /**
* Display content. * Display content.
* *
* @return nothing * @return void
*/ */
function showContent() function showContent()
{ {
$this->element('div', array('class' => 'info'), $this->message); $this->element('div', ['class' => 'info'], $this->message);
} }
} }

View File

@ -150,12 +150,12 @@ class Menu extends Widget
function submenu($label, $menu) function submenu($label, $menu)
{ {
if (Event::handle('StartSubMenu', array($this->action, $menu, $label))) { if (Event::handle('StartSubMenu', [$this->action, $menu, $label])) {
$this->action->elementStart('li'); $this->action->elementStart('li');
$this->action->element('h3', null, $label); $this->action->element('h3', null, $label);
$menu->show(); $menu->show();
$this->action->elementEnd('li'); $this->action->elementEnd('li');
Event::handle('EndSubMenu', array($this->action, $menu, $label)); Event::handle('EndSubMenu', [$this->action, $menu, $label]);
} }
} }
} }

View File

@ -29,7 +29,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
if (!defined('GNUSOCIAL')) { exit(1); } if (!defined('GNUSOCIAL')) {
exit(1);
}
/** /**
* Class for displaying HTTP server errors * Class for displaying HTTP server errors
@ -48,17 +50,16 @@ if (!defined('GNUSOCIAL')) { exit(1); }
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3 * @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://status.net/ * @link http://status.net/
*/ */
class ServerErrorAction extends ErrorAction class ServerErrorAction extends ErrorAction
{ {
static $status = array(500 => 'Internal Server Error', static $status = [500 => 'Internal Server Error',
501 => 'Not Implemented', 501 => 'Not Implemented',
502 => 'Bad Gateway', 502 => 'Bad Gateway',
503 => 'Service Unavailable', 503 => 'Service Unavailable',
504 => 'Gateway Timeout', 504 => 'Gateway Timeout',
505 => 'HTTP Version Not Supported'); 505 => 'HTTP Version Not Supported'];
function __construct($message='Error', $code=500, $ex=null) function __construct($message = 'Error', $code = 500, $ex = null)
{ {
parent::__construct($message, $code); parent::__construct($message, $code);
@ -85,23 +86,23 @@ class ServerErrorAction extends ErrorAction
/** /**
* To specify additional HTTP headers for the action * To specify additional HTTP headers for the action
* *
* @return void * @return void
*/ */
function extraHeaders() function extraHeaders()
{ {
$status_string = @self::$status[$this->code]; $status_string = self::$status[$this->code];
header('HTTP/1.1 '.$this->code.' '.$status_string); header('HTTP/1.1 ' . $this->code . ' ' . $status_string);
} }
/** /**
* Page title. * Page title.
* *
* @return page title * @return string page title
*/ */
function title() function title()
{ {
return @self::$status[$this->code]; return self::$status[$this->code];
} }
} }

View File

@ -45,7 +45,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
class ServerException extends Exception class ServerException extends Exception
{ {
public function __construct($message = null, $code = 500) { public function __construct($message = "", $code = 500) {
parent::__construct($message, $code); parent::__construct($message, $code);
} }

View File

@ -48,7 +48,6 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
* @see Action * @see Action
* @see HTMLOutputter * @see HTMLOutputter
*/ */
class XMLOutputter class XMLOutputter
{ {
/** /**
@ -56,25 +55,25 @@ class XMLOutputter
* for output. * for output.
*/ */
var $xw = null; public $xw = null;
/** /**
* Constructor * Constructor
* *
* Initializes the wrapped XMLWriter. * Initializes the wrapped XMLWriter.
* *
* @param string $output URL for outputting, if null it defaults to stdout ('php://output') * @param string $output URL for outputting, if null it defaults to stdout ('php://output')
* @param boolean $indent Whether to indent output, default true * @param boolean $indent Whether to indent output, default true
*/ */
function __construct($output=null, $indent=null) public function __construct($output = null, $indent = null)
{ {
if (is_null($output)) { if (is_null($output)) {
$output = 'php://output'; $output = 'php://output';
} }
$this->xw = new XMLWriter(); $this->xw = new XMLWriter();
$this->xw->openURI($output); $this->xw->openURI($output);
if(is_null($indent)) { if (is_null($indent)) {
$indent = common_config('site', 'indent'); $indent = common_config('site', 'indent');
} }
$this->xw->setIndent($indent); $this->xw->setIndent($indent);
@ -83,14 +82,14 @@ class XMLOutputter
/** /**
* Start a new XML document * Start a new XML document
* *
* @param string $doc document element * @param string $doc document element
* @param string $public public identifier * @param string $public public identifier
* @param string $system system identifier * @param string $system system identifier
* *
* @return void * @return void
*/ */
function startXML($doc=null, $public=null, $system=null) public function startXML($doc = null, $public = null, $system = null)
{ {
$this->xw->startDocument('1.0', 'UTF-8'); $this->xw->startDocument('1.0', 'UTF-8');
if ($doc) { if ($doc) {
@ -107,7 +106,7 @@ class XMLOutputter
* @return void * @return void
*/ */
function endXML() public function endXML()
{ {
$this->xw->endDocument(); $this->xw->endDocument();
$this->xw->flush(); $this->xw->flush();
@ -128,28 +127,18 @@ class XMLOutputter
* If $attrs is a string instead of an array, it will be treated * If $attrs is a string instead of an array, it will be treated
* as the class attribute of the element. * as the class attribute of the element.
* *
* @param string $tag Element type or tagname * @param string $tag Element type or tagname
* @param array $attrs Array of element attributes, as * @param array|string|null $attrs Array of element attributes, as key-value pairs
* key-value pairs * @param string|null $content string content of the element
* @param string $content string content of the element
* *
* @return void * @return void
*/ */
function element($tag, $attrs=null, $content=null) public function element(string $tag, $attrs = null, $content = null)
{ {
$this->elementStart($tag, $attrs); $this->elementStart($tag, $attrs);
if (!is_null($content)) { if (!is_null($content)) {
$this->xw->text($content); $this->xw->text(strval($content));
}
$this->elementEnd($tag);
}
function elementNS(array $ns, $tag, $attrs=null, $content=null)
{
$this->elementStartNS($ns, $tag, $attrs);
if (!is_null($content)) {
$this->xw->text($content);
} }
$this->elementEnd($tag); $this->elementEnd($tag);
} }
@ -163,34 +152,20 @@ class XMLOutputter
* If $attrs is a string instead of an array, it will be treated * If $attrs is a string instead of an array, it will be treated
* as the class attribute of the element. * as the class attribute of the element.
* *
* @param string $tag Element type or tagname * @param string $tag Element type or tagname
* @param array $attrs Array of element attributes * @param array|string|null $attrs Attributes
* *
* @return void * @return void
*/ */
function elementStart($tag, $attrs=null) public function elementStart(string $tag, $attrs = null)
{ {
$this->xw->startElement($tag); $this->xw->startElement($tag);
if (is_array($attrs)) { if (is_array($attrs)) {
foreach ($attrs as $name => $value) { foreach ($attrs as $name => $value) {
$this->xw->writeAttribute($name, $value); $this->xw->writeAttribute($name, $value);
} }
} else if (is_string($attrs)) { } elseif (is_string($attrs)) {
$this->xw->writeAttribute('class', $attrs);
}
}
function elementStartNS(array $ns, $tag, $attrs=null)
{
reset($ns); // array pointer to 0
$uri = key($ns);
$this->xw->startElementNS($ns[$uri], $tag, $uri);
if (is_array($attrs)) {
foreach ($attrs as $name => $value) {
$this->xw->writeAttribute($name, $value);
}
} else if (is_string($attrs)) {
$this->xw->writeAttribute('class', $attrs); $this->xw->writeAttribute('class', $attrs);
} }
} }
@ -211,11 +186,11 @@ class XMLOutputter
* @return void * @return void
*/ */
function elementEnd($tag) public function elementEnd(string $tag)
{ {
static $empty_tag = array('base', 'meta', 'link', 'hr', static $empty_tag = ['base', 'meta', 'link', 'hr',
'br', 'param', 'img', 'area', 'br', 'param', 'img', 'area',
'input', 'col', 'source'); 'input', 'col', 'source'];
// XXX: check namespace // XXX: check namespace
if (in_array($tag, $empty_tag)) { if (in_array($tag, $empty_tag)) {
$this->xw->endElement(); $this->xw->endElement();
@ -224,6 +199,29 @@ class XMLOutputter
} }
} }
public function elementNS(array $ns, $tag, $attrs = null, $content = null)
{
$this->elementStartNS($ns, $tag, $attrs);
if (!is_null($content)) {
$this->xw->text($content);
}
$this->elementEnd($tag);
}
public function elementStartNS(array $ns, $tag, $attrs = null)
{
reset($ns); // array pointer to 0
$uri = key($ns);
$this->xw->startElementNS($ns[$uri], $tag, $uri);
if (is_array($attrs)) {
foreach ($attrs as $name => $value) {
$this->xw->writeAttribute($name, $value);
}
} elseif (is_string($attrs)) {
$this->xw->writeAttribute('class', $attrs);
}
}
/** /**
* output plain text * output plain text
* *
@ -235,7 +233,7 @@ class XMLOutputter
* @return void * @return void
*/ */
function text($txt) public function text($txt)
{ {
$this->xw->text($txt); $this->xw->text($txt);
} }
@ -251,7 +249,7 @@ class XMLOutputter
* @return void * @return void
*/ */
function raw($xml) public function raw($xml)
{ {
$this->xw->writeRaw($xml); $this->xw->writeRaw($xml);
} }
@ -264,7 +262,7 @@ class XMLOutputter
* @return void * @return void
*/ */
function comment($txt) public function comment($txt)
{ {
$this->xw->writeComment($txt); $this->xw->writeComment($txt);
} }
@ -275,7 +273,7 @@ class XMLOutputter
* @return void * @return void
*/ */
function flush() public function flush()
{ {
$this->xw->flush(); $this->xw->flush();
} }

View File

@ -42,27 +42,26 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
* @see Action * @see Action
* @see HTMLOutputter * @see HTMLOutputter
*/ */
class XMLStringer extends XMLOutputter class XMLStringer extends XMLOutputter
{ {
function __construct($indent=false) public function __construct($indent = false)
{ {
$this->xw = new XMLWriter(); $this->xw = new XMLWriter();
$this->xw->openMemory(); $this->xw->openMemory();
$this->xw->setIndent($indent); $this->xw->setIndent($indent);
} }
function getString() public static function estring($tag, $attrs = null, $content = null)
{
return $this->xw->outputMemory();
}
// utility for quickly creating XML-strings
static function estring($tag, $attrs=null, $content=null)
{ {
$xs = new XMLStringer(); $xs = new XMLStringer();
$xs->element($tag, $attrs, $content); $xs->element($tag, $attrs, $content);
return $xs->getString(); return $xs->getString();
} }
// utility for quickly creating XML-strings
public function getString()
{
return $this->xw->outputMemory();
}
} }

View File

@ -97,7 +97,7 @@ class SortableGroupList extends SortableSubscriptionList
// TRANS: Column header in table for members of a group. // TRANS: Column header in table for members of a group.
$this->out->element('th', array('id' => 'Members'), _m('Members')); $this->out->element('th', array('id' => 'Members'), _m('Members'));
$this->out->element('th', array('id' => 'controls'), null); $this->out->element('th', array('id' => 'controls'));
$this->out->elementEnd('tr'); $this->out->elementEnd('tr');
$this->out->elementEnd('thead'); $this->out->elementEnd('thead');

View File

@ -100,7 +100,7 @@ class SortableSubscriptionList extends SubscriptionList
$this->out->element('th', array('id' => 'subscriptions'), _m('Subscriptions')); $this->out->element('th', array('id' => 'subscriptions'), _m('Subscriptions'));
// TRANS: Column header for number of notices. // TRANS: Column header for number of notices.
$this->out->element('th', array('id' => 'notices'), _m('Notices')); $this->out->element('th', array('id' => 'notices'), _m('Notices'));
$this->out->element('th', array('id' => 'controls'), null); $this->out->element('th', array('id' => 'controls'));
$this->out->elementEnd('tr'); $this->out->elementEnd('tr');
$this->out->elementEnd('thead'); $this->out->elementEnd('thead');

View File

@ -103,7 +103,7 @@ class OembedPlugin extends Plugin
array('format'=>'json', 'url'=> array('format'=>'json', 'url'=>
common_local_url('attachment', common_local_url('attachment',
array('attachment' => $action->attachment->getID())))), array('attachment' => $action->attachment->getID())))),
'title'=>'oEmbed'),null); 'title'=>'oEmbed'));
$action->element('link',array('rel'=>'alternate', $action->element('link',array('rel'=>'alternate',
'type'=>'text/xml+oembed', 'type'=>'text/xml+oembed',
'href'=>common_local_url( 'href'=>common_local_url(
@ -112,7 +112,7 @@ class OembedPlugin extends Plugin
array('format'=>'xml','url'=> array('format'=>'xml','url'=>
common_local_url('attachment', common_local_url('attachment',
array('attachment' => $action->attachment->getID())))), array('attachment' => $action->attachment->getID())))),
'title'=>'oEmbed'),null); 'title'=>'oEmbed'));
break; break;
case 'shownotice': case 'shownotice':
if (!$action->notice->isLocal()) { if (!$action->notice->isLocal()) {
@ -125,14 +125,14 @@ class OembedPlugin extends Plugin
'oembed', 'oembed',
array(), array(),
array('format'=>'json','url'=>$action->notice->getUrl())), array('format'=>'json','url'=>$action->notice->getUrl())),
'title'=>'oEmbed'),null); 'title'=>'oEmbed'));
$action->element('link',array('rel'=>'alternate', $action->element('link',array('rel'=>'alternate',
'type'=>'text/xml+oembed', 'type'=>'text/xml+oembed',
'href'=>common_local_url( 'href'=>common_local_url(
'oembed', 'oembed',
array(), array(),
array('format'=>'xml','url'=>$action->notice->getUrl())), array('format'=>'xml','url'=>$action->notice->getUrl())),
'title'=>'oEmbed'),null); 'title'=>'oEmbed'));
} catch (InvalidUrlException $e) { } catch (InvalidUrlException $e) {
// The notice is probably a share or similar, which don't // The notice is probably a share or similar, which don't
// have a representational URL of their own. // have a representational URL of their own.

View File

@ -137,8 +137,8 @@ class OpenidloginAction extends Action
$appendUsername = common_config('openid', 'append_username'); $appendUsername = common_config('openid', 'append_username');
if ($provider) { if ($provider) {
// TRANS: Field label. // TRANS: Field label.
$this->element('label', array(), _m('LABEL','OpenID provider')); $this->element('label', [], _m('LABEL','OpenID provider'));
$this->element('span', array(), $provider); $this->element('span', [], $provider);
if ($appendUsername) { if ($appendUsername) {
$this->element('input', array('id' => 'openid_username', $this->element('input', array('id' => 'openid_username',
'name' => 'openid_username', 'name' => 'openid_username',