X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Faction.php;h=f0baa062c2c0c7290cb987d28886b35fa4f64260;hb=a13bfa5848705d23353783f195b67c088a72a8cb;hp=e62a032b6061f696c1afe16598239252ad83e157;hpb=97c98cf59ace088e487e130182ff4dc99d2d408b;p=quix0rs-gnu-social.git
diff --git a/lib/action.php b/lib/action.php
index e62a032b60..f0baa062c2 100644
--- a/lib/action.php
+++ b/lib/action.php
@@ -53,7 +53,6 @@ require_once INSTALLDIR.'/lib/htmloutputter.php';
*
* @see HTMLOutputter
*/
-
class Action extends HTMLOutputter // lawsuit
{
var $args;
@@ -69,33 +68,51 @@ class Action extends HTMLOutputter // lawsuit
* @see XMLOutputter::__construct
* @see HTMLOutputter::__construct
*/
-
function __construct($output='php://output', $indent=true)
{
parent::__construct($output, $indent);
}
- // For initializing members of the class
-
+ /**
+ * For initializing members of the class.
+ *
+ * @param array $argarray misc. arguments
+ *
+ * @return boolean true
+ */
function prepare($argarray)
{
$this->args =& common_copy_args($argarray);
return true;
}
+ /**
+ * Show page, a template method.
+ *
+ * @return nothing
+ */
function showPage()
{
- $this->startHTML();
+ if (Event::handle('StartShowHTML', array($this))) {
+ $this->startHTML();
+ Event::handle('EndShowHTML', array($this));
+ }
$this->showHead();
$this->showBody();
$this->endHTML();
}
+ /**
+ * Show head, a template method.
+ *
+ * @return nothing
+ */
function showHead()
{
// XXX: attributes (profile?)
$this->elementStart('head');
$this->showTitle();
+ $this->showShortcutIcon();
$this->showStylesheets();
$this->showScripts();
$this->showOpenSearch();
@@ -105,6 +122,11 @@ class Action extends HTMLOutputter // lawsuit
$this->elementEnd('head');
}
+ /**
+ * Show title, a template method.
+ *
+ * @return nothing
+ */
function showTitle()
{
$this->element('title', null,
@@ -113,95 +135,219 @@ class Action extends HTMLOutputter // lawsuit
common_config('site', 'name')));
}
- // SHOULD overload
+ /**
+ * Returns the page title
+ *
+ * SHOULD overload
+ *
+ * @return string page title
+ */
function title()
{
return _("Untitled page");
}
+ /**
+ * Show themed shortcut icon
+ *
+ * @return nothing
+ */
+ 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 {
+ $this->element('link', array('rel' => 'shortcut icon',
+ 'href' => common_path('favicon.ico')));
+ }
+
+ 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')));
+ } else {
+ $this->element('link', array('rel' => 'apple-touch-icon',
+ 'href' => common_path('apple-touch-icon.png')));
+ }
+ }
+ }
+
+ /**
+ * Show stylesheets
+ *
+ * @return nothing
+ */
function showStylesheets()
{
- $this->element('link', array('rel' => 'stylesheet',
- 'type' => 'text/css',
- 'href' => theme_path('css/display.css', 'base') . '?version=' . LACONICA_VERSION,
- 'media' => 'screen, projection, tv'));
- $this->element('link', array('rel' => 'stylesheet',
- 'type' => 'text/css',
- 'href' => theme_path('css/thickbox.css', 'base') . '?version=' . LACONICA_VERSION,
- 'media' => 'screen, projection, tv'));
- $this->element('link', array('rel' => 'stylesheet',
- 'type' => 'text/css',
- 'href' => theme_path('css/display.css', null) . '?version=' . LACONICA_VERSION,
- 'media' => 'screen, projection, tv'));
- foreach (array(6,7) as $ver) {
- if (file_exists(theme_file('ie'.$ver.'.css'))) {
- // Yes, IE people should be put in jail.
- $this->comment('[if lte IE '.$ver.']>element('link', array('rel' => 'stylesheet',
+ 'type' => 'text/css',
+ 'href' => theme_path('css/display.css', 'base') . '?version=' . LACONICA_VERSION,
+ 'media' => 'screen, projection, tv'));
+ $this->element('link', array('rel' => 'stylesheet',
+ 'type' => 'text/css',
+ 'href' => theme_path('css/display.css', null) . '?version=' . LACONICA_VERSION,
+ 'media' => 'screen, projection, tv'));
+ if (common_config('site', 'mobile')) {
+ $this->element('link', array('rel' => 'stylesheet',
+ 'type' => 'text/css',
+ 'href' => theme_path('css/mobile.css', 'base') . '?version=' . LACONICA_VERSION,
+ // TODO: "handheld" CSS for other mobile devices
+ 'media' => 'only screen and (max-device-width: 480px)')); // Mobile WebKit
+ }
+ $this->element('link', array('rel' => 'stylesheet',
+ 'type' => 'text/css',
+ 'href' => theme_path('css/print.css', 'base') . '?version=' . LACONICA_VERSION,
+ 'media' => 'print'));
+ Event::handle('EndShowLaconicaStyles', array($this));
}
+ if (Event::handle('StartShowUAStyles', array($this))) {
+ $this->comment('[if IE]>comment('[if lte IE '.$ver.']>comment('[if IE]>element('script', array('type' => 'text/javascript',
- 'src' => common_path('js/jquery.min.js')),
- ' ');
- $this->element('script', array('type' => 'text/javascript',
- 'src' => common_path('js/jquery.form.js')),
- ' ');
- $this->element('script', array('type' => 'text/javascript',
- 'src' => common_path('js/xbImportNode.js')),
- ' ');
- $this->element('script', array('type' => 'text/javascript',
- 'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
- ' ');
+ if (Event::handle('StartShowScripts', array($this))) {
+ if (Event::handle('StartShowJQueryScripts', array($this))) {
+ $this->element('script', array('type' => 'text/javascript',
+ 'src' => common_path('js/jquery.min.js')),
+ ' ');
+ $this->element('script', array('type' => 'text/javascript',
+ 'src' => common_path('js/jquery.form.js')),
+ ' ');
+ Event::handle('EndShowJQueryScripts', array($this));
+ }
+ if (Event::handle('StartShowLaconicaScripts', array($this))) {
+ $this->element('script', array('type' => 'text/javascript',
+ 'src' => common_path('js/xbImportNode.js')),
+ ' ');
+ $this->element('script', array('type' => 'text/javascript',
+ 'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
+ ' ');
+ // Frame-busting code to avoid clickjacking attacks.
+ $this->element('script', array('type' => 'text/javascript'),
+ 'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
+ Event::handle('EndShowLaconicaScripts', array($this));
+ }
+ Event::handle('EndShowScripts', array($this));
+ }
}
+ /**
+ * Show OpenSearch headers
+ *
+ * @return nothing
+ */
function showOpenSearch()
{
- $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
+ $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'));
-
$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'));
}
- // MAY overload
+ /**
+ * Show feed headers
+ *
+ * MAY overload
+ *
+ * @return nothing
+ */
function showFeeds()
{
- // does nothing by default
- }
+ $feeds = $this->getFeeds();
- // SHOULD overload
+ if ($feeds) {
+ foreach ($feeds as $feed) {
+ $this->element('link', array('rel' => $feed->rel(),
+ 'href' => $feed->url,
+ 'type' => $feed->mimeType(),
+ 'title' => $feed->title));
+ }
+ }
+ }
+ /**
+ * Show description.
+ *
+ * SHOULD overload
+ *
+ * @return nothing
+ */
function showDescription()
{
// does nothing by default
}
- // MAY overload
-
+ /**
+ * Show extra stuff in .
+ *
+ * MAY overload
+ *
+ * @return nothing
+ */
function extraHead()
{
// does nothing by default
}
+ /**
+ * Show body.
+ *
+ * Calls template methods
+ *
+ * @return nothing
+ */
function showBody()
{
$this->elementStart('body', array('id' => $this->trimmed('action')));
- $this->elementStart('div', 'wrap');
- $this->showHeader();
+ $this->elementStart('div', array('id' => 'wrap'));
+ if (Event::handle('StartShowHeader', array($this))) {
+ $this->showHeader();
+ Event::handle('EndShowHeader', array($this));
+ }
$this->showCore();
- $this->showFooter();
+ if (Event::handle('StartShowFooter', array($this))) {
+ $this->showFooter();
+ Event::handle('EndShowFooter', array($this));
+ }
$this->elementEnd('div');
$this->elementEnd('body');
}
+ /**
+ * Show header of the page.
+ *
+ * Calls template methods
+ *
+ * @return nothing
+ */
function showHeader()
{
$this->elementStart('div', array('id' => 'header'));
@@ -216,14 +362,18 @@ class Action extends HTMLOutputter // lawsuit
$this->elementEnd('div');
}
+ /**
+ * Show configured logo.
+ *
+ * @return nothing
+ */
function showLogo()
{
$this->elementStart('address', array('id' => 'site_contact',
'class' => 'vcard'));
$this->elementStart('a', array('class' => 'url home bookmark',
'href' => common_local_url('public')));
- if (common_config('site', 'logo') || file_exists(theme_file('logo.png')))
- {
+ if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
$this->element('img', array('class' => 'logo photo',
'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
'alt' => common_config('site', 'name')));
@@ -233,86 +383,157 @@ class Action extends HTMLOutputter // lawsuit
$this->elementEnd('address');
}
+ /**
+ * Show primary navigation.
+ *
+ * @return nothing
+ */
function showPrimaryNav()
{
+ $user = common_current_user();
+
$this->elementStart('dl', array('id' => 'site_nav_global_primary'));
$this->element('dt', null, _('Primary site navigation'));
$this->elementStart('dd');
- $user = common_current_user();
$this->elementStart('ul', array('class' => 'nav'));
- if ($user) {
- $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
- _('Home'));
- }
- $this->menuItem(common_local_url('peoplesearch'), _('Search'));
- if ($user) {
- $this->menuItem(common_local_url('profilesettings'),
- _('Account'));
- $this->menuItem(common_local_url('imsettings'),
- _('Connect'));
- $this->menuItem(common_local_url('logout'),
- _('Logout'));
- } else {
- $this->menuItem(common_local_url('login'), _('Login'));
- if (!common_config('site', 'closed')) {
- $this->menuItem(common_local_url('register'), _('Register'));
+ if (Event::handle('StartPrimaryNav', array($this))) {
+ if ($user) {
+ $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
+ _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
+ }
+ $this->menuItem(common_local_url('peoplesearch'),
+ _('Search'), _('Search for people or text'), false, 'nav_search');
+ if ($user) {
+ $this->menuItem(common_local_url('profilesettings'),
+ _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
+
+ if (common_config('xmpp', 'enabled')) {
+ $this->menuItem(common_local_url('imsettings'),
+ _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
+ } else {
+ $this->menuItem(common_local_url('smssettings'),
+ _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
+ }
+ $this->menuItem(common_local_url('logout'),
+ _('Logout'), _('Logout from the site'), false, 'nav_logout');
+ } else {
+ $this->menuItem(common_local_url('login'),
+ _('Login'), _('Login to the site'), false, 'nav_login');
+ if (!common_config('site', 'closed')) {
+ $this->menuItem(common_local_url('register'),
+ _('Register'), _('Create an account'), false, 'nav_register');
+ }
+ $this->menuItem(common_local_url('openidlogin'),
+ _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
}
- $this->menuItem(common_local_url('openidlogin'), _('OpenID'));
+ $this->menuItem(common_local_url('doc', array('title' => 'help')),
+ _('Help'), _('Help me!'), false, 'nav_help');
+ Event::handle('EndPrimaryNav', array($this));
}
- $this->menuItem(common_local_url('doc', array('title' => 'help')),
- _('Help'));
$this->elementEnd('ul');
$this->elementEnd('dd');
$this->elementEnd('dl');
}
- // Revist. Should probably do an hAtom pattern here
+ /**
+ * Show site notice.
+ *
+ * @return nothing
+ */
function showSiteNotice()
{
+ // Revist. Should probably do an hAtom pattern here
$text = common_config('site', 'notice');
if ($text) {
$this->elementStart('dl', array('id' => 'site_notice',
'class' => 'system_notice'));
$this->element('dt', null, _('Site notice'));
- $this->element('dd', null, $text);
+ $this->elementStart('dd', null);
+ $this->raw($text);
+ $this->elementEnd('dd');
$this->elementEnd('dl');
}
}
- // MAY overload if no notice form needed... or direct message box????
-
+ /**
+ * Show notice form.
+ *
+ * MAY overload if no notice form needed... or direct message box????
+ *
+ * @return nothing
+ */
function showNoticeForm()
{
$notice_form = new NoticeForm($this);
$notice_form->show();
}
+ /**
+ * Show anonymous message.
+ *
+ * SHOULD overload
+ *
+ * @return nothing
+ */
function showAnonymousMessage()
{
// needs to be defined by the class
}
+ /**
+ * Show core.
+ *
+ * Shows local navigation, content block and aside.
+ *
+ * @return nothing
+ */
function showCore()
{
$this->elementStart('div', array('id' => 'core'));
+ if (Event::handle('StartShowLocalNavBlock', array($this))) {
+ $this->showLocalNavBlock();
+ Event::handle('EndShowLocalNavBlock', array($this));
+ }
+ if (Event::handle('StartShowContentBlock', array($this))) {
+ $this->showContentBlock();
+ Event::handle('EndShowContentBlock', array($this));
+ }
+ $this->showAside();
+ $this->elementEnd('div');
+ }
+
+ /**
+ * Show local navigation block.
+ *
+ * @return nothing
+ */
+ function showLocalNavBlock()
+ {
$this->elementStart('dl', array('id' => 'site_nav_local_views'));
$this->element('dt', null, _('Local views'));
$this->elementStart('dd');
$this->showLocalNav();
$this->elementEnd('dd');
$this->elementEnd('dl');
- $this->showContentBlock();
- $this->showAside();
- $this->elementEnd('div');
}
- // SHOULD overload
-
+ /**
+ * Show local navigation.
+ *
+ * SHOULD overload
+ *
+ * @return nothing
+ */
function showLocalNav()
{
// does nothing by default
}
+ /**
+ * Show content block.
+ *
+ * @return nothing
+ */
function showContentBlock()
{
$this->elementStart('div', array('id' => 'content'));
@@ -325,10 +546,21 @@ class Action extends HTMLOutputter // lawsuit
$this->elementEnd('div');
}
- function showPageTitle() {
- $this->element('h1', NULL, $this->title());
+ /**
+ * Show page title.
+ *
+ * @return nothing
+ */
+ function showPageTitle()
+ {
+ $this->element('h1', null, $this->title());
}
+ /**
+ * Show page notice block.
+ *
+ * @return nothing
+ */
function showPageNoticeBlock()
{
$this->elementStart('dl', array('id' => 'page_notice',
@@ -338,44 +570,80 @@ class Action extends HTMLOutputter // lawsuit
$this->showPageNotice();
$this->elementEnd('dd');
$this->elementEnd('dl');
- }
-
- // SHOULD overload (unless there's not a notice)
+ }
+ /**
+ * Show page notice.
+ *
+ * SHOULD overload (unless there's not a notice)
+ *
+ * @return nothing
+ */
function showPageNotice()
{
}
- // MUST overload
-
+ /**
+ * Show content.
+ *
+ * MUST overload (unless there's not a notice)
+ *
+ * @return nothing
+ */
function showContent()
{
}
+ /**
+ * Show Aside.
+ *
+ * @return nothing
+ */
+
function showAside()
{
$this->elementStart('div', array('id' => 'aside_primary',
'class' => 'aside'));
$this->showExportData();
- $this->showSections();
+ if (Event::handle('StartShowSections', array($this))) {
+ $this->showSections();
+ Event::handle('EndShowSections', array($this));
+ }
$this->elementEnd('div');
}
- // MAY overload if there are feeds
+ /**
+ * Show export data feeds.
+ *
+ * @return void
+ */
function showExportData()
{
- // is there structure to this?
- // list of (visible!) feed links
- // can we reuse list of feeds from showFeeds() ?
+ $feeds = $this->getFeeds();
+ if ($feeds) {
+ $fl = new FeedList($this);
+ $fl->show($feeds);
+ }
}
- // SHOULD overload
-
- function showSections() {
+ /**
+ * Show sections.
+ *
+ * SHOULD overload
+ *
+ * @return nothing
+ */
+ function showSections()
+ {
// for each section, show it
}
+ /**
+ * Show footer.
+ *
+ * @return nothing
+ */
function showFooter()
{
$this->elementStart('div', array('id' => 'footer'));
@@ -384,29 +652,44 @@ class Action extends HTMLOutputter // lawsuit
$this->elementEnd('div');
}
+ /**
+ * Show secondary navigation.
+ *
+ * @return nothing
+ */
function showSecondaryNav()
{
$this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
$this->element('dt', null, _('Secondary site navigation'));
$this->elementStart('dd', null);
$this->elementStart('ul', array('class' => 'nav'));
- $this->menuItem(common_local_url('doc', array('title' => 'help')),
- _('Help'));
- $this->menuItem(common_local_url('doc', array('title' => 'about')),
- _('About'));
- $this->menuItem(common_local_url('doc', array('title' => 'faq')),
- _('FAQ'));
- $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
- _('Privacy'));
- $this->menuItem(common_local_url('doc', array('title' => 'source')),
- _('Source'));
- $this->menuItem(common_local_url('doc', array('title' => 'contact')),
- _('Contact'));
+ if (Event::handle('StartSecondaryNav', array($this))) {
+ $this->menuItem(common_local_url('doc', array('title' => 'help')),
+ _('Help'));
+ $this->menuItem(common_local_url('doc', array('title' => 'about')),
+ _('About'));
+ $this->menuItem(common_local_url('doc', array('title' => 'faq')),
+ _('FAQ'));
+ $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
+ _('Privacy'));
+ $this->menuItem(common_local_url('doc', array('title' => 'source')),
+ _('Source'));
+ $this->menuItem(common_local_url('doc', array('title' => 'contact')),
+ _('Contact'));
+ $this->menuItem(common_local_url('doc', array('title' => 'badge')),
+ _('Badge'));
+ Event::handle('EndSecondaryNav', array($this));
+ }
$this->elementEnd('ul');
$this->elementEnd('dd');
$this->elementEnd('dl');
}
+ /**
+ * Show licenses.
+ *
+ * @return nothing
+ */
function showLicenses()
{
$this->elementStart('dl', array('id' => 'licenses'));
@@ -415,6 +698,11 @@ class Action extends HTMLOutputter // lawsuit
$this->elementEnd('dl');
}
+ /**
+ * Show Laconica license.
+ *
+ * @return nothing
+ */
function showLaconicaLicense()
{
$this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
@@ -431,6 +719,11 @@ class Action extends HTMLOutputter // lawsuit
// do it
}
+ /**
+ * Show content license.
+ *
+ * @return nothing
+ */
function showContentLicense()
{
$this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
@@ -439,7 +732,8 @@ class Action extends HTMLOutputter // lawsuit
$this->element('img', array('id' => 'license_cc',
'src' => common_config('license', 'image'),
'alt' => common_config('license', 'title')));
- $this->text(_('All criti.ca content and data are available under the '));
+ //TODO: This is dirty: i18n
+ $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
$this->element('a', array('class' => 'license',
'rel' => 'external license',
'href' => common_config('license', 'url')),
@@ -449,24 +743,52 @@ class Action extends HTMLOutputter // lawsuit
$this->elementEnd('dd');
}
- // For comparison with If-Last-Modified
- // If not applicable, return null
-
- function last_modified()
+ /**
+ * 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
+ *
+ * @return boolean is read only action?
+ */
function isReadOnly()
{
return false;
}
+ /**
+ * 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)) {
@@ -476,32 +798,43 @@ class Action extends HTMLOutputter // lawsuit
}
}
+ /**
+ * 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?
+ */
function trimmed($key, $def=null)
{
$arg = $this->arg($key, $def);
- return (is_string($arg)) ? trim($arg) : $arg;
+ return is_string($arg) ? trim($arg) : $arg;
}
- // Note: argarray ignored, since it's now passed in in prepare()
-
+ /**
+ * Handler method
+ *
+ * @param array $argarray is ignored since it's now passed in in prepare()
+ *
+ * @return boolean is read only action?
+ */
function handle($argarray=null)
{
-
- $lm = $this->last_modified();
+ $lm = $this->lastModified();
$etag = $this->etag();
-
if ($etag) {
header('ETag: ' . $etag);
}
-
if ($lm) {
header('Last-Modified: ' . date(DATE_RFC1123, $lm));
- $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
- if ($if_modified_since) {
- $ims = strtotime($if_modified_since);
+ if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
+ $ims = strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']);
if ($lm <= $ims) {
- if (!$etag ||
- $this->_has_etag($etag, $_SERVER['HTTP_IF_NONE_MATCH'])) {
+ $if_none_match = $_SERVER['HTTP_IF_NONE_MATCH'];
+ if (!$if_none_match ||
+ !$etag ||
+ $this->_hasEtag($etag, $if_none_match)) {
header('HTTP/1.1 304 Not Modified');
// Better way to do this?
exit(0);
@@ -511,11 +844,29 @@ class Action extends HTMLOutputter // lawsuit
}
}
- function _has_etag($etag, $if_none_match)
+ /**
+ * 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)
{
- return ($if_none_match) && in_array($etag, explode(',', $if_none_match));
+ $etags = explode(',', $if_none_match);
+ return in_array($etag, $etags) || in_array('*', $etags);
}
+ /**
+ * 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
+ */
function boolean($key, $def=false)
{
$arg = strtolower($this->trimmed($key));
@@ -531,24 +882,47 @@ class Action extends HTMLOutputter // lawsuit
}
}
+ /**
+ * 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)
{
$action = $this->trimmed('action');
common_debug("Server error '$code' on '$action': $msg", __FILE__);
- common_server_error($msg, $code);
+ throw new ServerException($msg, $code);
}
+ /**
+ * Client error
+ *
+ * @param string $msg error message to display
+ * @param integer $code http error code, 400 by default
+ *
+ * @return nothing
+ */
+
function clientError($msg, $code=400)
{
$action = $this->trimmed('action');
common_debug("User error '$code' on '$action': $msg", __FILE__);
- common_user_error($msg, $code);
+ throw new ClientException($msg, $code);
}
+ /**
+ * Returns the current URL
+ *
+ * @return string current URL
+ */
function selfUrl()
{
$action = $this->trimmed('action');
- $args = $this->args;
+ $args = $this->args;
unset($args['action']);
foreach (array_keys($_COOKIE) as $cookie) {
unset($args[$cookie]);
@@ -556,11 +930,21 @@ class Action extends HTMLOutputter // lawsuit
return common_local_url($action, $args);
}
- // Added @id to li for some control.
- // XXX: We might want to move this to htmloutputter.php
-
+ /**
+ * Generate a menu item
+ *
+ * @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
+ *
+ * @return nothing
+ */
function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
{
+ // Added @id to li for some control.
+ // XXX: We might want to move this to htmloutputter.php
$lattrs = array();
if ($is_selected) {
$lattrs['class'] = 'current';
@@ -577,10 +961,20 @@ class Action extends HTMLOutputter // lawsuit
$this->elementEnd('li');
}
- // Does a little before-after block for next/prev page
-
+ /**
+ * 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 nothing
+ */
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('div', array('class' => 'pagination'));
$this->elementStart('dl', null);
@@ -588,26 +982,22 @@ class Action extends HTMLOutputter // lawsuit
$this->elementStart('dd', null);
$this->elementStart('ul', array('class' => 'nav'));
}
-
if ($have_before) {
- $pargs = array('page' => $page-1);
- $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
-
+ $pargs = array('page' => $page-1);
$this->elementStart('li', array('class' => 'nav_prev'));
- $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'prev'),
+ $this->element('a', array('href' => common_local_url($action, $args, $pargs),
+ 'rel' => 'prev'),
_('After'));
$this->elementEnd('li');
}
-
if ($have_after) {
- $pargs = array('page' => $page+1);
- $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
+ $pargs = array('page' => $page+1);
$this->elementStart('li', array('class' => 'nav_next'));
- $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'next'),
+ $this->element('a', array('href' => common_local_url($action, $args, $pargs),
+ 'rel' => 'next'),
_('Before'));
$this->elementEnd('li');
}
-
if ($have_before || $have_after) {
$this->elementEnd('ul');
$this->elementEnd('dd');
@@ -615,4 +1005,17 @@ class Action extends HTMLOutputter // lawsuit
$this->elementEnd('div');
}
}
+
+ /**
+ * 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 null;
+ }
}