* @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.
*/
class ApiAccountRateLimitStatusAction extends ApiBareAuthAction
{
+ /**
+ * Return true if read only.
+ *
+ * MAY override
+ *
+ * @param array $args other arguments
+ *
+ * @return boolean is read only action?
+ */
+ public function isReadOnly($args)
+ {
+ return true;
+ }
+
/**
* Handle the request
*
* Return some Twitter-ish data about API limits
*
- * @param array $args $_REQUEST data (unused)
- *
* @return void
+ * @throws ClientException
*/
protected function handle()
{
parent::handle();
- if (!in_array($this->format, array('xml', 'json'))) {
+ if (!in_array($this->format, ['xml', 'json'])) {
$this->clientError(
- // TRANS: Client error displayed when coming across a non-supported API method.
+ // TRANS: Client error displayed when coming across a non-supported API method.
_('API method not found.'),
404,
$this->format
);
}
- $reset = new DateTime();
+ $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);
- }
+ 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);
}
-
- /**
- * Return true if read only.
- *
- * MAY override
- *
- * @param array $args other arguments
- *
- * @return boolean is read only action?
- */
- function isReadOnly($args)
- {
- return true;
- }
}
// Network public tag cloud?
}
+ /**
+ * Output <head> elements for RSS and Atom feeds
+ *
+ * @return array
+ */
function getFeeds()
{
- return array(new Feed(Feed::JSON,
- common_local_url('ApiTimelineNetworkPublic',
- array('format' => 'as')),
- // TRANS: Link description for the _global_ network public timeline feed.
- _('Network Public Timeline Feed (Activity Streams JSON)')),
- new Feed(Feed::RSS1, common_local_url('publicrss'),
- // TRANS: Link description for the _global_ network public timeline feed.
- _('Network Public Timeline Feed (RSS 1.0)')),
- new Feed(Feed::RSS2,
- common_local_url('ApiTimelineNetworkPublic',
- array('format' => 'rss')),
- // TRANS: Link description for the _global_ network public timeline feed.
- _('Network Public Timeline Feed (RSS 2.0)')),
- new Feed(Feed::ATOM,
- common_local_url('ApiTimelineNetworkPublic',
- array('format' => 'atom')),
- // TRANS: Link description for the _global_ network public timeline feed.
- _('Network Public Timeline Feed (Atom)')));
+ return [
+ new Feed(Feed::ATOM,
+ common_local_url('ApiTimelinePublic',
+ array('format' => 'atom')),
+ // TRANS: Link description for public timeline feed.
+ _('Public Timeline Feed (Atom)')
+ ),
+ new Feed(Feed::JSON,
+ common_local_url('ApiTimelinePublic',
+ array('format' => 'as')),
+ // TRANS: Link description for public timeline feed.
+ _('Public Timeline Feed (Activity Streams JSON)')
+ ),
+ new Feed(Feed::RSS1, common_local_url('publicrss'),
+ // TRANS: Link description for public timeline feed.
+ _('Public Timeline Feed (RSS 1.0)')
+ ),
+ new Feed(Feed::RSS2,
+ common_local_url('ApiTimelinePublic',
+ array('format' => 'rss')),
+ // TRANS: Link description for public timeline feed.
+ _('Public Timeline Feed (RSS 2.0)')
+ ),
+ ];
}
}
/**
* Output <head> elements for RSS and Atom feeds
*
- * @return void
+ * @return array
*/
function getFeeds()
{
* @link http://status.net/
*/
-if (!defined('GNUSOCIAL')) { exit(1); }
+if (!defined('GNUSOCIAL')) {
+ exit(1);
+}
/**
* Base class for all actions
class Action extends HTMLOutputter // lawsuit
{
// This should be protected/private in the future
- public $args = array();
+ public $args = [];
// Action properties, set per-class
protected $action = false;
- protected $ajax = false;
- protected $menus = true;
+ protected $ajax = false;
+ protected $menus = true;
protected $needLogin = false;
protected $needPost = false; // implies canPost if true
protected $canPost = false; // can this action handle POST method?
// Related to front-end user representation
protected $format = null;
- protected $error = null;
- protected $msg = null;
+ protected $error = null;
+ protected $msg = null;
/**
* Constructor
*
* Just wraps the HTMLOutputter 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
*
* @see XMLOutputter::__construct
* @see HTMLOutputter::__construct
*/
- function __construct($output='php://output', $indent=null)
+ public function __construct($output = 'php://output', $indent = null)
{
parent::__construct($output, $indent);
}
- function getError()
+ public static function run(array $args = [], $output = 'php://output', $indent = null)
{
- return $this->error;
+ $class = get_called_class();
+ $action = new $class($output, $indent);
+ set_exception_handler(array($action, 'handleError'));
+ $action->execute($args);
+ return $action;
}
- function getInfo()
+ public function getInfo()
{
return $this->msg;
}
}
}
- static public function run(array $args=array(), $output='php://output', $indent=null) {
- $class = get_called_class();
- $action = new $class($output, $indent);
- set_exception_handler(array($action, 'handleError'));
- $action->execute($args);
- return $action;
+ /**
+ * Client error
+ *
+ * @param string $msg error message to display
+ * @param integer $code http error code, 400 by default
+ * @param string $format error format (json, xml, text) for ApiAction
+ *
+ * @return void
+ * @throws ClientException always
+ */
+ public function clientError($msg, $code = 400, $format = null)
+ {
+ // $format is currently only relevant for an ApiAction anyway
+ if ($format === null) {
+ $format = $this->format;
+ }
+
+ common_debug("User error '{$code}' on '{$this->action}': {$msg}", __FILE__);
+
+ if (!array_key_exists($code, ClientErrorAction::$status)) {
+ $code = 400;
+ }
+
+ $status_string = ClientErrorAction::$status[$code];
+
+ switch ($format) {
+ case 'xml':
+ header("HTTP/1.1 {$code} {$status_string}");
+ $this->initDocument('xml');
+ $this->elementStart('hash');
+ $this->element('error', null, $msg);
+ $this->element('request', null, $_SERVER['REQUEST_URI']);
+ $this->elementEnd('hash');
+ $this->endDocument('xml');
+ break;
+ case 'json':
+ if (!isset($this->callback)) {
+ header("HTTP/1.1 {$code} {$status_string}");
+ }
+ $this->initDocument('json');
+ $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
+ print(json_encode($error_array));
+ $this->endDocument('json');
+ break;
+ case 'text':
+ header("HTTP/1.1 {$code} {$status_string}");
+ header('Content-Type: text/plain; charset=utf-8');
+ echo $msg;
+ break;
+ default:
+ common_log(LOG_ERR, 'Handled clientError (' . _ve($code) . ') but cannot output into desired format (' . _ve($this->format) . '): ' . _ve($msg));
+ $action = new ClientErrorAction($msg, $code);
+ $action->execute();
+ }
+ exit((int)$code);
}
- public function execute(array $args=array()) {
+ public function execute(array $args = [])
+ {
// checkMirror stuff
if (common_config('db', 'mirror') && $this->isReadOnly($args)) {
if (is_array(common_config('db', 'mirror'))) {
if (Event::handle('StartActionExecute', array($this, &$args))) {
$prepared = $this->prepare($args);
if ($prepared) {
- $this->handle($args);
+ $this->handle();
} else {
common_debug('Prepare failed for Action.');
}
}
}
+ /**
+ * Return true if read only.
+ *
+ * MAY override
+ *
+ * @param array $args other arguments
+ *
+ * @return boolean is read only action?
+ */
+ public function isReadOnly($args)
+ {
+ return false;
+ }
+
/**
* For initializing members of the class.
*
- * @param array $argarray misc. arguments
+ * @param array $args misc. arguments
*
* @return boolean true
+ * @throws ClientException
*/
- protected function prepare(array $args=array())
+ protected function prepare(array $args = [])
{
if ($this->needPost && !$this->isPost()) {
// TRANS: Client error. POST is a HTTP command. It should not be translated.
return true;
}
- public function updateScopedProfile()
- {
- $this->scoped = Profile::current();
- return $this->scoped;
- }
+ /**
+ * Check if the current request is a POST
+ *
+ * @return boolean true if POST; otherwise false.
+ */
- public function getScoped()
+ public function isPost()
{
- return ($this->scoped instanceof Profile) ? $this->scoped : null;
+ return ($_SERVER['REQUEST_METHOD'] == 'POST');
}
// Must be run _after_ prepare
- public function getActionName()
- {
- return $this->action;
- }
- public function isAction(array $names)
+ /**
+ * Returns trimmed query argument or default value if not found
+ *
+ * @param string $key requested argument
+ * @param string $def default value to return if $key is not provided
+ *
+ * @return boolean is read only action?
+ */
+ public function trimmed($key, $def = null)
{
- foreach ($names as $class) {
- // PHP is case insensitive, and we have stuff like ApiUpperCaseAction,
- // but we at least make a point out of wanting to do stuff case-sensitive.
- $class = ucfirst($class) . 'Action';
- if ($this instanceof $class) {
- return true;
- }
- }
- return false;
+ $arg = $this->arg($key, $def);
+ return is_string($arg) ? trim($arg) : $arg;
}
/**
- * Show page, a template method.
+ * Returns query argument or default value if not found
*
- * @return nothing
+ * @param string $key requested argument
+ * @param string $def default value to return if $key is not provided
+ *
+ * @return boolean is read only action?
*/
- public function showPage()
+ public function arg($key, $def = null)
{
- if (GNUsocial::isAjax()) {
- self::showAjax();
- return;
- }
- if (Event::handle('StartShowHTML', array($this))) {
- $this->startHTML();
- $this->flush();
- Event::handle('EndShowHTML', array($this));
- }
- if (Event::handle('StartShowHead', array($this))) {
- $this->showHead();
- $this->flush();
- Event::handle('EndShowHead', array($this));
- }
- if (Event::handle('StartShowBody', array($this))) {
- $this->showBody();
- Event::handle('EndShowBody', array($this));
- }
- if (Event::handle('StartEndHTML', array($this))) {
- $this->endHTML();
- Event::handle('EndEndHTML', array($this));
+ if (array_key_exists($key, $this->args)) {
+ return $this->args[$key];
+ } else {
+ return $def;
}
}
- public function showAjax()
+ /**
+ * Boolean understands english (yes, no, true, false)
+ *
+ * @param string $key query key we're interested in
+ * @param string $def default value
+ *
+ * @return boolean interprets yes/no strings as boolean
+ */
+ public function boolean($key, $def = false)
{
- $this->startHTML('text/xml;charset=utf-8');
- $this->elementStart('head');
- // TRANS: Title for conversation page.
- $this->element('title', null, $this->title());
- $this->elementEnd('head');
- $this->elementStart('body');
- if ($this->getError()) {
- $this->element('p', array('id'=>'error'), $this->getError());
+ $arg = strtolower($this->trimmed($key));
+
+ if (is_null($arg)) {
+ return $def;
+ } elseif (in_array($arg, array('true', 'yes', '1', 'on'))) {
+ return true;
+ } elseif (in_array($arg, array('false', 'no', '0'))) {
+ return false;
} else {
- $this->showContent();
+ return $def;
}
- $this->elementEnd('body');
- $this->endHTML();
}
- function endHTML()
+ /**
+ * If not logged in, take appropriate action (redir or exception)
+ *
+ * @param boolean $redir Redirect to login if not logged in
+ *
+ * @return boolean true if logged in (never returns if not)
+ * @throws ClientException
+ */
+ public function checkLogin($redir = true)
{
- global $_startTime;
+ if (common_logged_in()) {
+ return true;
+ }
- if (isset($_startTime)) {
- $endTime = microtime(true);
- $diff = round(($endTime - $_startTime) * 1000);
- $this->raw("<!-- ${diff}ms -->");
+ if ($redir == true) {
+ common_set_returnto($_SERVER['REQUEST_URI']);
+ common_redirect(common_local_url('login'));
}
- return parent::endHTML();
+ // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
+ $this->clientError(_('Not logged in.'), 403);
+ }
+
+ public function updateScopedProfile()
+ {
+ $this->scoped = Profile::current();
+ return $this->scoped;
}
/**
- * Show head, a template method.
- *
- * @return nothing
+ * Handler method
*/
- function showHead()
+ protected function handle()
{
- // XXX: attributes (profile?)
- $this->elementStart('head');
- if (Event::handle('StartShowHeadElements', array($this))) {
- if (Event::handle('StartShowHeadTitle', array($this))) {
- $this->showTitle();
- Event::handle('EndShowHeadTitle', array($this));
+ header('Vary: Accept-Encoding,Cookie');
+
+ $lm = $this->lastModified();
+ $etag = $this->etag();
+
+ if ($etag) {
+ header('ETag: ' . $etag);
+ }
+
+ if ($lm) {
+ header('Last-Modified: ' . date(DATE_RFC1123, $lm));
+ if ($this->isCacheable()) {
+ header('Expires: ' . gmdate('D, d M Y H:i:s', 0) . ' GMT');
+ header("Cache-Control: private, must-revalidate, max-age=0");
+ header("Pragma:");
+ }
+ }
+
+ $checked = false;
+ if ($etag) {
+ $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
+ $_SERVER['HTTP_IF_NONE_MATCH'] : null;
+ if ($if_none_match) {
+ // If this check fails, ignore the if-modified-since below.
+ $checked = true;
+ if ($this->_hasEtag($etag, $if_none_match)) {
+ header('HTTP/1.1 304 Not Modified');
+ // Better way to do this?
+ exit(0);
+ }
+ }
+ }
+
+ if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
+ $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
+ $ims = strtotime($if_modified_since);
+ if ($lm <= $ims) {
+ header('HTTP/1.1 304 Not Modified');
+ // Better way to do this?
+ exit(0);
}
- $this->showShortcutIcon();
- $this->showStylesheets();
- $this->showOpenSearch();
- $this->showFeeds();
- $this->showDescription();
- $this->extraHead();
- Event::handle('EndShowHeadElements', array($this));
}
- $this->elementEnd('head');
}
/**
- * Show title, a template method.
+ * Return last modified, if applicable.
*
- * @return nothing
+ * MAY override
+ *
+ * @return string last modified http header
*/
- function showTitle()
+ public function lastModified()
{
- $this->element('title', null,
- // TRANS: Page title. %1$s is the title, %2$s is the site name.
- sprintf(_('%1$s - %2$s'),
- $this->title(),
- common_config('site', 'name')));
+ // For comparison with If-Last-Modified
+ // If not applicable, return null
+ return null;
}
/**
- * Returns the page title
+ * Return etag, if applicable.
*
- * SHOULD overload
+ * MAY override
*
- * @return string page title
+ * @return string etag http header
*/
-
- function title()
+ public function etag()
{
- // TRANS: Page title for a page without a title set.
- return _('Untitled page');
+ return null;
}
/**
- * Show themed shortcut icon
+ * Is this action cacheable?
+ *
+ * If the action returns a last-modified
*
- * @return nothing
+ * @return boolean is read only action?
*/
- function showShortcutIcon()
+ public function isCacheable()
{
- if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
- $this->element('link', array('rel' => 'shortcut icon',
- 'href' => Theme::path('favicon.ico')));
- } else {
+ return true;
+ }
+
+ /**
+ * Has etag? (private)
+ *
+ * @param string $etag etag http header
+ * @param string $if_none_match ifNoneMatch http header
+ *
+ * @return boolean
+ */
+ public function _hasEtag($etag, $if_none_match)
+ {
+ $etags = explode(',', $if_none_match);
+ return in_array($etag, $etags) || in_array('*', $etags);
+ }
+
+ /**
+ * Server error
+ *
+ * @param string $msg error message to display
+ * @param integer $code http error code, 500 by default
+ *
+ * @param string $format
+ * @return void
+ */
+ public function serverError($msg, $code = 500, $format = null)
+ {
+ if ($format === null) {
+ $format = $this->format;
+ }
+
+ common_debug("Server error '{$code}' on '{$this->action}': {$msg}", __FILE__);
+
+ if (!array_key_exists($code, ServerErrorAction::$status)) {
+ $code = 500;
+ }
+
+ $status_string = ServerErrorAction::$status[$code];
+
+ switch ($format) {
+ case 'xml':
+ header("HTTP/1.1 {$code} {$status_string}");
+ $this->initDocument('xml');
+ $this->elementStart('hash');
+ $this->element('error', null, $msg);
+ $this->element('request', null, $_SERVER['REQUEST_URI']);
+ $this->elementEnd('hash');
+ $this->endDocument('xml');
+ break;
+ case 'json':
+ if (!isset($this->callback)) {
+ header("HTTP/1.1 {$code} {$status_string}");
+ }
+ $this->initDocument('json');
+ $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
+ print(json_encode($error_array));
+ $this->endDocument('json');
+ break;
+ default:
+ common_log(LOG_ERR, 'Handled serverError (' . _ve($code) . ') but cannot output into desired format (' . _ve($this->format) . '): ' . _ve($msg));
+ $action = new ServerErrorAction($msg, $code);
+ $action->execute();
+ }
+
+ exit((int)$code);
+ }
+
+ public function getScoped()
+ {
+ return ($this->scoped instanceof Profile) ? $this->scoped : null;
+ }
+
+ public function isAction(array $names)
+ {
+ foreach ($names as $class) {
+ // PHP is case insensitive, and we have stuff like ApiUpperCaseAction,
+ // but we at least make a point out of wanting to do stuff case-sensitive.
+ $class = ucfirst($class) . 'Action';
+ if ($this instanceof $class) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Show page, a template method.
+ *
+ * @return void
+ * @throws ClientException
+ * @throws ReflectionException
+ * @throws ServerException
+ */
+ public function showPage()
+ {
+ if (GNUsocial::isAjax()) {
+ self::showAjax();
+ return;
+ }
+ if (Event::handle('StartShowHTML', array($this))) {
+ $this->startHTML();
+ $this->flush();
+ Event::handle('EndShowHTML', array($this));
+ }
+ if (Event::handle('StartShowHead', array($this))) {
+ $this->showHead();
+ $this->flush();
+ Event::handle('EndShowHead', array($this));
+ }
+ if (Event::handle('StartShowBody', array($this))) {
+ $this->showBody();
+ Event::handle('EndShowBody', array($this));
+ }
+ if (Event::handle('StartEndHTML', array($this))) {
+ $this->endHTML();
+ Event::handle('EndEndHTML', array($this));
+ }
+ }
+
+ public function showAjax()
+ {
+ $this->startHTML('text/xml;charset=utf-8');
+ $this->elementStart('head');
+ // TRANS: Title for conversation page.
+ $this->element('title', null, $this->title());
+ $this->elementEnd('head');
+ $this->elementStart('body');
+ if ($this->getError()) {
+ $this->element('p', array('id' => 'error'), $this->getError());
+ } else {
+ $this->showContent();
+ }
+ $this->elementEnd('body');
+ $this->endHTML();
+ }
+
+ /**
+ * Returns the page title
+ *
+ * SHOULD overload
+ *
+ * @return string page title
+ */
+
+ public function title()
+ {
+ // TRANS: Page title for a page without a title set.
+ return _('Untitled page');
+ }
+
+ public function getError()
+ {
+ return $this->error;
+ }
+
+ /**
+ * Show content.
+ *
+ * MUST overload (unless there's not a notice)
+ *
+ * @return void
+ */
+ protected function showContent()
+ {
+ }
+
+ public function endHTML()
+ {
+ global $_startTime;
+
+ if (isset($_startTime)) {
+ $endTime = microtime(true);
+ $diff = round(($endTime - $_startTime) * 1000);
+ $this->raw("<!-- ${diff}ms -->");
+ }
+
+ parent::endHTML();
+ }
+
+ /**
+ * Show head, a template method.
+ *
+ * @return void
+ */
+ public function showHead()
+ {
+ // XXX: attributes (profile?)
+ $this->elementStart('head');
+ if (Event::handle('StartShowHeadElements', array($this))) {
+ if (Event::handle('StartShowHeadTitle', array($this))) {
+ $this->showTitle();
+ Event::handle('EndShowHeadTitle', array($this));
+ }
+ $this->showShortcutIcon();
+ $this->showStylesheets();
+ $this->showOpenSearch();
+ $this->showFeeds();
+ $this->showDescription();
+ $this->extraHead();
+ Event::handle('EndShowHeadElements', array($this));
+ }
+ $this->elementEnd('head');
+ }
+
+ /**
+ * Show title, a template method.
+ *
+ * @return void
+ */
+ public function showTitle()
+ {
+ $this->element(
+ 'title',
+ null,
+ // TRANS: Page title. %1$s is the title, %2$s is the site name.
+ sprintf(
+ _('%1$s - %2$s'),
+ $this->title(),
+ common_config('site', 'name')
+ )
+ );
+ }
+
+ /**
+ * Show themed shortcut icon
+ *
+ * @return void
+ */
+ public function showShortcutIcon()
+ {
+ if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
+ $this->element('link', array('rel' => 'shortcut icon',
+ 'href' => Theme::path('favicon.ico')));
+ } else {
// favicon.ico should be HTTPS if the rest of the page is
$this->element('link', array('rel' => 'shortcut icon',
- 'href' => common_path('favicon.ico', GNUsocial::isHTTPS())));
+ 'href' => common_path('favicon.ico', GNUsocial::isHTTPS())));
}
if (common_config('site', 'mobile')) {
if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
$this->element('link', array('rel' => 'apple-touch-icon',
- 'href' => Theme::path('apple-touch-icon.png')));
+ 'href' => Theme::path('apple-touch-icon.png')));
} else {
$this->element('link', array('rel' => 'apple-touch-icon',
- 'href' => common_path('apple-touch-icon.png')));
+ 'href' => common_path('apple-touch-icon.png')));
}
}
}
/**
* Show stylesheets
*
- * @return nothing
+ * @return void
*/
- function showStylesheets()
+ public function showStylesheets()
{
if (Event::handle('StartShowStyles', array($this))) {
}
}
- function primaryCssLink($mainTheme=null, $media=null)
+ public function primaryCssLink($mainTheme = null, $media = null)
{
$theme = new Theme($mainTheme);
}
}
- /**
- * Show javascript headers
- *
- * @return nothing
- */
- function showScripts()
- {
- if (Event::handle('StartShowScripts', array($this))) {
- if (Event::handle('StartShowJQueryScripts', array($this))) {
- $this->script('extlib/jquery.js');
- $this->script('extlib/jquery.form.js');
- $this->script('extlib/jquery-ui/jquery-ui.js');
- $this->script('extlib/jquery.cookie.js');
-
- Event::handle('EndShowJQueryScripts', array($this));
- }
- if (Event::handle('StartShowStatusNetScripts', array($this))) {
- $this->script('util.js');
- $this->script('xbImportNode.js');
-
- // This route isn't available in single-user mode.
- // Not sure why, but it causes errors here.
- $this->inlineScript('var _peopletagAC = "' .
- common_local_url('peopletagautocomplete') . '";');
- $this->showScriptMessages();
- $this->showScriptVariables();
- // Anti-framing code to avoid clickjacking attacks in older browsers.
- // This will show a blank page if the page is being framed, which is
- // consistent with the behavior of the 'X-Frame-Options: SAMEORIGIN'
- // header, which prevents framing in newer browser.
- if (common_config('javascript', 'bustframes')) {
- $this->inlineScript('if (window.top !== window.self) { document.write = ""; window.top.location = window.self.location; setTimeout(function () { document.body.innerHTML = ""; }, 1); window.self.onload = function () { document.body.innerHTML = ""; }; }');
- }
- Event::handle('EndShowStatusNetScripts', array($this));
- }
- Event::handle('EndShowScripts', array($this));
- }
- }
-
- /**
- * Exports a map of localized text strings to JavaScript code.
- *
- * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
- * events and appending to the array. Try to avoid adding strings that won't be used, as
- * they'll be added to HTML output.
- */
- function showScriptMessages()
- {
- $messages = array();
-
- if (Event::handle('StartScriptMessages', array($this, &$messages))) {
- // Common messages needed for timeline views etc...
-
- // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
- $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
- $messages['popup_close_button'] = _m('TOOLTIP', 'Close popup');
-
- $messages = array_merge($messages, $this->getScriptMessages());
-
- Event::handle('EndScriptMessages', array($this, &$messages));
- }
-
- if (!empty($messages)) {
- $this->inlineScript('SN.messages=' . json_encode($messages));
- }
-
- return $messages;
- }
-
- protected function showScriptVariables()
- {
- $vars = array();
-
- if (Event::handle('StartScriptVariables', array($this, &$vars))) {
- $vars['urlNewNotice'] = common_local_url('newnotice');
- $vars['xhrTimeout'] = ini_get('max_execution_time')*1000; // milliseconds
- Event::handle('EndScriptVariables', array($this, &$vars));
- }
-
- $this->inlineScript('SN.V = ' . json_encode($vars) . ';');
-
- return $vars;
- }
-
- /**
- * If the action will need localizable text strings, export them here like so:
- *
- * return array('pool_deepend' => _('Deep end'),
- * 'pool_shallow' => _('Shallow end'));
- *
- * The exported map will be available via SN.msg() to JS code:
- *
- * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
- * $('#pool .deepend').text(SN.msg('pool_deepend'));
- * $('#pool .shallow').text(SN.msg('pool_shallow'));
- *
- * Exports a map of localized text strings to JavaScript code.
- *
- * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
- * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
- * be used, as they'll be added to HTML output.
- */
- function getScriptMessages()
- {
- return array();
- }
-
/**
* Show OpenSearch headers
*
- * @return nothing
+ * @return void
*/
- function showOpenSearch()
+ public function showOpenSearch()
{
$this->element('link', array('rel' => 'search',
- 'type' => 'application/opensearchdescription+xml',
- 'href' => common_local_url('opensearch', array('type' => 'people')),
- 'title' => common_config('site', 'name').' People Search'));
+ 'type' => 'application/opensearchdescription+xml',
+ 'href' => common_local_url('opensearch', array('type' => 'people')),
+ 'title' => common_config('site', 'name') . ' People Search'));
$this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
- 'href' => common_local_url('opensearch', array('type' => 'notice')),
- 'title' => common_config('site', 'name').' Notice Search'));
+ 'href' => common_local_url('opensearch', array('type' => 'notice')),
+ 'title' => common_config('site', 'name') . ' Notice Search'));
}
/**
*
* MAY overload
*
- * @return nothing
+ * @return void
*/
- function showFeeds()
+ public function showFeeds()
{
foreach ($this->getFeeds() as $feed) {
$this->element('link', array('rel' => $feed->rel(),
- 'href' => $feed->url,
- 'type' => $feed->mimeType(),
- 'title' => $feed->title));
+ 'href' => $feed->url,
+ 'type' => $feed->mimeType(),
+ 'title' => $feed->title));
}
}
+ /**
+ * An array of feeds for this action.
+ *
+ * Returns an array of potential feeds for this action.
+ *
+ * @return array Feed object to show in head and links
+ */
+ public function getFeeds()
+ {
+ return [];
+ }
+
/**
* Show description.
*
* SHOULD overload
*
- * @return nothing
+ * @return void
*/
- function showDescription()
+ public function showDescription()
{
// does nothing by default
}
*
* MAY overload
*
- * @return nothing
+ * @return void
*/
- function extraHead()
+ public function extraHead()
{
// does nothing by default
}
*
* Calls template methods
*
- * @return nothing
+ * @return void
+ * @throws ServerException
+ * @throws ReflectionException
*/
- function showBody()
+ public function showBody()
{
$params = array('id' => $this->getActionName());
if ($this->scoped instanceof Profile) {
$this->elementEnd('body');
}
+ public function getActionName()
+ {
+ return $this->action;
+ }
+
/**
* Show header of the page.
*
* Calls template methods
*
- * @return nothing
+ * @return void
+ * @throws ServerException
*/
- function showHeader()
+ public function showHeader()
{
$this->elementStart('div', array('id' => 'header'));
$this->showLogo();
/**
* Show configured logo.
*
- * @return nothing
+ * @return void
+ * @throws ServerException
*/
- function showLogo()
+ public function showLogo()
{
$this->elementStart('address', array('id' => 'site_contact', 'class' => 'h-card'));
if (Event::handle('StartAddressData', array($this))) {
if (common_config('singleuser', 'enabled')) {
$user = User::singleUser();
- $url = common_local_url('showstream',
- array('nickname' => $user->nickname));
- } else if (common_logged_in()) {
+ $url = common_local_url(
+ 'showstream',
+ array('nickname' => $user->nickname)
+ );
+ } elseif (common_logged_in()) {
$cur = common_current_user();
$url = common_local_url('all', array('nickname' => $cur->nickname));
} else {
}
$this->elementStart('a', array('class' => 'home bookmark',
- 'href' => $url));
+ 'href' => $url));
if (GNUsocial::isHTTPS()) {
$logoUrl = common_config('site', 'ssllogo');
if (!empty($logoUrl)) {
$this->element('img', array('class' => 'logo u-photo p-name',
- 'src' => $logoUrl,
- 'alt' => common_config('site', 'name')));
+ 'src' => $logoUrl,
+ 'alt' => common_config('site', 'name')));
}
$this->elementEnd('a');
/**
* Show primary navigation.
*
- * @return nothing
+ * @return void
*/
- function showPrimaryNav()
+ public function showPrimaryNav()
{
$this->elementStart('div', array('id' => 'site_nav_global_primary'));
/**
* Show site notice.
*
- * @return nothing
- */
- function showSiteNotice()
- {
- // Revist. Should probably do an hAtom pattern here
- $text = common_config('site', 'notice');
- if ($text) {
- $this->elementStart('div', array('id' => 'site_notice',
- 'class' => 'system_notice'));
- $this->raw($text);
- $this->elementEnd('div');
- }
- }
-
- /**
- * Show notice form.
- *
- * MAY overload if no notice form needed... or direct message box????
- *
- * @return nothing
- */
- function showNoticeForm()
- {
- // TRANS: Tab on the notice form.
- $tabs = array('status' => array('title' => _m('TAB','Status'),
- 'href' => common_local_url('newnotice')));
-
- $this->elementStart('div', 'input_forms');
-
- $this->element('label', array('for'=>'input_form_nav'), _m('TAB', 'Share your:'));
-
- if (Event::handle('StartShowEntryForms', array(&$tabs))) {
- $this->elementStart('ul', array('class' => 'nav',
- 'id' => 'input_form_nav'));
-
- foreach ($tabs as $tag => $data) {
- $tag = htmlspecialchars($tag);
- $attrs = array('id' => 'input_form_nav_'.$tag,
- 'class' => 'input_form_nav_tab');
-
- if ($tag == 'status') {
- $attrs['class'] .= ' current';
- }
- $this->elementStart('li', $attrs);
-
- $this->element('a',
- array('onclick' => 'return SN.U.switchInputFormTab("'.$tag.'");',
- 'href' => $data['href']),
- $data['title']);
- $this->elementEnd('li');
- }
-
- $this->elementEnd('ul');
-
- foreach ($tabs as $tag => $data) {
- $attrs = array('class' => 'input_form',
- 'id' => 'input_form_'.$tag);
- if ($tag == 'status') {
- $attrs['class'] .= ' current';
- }
-
- $this->elementStart('div', $attrs);
-
- $form = null;
-
- if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
- if ($tag == 'status') {
- $options = $this->noticeFormOptions();
- $form = new NoticeForm($this, $options);
- }
- Event::handle('EndMakeEntryForm', array($tag, $this, $form));
- }
-
- if (!empty($form)) {
- $form->show();
- }
-
- $this->elementEnd('div');
- }
- }
-
- $this->elementEnd('div');
- }
-
- function noticeFormOptions()
- {
- return array();
- }
-
- /**
- * Show anonymous message.
- *
- * SHOULD overload
- *
- * @return nothing
+ * @return void
*/
- function showAnonymousMessage()
+ public function showSiteNotice()
{
- // needs to be defined by the class
+ // Revist. Should probably do an hAtom pattern here
+ $text = common_config('site', 'notice');
+ if ($text) {
+ $this->elementStart('div', array('id' => 'site_notice',
+ 'class' => 'system_notice'));
+ $this->raw($text);
+ $this->elementEnd('div');
+ }
}
/**
*
* Shows local navigation, content block and aside.
*
- * @return nothing
+ * @return void
+ * @throws ReflectionException
*/
- function showCore()
+ public function showCore()
{
$this->elementStart('div', array('id' => 'core'));
$this->elementStart('div', array('id' => 'aside_primary_wrapper'));
/**
* Show local navigation block.
*
- * @return nothing
+ * @return void
*/
- function showLocalNavBlock()
+ public function showLocalNavBlock()
{
// Need to have this ID for CSS; I'm too lazy to add it to
// all menus
$this->elementEnd('div');
}
- /**
- * If there's a logged-in user, show a bit of login context
- *
- * @return nothing
- */
- function showProfileBlock()
- {
- if (common_logged_in()) {
- $block = new DefaultProfileBlock($this);
- $block->show();
- }
- }
-
/**
* Show local navigation.
*
* SHOULD overload
*
- * @return nothing
+ * @return void
*/
- function showLocalNav()
+ public function showLocalNav()
{
$nav = new DefaultLocalNav($this);
$nav->show();
}
- /**
- * Show menu for an object (group, profile)
- *
- * This block will only show if a subclass has overridden
- * the showObjectNav() method.
- *
- * @return nothing
- */
- function showObjectNavBlock()
- {
- $rmethod = new ReflectionMethod($this, 'showObjectNav');
- $dclass = $rmethod->getDeclaringClass()->getName();
-
- if ($dclass != 'Action') {
- // Need to have this ID for CSS; I'm too lazy to add it to
- // all menus
- $this->elementStart('div', array('id' => 'site_nav_object',
- 'class' => 'section'));
- $this->showObjectNav();
- $this->elementEnd('div');
- }
- }
-
- /**
- * Show object navigation.
- *
- * If there are things to do with this object, show it here.
- *
- * @return nothing
- */
- function showObjectNav()
- {
- /* Nothing here. */
- }
-
/**
* Show content block.
*
- * @return nothing
+ * @return void
+ * @throws ReflectionException
*/
- function showContentBlock()
+ public function showContentBlock()
{
$this->elementStart('div', array('id' => 'content'));
if (common_logged_in()) {
$this->elementEnd('div');
}
+ /**
+ * Show notice form.
+ *
+ * MAY overload if no notice form needed... or direct message box????
+ *
+ * @return void
+ */
+ public function showNoticeForm()
+ {
+ // TRANS: Tab on the notice form.
+ $tabs = array('status' => array('title' => _m('TAB', 'Status'),
+ 'href' => common_local_url('newnotice')));
+
+ $this->elementStart('div', 'input_forms');
+
+ $this->element('label', array('for' => 'input_form_nav'), _m('TAB', 'Share your:'));
+
+ if (Event::handle('StartShowEntryForms', array(&$tabs))) {
+ $this->elementStart('ul', array('class' => 'nav',
+ 'id' => 'input_form_nav'));
+
+ foreach ($tabs as $tag => $data) {
+ $tag = htmlspecialchars($tag);
+ $attrs = array('id' => 'input_form_nav_' . $tag,
+ 'class' => 'input_form_nav_tab');
+
+ if ($tag == 'status') {
+ $attrs['class'] .= ' current';
+ }
+ $this->elementStart('li', $attrs);
+
+ $this->element(
+ 'a',
+ array('onclick' => 'return SN.U.switchInputFormTab("' . $tag . '");',
+ 'href' => $data['href']),
+ $data['title']
+ );
+ $this->elementEnd('li');
+ }
+
+ $this->elementEnd('ul');
+
+ foreach ($tabs as $tag => $data) {
+ $attrs = array('class' => 'input_form',
+ 'id' => 'input_form_' . $tag);
+ if ($tag == 'status') {
+ $attrs['class'] .= ' current';
+ }
+
+ $this->elementStart('div', $attrs);
+
+ $form = null;
+
+ if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
+ if ($tag == 'status') {
+ $options = $this->noticeFormOptions();
+ $form = new NoticeForm($this, $options);
+ }
+ Event::handle('EndMakeEntryForm', array($tag, $this, $form));
+ }
+
+ if (!empty($form)) {
+ $form->show();
+ }
+
+ $this->elementEnd('div');
+ }
+ }
+
+ $this->elementEnd('div');
+ }
+
+ public function noticeFormOptions()
+ {
+ return [];
+ }
+
/**
* Show page title.
*
- * @return nothing
+ * @return void
*/
- function showPageTitle()
+ public function showPageTitle()
{
$this->element('h1', null, $this->title());
}
* 'page_notice' definition list is desired. This is to prevent
* empty 'page_notice' definition lists from being output everywhere.
*
- * @return nothing
+ * @return void
+ * @throws ReflectionException
*/
- function showPageNoticeBlock()
+ public function showPageNoticeBlock()
{
$rmethod = new ReflectionMethod($this, 'showPageNotice');
$dclass = $rmethod->getDeclaringClass()->getName();
if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
-
$this->elementStart('div', array('id' => 'page_notice',
- 'class' => 'system_notice'));
+ 'class' => 'system_notice'));
if (Event::handle('StartShowPageNotice', array($this))) {
$this->showPageNotice();
Event::handle('EndShowPageNotice', array($this));
*
* SHOULD overload (unless there's not a notice)
*
- * @return nothing
- */
- function showPageNotice()
- {
- }
-
- /**
- * Show content.
- *
- * MUST overload (unless there's not a notice)
- *
- * @return nothing
+ * @return void
*/
- protected function showContent()
+ public function showPageNotice()
{
}
/**
* Show Aside.
*
- * @return nothing
+ * @return void
+ * @throws ReflectionException
*/
- function showAside()
+ public function showAside()
{
$this->elementStart('div', array('id' => 'aside_primary',
- 'class' => 'aside'));
+ 'class' => 'aside'));
$this->showProfileBlock();
if (Event::handle('StartShowObjectNavBlock', array($this))) {
$this->showObjectNavBlock();
}
/**
- * Show export data feeds.
+ * If there's a logged-in user, show a bit of login context
*
* @return void
+ * @throws Exception
*/
- function showExportData()
+ public function showProfileBlock()
{
- $feeds = $this->getFeeds();
- if (!empty($feeds)) {
- $fl = new FeedList($this, $feeds);
- $fl->show();
+ if (common_logged_in()) {
+ $block = new DefaultProfileBlock($this);
+ $block->show();
+ }
+ }
+
+ /**
+ * Show menu for an object (group, profile)
+ *
+ * This block will only show if a subclass has overridden
+ * the showObjectNav() method.
+ *
+ * @return void
+ * @throws ReflectionException
+ */
+ public function showObjectNavBlock()
+ {
+ $rmethod = new ReflectionMethod($this, 'showObjectNav');
+ $dclass = $rmethod->getDeclaringClass()->getName();
+
+ if ($dclass != 'Action') {
+ // Need to have this ID for CSS; I'm too lazy to add it to
+ // all menus
+ $this->elementStart('div', array('id' => 'site_nav_object',
+ 'class' => 'section'));
+ $this->showObjectNav();
+ $this->elementEnd('div');
}
}
+ /**
+ * Show object navigation.
+ *
+ * If there are things to do with this object, show it here.
+ *
+ * @return void
+ */
+ public function showObjectNav()
+ {
+ /* Nothing here. */
+ }
+
/**
* Show sections.
*
* SHOULD overload
*
- * @return nothing
+ * @return void
*/
- function showSections()
+ public function showSections()
{
// for each section, show it
}
+ /**
+ * Show export data feeds.
+ *
+ * @return void
+ */
+ public function showExportData()
+ {
+ $feeds = $this->getFeeds();
+ if (!empty($feeds)) {
+ $fl = new FeedList($this, $feeds);
+ $fl->show();
+ }
+ }
+
/**
* Show footer.
*
- * @return nothing
+ * @return void
*/
- function showFooter()
+ public function showFooter()
{
$this->elementStart('div', array('id' => 'footer'));
if (Event::handle('StartShowInsideFooter', array($this))) {
/**
* Show secondary navigation.
*
- * @return nothing
+ * @return void
*/
- function showSecondaryNav()
+ public function showSecondaryNav()
{
$sn = new SecondaryNav($this);
$sn->show();
/**
* Show licenses.
*
- * @return nothing
+ * @return void
*/
- function showLicenses()
+ public function showLicenses()
{
$this->showGNUsocialLicense();
$this->showContentLicense();
/**
* Show GNU social license.
*
- * @return nothing
+ * @return void
*/
- function showGNUsocialLicense()
+ public function showGNUsocialLicense()
{
if (common_config('site', 'broughtby')) {
// TRANS: First sentence of the GNU social site license. Used if 'broughtby' is set.
/**
* Show content license.
*
- * @return nothing
+ * @return void
*/
- function showContentLicense()
+ public function showContentLicense()
{
if (Event::handle('StartShowContentLicense', array($this))) {
switch (common_config('license', 'type')) {
- case 'private':
- // TRANS: Content license displayed when license is set to 'private'.
- // TRANS: %1$s is the site name.
- $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
- common_config('site', 'name')));
+ case 'private':
+ // TRANS: Content license displayed when license is set to 'private'.
+ // TRANS: %1$s is the site name.
+ $this->element('p', null, sprintf(
+ _('Content and data of %1$s are private and confidential.'),
+ common_config('site', 'name')
+ ));
// fall through
- case 'allrightsreserved':
- if (common_config('license', 'owner')) {
- // TRANS: Content license displayed when license is set to 'allrightsreserved'.
- // TRANS: %1$s is the copyright owner.
- $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
- common_config('license', 'owner')));
- } else {
- // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
- $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
- }
- break;
- case 'cc': // fall through
- default:
- $this->elementStart('p');
-
- $image = common_config('license', 'image');
- $sslimage = common_config('license', 'sslimage');
-
- if (GNUsocial::isHTTPS()) {
- if (!empty($sslimage)) {
- $url = $sslimage;
- } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
- // CC support HTTPS on their images
- $url = preg_replace('/^http/', 'https', $image, 1);
+ // no break
+ case 'allrightsreserved':
+ if (common_config('license', 'owner')) {
+ // TRANS: Content license displayed when license is set to 'allrightsreserved'.
+ // TRANS: %1$s is the copyright owner.
+ $this->element('p', null, sprintf(
+ _('Content and data copyright by %1$s. All rights reserved.'),
+ common_config('license', 'owner')
+ ));
+ } else {
+ // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
+ $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
+ }
+ break;
+ case 'cc': // fall through
+ default:
+ $this->elementStart('p');
+
+ $image = common_config('license', 'image');
+ $sslimage = common_config('license', 'sslimage');
+
+ if (GNUsocial::isHTTPS()) {
+ if (!empty($sslimage)) {
+ $url = $sslimage;
+ } elseif (preg_match('#^http://i.creativecommons.org/#', $image)) {
+ // CC support HTTPS on their images
+ $url = preg_replace('/^http/', 'https', $image, 1);
+ } else {
+ // Better to show mixed content than no content
+ $url = $image;
+ }
} else {
- // Better to show mixed content than no content
$url = $image;
}
- } else {
- $url = $image;
- }
- $this->element('img', array('id' => 'license_cc',
- 'src' => $url,
- 'alt' => common_config('license', 'title'),
- 'width' => '80',
- 'height' => '15'));
- $this->text(' ');
- // TRANS: license message in footer.
- // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
- $notice = _('All %1$s content and data are available under the %2$s license.');
- $link = sprintf('<a class="license" rel="external license" href="%1$s">%2$s</a>',
- htmlspecialchars(common_config('license', 'url')),
- htmlspecialchars(common_config('license', 'title')));
- $this->raw(@sprintf(htmlspecialchars($notice),
- htmlspecialchars(common_config('site', 'name')),
- $link));
- $this->elementEnd('p');
- break;
+ $this->element('img', array('id' => 'license_cc',
+ 'src' => $url,
+ 'alt' => common_config('license', 'title'),
+ 'width' => '80',
+ 'height' => '15'));
+ $this->text(' ');
+ // TRANS: license message in footer.
+ // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
+ $notice = _('All %1$s content and data are available under the %2$s license.');
+ $link = sprintf(
+ '<a class="license" rel="external license" href="%1$s">%2$s</a>',
+ htmlspecialchars(common_config('license', 'url')),
+ htmlspecialchars(common_config('license', 'title'))
+ );
+ $this->raw(@sprintf(
+ htmlspecialchars($notice),
+ htmlspecialchars(common_config('site', 'name')),
+ $link
+ ));
+ $this->elementEnd('p');
+ break;
}
Event::handle('EndShowContentLicense', array($this));
}
/**
- * Return last modified, if applicable.
- *
- * MAY override
- *
- * @return string last modified http header
- */
- function lastModified()
- {
- // For comparison with If-Last-Modified
- // If not applicable, return null
- return null;
- }
-
- /**
- * Return etag, if applicable.
- *
- * MAY override
- *
- * @return string etag http header
- */
- function etag()
- {
- return null;
- }
-
- /**
- * Return true if read only.
- *
- * MAY override
- *
- * @param array $args other arguments
+ * Show javascript headers
*
- * @return boolean is read only action?
+ * @return void
*/
- function isReadOnly($args)
+ public function showScripts()
{
- return false;
- }
+ if (Event::handle('StartShowScripts', array($this))) {
+ if (Event::handle('StartShowJQueryScripts', array($this))) {
+ $this->script('extlib/jquery.js');
+ $this->script('extlib/jquery.form.js');
+ $this->script('extlib/jquery-ui/jquery-ui.js');
+ $this->script('extlib/jquery.cookie.js');
- /**
- * Returns query argument or default value if not found
- *
- * @param string $key requested argument
- * @param string $def default value to return if $key is not provided
- *
- * @return boolean is read only action?
- */
- function arg($key, $def=null)
- {
- if (array_key_exists($key, $this->args)) {
- return $this->args[$key];
- } else {
- return $def;
+ Event::handle('EndShowJQueryScripts', array($this));
+ }
+ if (Event::handle('StartShowStatusNetScripts', array($this))) {
+ $this->script('util.js');
+ $this->script('xbImportNode.js');
+
+ // This route isn't available in single-user mode.
+ // Not sure why, but it causes errors here.
+ $this->inlineScript('var _peopletagAC = "' .
+ common_local_url('peopletagautocomplete') . '";');
+ $this->showScriptMessages();
+ $this->showScriptVariables();
+ // Anti-framing code to avoid clickjacking attacks in older browsers.
+ // This will show a blank page if the page is being framed, which is
+ // consistent with the behavior of the 'X-Frame-Options: SAMEORIGIN'
+ // header, which prevents framing in newer browser.
+ if (common_config('javascript', 'bustframes')) {
+ $this->inlineScript('if (window.top !== window.self) { document.write = ""; window.top.location = window.self.location; setTimeout(function () { document.body.innerHTML = ""; }, 1); window.self.onload = function () { document.body.innerHTML = ""; }; }');
+ }
+ Event::handle('EndShowStatusNetScripts', array($this));
+ }
+ Event::handle('EndShowScripts', array($this));
}
}
/**
- * Returns trimmed query argument or default value if not found
- *
- * @param string $key requested argument
- * @param string $def default value to return if $key is not provided
+ * Exports a map of localized text strings to JavaScript code.
*
- * @return boolean is read only action?
+ * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
+ * events and appending to the array. Try to avoid adding strings that won't be used, as
+ * they'll be added to HTML output.
*/
- function trimmed($key, $def=null)
+ public function showScriptMessages()
{
- $arg = $this->arg($key, $def);
- return is_string($arg) ? trim($arg) : $arg;
- }
+ $messages = [];
- /**
- * Handler method
- *
- * @return boolean is read only action?
- */
- protected function handle()
- {
- header('Vary: Accept-Encoding,Cookie');
+ if (Event::handle('StartScriptMessages', array($this, &$messages))) {
+ // Common messages needed for timeline views etc...
- $lm = $this->lastModified();
- $etag = $this->etag();
+ // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
+ $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
+ $messages['popup_close_button'] = _m('TOOLTIP', 'Close popup');
- if ($etag) {
- header('ETag: ' . $etag);
- }
+ $messages = array_merge($messages, $this->getScriptMessages());
- if ($lm) {
- header('Last-Modified: ' . date(DATE_RFC1123, $lm));
- if ($this->isCacheable()) {
- header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
- header( "Cache-Control: private, must-revalidate, max-age=0" );
- header( "Pragma:");
- }
+ Event::handle('EndScriptMessages', array($this, &$messages));
}
- $checked = false;
- if ($etag) {
- $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
- $_SERVER['HTTP_IF_NONE_MATCH'] : null;
- if ($if_none_match) {
- // If this check fails, ignore the if-modified-since below.
- $checked = true;
- if ($this->_hasEtag($etag, $if_none_match)) {
- header('HTTP/1.1 304 Not Modified');
- // Better way to do this?
- exit(0);
- }
- }
+ if (!empty($messages)) {
+ $this->inlineScript('SN.messages=' . json_encode($messages));
}
- if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
- $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
- $ims = strtotime($if_modified_since);
- if ($lm <= $ims) {
- header('HTTP/1.1 304 Not Modified');
- // Better way to do this?
- exit(0);
- }
- }
+ return $messages;
}
/**
- * Is this action cacheable?
+ * If the action will need localizable text strings, export them here like so:
*
- * If the action returns a last-modified
+ * return array('pool_deepend' => _('Deep end'),
+ * 'pool_shallow' => _('Shallow end'));
*
- * @param array $argarray is ignored since it's now passed in in prepare()
+ * The exported map will be available via SN.msg() to JS code:
*
- * @return boolean is read only action?
+ * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
+ * $('#pool .deepend').text(SN.msg('pool_deepend'));
+ * $('#pool .shallow').text(SN.msg('pool_shallow'));
+ *
+ * Exports a map of localized text strings to JavaScript code.
+ *
+ * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
+ * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
+ * be used, as they'll be added to HTML output.
*/
- function isCacheable()
+ public function getScriptMessages()
{
- return true;
+ return [];
}
- /**
- * Has etag? (private)
- *
- * @param string $etag etag http header
- * @param string $if_none_match ifNoneMatch http header
- *
- * @return boolean
- */
- function _hasEtag($etag, $if_none_match)
+ protected function showScriptVariables()
{
- $etags = explode(',', $if_none_match);
- return in_array($etag, $etags) || in_array('*', $etags);
+ $vars = [];
+
+ if (Event::handle('StartScriptVariables', array($this, &$vars))) {
+ $vars['urlNewNotice'] = common_local_url('newnotice');
+ $vars['xhrTimeout'] = ini_get('max_execution_time') * 1000; // milliseconds
+ Event::handle('EndScriptVariables', array($this, &$vars));
+ }
+
+ $this->inlineScript('SN.V = ' . json_encode($vars) . ';');
+
+ return $vars;
}
/**
- * Boolean understands english (yes, no, true, false)
+ * Show anonymous message.
*
- * @param string $key query key we're interested in
- * @param string $def default value
+ * SHOULD overload
*
- * @return boolean interprets yes/no strings as boolean
+ * @return void
*/
- function boolean($key, $def=false)
+ public function showAnonymousMessage()
{
- $arg = strtolower($this->trimmed($key));
-
- if (is_null($arg)) {
- return $def;
- } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
- return true;
- } else if (in_array($arg, array('false', 'no', '0'))) {
- return false;
- } else {
- return $def;
- }
+ // needs to be defined by the class
}
/**
* Upstream bug is::
* https://pear.php.net/bugs/bug.php?id=20291
*/
- function booleanintstring($key, $def=false)
+ public function booleanintstring($key, $def = false)
{
return $this->boolean($key, $def) ? '1' : '0';
}
/**
* Integer value of an argument
*
- * @param string $key query key we're interested in
+ * @param string $key query key we're interested in
* @param string $defValue optional default value (default null)
* @param string $maxValue optional max value (default null)
* @param string $minValue optional min value (default null)
*
* @return integer integer value
*/
- function int($key, $defValue=null, $maxValue=null, $minValue=null)
+ public function int($key, $defValue = null, $maxValue = null, $minValue = null)
{
$arg = intval($this->arg($key));
return $arg;
}
- /**
- * Server error
- *
- * @param string $msg error message to display
- * @param integer $code http error code, 500 by default
- *
- * @return nothing
- */
- function serverError($msg, $code=500, $format=null)
- {
- if ($format === null) {
- $format = $this->format;
- }
-
- common_debug("Server error '{$code}' on '{$this->action}': {$msg}", __FILE__);
-
- if (!array_key_exists($code, ServerErrorAction::$status)) {
- $code = 500;
- }
-
- $status_string = ServerErrorAction::$status[$code];
-
- switch ($format) {
- case 'xml':
- header("HTTP/1.1 {$code} {$status_string}");
- $this->initDocument('xml');
- $this->elementStart('hash');
- $this->element('error', null, $msg);
- $this->element('request', null, $_SERVER['REQUEST_URI']);
- $this->elementEnd('hash');
- $this->endDocument('xml');
- break;
- case 'json':
- if (!isset($this->callback)) {
- header("HTTP/1.1 {$code} {$status_string}");
- }
- $this->initDocument('json');
- $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
- print(json_encode($error_array));
- $this->endDocument('json');
- break;
- default:
- common_log(LOG_ERR, 'Handled serverError ('._ve($code).') but cannot output into desired format ('._ve($this->format).'): '._ve($msg));
- $action = new ServerErrorAction($msg, $code);
- $action->execute();
- }
-
- exit((int)$code);
- }
-
- /**
- * Client error
- *
- * @param string $msg error message to display
- * @param integer $code http error code, 400 by default
- * @param string $format error format (json, xml, text) for ApiAction
- *
- * @return nothing
- * @throws ClientException always
- */
- function clientError($msg, $code=400, $format=null)
- {
- // $format is currently only relevant for an ApiAction anyway
- if ($format === null) {
- $format = $this->format;
- }
-
- common_debug("User error '{$code}' on '{$this->action}': {$msg}", __FILE__);
-
- if (!array_key_exists($code, ClientErrorAction::$status)) {
- $code = 400;
- }
-
- $status_string = ClientErrorAction::$status[$code];
-
- switch ($format) {
- case 'xml':
- header("HTTP/1.1 {$code} {$status_string}");
- $this->initDocument('xml');
- $this->elementStart('hash');
- $this->element('error', null, $msg);
- $this->element('request', null, $_SERVER['REQUEST_URI']);
- $this->elementEnd('hash');
- $this->endDocument('xml');
- break;
- case 'json':
- if (!isset($this->callback)) {
- header("HTTP/1.1 {$code} {$status_string}");
- }
- $this->initDocument('json');
- $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
- print(json_encode($error_array));
- $this->endDocument('json');
- break;
- case 'text':
- header("HTTP/1.1 {$code} {$status_string}");
- header('Content-Type: text/plain; charset=utf-8');
- echo $msg;
- break;
- default:
- common_log(LOG_ERR, 'Handled clientError ('._ve($code).') but cannot output into desired format ('._ve($this->format).'): '._ve($msg));
- $action = new ClientErrorAction($msg, $code);
- $action->execute();
- }
- exit((int)$code);
- }
-
- /**
- * If not logged in, take appropriate action (redir or exception)
- *
- * @param boolean $redir Redirect to login if not logged in
- *
- * @return boolean true if logged in (never returns if not)
- */
- public function checkLogin($redir=true)
- {
- if (common_logged_in()) {
- return true;
- }
-
- if ($redir==true) {
- common_set_returnto($_SERVER['REQUEST_URI']);
- common_redirect(common_local_url('login'));
- }
-
- // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
- $this->clientError(_('Not logged in.'), 403);
- }
-
/**
* Returns the current URL
*
* @return string current URL
*/
- function selfUrl()
+ public function selfUrl()
{
list($action, $args) = $this->returnToArgs();
return common_local_url($action, $args);
}
+ /**
+ * Generate pagination links
+ *
+ * @param boolean $have_before is there something before?
+ * @param boolean $have_after is there something after?
+ * @param integer $page current page
+ * @param string $action current action
+ * @param array $args rest of query arguments
+ *
+ * @return void
+ */
+ // XXX: The messages in this pagination method only tailor to navigating
+ // notices. In other lists, "Previous"/"Next" type navigation is
+ // desirable, but not available.
/**
* Returns arguments sufficient for re-constructing URL
*
* @return array two elements: action, other args
*/
- function returnToArgs()
+ public function returnToArgs()
{
$action = $this->getActionName();
- $args = $this->args;
+ $args = $this->args;
unset($args['action']);
if (common_config('site', 'fancy')) {
unset($args['p']);
/**
* Generate a menu item
*
- * @param string $url menu URL
- * @param string $text menu name
- * @param string $title title attribute, null by default
+ * @param string $url menu URL
+ * @param string $text menu name
+ * @param string $title title attribute, null by default
* @param boolean $is_selected current menu item, false by default
- * @param string $id element id, null by default
+ * @param string $id element id, null by default
*
- * @return nothing
+ * @return void
*/
- function menuItem($url, $text, $title=null, $is_selected=false, $id=null, $class=null)
+ public function menuItem($url, $text, $title = null, $is_selected = false, $id = null, $class = null)
{
// Added @id to li for some control.
// XXX: We might want to move this to htmloutputter.php
- $lattrs = array();
- $classes = array();
+ $lattrs = [];
+ $classes = [];
if ($class !== null) {
$classes[] = trim($class);
}
}
/**
- * Generate pagination links
+ * Check the session token.
*
- * @param boolean $have_before is there something before?
- * @param boolean $have_after is there something after?
- * @param integer $page current page
- * @param string $action current action
- * @param array $args rest of query arguments
+ * Checks that the current form has the correct session token,
+ * and throw an exception if it does not.
*
- * @return nothing
+ * @return void
*/
- // XXX: The messages in this pagination method only tailor to navigating
- // notices. In other lists, "Previous"/"Next" type navigation is
- // desirable, but not available.
- function pagination($have_before, $have_after, $page, $action, $args=null)
+ // XXX: Finding this type of check with the same message about 50 times.
+ // Possible to refactor?
+
+ public function pagination($have_before, $have_after, $page, $action, $args = null)
{
// Does a little before-after block for next/prev page
if ($have_before || $have_after) {
$this->elementStart('ul', array('class' => 'nav',
- 'id' => 'pagination'));
+ 'id' => 'pagination'));
}
if ($have_before) {
- $pargs = array('page' => $page-1);
+ $pargs = array('page' => $page - 1);
$this->elementStart('li', array('class' => 'nav_prev'));
- $this->element('a', array('href' => common_local_url($action, $args, $pargs),
- 'rel' => 'prev'),
- // TRANS: Pagination message to go to a page displaying information more in the
- // TRANS: present than the currently displayed information.
- _('After'));
+ $this->element(
+ 'a',
+ array('href' => common_local_url($action, $args, $pargs),
+ 'rel' => 'prev'),
+ // TRANS: Pagination message to go to a page displaying information more in the
+ // TRANS: present than the currently displayed information.
+ _('After')
+ );
$this->elementEnd('li');
}
if ($have_after) {
- $pargs = array('page' => $page+1);
+ $pargs = array('page' => $page + 1);
$this->elementStart('li', array('class' => 'nav_next'));
- $this->element('a', array('href' => common_local_url($action, $args, $pargs),
- 'rel' => 'next'),
- // TRANS: Pagination message to go to a page displaying information more in the
- // TRANS: past than the currently displayed information.
- _('Before'));
+ $this->element(
+ 'a',
+ array('href' => common_local_url($action, $args, $pargs),
+ 'rel' => 'next'),
+ // TRANS: Pagination message to go to a page displaying information more in the
+ // TRANS: past than the currently displayed information.
+ _('Before')
+ );
$this->elementEnd('li');
}
if ($have_before || $have_after) {
}
}
- /**
- * An array of feeds for this action.
- *
- * Returns an array of potential feeds for this action.
- *
- * @return array Feed object to show in head and links
- */
- function getFeeds()
- {
- return array();
- }
- /**
- * Check the session token.
- *
- * Checks that the current form has the correct session token,
- * and throw an exception if it does not.
- *
- * @return void
- */
- // XXX: Finding this type of check with the same message about 50 times.
- // Possible to refactor?
- function checkSessionToken()
+ public function checkSessionToken()
{
// CSRF protection
$token = $this->trimmed('token');
$this->clientError(_('There was a problem with your session token.'));
}
}
-
- /**
- * Check if the current request is a POST
- *
- * @return boolean true if POST; otherwise false.
- */
-
- function isPost()
- {
- return ($_SERVER['REQUEST_METHOD'] == 'POST');
- }
}
* @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
*/
class ActivityObject
{
- const ARTICLE = 'http://activitystrea.ms/schema/1.0/article';
- const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry';
- const NOTE = 'http://activitystrea.ms/schema/1.0/note';
- const STATUS = 'http://activitystrea.ms/schema/1.0/status';
- const FILE = 'http://activitystrea.ms/schema/1.0/file';
- const PHOTO = 'http://activitystrea.ms/schema/1.0/photo';
- const ALBUM = 'http://activitystrea.ms/schema/1.0/photo-album';
- const PLAYLIST = 'http://activitystrea.ms/schema/1.0/playlist';
- const VIDEO = 'http://activitystrea.ms/schema/1.0/video';
- const AUDIO = 'http://activitystrea.ms/schema/1.0/audio';
- const BOOKMARK = 'http://activitystrea.ms/schema/1.0/bookmark';
- const PERSON = 'http://activitystrea.ms/schema/1.0/person';
- const GROUP = 'http://activitystrea.ms/schema/1.0/group';
- const _LIST = 'http://activitystrea.ms/schema/1.0/list'; // LIST is reserved
- const PLACE = 'http://activitystrea.ms/schema/1.0/place';
- const COMMENT = 'http://activitystrea.ms/schema/1.0/comment';
+ const ARTICLE = 'http://activitystrea.ms/schema/1.0/article';
+ const BLOGENTRY = 'http://activitystrea.ms/schema/1.0/blog-entry';
+ const NOTE = 'http://activitystrea.ms/schema/1.0/note';
+ const STATUS = 'http://activitystrea.ms/schema/1.0/status';
+ const FILE = 'http://activitystrea.ms/schema/1.0/file';
+ const PHOTO = 'http://activitystrea.ms/schema/1.0/photo';
+ const ALBUM = 'http://activitystrea.ms/schema/1.0/photo-album';
+ const PLAYLIST = 'http://activitystrea.ms/schema/1.0/playlist';
+ const VIDEO = 'http://activitystrea.ms/schema/1.0/video';
+ const AUDIO = 'http://activitystrea.ms/schema/1.0/audio';
+ const BOOKMARK = 'http://activitystrea.ms/schema/1.0/bookmark';
+ const PERSON = 'http://activitystrea.ms/schema/1.0/person';
+ const GROUP = 'http://activitystrea.ms/schema/1.0/group';
+ const _LIST = 'http://activitystrea.ms/schema/1.0/list'; // LIST is reserved
+ const PLACE = 'http://activitystrea.ms/schema/1.0/place';
+ const COMMENT = 'http://activitystrea.ms/schema/1.0/comment';
// ^^^^^^^^^^ tea!
- const ACTIVITY = 'http://activitystrea.ms/schema/1.0/activity';
- const SERVICE = 'http://activitystrea.ms/schema/1.0/service';
- const IMAGE = 'http://activitystrea.ms/schema/1.0/image';
- const COLLECTION = 'http://activitystrea.ms/schema/1.0/collection';
+ const ACTIVITY = 'http://activitystrea.ms/schema/1.0/activity';
+ const SERVICE = 'http://activitystrea.ms/schema/1.0/service';
+ const IMAGE = 'http://activitystrea.ms/schema/1.0/image';
+ const COLLECTION = 'http://activitystrea.ms/schema/1.0/collection';
const APPLICATION = 'http://activitystrea.ms/schema/1.0/application';
// Atom elements we snarf
- const TITLE = 'title';
+ const TITLE = 'title';
const SUMMARY = 'summary';
- const ID = 'id';
- const SOURCE = 'source';
+ const ID = 'id';
+ const SOURCE = 'source';
- const NAME = 'name';
- const URI = 'uri';
+ const NAME = 'name';
+ const URI = 'uri';
const EMAIL = 'email';
- const POSTEROUS = 'http://posterous.com/help/rss/1.0';
- const AUTHOR = 'author';
- const USERIMAGE = 'userImage';
- const PROFILEURL = 'profileUrl';
- const NICKNAME = 'nickName';
+ const POSTEROUS = 'http://posterous.com/help/rss/1.0';
+ const AUTHOR = 'author';
+ const USERIMAGE = 'userImage';
+ const PROFILEURL = 'profileUrl';
+ const NICKNAME = 'nickName';
const DISPLAYNAME = 'displayName';
-
+ const MEDIA_DESCRIPTION = 'description';
public $element;
public $type;
public $id;
public $summary;
public $content;
public $owner;
- public $link;
- public $selfLink; // think APP (Atom Publishing Protocol)
+ public $link; // think APP (Atom Publishing Protocol)
+ public $selfLink;
public $source;
- public $avatarLinks = array();
+ public $avatarLinks = [];
public $geopoint;
public $poco;
- public $displayName;
// @todo move this stuff to it's own PHOTO activity object
- const MEDIA_DESCRIPTION = 'description';
-
+ public $displayName;
public $thumbnail;
public $largerImage;
public $description;
- public $extra = array();
+ public $extra = [];
public $stream;
*
* @param DOMElement $element DOM thing to turn into an Activity thing
*/
- function __construct($element = null)
+ public function __construct($element = null)
{
if (empty($element)) {
return;
if ($element->tagName == 'author') {
$this->_fromAuthor($element);
- } else if ($element->tagName == 'item') {
+ } elseif ($element->tagName == 'item') {
$this->_fromRssItem($element);
} else {
$this->_fromAtomEntry($element);
}
if ($this->type == self::PHOTO) {
-
- $this->thumbnail = ActivityUtils::getLink($element, 'preview');
+ $this->thumbnail = ActivityUtils::getLink($element, 'preview');
$this->largerImage = ActivityUtils::getLink($element, 'enclosure');
$this->description = ActivityUtils::childContent(
}
}
+ private function _childContent($element, $tag, $namespace = ActivityUtils::ATOM)
+ {
+ return ActivityUtils::childContent($element, $tag, $namespace);
+ }
+
private function _fromAuthor($element)
{
- $this->type = $this->_childContent($element,
- Activity::OBJECTTYPE,
- Activity::SPEC);
+ $this->type = $this->_childContent(
+ $element,
+ Activity::OBJECTTYPE,
+ Activity::SPEC
+ );
if (empty($this->type)) {
$this->type = self::PERSON; // XXX: is this fair?
$email = $this->_childContent($element, self::EMAIL);
if (!empty($email)) {
// XXX: acct: ?
- $this->id = 'mailto:'.$email;
+ $this->id = 'mailto:' . $email;
}
}
}
}
+ // @todo FIXME: rationalize with Activity::_fromRssItem()
+
+ private function _fromRssItem($item)
+ {
+ if (empty($this->type)) {
+ $this->type = ActivityObject::NOTE;
+ }
+
+ $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);
+
+ $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, Activity::CONTENTNS);
+
+ if (!empty($contentEl)) {
+ $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
+ } else {
+ $descriptionEl = ActivityUtils::child($item, Activity::DESCRIPTION, Activity::RSS);
+ if (!empty($descriptionEl)) {
+ $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
+ }
+ }
+
+ $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, Activity::RSS);
+
+ $guidEl = ActivityUtils::child($item, Activity::GUID, Activity::RSS);
+
+ if (!empty($guidEl)) {
+ $this->id = $guidEl->textContent;
+
+ if ($guidEl->hasAttribute('isPermaLink') && $guidEl->getAttribute('isPermaLink') != 'false') {
+ // overwrites <link>
+ $this->link = $this->id;
+ }
+ }
+ }
+
private function _fromAtomEntry($element)
{
- $this->type = $this->_childContent($element, Activity::OBJECTTYPE,
- Activity::SPEC);
+ $this->type = $this->_childContent(
+ $element,
+ Activity::OBJECTTYPE,
+ Activity::SPEC
+ );
if (empty($this->type)) {
$this->type = ActivityObject::NOTE;
// 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->source = $this->_getSource($element);
$this->link = ActivityUtils::getPermalink($element);
$this->selfLink = ActivityUtils::getSelfLink($element);
}
$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 = [];
+ foreach ($link->attributes as $attrName => $attrNode) {
$attrs[$attrName] = $attrNode->nodeValue;
}
$this->extra[] = [$link->localName,
- $attrs,
- $link->nodeValue];
+ $attrs,
+ $link->nodeValue];
}
}
}
- // @todo FIXME: rationalize with Activity::_fromRssItem()
- private function _fromRssItem($item)
+ private function _getSource($element)
{
- if (empty($this->type)) {
- $this->type = ActivityObject::NOTE;
- }
-
- $this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);
-
- $contentEl = ActivityUtils::child($item, ActivityUtils::CONTENT, Activity::CONTENTNS);
+ $sourceEl = ActivityUtils::child($element, 'source');
- if (!empty($contentEl)) {
- $this->content = htmlspecialchars_decode($contentEl->textContent, ENT_QUOTES);
+ if (empty($sourceEl)) {
+ return null;
} else {
- $descriptionEl = ActivityUtils::child($item, Activity::DESCRIPTION, Activity::RSS);
- if (!empty($descriptionEl)) {
- $this->content = htmlspecialchars_decode($descriptionEl->textContent, ENT_QUOTES);
- }
- }
-
- $this->link = ActivityUtils::childContent($item, ActivityUtils::LINK, Activity::RSS);
-
- $guidEl = ActivityUtils::child($item, Activity::GUID, Activity::RSS);
-
- if (!empty($guidEl)) {
- $this->id = $guidEl->textContent;
-
- if ($guidEl->hasAttribute('isPermaLink') && $guidEl->getAttribute('isPermaLink') != 'false') {
- // overwrites <link>
- $this->link = $this->id;
+ $href = ActivityUtils::getLink($sourceEl, 'self');
+ if (!empty($href)) {
+ return $href;
+ } else {
+ return ActivityUtils::childContent($sourceEl, 'id');
}
}
}
if (preg_match('/^(.*?) \((.*)\)$/', $text, $match)) {
$email = $match[1];
$name = $match[2];
- } else if (preg_match('/^(.*?) <(.*)>$/', $text, $match)) {
+ } elseif (preg_match('/^(.*?) <(.*)>$/', $text, $match)) {
$name = $match[1];
$email = $match[2];
- } else if (preg_match('/.*@.*/', $text)) {
+ } elseif (preg_match('/.*@.*/', $text)) {
$email = $text;
$name = null;
} else {
$obj->element = $el;
- $obj->type = ActivityObject::PERSON;
+ $obj->type = ActivityObject::PERSON;
$obj->title = $name;
if (!empty($email)) {
- $obj->id = 'mailto:'.$email;
+ $obj->id = 'mailto:' . $email;
}
return $obj;
$obj->element = $el;
$obj->title = $text;
- $obj->type = ActivityObject::PERSON;
+ $obj->type = ActivityObject::PERSON;
return $obj;
}
$obj->type = ActivityObject::PERSON; // @fixme guess better
$obj->title = ActivityUtils::childContent($el, ActivityObject::TITLE, Activity::RSS);
- $obj->link = ActivityUtils::childContent($el, ActivityUtils::LINK, Activity::RSS);
- $obj->id = ActivityUtils::getLink($el, Activity::SELF);
+ $obj->link = ActivityUtils::childContent($el, ActivityUtils::LINK, Activity::RSS);
+ $obj->id = ActivityUtils::getLink($el, Activity::SELF);
if (empty($obj->id)) {
$obj->id = $obj->link;
return $obj;
}
+ // Try to get a unique id for the source feed
+
public static function fromPosterousAuthor($el)
{
$obj = new ActivityObject();
}
$obj->link = ActivityUtils::childContent($el, self::PROFILEURL, self::POSTEROUS);
- $obj->id = $obj->link;
+ $obj->id = $obj->link;
$obj->poco = new PoCo();
$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;
return $obj;
}
- private function _childContent($element, $tag, $namespace=ActivityUtils::ATOM)
- {
- 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)
+ public static function fromGroup(User_group $group)
{
$object = new ActivityObject();
- if (Event::handle('StartActivityObjectFromGroup', array($group, &$object))) {
-
- $object->type = ActivityObject::GROUP;
- $object->id = $group->getUri();
- $object->title = $group->getBestName();
- $object->link = $group->getUri();
+ if (Event::handle('StartActivityObjectFromGroup', [$group, &$object])) {
+ $object->type = ActivityObject::GROUP;
+ $object->id = $group->getUri();
+ $object->title = $group->getBestName();
+ $object->link = $group->getUri();
- $object->avatarLinks[] = AvatarLink::fromFilename($group->homepage_logo,
- AVATAR_PROFILE_SIZE);
+ $object->avatarLinks[] = AvatarLink::fromFilename(
+ $group->homepage_logo,
+ AVATAR_PROFILE_SIZE
+ );
- $object->avatarLinks[] = AvatarLink::fromFilename($group->stream_logo,
- AVATAR_STREAM_SIZE);
+ $object->avatarLinks[] = AvatarLink::fromFilename(
+ $group->stream_logo,
+ AVATAR_STREAM_SIZE
+ );
- $object->avatarLinks[] = AvatarLink::fromFilename($group->mini_logo,
- AVATAR_MINI_SIZE);
+ $object->avatarLinks[] = AvatarLink::fromFilename(
+ $group->mini_logo,
+ AVATAR_MINI_SIZE
+ );
$object->poco = PoCo::fromGroup($group);
- Event::handle('EndActivityObjectFromGroup', array($group, &$object));
+ Event::handle('EndActivityObjectFromGroup', [$group, &$object]);
}
return $object;
}
- static function fromPeopletag($ptag)
+ public static function fromPeopletag($ptag)
{
$object = new ActivityObject();
- if (Event::handle('StartActivityObjectFromPeopletag', array($ptag, &$object))) {
- $object->type = ActivityObject::_LIST;
+ if (Event::handle('StartActivityObjectFromPeopletag', [$ptag, &$object])) {
+ $object->type = ActivityObject::_LIST;
- $object->id = $ptag->getUri();
- $object->title = $ptag->tag;
+ $object->id = $ptag->getUri();
+ $object->title = $ptag->tag;
$object->summary = $ptag->description;
- $object->link = $ptag->homeUrl();
- $object->owner = Profile::getKV('id', $ptag->tagger);
- $object->poco = PoCo::fromProfile($object->owner);
- Event::handle('EndActivityObjectFromPeopletag', array($ptag, &$object));
+ $object->link = $ptag->homeUrl();
+ $object->owner = Profile::getKV('id', $ptag->tagger);
+ $object->poco = PoCo::fromProfile($object->owner);
+ Event::handle('EndActivityObjectFromPeopletag', [$ptag, &$object]);
}
return $object;
}
- static function fromFile(File $file)
+ public static function fromFile(File $file)
{
$object = new ActivityObject();
- if (Event::handle('StartActivityObjectFromFile', array($file, &$object))) {
-
+ if (Event::handle('StartActivityObjectFromFile', [$file, &$object])) {
$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();
if ($file->title) {
}
switch (self::canonicalType($object->type)) {
+ case 'image':
+ $object->largerImage = $file->getUrl();
+ break;
+ case 'video':
+ case 'audio':
+ $object->stream = $file->getUrl();
+ break;
+ }
+
+ Event::handle('EndActivityObjectFromFile', [$file, &$object]);
+ }
+
+ return $object;
+ }
+
+ public static function mimeTypeToObjectType($mimeType)
+ {
+ $ot = null;
+
+ // Default
+
+ if (empty($mimeType)) {
+ return self::FILE;
+ }
+
+ $parts = explode('/', $mimeType);
+
+ switch ($parts[0]) {
case 'image':
- $object->largerImage = $file->getUrl();
+ $ot = self::IMAGE;
break;
- case 'video':
case 'audio':
- $object->stream = $file->getUrl();
+ $ot = self::AUDIO;
break;
- }
-
- Event::handle('EndActivityObjectFromFile', array($file, &$object));
+ case 'video':
+ $ot = self::VIDEO;
+ break;
+ default:
+ $ot = self::FILE;
}
- return $object;
+ return $ot;
+ }
+
+ public static function canonicalType($type)
+ {
+ return ActivityUtils::resolveUri($type, true);
}
- static function fromNoticeSource(Notice_source $source)
+ public static function fromNoticeSource(Notice_source $source)
{
$object = new ActivityObject();
- $wellKnown = array('web', 'xmpp', 'mail', 'omb', 'system', 'api', 'ostatus',
- 'activity', 'feed', 'mirror', 'twitter', 'facebook');
+ $wellKnown = ['web', 'xmpp', 'mail', 'omb', 'system', 'api', 'ostatus',
+ 'activity', 'feed', 'mirror', 'twitter', 'facebook'];
- if (Event::handle('StartActivityObjectFromNoticeSource', array($source, &$object))) {
+ if (Event::handle('StartActivityObjectFromNoticeSource', [$source, &$object])) {
$object->type = ActivityObject::APPLICATION;
if (in_array($source->code, $wellKnown)) {
// We use one ID for all well-known StatusNet sources
- $object->id = "tag:status.net,2009:notice-source:".$source->code;
- } else if ($source->url) {
+ $object->id = "tag:status.net,2009:notice-source:" . $source->code;
+ } elseif ($source->url) {
// They registered with an URL
$object->id = $source->url;
} else {
// 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->created) {
$object->date = $source->created;
}
-
- $object->extra[] = array('status_net', array('source_code' => $source->code));
- Event::handle('EndActivityObjectFromNoticeSource', array($source, &$object));
+ $object->extra[] = ['status_net', ['source_code' => $source->code]];
+
+ Event::handle('EndActivityObjectFromNoticeSource', [$source, &$object]);
}
return $object;
}
- static function fromMessage(Message $message)
+ public static function fromMessage(Message $message)
{
$object = new ActivityObject();
- if (Event::handle('StartActivityObjectFromMessage', array($message, &$object))) {
-
- $object->type = ActivityObject::NOTE;
- $object->id = ($message->uri) ? $message->uri : (($message->url) ? $message->url : TagURI::mint(sprintf("message:%d", $message->id)));
+ if (Event::handle('StartActivityObjectFromMessage', [$message, &$object])) {
+ $object->type = ActivityObject::NOTE;
+ $object->id = ($message->uri) ? $message->uri : (($message->url) ? $message->url : TagURI::mint(sprintf("message:%d", $message->id)));
$object->content = $message->rendered;
- $object->date = $message->created;
+ $object->date = $message->created;
if ($message->url) {
$object->link = $message->url;
} 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));
-
- Event::handle('EndActivityObjectFromMessage', array($message, &$object));
+ $object->extra[] = ['status_net', ['message_id' => $message->id]];
+
+ Event::handle('EndActivityObjectFromMessage', [$message, &$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)) {
$xo->elementStart($tag);
}
- if (Event::handle('StartActivityObjectOutputAtom', array($this, $xo))) {
+ if (Event::handle('StartActivityObjectOutputAtom', [$this, $xo])) {
$xo->element('activity:object-type', null, $this->type);
// <author> uses URI
// XXX: assuming HTML content here
$xo->element(
ActivityUtils::CONTENT,
- array('type' => 'html'),
+ ['type' => 'html'],
common_xml_safe_str($this->content)
);
}
if (!empty($this->link)) {
$xo->element(
'link',
- array(
+ [
'rel' => 'alternate',
'type' => 'text/html',
'href' => $this->link
- ),
- null
+ ]
);
}
if (!empty($this->selfLink)) {
$xo->element(
'link',
- array(
+ [
'rel' => 'self',
'type' => 'application/atom+xml',
'href' => $this->selfLink
- ),
- null
+ ]
);
}
- if(!empty($this->owner)) {
+ if (!empty($this->owner)) {
$owner = $this->owner->asActivityNoun(self::AUTHOR);
$xo->raw($owner);
}
if ($this->type == ActivityObject::PERSON
|| $this->type == ActivityObject::GROUP) {
-
foreach ($this->avatarLinks as $alink) {
- $xo->element('link',
- array(
- 'rel' => 'avatar',
- 'type' => $alink->type,
- 'media:width' => $alink->width,
- 'media:height' => $alink->height,
- 'href' => $alink->url,
- ),
- null);
+ $xo->element(
+ 'link',
+ [
+ 'rel' => 'avatar',
+ 'type' => $alink->type,
+ 'media:width' => $alink->width,
+ 'media:height' => $alink->height,
+ 'href' => $alink->url,
+ ]
+ );
}
}
$xo->element($extraTag, $attrs, $content);
}
- Event::handle('EndActivityObjectOutputAtom', array($this, $xo));
+ Event::handle('EndActivityObjectOutputAtom', [$this, $xo]);
}
if (!empty($tag)) {
return;
}
- function asString($tag='activity:object')
+ public function asArray()
{
- $xs = new XMLStringer(true);
-
- $this->outputTo($xs, $tag);
+ $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))) {
+ if (Event::handle('StartActivityObjectOutputJson', [$this, &$object])) {
// XXX: attachments are added by Activity
// author (Add object for author? Could be useful for repeats.)
if ($this->id) {
$object['id'] = $this->id;
- } else if ($this->link) {
+ } elseif ($this->link) {
$object['id'] = $this->link;
}
// XXX: Not sure what the best avatar is to use for the
// author's "image". For now, I'm using the large size.
- $imgLink = null;
- $avatarMediaLinks = array();
+ $imgLink = null;
+ $avatarMediaLinks = [];
foreach ($this->avatarLinks as $a) {
}
if (!array_key_exists('status_net', $object)) {
- $object['status_net'] = array();
+ $object['status_net'] = [];
}
$object['status_net']['avatarLinks'] = $avatarMediaLinks; // extension
// image
if (!empty($imgLink)) {
- $object['image'] = $imgLink->asArray();
+ $object['image'] = $imgLink->asArray();
}
}
$parts = explode(":", $objectName);
if (count($parts) == 2 && $parts[0] == "statusnet") {
if (!array_key_exists('status_net', $object)) {
- $object['status_net'] = array();
+ $object['status_net'] = [];
}
$object['status_net'][$parts[1]] = $props;
} else {
}
if (!empty($this->geopoint)) {
-
list($lat, $lon) = explode(' ', $this->geopoint);
if (!empty($lat) && !empty($lon)) {
- $object['location'] = array(
+ $object['location'] = [
'objectType' => 'place',
'position' => sprintf("%+02.5F%+03.5F/", $lat, $lon),
'lat' => $lat,
'lon' => $lon
- );
+ ];
$loc = Location::fromLatLon((float)$lat, (float)$lon);
if (!empty($this->thumbnail)) {
if (is_string($this->thumbnail)) {
- $object['image'] = array('url' => $this->thumbnail);
+ $object['image'] = ['url' => $this->thumbnail];
} else {
- $object['image'] = array('url' => $this->thumbnail->getUrl());
+ $object['image'] = ['url' => $this->thumbnail->getUrl()];
if ($this->thumbnail->width) {
$object['image']['width'] = $this->thumbnail->width;
}
}
switch (self::canonicalType($this->type)) {
- case 'image':
- if (!empty($this->largerImage)) {
- $object['fullImage'] = array('url' => $this->largerImage);
- }
- break;
- case 'audio':
- case 'video':
- if (!empty($this->stream)) {
- $object['stream'] = array('url' => $this->stream);
- }
- break;
+ case 'image':
+ if (!empty($this->largerImage)) {
+ $object['fullImage'] = ['url' => $this->largerImage];
+ }
+ break;
+ case 'audio':
+ case 'video':
+ if (!empty($this->stream)) {
+ $object['stream'] = ['url' => $this->stream];
+ }
+ break;
}
- Event::handle('EndActivityObjectOutputJson', array($this, &$object));
+ Event::handle('EndActivityObjectOutputJson', [$this, &$object]);
}
return array_filter($object);
}
- public function getIdentifiers() {
- $ids = array();
- foreach(array('id', 'link', 'url') as $id) {
+ public function getIdentifiers()
+ {
+ $ids = [];
+ foreach (['id', 'link', 'url'] as $id) {
if (isset($this->$id)) {
$ids[] = $this->$id;
}
}
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;
- }
}
{
const READ_ONLY = 1;
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 $auth_user = null;
public $page = null;
public function twitterRelationshipArray($source, $target)
{
- $relationship = array();
+ $relationship = [];
$relationship['source'] =
$this->relationshipDetailsArray($source->getProfile(), $target->getProfile());
$relationship['target'] =
$this->relationshipDetailsArray($target->getProfile(), $source->getProfile());
- return array('relationship' => $relationship);
+ return ['relationship' => $relationship];
}
public function relationshipDetailsArray(Profile $source, Profile $target)
{
- $details = array();
+ $details = [];
$details['screen_name'] = $source->getNickname();
$details['followed_by'] = $target->isSubscribed($source);
* See that method's documentation for more info.
*
* @param string $tag Element type or tagname
- * @param array $attrs Array of element attributes, as
- * key-value pairs
- * @param string $content string content of the element
+ * @param array|string|null $attrs Array of element attributes, as key-value pairs
+ * @param string|null $content string content of the element
*
* @return void
*/
- public function element($tag, $attrs = [], $content = "")
+ public function element(string $tag, $attrs = null, $content = null)
{
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)
$this->startXML();
$this->elementStart(
'rss',
- array(
+ [
'version' => '2.0',
'xmlns:atom' => 'http://www.w3.org/2005/Atom',
'xmlns:georss' => 'http://www.georss.org/georss'
- )
+ ]
);
$this->elementStart('channel');
- Event::handle('StartApiRss', array($this));
+ Event::handle('StartApiRss', [$this]);
}
public function initTwitterAtom()
{
$this->startXML();
// 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',
- '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)
{
$profile = $notice->getProfile();
- $twitter_status = array();
+ $twitter_status = [];
$twitter_status['text'] = $notice->content;
$twitter_status['truncated'] = false; # Not possible on StatusNet
$twitter_status['created_at'] = self::dateTwitter($notice->created);
try {
$notloc = Notice_location::locFromStored($notice);
// This is the format that GeoJSON expects stuff to be in
- $twitter_status['geo'] = array('type' => 'Point',
- 'coordinates' => array((float)$notloc->lat,
- (float)$notloc->lon));
+ $twitter_status['geo'] = ['type' => 'Point',
+ 'coordinates' => [(float)$notloc->lat,
+ (float)$notloc->lon]];
} catch (ServerException $e) {
$twitter_status['geo'] = null;
}
$attachments = $notice->attachments();
if (!empty($attachments)) {
- $twitter_status['attachments'] = array();
+ $twitter_status['attachments'] = [];
foreach ($attachments as $attachment) {
try {
$enclosure_o = $attachment->getEnclosure();
- $enclosure = array();
+ $enclosure = [];
$enclosure['url'] = $enclosure_o->url;
$enclosure['mimetype'] = $enclosure_o->mimetype;
$enclosure['size'] = $enclosure_o->size;
$twitter_status['statusnet_conversation_id'] = intval($notice->conversation);
// The event call to handle NoticeSimpleStatusArray lets plugins add data to the output array
- Event::handle('NoticeSimpleStatusArray', array($notice, &$twitter_status, $this->scoped,
- array('include_user' => $include_user)));
+ Event::handle('NoticeSimpleStatusArray', [$notice, &$twitter_status, $this->scoped,
+ ['include_user' => $include_user]]);
return $twitter_status;
}
public function twitterUserArray($profile, $get_notice = false)
{
- $twitter_user = array();
+ $twitter_user = [];
try {
$user = $profile->getUser();
$twitter_user['profile_image_url_original'] = $origurl;
$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);
}
// END introduced by qvitter API, not necessary for StatusNet API
$twitter_user['statusnet_profile_url'] = $profile->profileurl;
// 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;
}
public function showTwitterXmlStatus($twitter_status, $tag = 'status', $namespaces = false)
{
- $attrs = array();
+ $attrs = [];
if ($namespaces) {
$attrs['xmlns:statusnet'] = 'http://status.net/schema/api/1/';
}
public function showTwitterXmlUser($twitter_user, $role = 'user', $namespaces = false)
{
- $attrs = array();
+ $attrs = [];
if ($namespaces) {
$attrs['xmlns:statusnet'] = 'http://status.net/schema/api/1/';
}
public function showXmlAttachments($attachments)
{
if (!empty($attachments)) {
- $this->elementStart('attachments', array('type' => 'array'));
+ $this->elementStart('attachments', ['type' => 'array']);
foreach ($attachments as $attachment) {
- $attrs = array();
+ $attrs = [];
$attrs['url'] = $attachment['url'];
$attrs['mimetype'] = $attachment['mimetype'];
$attrs['size'] = $attachment['size'];
// empty geo element
$this->element('geo');
} 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->elementEnd('geo');
}
public function showXmlTimeline($notice)
{
$this->initDocument('xml');
- $this->elementStart('statuses', array('type' => 'array',
- 'xmlns:statusnet' => 'http://status.net/schema/api/1/'));
+ $this->elementStart('statuses', ['type' => 'array',
+ 'xmlns:statusnet' => 'http://status.net/schema/api/1/']);
if (is_array($notice)) {
//FIXME: make everything calling showJsonTimeline use only Notice objects
- $ids = array();
+ $ids = [];
foreach ($notice as $n) {
$ids[] = $n->getID();
}
if (!is_null($self)) {
$this->element(
'atom:link',
- array(
+ [
'type' => 'application/rss+xml',
'href' => $self,
'rel' => 'self'
- )
+ ]
);
}
if (!is_null($suplink)) {
// 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',
'href' => $suplink,
- 'type' => 'application/json'));
+ 'type' => 'application/json']);
}
if (!is_null($logo)) {
if (is_array($notice)) {
//FIXME: make everything calling showJsonTimeline use only Notice objects
- $ids = array();
+ $ids = [];
foreach ($notice as $n) {
$ids[] = $n->getID();
}
public function twitterRssEntryArray($notice)
{
- $entry = array();
+ $entry = [];
- if (Event::handle('StartRssEntryArray', array($notice, &$entry))) {
+ if (Event::handle('StartRssEntryArray', [$notice, &$entry])) {
$profile = $notice->getProfile();
// We trim() to avoid extraneous whitespace in the output
$entry['content'] = common_xml_safe_str(trim($notice->getRendered()));
$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);
$taguribase = TagURI::base();
// Enclosures
$attachments = $notice->attachments();
- $enclosures = array();
+ $enclosures = [];
foreach ($attachments as $attachment) {
try {
$enclosure_o = $attachment->getEnclosure();
- $enclosure = array();
+ $enclosure = [];
$enclosure['url'] = $enclosure_o->url;
$enclosure['mimetype'] = $enclosure_o->mimetype;
$enclosure['size'] = $enclosure_o->size;
$tag = new Notice_tag();
$tag->notice_id = $notice->id;
if ($tag->find()) {
- $entry['tags'] = array();
+ $entry['tags'] = [];
while ($tag->fetch()) {
$entry['tags'][] = $tag->tag;
}
$notloc = Notice_location::locFromStored($notice);
// This is the format that GeoJSON expects stuff to be in.
// showGeoRSS() below uses it for XML output, so we reuse it
- $entry['geo'] = array('type' => 'Point',
- 'coordinates' => array((float)$notloc->lat,
- (float)$notloc->lon));
+ $entry['geo'] = ['type' => 'Point',
+ 'coordinates' => [(float)$notloc->lat,
+ (float)$notloc->lon]];
} catch (ServerException $e) {
$entry['geo'] = null;
}
- Event::handle('EndRssEntryArray', array($notice, &$entry));
+ Event::handle('EndRssEntryArray', [$notice, &$entry]);
}
return $entry;
// RSS only supports 1 enclosure per item
if (array_key_exists('enclosures', $entry) and !empty($entry['enclosures'])) {
$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)) {
$this->element('title', null, $title);
$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)) {
$this->element('logo', null, $logo);
if (!is_null($suplink)) {
// 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,
- 'type' => 'application/json'));
+ 'type' => 'application/json']);
}
if (!is_null($selfuri)) {
- $this->element('link', array('href' => $selfuri,
- 'rel' => 'self', 'type' => 'application/atom+xml'), null);
+ $this->element('link', ['href' => $selfuri,
+ 'rel' => 'self', 'type' => 'application/atom+xml']);
}
$this->element('updated', null, common_date_iso8601('now'));
if (is_array($notice)) {
//FIXME: make everything calling showJsonTimeline use only Notice objects
- $ids = array();
+ $ids = [];
foreach ($notice as $n) {
$ids[] = $n->getID();
}
public function twitterRssGroupArray($group)
{
- $entry = array();
+ $entry = [];
$entry['content'] = $group->description;
$entry['title'] = $group->nickname;
$entry['link'] = $group->permalink();
$this->element('title', null, common_xml_safe_str($entry['title']));
$this->element(
'content',
- array('type' => 'html'),
+ ['type' => 'html'],
common_xml_safe_str($entry['content'])
);
$this->element('id', null, $entry['id']);
$this->element('published', null, $entry['published']);
$this->element('updated', null, $entry['updated']);
- $this->element('link', array('type' => 'text/html',
+ $this->element('link', ['type' => 'text/html',
'href' => $entry['link'],
- 'rel' => 'alternate'));
- $this->element('link', array('type' => $entry['avatar-type'],
+ 'rel' => 'alternate']);
+ $this->element('link', ['type' => $entry['avatar-type'],
'href' => $entry['avatar'],
- 'rel' => 'image'));
+ 'rel' => 'image']);
$this->elementStart('author');
$this->element('name', null, $entry['author-name']);
$this->element('title', null, common_xml_safe_str($title));
$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)) {
- $this->element('link', array('href' => $selfuri,
- 'rel' => 'self', 'type' => 'application/atom+xml'), null);
+ $this->element('link', ['href' => $selfuri,
+ 'rel' => 'self', 'type' => 'application/atom+xml']);
}
$this->element('updated', null, common_date_iso8601('now'));
{
$this->initDocument('json');
- $statuses = array();
+ $statuses = [];
if (is_array($notice)) {
//FIXME: make everything calling showJsonTimeline use only Notice objects
- $ids = array();
+ $ids = [];
foreach ($notice as $n) {
$ids[] = $n->getID();
}
{
$this->initDocument('json');
- $groups = array();
+ $groups = [];
if (is_array($group)) {
foreach ($group as $g) {
public function twitterGroupArray($group)
{
- $twitter_group = array();
+ $twitter_group = [];
$twitter_group['id'] = intval($group->id);
$twitter_group['url'] = $group->permalink();
public function showXmlGroups($group)
{
$this->initDocument('xml');
- $this->elementStart('groups', array('type' => 'array'));
+ $this->elementStart('groups', ['type' => 'array']);
if (is_array($group)) {
foreach ($group as $g) {
{
$this->initDocument('xml');
$this->elementStart('lists_list');
- $this->elementStart('lists', array('type' => 'array'));
+ $this->elementStart('lists', ['type' => 'array']);
if (is_array($list)) {
foreach ($list as $l) {
{
$profile = Profile::getKV('id', $list->tagger);
- $twitter_list = array();
+ $twitter_list = [];
$twitter_list['id'] = $list->id;
$twitter_list['name'] = $list->tag;
$twitter_list['full_name'] = '@' . $profile->nickname . '/' . $list->tag;;
{
$this->initDocument('json');
- $lists = array();
+ $lists = [];
if (is_array($list)) {
foreach ($list as $l) {
}
}
- $lists_list = array(
+ $lists_list = [
'lists' => $lists,
'next_cursor' => $next_cursor,
'next_cursor_str' => strval($next_cursor),
'previous_cursor' => $prev_cursor,
'previous_cursor_str' => strval($prev_cursor)
- );
+ ];
$this->showJsonObjects($lists_list);
public function showTwitterXmlUsers($user)
{
$this->initDocument('xml');
- $this->elementStart('users', array('type' => 'array',
- 'xmlns:statusnet' => 'http://status.net/schema/api/1/'));
+ $this->elementStart('users', ['type' => 'array',
+ 'xmlns:statusnet' => 'http://status.net/schema/api/1/']);
if (is_array($user)) {
foreach ($user as $u) {
{
$this->initDocument('json');
- $users = array();
+ $users = [];
if (is_array($user)) {
foreach ($user as $u) {
public function getTargetProfile($id)
{
if (empty($id)) {
-
// Twitter supports these other ways of passing the user ID
if (self::is_decimal($this->arg('id'))) {
return Profile::getKV($this->arg('id'));
// Fall back to trying the currently authenticated user
return $this->scoped;
}
- } elseif (self::is_decimal($id) && intval($id) > 0) {
+ }
+
+ if (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();
}
+
+ // 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)
} elseif ($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);
} elseif ($this->arg('uri')) { // FIXME: move this into empty($id) check?
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)
// Fall back to trying the currently authenticated user
return $this->scoped->getUser();
}
- } elseif (self::is_decimal($id)) {
+ }
+
+ if (self::is_decimal($id)) {
return User::getKV($id);
- } else {
- $nickname = common_canonical_nickname($id);
- return User::getKV('nickname', $nickname);
}
+
+ $nickname = common_canonical_nickname($id);
+ return User::getKV('nickname', $nickname);
}
/**
$action = mb_substr(get_class($this), 0, -6); // remove 'Action'
$id = $this->arg('id');
- $aargs = array('format' => $this->format);
+ $aargs = ['format' => $this->format];
if (!empty($id)) {
$aargs['id'] = $id;
}
* @param array $args Web and URL arguments
*
* @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
parent::prepare($args);
/**
* Handle a request
*
- * @param array $args Arguments from $_REQUEST
- *
* @return void
*/
protected function handle()
{
foreach ($this->links as $attrs)
{
- $this->element('link', $attrs, null);
+ $this->element('link', $attrs);
}
}
$attrs['member_count'] = $this->group->getMemberCount();
- $this->element('statusnet:group_info', $attrs, null);
+ $this->element('statusnet:group_info', $attrs);
}
}
*/
class ErrorAction extends InfoAction
{
- static $status = array();
+ static $status = [];
var $code = null;
var $message = null;
/**
* Display content.
*
- * @return nothing
+ * @return void
*/
function showContent()
{
- $this->element('div', array('class' => 'error'), $this->message);
+ $this->element('div', ['class' => 'error'], $this->message);
}
function showNoticeForm()
*
* Goes back to the browser, where it's shown in a popup.
*
- * @param string $msg Message to show
- *
* @return void
+ * @throws ClientException
*/
function ajaxErrorMsg()
{
- $this->startHTML('text/xml;charset=utf-8', true);
+ $this->startHTML('text/xml;charset=utf-8');
$this->elementStart('head');
// TRANS: Page title after an AJAX error occurs on the send notice page.
$this->element('title', null, _('Ajax Error'));
$this->elementEnd('head');
$this->elementStart('body');
- $this->element('p', array('id' => 'error'), $this->message);
+ $this->element('p', ['id' => 'error'], $this->message);
$this->elementEnd('body');
$this->endHTML();
}
* @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.
define('PAGE_TYPE_PREFS', 'text/html');
* @see Action
* @see XMLOutputter
*/
-
class HTMLOutputter extends XMLOutputter
{
- protected $DTD = array('doctype' => 'html',
- 'spec' => '-//W3C//DTD XHTML 1.0 Strict//EN',
- 'uri' => 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
+ protected $DTD = ['doctype' => 'html',
+ 'spec' => '-//W3C//DTD XHTML 1.0 Strict//EN',
+ 'uri' => 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'];
+
/**
* 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
*/
- function __construct($output='php://output', $indent=null)
+ public function __construct($output = 'php://output', $indent = null)
{
parent::__construct($output, $indent);
}
*
* @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.
*
- * @return void
*/
- function startHTML($type=null)
+ public function startHTML($type = null)
{
if (!$type) {
$httpaccept = isset($_SERVER['HTTP_ACCEPT']) ?
- $_SERVER['HTTP_ACCEPT'] : null;
+ $_SERVER['HTTP_ACCEPT'] : null;
// XXX: allow content negotiation for RDF, RSS, or XRDS
if (!$type) {
// TRANS: Client exception 406
- throw new ClientException(_('This page is not available in a '.
- 'media type you accept'), 406);
+ throw new ClientException(_('This page is not available in a ' .
+ '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).
- if (common_config('javascript', 'bustframes')) {
+ if (common_config('javascript', 'bustframes')) {
header('X-XSS-Protection: 1; mode=block'); // detect XSS Reflection attacks
header('X-Frame-Options: SAMEORIGIN'); // no rendering if origin mismatch
}
$language = $this->getLanguage();
- $attrs = array(
+ $attrs = [
'xmlns' => 'http://www.w3.org/1999/xhtml',
'xml:lang' => $language,
'lang' => $language
- );
+ ];
- if (Event::handle('StartHtmlElement', array($this, &$attrs))) {
+ if (Event::handle('StartHtmlElement', [$this, &$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()
{
- $this->xw->writeDTD($this->DTD['doctype'],
- $this->DTD['spec'],
- $this->DTD['uri']);
+ $this->xw->writeDTD(
+ $this->DTD['doctype'],
+ $this->DTD['spec'],
+ $this->DTD['uri']
+ );
}
- function getLanguage()
+ public function getLanguage()
{
// FIXME: correct language for interface
return common_language();
}
- /**
- * Ends an HTML document
- *
- * @return void
- */
- function endHTML()
+ public function setDTD($doctype, $spec, $uri)
{
- $this->elementEnd('html');
- $this->endXML();
+ $this->DTD = ['doctype' => $doctype, 'spec' => $spec, 'uri' => $uri];
}
/**
- * To specify additional HTTP headers for the action
- *
- * @return void
- */
- function extraHeaders()
+ * Ends an HTML document
+ *
+ * @return void
+ */
+ public function endHTML()
{
- // Needs to be overloaded
+ $this->elementEnd('html');
+ $this->endXML();
}
/**
*
* If $attrs['type'] does not exist it will be set to 'text'.
*
- * @param string $id element ID, must be unique on page
- * @param string $label text of label for the element
- * @param string $value value of the element, default null
+ * @param string $id element ID, must be unique on page
+ * @param string $label text of label for the element
+ * @param string $value value of the element, default null
* @param string $instructions instructions for valid input
- * @param string $name name of the element; if null, the id will
- * be used
- * @param bool $required HTML5 required attribute (exclude when false)
- * @param array $attrs Initial attributes manually set in an array (overwritten by previous options)
+ * @param string $name name of the element; if null, the id will be used
+ * @param bool $required HTML5 required attribute (exclude when false)
+ * @param array $attrs Initial attributes manually set in an array (overwritten by previous options)
*
+ * @return void
* @todo add a $maxLength 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)) {
$attrs['type'] = 'text';
}
* Note that the value is default 'true' (the string), which can
* be used by Action::boolean()
*
- * @param string $id element ID, must be unique on page
- * @param string $label text of label for the element
- * @param string $checked if the box is checked, default false
+ * @param string $id element ID, must be unique on page
+ * @param string $label text of label for the element
+ * @param bool $checked if the box is checked, default false
* @param string $instructions instructions for valid input
- * @param string $value value of the checkbox, default 'true'
- * @param string $disabled show the checkbox disabled, default false
+ * @param string $value value of the checkbox, default 'true'
+ * @param bool $disabled show the checkbox disabled, default false
*
* @return void
*
* @todo add a $name parameter
*/
- function checkbox($id, $label, $checked=false, $instructions=null,
- $value='true', $disabled=false)
+ public function checkbox(
+ $id,
+ $label,
+ $checked = false,
+ $instructions = null,
+ $value = 'true',
+ $disabled = false
+ )
{
- $attrs = array('name' => $id,
- 'type' => 'checkbox',
- 'class' => 'checkbox',
- 'id' => $id);
+ $attrs = ['name' => $id,
+ 'type' => 'checkbox',
+ 'class' => 'checkbox',
+ 'id' => $id];
if ($value) {
$attrs['value'] = $value;
}
}
$this->element('input', $attrs);
$this->text(' ');
- $this->element('label', array('class' => 'checkbox',
- 'for' => $id),
- $label);
+ $this->element(
+ 'label',
+ ['class' => 'checkbox',
+ 'for' => $id],
+ $label
+ );
$this->text(' ');
if ($instructions) {
$this->element('p', 'form_guide', $instructions);
* the key is the option value attribute and the value is the option
* text. (Careful on the overuse of 'value' here.)
*
- * @param string $id element ID, must be unique on page
- * @param string $label text of label for the element
- * @param array $content options array, value => text
+ * @param string $id element ID, must be unique on page
+ * @param string $label text of label for the element
+ * @param array $content options array, value => text
* @param string $instructions instructions for valid input
- * @param string $blank_select whether to have a blank entry, default false
- * @param string $selected selected value, default null
+ * @param bool $blank_select whether to have a blank entry, default false
+ * @param string $selected selected value, default null
*
* @return void
*
* @todo add a $name parameter
*/
- function dropdown($id, $label, $content, $instructions=null,
- $blank_select=false, $selected=null)
+ public function dropdown(
+ $id,
+ $label,
+ $content,
+ $instructions = null,
+ $blank_select = false,
+ $selected = null
+ )
{
- $this->element('label', array('for' => $id), $label);
- $this->elementStart('select', array('id' => $id, 'name' => $id));
+ $this->element('label', ['for' => $id], $label);
+ $this->elementStart('select', ['id' => $id, 'name' => $id]);
if ($blank_select) {
- $this->element('option', array('value' => ''));
+ $this->element('option', ['value' => '']);
}
foreach ($content as $value => $option) {
if ($value == $selected) {
- $this->element('option', array('value' => $value,
- 'selected' => 'selected'),
- $option);
+ $this->element(
+ 'option',
+ ['value' => $value,
+ 'selected' => 'selected'],
+ $option
+ );
} else {
- $this->element('option', array('value' => $value), $option);
+ $this->element('option', ['value' => $value], $option);
}
}
$this->elementEnd('select');
*
* $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 $name name, if different than ID
+ * @param string $name name, if different than ID
*
* @return void
*/
- function hidden($id, $value, $name=null)
+ public function hidden($id, $value, $name = null)
{
- $this->element('input', array('name' => $name ?: $id,
- 'type' => 'hidden',
- 'id' => $id,
- 'value' => $value));
+ $this->element('input', ['name' => $name ?: $id,
+ 'type' => 'hidden',
+ 'id' => $id,
+ 'value' => $value]);
}
/**
* output an HTML password input and associated elements
*
- * @param string $id element ID, must be unique on page
- * @param string $label text of label for the element
+ * @param string $id element ID, must be unique on page
+ * @param string $label text of label for the element
* @param string $instructions instructions for valid input
*
* @return void
* @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);
- $attrs = array('name' => $id,
- 'type' => 'password',
- 'class' => 'password',
- 'id' => $id);
+ $this->element('label', ['for' => $id], $label);
+ $attrs = ['name' => $id,
+ 'type' => 'password',
+ 'class' => 'password',
+ 'id' => $id];
$this->element('input', $attrs);
if ($instructions) {
$this->element('p', 'form_guide', $instructions);
/**
* 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 $cls class of the button, default 'submit'
- * @param string $name name, if different than ID
- * @param string $title title text for the submit button
+ * @param string $cls class of the button, default 'submit'
+ * @param string $name name, if different than ID
+ * @param string $title title text for the submit button
*
* @return void
*
* @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',
- 'id' => $id,
- 'name' => $name ?: $id,
- 'class' => $cls,
- 'value' => $label,
- 'title' => $title));
+ $this->element('input', ['type' => 'submit',
+ 'id' => $id,
+ 'name' => $name ?: $id,
+ 'class' => $cls,
+ 'value' => $label,
+ 'title' => $title]);
}
/**
* output a script (almost always javascript) tag
*
- * @param string $src relative or absolute script path
- * @param string $type 'type' attribute value of the tag
+ * @param string $src relative or absolute script path
+ * @param string $type 'type' attribute value of the tag
*
* @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);
if (empty($url['scheme']) && empty($url['host']) && empty($url['query']) && empty($url['fragment'])) {
// XXX: this seems like a big assumption
if (strpos($src, 'plugins/') === 0 || strpos($src, 'local/') === 0) {
-
$src = common_path($src, GNUsocial::isHTTPS()) . '?version=' . GNUSOCIAL_VERSION;
-
} else {
-
if (GNUsocial::isHTTPS()) {
+ $server = common_config('javascript', 'sslserver');
- $sslserver = common_config('javascript', 'sslserver');
-
- if (empty($sslserver)) {
+ if (empty($server)) {
if (is_string(common_config('site', 'sslserver')) &&
mb_strlen(common_config('site', 'sslserver')) > 0) {
$server = common_config('site', 'sslserver');
- } else if (common_config('site', 'server')) {
+ } elseif (common_config('site', 'server')) {
$server = common_config('site', 'server');
}
- $path = common_config('site', 'path') . '/js/';
+ $path = common_config('site', 'path') . '/js/';
} else {
- $server = $sslserver;
- $path = common_config('javascript', 'sslpath');
+ $path = common_config('javascript', 'sslpath');
if (empty($path)) {
$path = common_config('javascript', 'path');
}
}
$protocol = 'https';
-
} else {
-
$path = common_config('javascript', 'path');
if (empty($path)) {
$protocol = 'http';
}
- if ($path[strlen($path)-1] != '/') {
+ if ($path[strlen($path) - 1] != '/') {
$path .= '/';
}
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,
- 'src' => $src),
- ' ');
+ $this->element(
+ 'script',
+ ['type' => $type,
+ 'src' => $src],
+ ' '
+ );
- Event::handle('EndScriptElement', array($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));
+ Event::handle('EndScriptElement', [$this, $src, $type]);
}
}
/**
* output a css link
*
- * @param string $src relative path within the theme directory, or an absolute path
- * @param string $theme 'theme' that contains the stylesheet
+ * @param string $src relative path within the theme directory, or an absolute path
+ * @param string $theme 'theme' that contains the stylesheet
* @param string media 'media' attribute of the tag
*
* @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);
- if( empty($url['scheme']) && empty($url['host']) && empty($url['query']) && empty($url['fragment']))
- {
- if(file_exists(Theme::file($src,$theme))){
- $src = Theme::path($src, $theme);
- }else{
+ if (empty($url['scheme']) && empty($url['host']) && empty($url['query']) && empty($url['fragment'])) {
+ if (file_exists(Theme::file($src, $theme))) {
+ $src = Theme::path($src, $theme);
+ } else {
$src = common_path($src, GNUsocial::isHTTPS());
}
- $src.= '?version=' . GNUSOCIAL_VERSION;
+ $src .= '?version=' . GNUSOCIAL_VERSION;
}
- $this->element('link', array('rel' => 'stylesheet',
- 'type' => 'text/css',
- 'href' => $src,
- 'media' => $media));
- Event::handle('EndCssLinkElement', array($this,$src,$theme,$media));
+ $this->element('link', ['rel' => 'stylesheet',
+ 'type' => 'text/css',
+ 'href' => $src,
+ 'media' => $media]);
+ Event::handle('EndCssLinkElement', [$this, $src, $theme, $media]);
}
}
* output a style (almost always css) tag with inline
* code.
*
- * @param string $code code to put in the style tag
- * @param string $type 'type' attribute value of the tag
- * @param string $media 'media' attribute value of the tag
+ * @param string $code code to put in the style tag
+ * @param string $type 'type' attribute value of the tag
+ * @param string $media 'media' attribute value of the tag
*
* @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))) {
- $this->elementStart('style', array('type' => $type, 'media' => $media));
+ if (Event::handle('StartStyleElement', [$this, &$code, &$type, &$media])) {
+ $this->elementStart('style', ['type' => $type, 'media' => $media]);
$this->raw($code);
$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
*
- * @param string $id element ID, must be unique on page
- * @param string $label text of label for the element
- * @param string $content content of the textarea, default none
+ * @param string $id element ID, must be unique on page
+ * @param string $label text of label for the element
+ * @param string $content content of the textarea, default none
* @param string $instructions instructions for valid input
- * @param string $name name of textarea; if null, $id will be used
- * @param int $cols number of columns
- * @param int $rows number of rows
- * @param bool $required HTML5 required attribute (exclude when false)
+ * @param string $name name of textarea; if null, $id will be used
+ * @param int $cols number of columns
+ * @param int $rows number of rows
+ * @param bool $required HTML5 required attribute (exclude when false)
*
* @return void
*/
- function textarea(
+ public function textarea(
$id,
$label,
- $content = null,
+ $content = null,
$instructions = null,
- $name = null,
- $cols = null,
- $rows = null,
- $required = false
- ) {
- $this->element('label', array('for' => $id), $label);
- $attrs = array(
+ $name = null,
+ $cols = null,
+ $rows = null,
+ $required = false
+ )
+ {
+ $this->element('label', ['for' => $id], $label);
+ $attrs = [
'rows' => 3,
'cols' => 40,
'id' => $id
- );
+ ];
$attrs['name'] = is_null($name) ? $id : $name;
if ($cols != null) {
$attrs['cols'] = $cols;
-
}
if ($rows != null) {
$attrs['rows'] = $rows;
}
+
+ if (!empty($required)) {
+ $attrs['required'] = 'required';
+ }
+
$this->element(
'textarea',
$attrs,
- is_null($content) ? '' : $content
+ $content
);
if ($instructions) {
$this->element('p', 'form_guide', $instructions);
}
}
- /**
- * Internal script to autofocus the given element on page onload.
- *
- * @param string $id element ID, must refer to an existing element
- *
- * @return void
- *
- */
- function autofocus($id)
+ /**
+ * Internal script to autofocus the given element on page onload.
+ *
+ * @param string $id element ID, must refer to an existing element
+ *
+ * @return void
+ *
+ */
+ public function autofocus($id)
{
$this->inlineScript(
- ' $(document).ready(function() {'.
- ' var el = $("#' . $id . '");'.
- ' if (el.length) { el.focus(); }'.
- ' });');
+ ' $(document).ready(function() {' .
+ ' var el = $("#' . $id . '");' .
+ ' 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]);
+ }
}
}
/**
* Page title.
*
- * @return page title
+ * @return string page title
*/
function title()
function showBody()
{
- $this->elementStart('body', array('id' => 'error'));
- $this->elementStart('div', array('id' => 'wrap'));
+ $this->elementStart('body', ['id' => 'error']);
+ $this->elementStart('div', ['id' => 'wrap']);
$this->showHeader();
$this->showCore();
$this->showFooter();
function showCore()
{
- $this->elementStart('div', array('id' => 'core'));
- $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
- $this->elementStart('div', array('id' => 'content_wrapper'));
- $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
+ $this->elementStart('div', ['id' => 'core']);
+ $this->elementStart('div', ['id' => 'aside_primary_wrapper']);
+ $this->elementStart('div', ['id' => 'content_wrapper']);
+ $this->elementStart('div', ['id' => 'site_nav_local_views_wrapper']);
$this->showContentBlock();
$this->elementEnd('div');
$this->elementEnd('div');
function showHeader()
{
- $this->elementStart('div', array('id' => 'header'));
+ $this->elementStart('div', ['id' => 'header']);
$this->showLogo();
$this->showPrimaryNav();
$this->elementEnd('div');
/**
* Display content.
*
- * @return nothing
+ * @return void
*/
function showContent()
{
- $this->element('div', array('class' => 'info'), $this->message);
+ $this->element('div', ['class' => 'info'], $this->message);
}
}
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->element('h3', null, $label);
$menu->show();
$this->action->elementEnd('li');
- Event::handle('EndSubMenu', array($this->action, $menu, $label));
+ Event::handle('EndSubMenu', [$this->action, $menu, $label]);
}
}
}
* 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
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
* @link http://status.net/
*/
-
class ServerErrorAction extends ErrorAction
{
- static $status = array(500 => 'Internal Server Error',
- 501 => 'Not Implemented',
- 502 => 'Bad Gateway',
- 503 => 'Service Unavailable',
- 504 => 'Gateway Timeout',
- 505 => 'HTTP Version Not Supported');
+ static $status = [500 => 'Internal Server Error',
+ 501 => 'Not Implemented',
+ 502 => 'Bad Gateway',
+ 503 => 'Service Unavailable',
+ 504 => 'Gateway Timeout',
+ 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);
/**
* To specify additional HTTP headers for the action
*
- * @return void
+ * @return void
*/
function extraHeaders()
{
- $status_string = @self::$status[$this->code];
- header('HTTP/1.1 '.$this->code.' '.$status_string);
+ $status_string = self::$status[$this->code];
+ header('HTTP/1.1 ' . $this->code . ' ' . $status_string);
}
/**
* Page title.
*
- * @return page title
+ * @return string page title
*/
function title()
{
- return @self::$status[$this->code];
+ return self::$status[$this->code];
}
}
class ServerException extends Exception
{
- public function __construct($message = null, $code = 500) {
+ public function __construct($message = "", $code = 500) {
parent::__construct($message, $code);
}
* @see Action
* @see HTMLOutputter
*/
-
class XMLOutputter
{
/**
* for output.
*/
- var $xw = null;
+ public $xw = null;
/**
* Constructor
*
* 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
*/
- function __construct($output=null, $indent=null)
+ public function __construct($output = null, $indent = null)
{
if (is_null($output)) {
$output = 'php://output';
}
$this->xw = new XMLWriter();
$this->xw->openURI($output);
- if(is_null($indent)) {
+ if (is_null($indent)) {
$indent = common_config('site', 'indent');
}
$this->xw->setIndent($indent);
/**
* Start a new XML document
*
- * @param string $doc document element
+ * @param string $doc document element
* @param string $public public identifier
* @param string $system system identifier
*
* @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');
if ($doc) {
* @return void
*/
- function endXML()
+ public function endXML()
{
$this->xw->endDocument();
$this->xw->flush();
* If $attrs is a string instead of an array, it will be treated
* as the class attribute of the element.
*
- * @param string $tag Element type or tagname
- * @param array $attrs Array of element attributes, as
- * key-value pairs
- * @param string $content string content of the element
+ * @param string $tag Element type or tagname
+ * @param array|string|null $attrs Array of element attributes, as key-value pairs
+ * @param string|null $content string content of the element
*
* @return void
*/
- function element($tag, $attrs=null, $content=null)
+ public function element(string $tag, $attrs = null, $content = null)
{
$this->elementStart($tag, $attrs);
if (!is_null($content)) {
- $this->xw->text($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->xw->text(strval($content));
}
$this->elementEnd($tag);
}
* If $attrs is a string instead of an array, it will be treated
* as the class attribute of the element.
*
- * @param string $tag Element type or tagname
- * @param array $attrs Array of element attributes
+ * @param string $tag Element type or tagname
+ * @param array|string|null $attrs Attributes
*
* @return void
*/
- function elementStart($tag, $attrs=null)
+ public function elementStart(string $tag, $attrs = null)
{
$this->xw->startElement($tag);
if (is_array($attrs)) {
foreach ($attrs as $name => $value) {
$this->xw->writeAttribute($name, $value);
}
- } else if (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)) {
+ } elseif (is_string($attrs)) {
$this->xw->writeAttribute('class', $attrs);
}
}
* @return void
*/
- function elementEnd($tag)
+ public function elementEnd(string $tag)
{
- static $empty_tag = array('base', 'meta', 'link', 'hr',
- 'br', 'param', 'img', 'area',
- 'input', 'col', 'source');
+ static $empty_tag = ['base', 'meta', 'link', 'hr',
+ 'br', 'param', 'img', 'area',
+ 'input', 'col', 'source'];
// XXX: check namespace
if (in_array($tag, $empty_tag)) {
$this->xw->endElement();
}
}
+ 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
*
* @return void
*/
- function text($txt)
+ public function text($txt)
{
$this->xw->text($txt);
}
* @return void
*/
- function raw($xml)
+ public function raw($xml)
{
$this->xw->writeRaw($xml);
}
* @return void
*/
- function comment($txt)
+ public function comment($txt)
{
$this->xw->writeComment($txt);
}
* @return void
*/
- function flush()
+ public function flush()
{
$this->xw->flush();
}
* @see Action
* @see HTMLOutputter
*/
-
class XMLStringer extends XMLOutputter
{
- function __construct($indent=false)
+ public function __construct($indent = false)
{
$this->xw = new XMLWriter();
$this->xw->openMemory();
$this->xw->setIndent($indent);
}
- function getString()
+ public static function estring($tag, $attrs = null, $content = null)
{
- return $this->xw->outputMemory();
+ $xs = new XMLStringer();
+ $xs->element($tag, $attrs, $content);
+ return $xs->getString();
}
// utility for quickly creating XML-strings
- static function estring($tag, $attrs=null, $content=null)
+ public function getString()
{
- $xs = new XMLStringer();
- $xs->element($tag, $attrs, $content);
- return $xs->getString();
+ return $this->xw->outputMemory();
}
-}
\ No newline at end of file
+}
// 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' => 'controls'), null);
+ $this->out->element('th', array('id' => 'controls'));
$this->out->elementEnd('tr');
$this->out->elementEnd('thead');
$this->out->element('th', array('id' => 'subscriptions'), _m('Subscriptions'));
// TRANS: Column header for number of 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('thead');
array('format'=>'json', 'url'=>
common_local_url('attachment',
array('attachment' => $action->attachment->getID())))),
- 'title'=>'oEmbed'),null);
+ 'title'=>'oEmbed'));
$action->element('link',array('rel'=>'alternate',
'type'=>'text/xml+oembed',
'href'=>common_local_url(
array('format'=>'xml','url'=>
common_local_url('attachment',
array('attachment' => $action->attachment->getID())))),
- 'title'=>'oEmbed'),null);
+ 'title'=>'oEmbed'));
break;
case 'shownotice':
if (!$action->notice->isLocal()) {
'oembed',
array(),
array('format'=>'json','url'=>$action->notice->getUrl())),
- 'title'=>'oEmbed'),null);
+ 'title'=>'oEmbed'));
$action->element('link',array('rel'=>'alternate',
'type'=>'text/xml+oembed',
'href'=>common_local_url(
'oembed',
array(),
array('format'=>'xml','url'=>$action->notice->getUrl())),
- 'title'=>'oEmbed'),null);
+ 'title'=>'oEmbed'));
} catch (InvalidUrlException $e) {
// The notice is probably a share or similar, which don't
// have a representational URL of their own.
$appendUsername = common_config('openid', 'append_username');
if ($provider) {
// TRANS: Field label.
- $this->element('label', array(), _m('LABEL','OpenID provider'));
- $this->element('span', array(), $provider);
+ $this->element('label', [], _m('LABEL','OpenID provider'));
+ $this->element('span', [], $provider);
if ($appendUsername) {
$this->element('input', array('id' => 'openid_username',
'name' => 'openid_username',
projects / quix0rs-gnu-social.git / commitdiff