]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/action.php
Extract image management code to a helper function
[quix0rs-gnu-social.git] / lib / action.php
index d7ffa41d477b0de3b45540ec5e0b6c2276d249c2..5987abf3c35dfe2fd28e01fae01ea0919221614d 100644 (file)
@@ -32,6 +32,9 @@ if (!defined('LACONICA')) {
     exit(1);
 }
 
+require_once INSTALLDIR.'/lib/noticeform.php';
+require_once INSTALLDIR.'/lib/htmloutputter.php';
+
 /**
  * Base class for all actions
  *
@@ -55,8 +58,21 @@ class Action extends HTMLOutputter // lawsuit
 {
     var $args;
 
-    function Action()
+    /**
+     * Constructor
+     *
+     * Just wraps the HTMLOutputter constructor.
+     *
+     * @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=true)
     {
+        parent::__construct($output, $indent);
     }
 
     // For initializing members of the class
@@ -78,7 +94,7 @@ class Action extends HTMLOutputter // lawsuit
     function showHead()
     {
         // XXX: attributes (profile?)
-        $this->startElement('head');
+        $this->elementStart('head');
         $this->showTitle();
         $this->showStylesheets();
         $this->showScripts();
@@ -86,7 +102,7 @@ class Action extends HTMLOutputter // lawsuit
         $this->showFeeds();
         $this->showDescription();
         $this->extraHead();
-        $this->elementElement('head');
+        $this->elementEnd('head');
     }
 
     function showTitle()
@@ -106,42 +122,52 @@ class Action extends HTMLOutputter // lawsuit
 
     function showStylesheets()
     {
-        common_element('link', array('rel' => 'stylesheet',
+        $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('display.css') . '?version=' . LACONICA_VERSION,
+                                     'href' => theme_path('css/display.css', null) . '?version=' . LACONICA_VERSION,
                                      'media' => 'screen, projection, tv'));
+        $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
+                       'href="'.theme_path('css/ie.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
         foreach (array(6,7) as $ver) {
             if (file_exists(theme_file('ie'.$ver.'.css'))) {
                 // Yes, IE people should be put in jail.
-                $xw->writeComment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
-                                  'href="'.theme_path('ie'.$ver.'.css').'?version='.LACONICA_VERSION.'" /><![endif]');
+                $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
+                               'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
             }
         }
     }
 
     function showScripts()
     {
-        common_element('script', array('type' => 'text/javascript',
+        $this->element('script', array('type' => 'text/javascript',
                                        'src' => common_path('js/jquery.min.js')),
                        ' ');
-        common_element('script', array('type' => 'text/javascript',
+        $this->element('script', array('type' => 'text/javascript',
                                        'src' => common_path('js/jquery.form.js')),
                        ' ');
-        common_element('script', array('type' => 'text/javascript',
+        $this->element('script', array('type' => 'text/javascript',
                                        'src' => common_path('js/xbImportNode.js')),
                        ' ');
-        common_element('script', array('type' => 'text/javascript',
+        $this->element('script', array('type' => 'text/javascript',
                                        'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
                        ' ');
     }
 
     function showOpenSearch()
     {
-        common_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'));
 
-        common_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' => 'notice')),
                                      'title' => common_config('site', 'name').' Notice Search'));
     }
@@ -169,126 +195,181 @@ class Action extends HTMLOutputter // lawsuit
 
     function showBody()
     {
-        // output body
-        // output wrap element
+        $this->elementStart('body', array('id' => $this->trimmed('action')));
+        $this->elementStart('div', 'wrap');
         $this->showHeader();
         $this->showCore();
         $this->showFooter();
+        $this->elementEnd('div');
+        $this->elementEnd('body');
     }
 
     function showHeader()
     {
-        // start header div stuff
+        $this->elementStart('div', array('id' => 'header'));
         $this->showLogo();
         $this->showPrimaryNav();
         $this->showSiteNotice();
-        $this->showNoticeForm();
-        // end header div stuff
+        if (common_logged_in()) {
+            $this->showNoticeForm();
+        } else {
+            $this->showAnonymousMessage();
+        }
+        $this->elementEnd('div');
     }
 
     function showLogo()
     {
-        $this->element_start('address', array('id' => 'site_contact',
-                                              'class' => 'vcard'));
-        $this->element_start('a', array('class' => 'url home bookmark',
-                                        'href' => common_local_url('public')));
-        if ((isset($config['site']['logo']) && is_string($config['site']['logo']) && (strlen($config['site']['logo']) > 0))
-            || file_exists(theme_file('logo.png')))
+        $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')))
         {
             $this->element('img', array('class' => 'logo photo',
-                                        'src' => isset($config['site']['logo']) ?
-                                        ($config['site']['logo']) : theme_path('logo.png'),
-                                        'alt' => $config['site']['name']);
+                                        'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
+                                        'alt' => common_config('site', 'name')));
         }
-        $this->element('span', array('class' => 'fn org'), $config['site']['name']));
-        $this->element_end('a');
-        $this->element_end('address');
+        $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
+        $this->elementEnd('a');
+        $this->elementEnd('address');
     }
 
     function showPrimaryNav()
     {
+        $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
+        $this->element('dt', null, _('Primary site navigation'));
+        $this->elementStart('dd');
         $user = common_current_user();
-        common_element_start('ul', array('id' => 'nav'));
+        $this->elementStart('ul', array('class' => 'nav'));
         if ($user) {
-            common_menu_item(common_local_url('all', array('nickname' => $user->nickname)),
-                             _('Home'));
+            $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
+                            _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
         }
-        common_menu_item(common_local_url('peoplesearch'), _('Search'));
+        $this->menuItem(common_local_url('peoplesearch'),
+                        _('Search'), _('Search for people or text'), false, 'nav_search');
         if ($user) {
-            common_menu_item(common_local_url('profilesettings'),
-                             _('Settings'));
-            common_menu_item(common_local_url('invite'),
-                             _('Invite'));
-            common_menu_item(common_local_url('logout'),
-                             _('Logout'));
+            $this->menuItem(common_local_url('profilesettings'),
+                            _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
+            $this->menuItem(common_local_url('imsettings'),
+                            _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
+            $this->menuItem(common_local_url('logout'),
+                            _('Logout'), _('Logout from the site'), false, 'nav_logout');
         } else {
-            common_menu_item(common_local_url('login'), _('Login'));
+            $this->menuItem(common_local_url('login'),
+                            _('Login'), _('Login to the site'), false, 'nav_login');
             if (!common_config('site', 'closed')) {
-                common_menu_item(common_local_url('register'), _('Register'));
+                $this->menuItem(common_local_url('register'),
+                                _('Register'), _('Create an account'), false, 'nav_register');
             }
-            common_menu_item(common_local_url('openidlogin'), _('OpenID'));
+            $this->menuItem(common_local_url('openidlogin'),
+                            _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
         }
-        common_menu_item(common_local_url('doc', array('title' => 'help')),
-                         _('Help'));
-        common_element_end('ul');
+        $this->menuItem(common_local_url('doc', array('title' => 'help')),
+                        _('Help'), _('Help me!'), false, 'nav_help');
+        $this->elementEnd('ul');
+        $this->elementEnd('dd');
+        $this->elementEnd('dl');
     }
 
+    // Revist. Should probably do an hAtom pattern here
     function showSiteNotice()
     {
-        // show the site notice 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->elementEnd('dl');
+        }
     }
 
     // MAY overload if no notice form needed... or direct message box????
 
     function showNoticeForm()
     {
-        // show the notice form here
+        $notice_form = new NoticeForm($this);
+        $notice_form->show();
+    }
+
+    function showAnonymousMessage()
+    {
+        // needs to be defined by the class
     }
 
     function showCore()
     {
-        // start core div
-        $this->showLocalNav();
+        $this->elementStart('div', array('id' => 'core'));
+        $this->showLocalNavBlock();
         $this->showContentBlock();
         $this->showAside();
-        // end core div
+        $this->elementEnd('div');
+    }
+
+    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');
     }
 
     // SHOULD overload
 
     function showLocalNav()
     {
+        // does nothing by default
     }
 
     function showContentBlock()
     {
+        $this->elementStart('div', array('id' => 'content'));
         $this->showPageTitle();
-        $this->showPageNotice();
+        $this->showPageNoticeBlock();
+        $this->elementStart('div', array('id' => 'content_inner'));
+        // show the actual content (forms, lists, whatever)
         $this->showContent();
+        $this->elementEnd('div');
+        $this->elementEnd('div');
     }
 
     function showPageTitle() {
         $this->element('h1', NULL, $this->title());
     }
 
+    function showPageNoticeBlock()
+    {
+        $this->elementStart('dl', array('id' => 'page_notice',
+                                        'class' => 'system_notice'));
+        $this->element('dt', null, _('Page notice'));
+        $this->elementStart('dd');
+        $this->showPageNotice();
+        $this->elementEnd('dd');
+        $this->elementEnd('dl');
+       }
+
     // SHOULD overload (unless there's not a notice)
 
     function showPageNotice()
     {
-        // output page notice div
     }
 
     // MUST overload
 
     function showContent()
     {
-        // show the actual content (forms, lists, whatever)
     }
 
     function showAside()
     {
+        $this->elementStart('div', array('id' => 'aside_primary',
+                                         'class' => 'aside'));
         $this->showExportData();
         $this->showSections();
+        $this->elementEnd('div');
     }
 
     // MAY overload if there are feeds
@@ -308,40 +389,47 @@ class Action extends HTMLOutputter // lawsuit
 
     function showFooter()
     {
-        // start footer div
+        $this->elementStart('div', array('id' => 'footer'));
         $this->showSecondaryNav();
         $this->showLicenses();
+        $this->elementEnd('div');
     }
 
     function showSecondaryNav()
     {
-        common_element_start('ul', array('id' => 'nav_sub'));
-        common_menu_item(common_local_url('doc', array('title' => 'help')),
-                         _('Help'));
-        common_menu_item(common_local_url('doc', array('title' => 'about')),
-                         _('About'));
-        common_menu_item(common_local_url('doc', array('title' => 'faq')),
-                         _('FAQ'));
-        common_menu_item(common_local_url('doc', array('title' => 'privacy')),
-                         _('Privacy'));
-        common_menu_item(common_local_url('doc', array('title' => 'source')),
-                         _('Source'));
-        common_menu_item(common_local_url('doc', array('title' => 'contact')),
-                         _('Contact'));
-        common_element_end('ul');
+        $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'));
+        $this->elementEnd('ul');
+        $this->elementEnd('dd');
+        $this->elementEnd('dl');
     }
 
     function showLicenses()
     {
-        // start license dl
+        $this->elementStart('dl', array('id' => 'licenses'));
         $this->showLaconicaLicense();
         $this->showContentLicense();
-        // end license dl
+        $this->elementEnd('dl');
     }
 
     function showLaconicaLicense()
     {
-        common_element_start('div', 'laconica');
+        $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
+        $this->elementStart('dd', null);
         if (common_config('site', 'broughtby')) {
             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
         } else {
@@ -349,32 +437,34 @@ class Action extends HTMLOutputter // lawsuit
         }
         $instr .= sprintf(_('It runs the [Laconica](http://laconi.ca/) microblogging software, version %s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), LACONICA_VERSION);
         $output = common_markup_to_html($instr);
-        common_raw($output);
-        common_element_end('div');
+        $this->raw($output);
+        $this->elementEnd('dd');
         // do it
     }
 
     function showContentLicense()
     {
-        common_element_start('div', array('id' => 'footer'));
-        common_element('img', array('id' => 'cc',
-                                    'src' => $config['license']['image'],
-                                    'alt' => $config['license']['title']));
-        common_element_start('p');
-        common_text(_('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
-        common_element('a', array('class' => 'license',
-                                  'rel' => 'license',
-                                  'href' => $config['license']['url']),
-                       $config['license']['title']);
-        common_text(_('. Contributors should be attributed by full name or nickname.'));
-        common_element_end('p');
-        common_element_end('div');
+        $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
+        $this->elementStart('dd', array('id' => 'site_content_license_cc'));
+        $this->elementStart('p');
+        $this->element('img', array('id' => 'license_cc',
+                                    'src' => common_config('license', 'image'),
+                                    'alt' => common_config('license', 'title')));
+        //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')),
+                       common_config('license', 'title'));
+        $this->text(_('license.'));
+        $this->elementEnd('p');
+        $this->elementEnd('dd');
     }
 
     // For comparison with If-Last-Modified
     // If not applicable, return null
 
-    function last_modified()
+    function lastModified()
     {
         return null;
     }
@@ -384,7 +474,7 @@ class Action extends HTMLOutputter // lawsuit
         return null;
     }
 
-    function is_readonly()
+    function isReadOnly()
     {
         return false;
     }
@@ -409,7 +499,7 @@ class Action extends HTMLOutputter // lawsuit
     function handle($argarray=null)
     {
 
-        $lm = $this->last_modified();
+        $lm = $this->lastModified();
         $etag = $this->etag();
 
         if ($etag) {
@@ -423,7 +513,7 @@ class Action extends HTMLOutputter // lawsuit
                 $ims = strtotime($if_modified_since);
                 if ($lm <= $ims) {
                     if (!$etag ||
-                        $this->_has_etag($etag, $_SERVER['HTTP_IF_NONE_MATCH'])) {
+                        $this->_hasEtag($etag, $_SERVER['HTTP_IF_NONE_MATCH'])) {
                         header('HTTP/1.1 304 Not Modified');
                         // Better way to do this?
                         exit(0);
@@ -433,7 +523,7 @@ class Action extends HTMLOutputter // lawsuit
         }
     }
 
-    function _has_etag($etag, $if_none_match)
+    function _hasEtag($etag, $if_none_match)
     {
         return ($if_none_match) && in_array($etag, explode(',', $if_none_match));
     }
@@ -453,21 +543,21 @@ class Action extends HTMLOutputter // lawsuit
         }
     }
 
-    function server_error($msg, $code=500)
+    function serverError($msg, $code=500)
     {
         $action = $this->trimmed('action');
         common_debug("Server error '$code' on '$action': $msg", __FILE__);
         common_server_error($msg, $code);
     }
 
-    function client_error($msg, $code=400)
+    function clientError($msg, $code=400)
     {
         $action = $this->trimmed('action');
         common_debug("User error '$code' on '$action': $msg", __FILE__);
         common_user_error($msg, $code);
     }
 
-    function self_url()
+    function selfUrl()
     {
         $action = $this->trimmed('action');
         $args = $this->args;
@@ -478,80 +568,25 @@ class Action extends HTMLOutputter // lawsuit
         return common_local_url($action, $args);
     }
 
-    function nav_menu($menu)
-    {
-        $action = $this->trimmed('action');
-        common_element_start('ul', array('id' => 'nav_views'));
-        foreach ($menu as $menuaction => $menudesc) {
-            common_menu_item(common_local_url($menuaction,
-                                              isset($menudesc[2]) ? $menudesc[2] : null),
-                             $menudesc[0],
-                             $menudesc[1],
-                             $action == $menuaction);
-        }
-        common_element_end('ul');
-    }
+    // Added @id to li for some control.
+    // XXX: We might want to move this to htmloutputter.php
 
-    function common_show_header($pagetitle, $callable=null, $data=null, $headercall=null)
-    {
-        global $config, $xw;
-        global $action; /* XXX: kind of cheating here. */
-
-        common_start_html();
-
-        common_element_start('head');
-
-        if ($callable) {
-            if ($data) {
-                call_user_func($callable, $data);
-            } else {
-                call_user_func($callable);
-            }
-        }
-        common_element_end('head');
-        common_element_start('body', $action);
-        common_element_start('div', array('id' => 'wrap'));
-        common_element_start('div', array('id' => 'header'));
-        common_nav_menu();
-
-
-        common_element('h1', 'pagetitle', $pagetitle);
-
-        if ($headercall) {
-            if ($data) {
-                call_user_func($headercall, $data);
-            } else {
-                call_user_func($headercall);
-            }
-        }
-        common_element_end('div');
-        common_element_start('div', array('id' => 'content'));
-    }
-
-    function common_show_footer()
-    {
-        global $xw, $config;
-        common_element_end('div'); // content div
-        common_foot_menu();
-        common_element_end('div');
-        common_element_end('body');
-        common_element_end('html');
-        common_end_xml();
-    }
-
-    function common_menu_item($url, $text, $title=null, $is_selected=false)
+    function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
     {
         $lattrs = array();
         if ($is_selected) {
             $lattrs['class'] = 'current';
         }
-        common_element_start('li', $lattrs);
+
+        (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
+
+        $this->elementStart('li', $lattrs);
         $attrs['href'] = $url;
         if ($title) {
             $attrs['title'] = $title;
         }
-        common_element('a', $attrs, $text);
-        common_element_end('li');
+        $this->element('a', $attrs, $text);
+        $this->elementEnd('li');
     }
 
     // Does a little before-after block for next/prev page
@@ -559,31 +594,36 @@ class Action extends HTMLOutputter // lawsuit
     function pagination($have_before, $have_after, $page, $action, $args=null)
     {
         if ($have_before || $have_after) {
-            $this->elementStart('div', array('id' => 'pagination'));
-            $this->elementStart('ul', array('id' => 'nav_pagination'));
+            $this->elementStart('div', array('class' => 'pagination'));
+            $this->elementStart('dl', null);
+            $this->element('dt', null, _('Pagination'));
+            $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;
 
-            $this->elementStart('li', 'before');
+            $this->elementStart('li', array('class' => 'nav_prev'));
             $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'prev'),
-                           _('« After'));
+                           _('After'));
             $this->elementEnd('li');
         }
 
         if ($have_after) {
             $pargs = array('page' => $page+1);
             $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
-            $this->elementStart('li', 'after');
+            $this->elementStart('li', array('class' => 'nav_next'));
             $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'next'),
-                           _('Before »'));
+                           _('Before'));
             $this->elementEnd('li');
         }
 
         if ($have_before || $have_after) {
             $this->elementEnd('ul');
+            $this->elementEnd('dd');
+            $this->elementEnd('dl');
             $this->elementEnd('div');
         }
     }