]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/action.php
Merge branch '0.9.x' into refactor-api
[quix0rs-gnu-social.git] / lib / action.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Base class for all actions (~views)
6  *
7  * PHP version 5
8  *
9  * LICENCE: This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU Affero General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Affero General Public License for more details.
18  *
19  * You should have received a copy of the GNU Affero General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  * @category  Action
23  * @package   StatusNet
24  * @author    Evan Prodromou <evan@status.net>
25  * @author    Sarven Capadisli <csarven@status.net>
26  * @copyright 2008 StatusNet, Inc.
27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28  * @link      http://status.net/
29  */
30
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
32     exit(1);
33 }
34
35 require_once INSTALLDIR.'/lib/noticeform.php';
36 require_once INSTALLDIR.'/lib/htmloutputter.php';
37
38 /**
39  * Base class for all actions
40  *
41  * This is the base class for all actions in the package. An action is
42  * more or less a "view" in an MVC framework.
43  *
44  * Actions are responsible for extracting and validating parameters; using
45  * model classes to read and write to the database; and doing ouput.
46  *
47  * @category Output
48  * @package  StatusNet
49  * @author   Evan Prodromou <evan@status.net>
50  * @author   Sarven Capadisli <csarven@status.net>
51  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
52  * @link     http://status.net/
53  *
54  * @see      HTMLOutputter
55  */
56 class Action extends HTMLOutputter // lawsuit
57 {
58     var $args;
59
60     /**
61      * Constructor
62      *
63      * Just wraps the HTMLOutputter constructor.
64      *
65      * @param string  $output URI to output to, default = stdout
66      * @param boolean $indent Whether to indent output, default true
67      *
68      * @see XMLOutputter::__construct
69      * @see HTMLOutputter::__construct
70      */
71     function __construct($output='php://output', $indent=true)
72     {
73         parent::__construct($output, $indent);
74     }
75
76     /**
77      * For initializing members of the class.
78      *
79      * @param array $argarray misc. arguments
80      *
81      * @return boolean true
82      */
83     function prepare($argarray)
84     {
85         $this->args =& common_copy_args($argarray);
86         return true;
87     }
88
89     /**
90      * Show page, a template method.
91      *
92      * @return nothing
93      */
94     function showPage()
95     {
96         if (Event::handle('StartShowHTML', array($this))) {
97             $this->startHTML();
98             Event::handle('EndShowHTML', array($this));
99         }
100         if (Event::handle('StartShowHead', array($this))) {
101             $this->showHead();
102             Event::handle('EndShowHead', array($this));
103         }
104         if (Event::handle('StartShowBody', array($this))) {
105             $this->showBody();
106             Event::handle('EndShowBody', array($this));
107         }
108         if (Event::handle('StartEndHTML', array($this))) {
109             $this->endHTML();
110             Event::handle('EndEndHTML', array($this));
111         }
112     }
113
114     /**
115      * Show head, a template method.
116      *
117      * @return nothing
118      */
119     function showHead()
120     {
121         // XXX: attributes (profile?)
122         $this->elementStart('head');
123         $this->showTitle();
124         $this->showShortcutIcon();
125         $this->showStylesheets();
126         $this->showScripts();
127         $this->showOpenSearch();
128         $this->showFeeds();
129         $this->showDescription();
130         $this->extraHead();
131         $this->elementEnd('head');
132     }
133
134     /**
135      * Show title, a template method.
136      *
137      * @return nothing
138      */
139     function showTitle()
140     {
141         $this->element('title', null,
142                        sprintf(_("%s - %s"),
143                                $this->title(),
144                                common_config('site', 'name')));
145     }
146
147     /**
148      * Returns the page title
149      *
150      * SHOULD overload
151      *
152      * @return string page title
153      */
154
155     function title()
156     {
157         return _("Untitled page");
158     }
159
160     /**
161      * Show themed shortcut icon
162      *
163      * @return nothing
164      */
165     function showShortcutIcon()
166     {
167         if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
168             $this->element('link', array('rel' => 'shortcut icon',
169                                          'href' => theme_path('favicon.ico')));
170         } else {
171             $this->element('link', array('rel' => 'shortcut icon',
172                                          'href' => common_path('favicon.ico')));
173         }
174
175         if (common_config('site', 'mobile')) {
176             if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
177                 $this->element('link', array('rel' => 'apple-touch-icon',
178                                              'href' => theme_path('apple-touch-icon.png')));
179             } else {
180                 $this->element('link', array('rel' => 'apple-touch-icon',
181                                              'href' => common_path('apple-touch-icon.png')));
182             }
183         }
184     }
185
186     /**
187      * Show stylesheets
188      *
189      * @return nothing
190      */
191     function showStylesheets()
192     {
193         if (Event::handle('StartShowStyles', array($this))) {
194
195             // Use old name for StatusNet for compatibility on events
196
197             if (Event::handle('StartShowStatusNetStyles', array($this)) &&
198                 Event::handle('StartShowLaconicaStyles', array($this))) {
199                 $this->cssLink('css/display.css',null,'screen, projection, tv');
200                 if (common_config('site', 'mobile')) {
201                     // TODO: "handheld" CSS for other mobile devices
202                     $this->cssLink('css/mobile.css','base','only screen and (max-device-width: 480px)'); // Mobile WebKit
203                 }
204                 $this->cssLink('css/print.css','base','print');
205                 Event::handle('EndShowStatusNetStyles', array($this));
206                 Event::handle('EndShowLaconicaStyles', array($this));
207             }
208
209             if (Event::handle('StartShowUAStyles', array($this))) {
210                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
211                                'href="'.theme_path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
212                 foreach (array(6,7) as $ver) {
213                     if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
214                         // Yes, IE people should be put in jail.
215                         $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
216                                        'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
217                     }
218                 }
219                 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
220                                'href="'.theme_path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
221                 Event::handle('EndShowUAStyles', array($this));
222             }
223
224             if (Event::handle('StartShowDesign', array($this))) {
225
226                 $user = common_current_user();
227
228                 if (empty($user) || $user->viewdesigns) {
229                     $design = $this->getDesign();
230
231                     if (!empty($design)) {
232                         $design->showCSS($this);
233                     }
234                 }
235
236                 Event::handle('EndShowDesign', array($this));
237             }
238             Event::handle('EndShowStyles', array($this));
239         }
240     }
241
242     /**
243      * Show javascript headers
244      *
245      * @return nothing
246      */
247     function showScripts()
248     {
249         if (Event::handle('StartShowScripts', array($this))) {
250             if (Event::handle('StartShowJQueryScripts', array($this))) {
251                 $this->script('js/jquery.min.js');
252                 $this->script('js/jquery.form.js');
253                 $this->script('js/jquery.joverlay.min.js');
254                 Event::handle('EndShowJQueryScripts', array($this));
255             }
256             if (Event::handle('StartShowStatusNetScripts', array($this)) &&
257                 Event::handle('StartShowLaconicaScripts', array($this))) {
258                 $this->script('js/xbImportNode.js');
259                 $this->script('js/util.js');
260                 // Frame-busting code to avoid clickjacking attacks.
261                 $this->element('script', array('type' => 'text/javascript'),
262                                'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
263                 Event::handle('EndShowStatusNetScripts', array($this));
264                 Event::handle('EndShowLaconicaScripts', array($this));
265             }
266             Event::handle('EndShowScripts', array($this));
267         }
268     }
269
270     /**
271      * Show OpenSearch headers
272      *
273      * @return nothing
274      */
275     function showOpenSearch()
276     {
277         $this->element('link', array('rel' => 'search',
278                                      'type' => 'application/opensearchdescription+xml',
279                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
280                                      'title' => common_config('site', 'name').' People Search'));
281         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
282                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
283                                      'title' => common_config('site', 'name').' Notice Search'));
284     }
285
286     /**
287      * Show feed headers
288      *
289      * MAY overload
290      *
291      * @return nothing
292      */
293
294     function showFeeds()
295     {
296         $feeds = $this->getFeeds();
297
298         if ($feeds) {
299             foreach ($feeds as $feed) {
300                 $this->element('link', array('rel' => $feed->rel(),
301                                              'href' => $feed->url,
302                                              'type' => $feed->mimeType(),
303                                              'title' => $feed->title));
304             }
305         }
306     }
307
308     /**
309      * Show description.
310      *
311      * SHOULD overload
312      *
313      * @return nothing
314      */
315     function showDescription()
316     {
317         // does nothing by default
318     }
319
320     /**
321      * Show extra stuff in <head>.
322      *
323      * MAY overload
324      *
325      * @return nothing
326      */
327     function extraHead()
328     {
329         // does nothing by default
330     }
331
332     /**
333      * Show body.
334      *
335      * Calls template methods
336      *
337      * @return nothing
338      */
339     function showBody()
340     {
341         $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
342                                                                     'class' => 'user_in')
343                             : array('id' => $this->trimmed('action')));
344         $this->elementStart('div', array('id' => 'wrap'));
345         if (Event::handle('StartShowHeader', array($this))) {
346             $this->showHeader();
347             Event::handle('EndShowHeader', array($this));
348         }
349         $this->showCore();
350         if (Event::handle('StartShowFooter', array($this))) {
351             $this->showFooter();
352             Event::handle('EndShowFooter', array($this));
353         }
354         $this->elementEnd('div');
355         $this->elementEnd('body');
356     }
357
358     /**
359      * Show header of the page.
360      *
361      * Calls template methods
362      *
363      * @return nothing
364      */
365     function showHeader()
366     {
367         $this->elementStart('div', array('id' => 'header'));
368         $this->showLogo();
369         $this->showPrimaryNav();
370         $this->showSiteNotice();
371         if (common_logged_in()) {
372             $this->showNoticeForm();
373         } else {
374             $this->showAnonymousMessage();
375         }
376         $this->elementEnd('div');
377     }
378
379     /**
380      * Show configured logo.
381      *
382      * @return nothing
383      */
384     function showLogo()
385     {
386         $this->elementStart('address', array('id' => 'site_contact',
387                                              'class' => 'vcard'));
388         if (Event::handle('StartAddressData', array($this))) {
389             $this->elementStart('a', array('class' => 'url home bookmark',
390                                            'href' => common_local_url('public')));
391             if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
392                 $this->element('img', array('class' => 'logo photo',
393                                             'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
394                                             'alt' => common_config('site', 'name')));
395             }
396             $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
397             $this->elementEnd('a');
398             Event::handle('EndAddressData', array($this));
399         }
400         $this->elementEnd('address');
401     }
402
403     /**
404      * Show primary navigation.
405      *
406      * @return nothing
407      */
408     function showPrimaryNav()
409     {
410         $user = common_current_user();
411         $connect = '';
412         if (common_config('xmpp', 'enabled')) {
413             $connect = 'imsettings';
414         } else if (common_config('sms', 'enabled')) {
415             $connect = 'smssettings';
416         } else if (common_config('twitter', 'enabled')) {
417             $connect = 'twittersettings';
418         }
419
420         $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
421         $this->element('dt', null, _('Primary site navigation'));
422         $this->elementStart('dd');
423         $this->elementStart('ul', array('class' => 'nav'));
424         if (Event::handle('StartPrimaryNav', array($this))) {
425             if ($user) {
426                 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
427                                 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
428                 $this->menuItem(common_local_url('profilesettings'),
429                                 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
430                 if ($connect) {
431                     $this->menuItem(common_local_url($connect),
432                                     _('Connect'), _('Connect to services'), false, 'nav_connect');
433                 }
434                 if (common_config('invite', 'enabled')) {
435                     $this->menuItem(common_local_url('invite'),
436                                     _('Invite'),
437                                     sprintf(_('Invite friends and colleagues to join you on %s'),
438                                             common_config('site', 'name')),
439                                     false, 'nav_invitecontact');
440                 }
441                 $this->menuItem(common_local_url('logout'),
442                                 _('Logout'), _('Logout from the site'), false, 'nav_logout');
443             }
444             else {
445                 if (!common_config('site', 'closed')) {
446                     $this->menuItem(common_local_url('register'),
447                                     _('Register'), _('Create an account'), false, 'nav_register');
448                 }
449                 $this->menuItem(common_local_url('login'),
450                                 _('Login'), _('Login to the site'), false, 'nav_login');
451             }
452             $this->menuItem(common_local_url('doc', array('title' => 'help')),
453                             _('Help'), _('Help me!'), false, 'nav_help');
454             if ($user || !common_config('site', 'private')) {
455                 $this->menuItem(common_local_url('peoplesearch'),
456                                 _('Search'), _('Search for people or text'), false, 'nav_search');
457             }
458             Event::handle('EndPrimaryNav', array($this));
459         }
460         $this->elementEnd('ul');
461         $this->elementEnd('dd');
462         $this->elementEnd('dl');
463     }
464
465     /**
466      * Show site notice.
467      *
468      * @return nothing
469      */
470     function showSiteNotice()
471     {
472         // Revist. Should probably do an hAtom pattern here
473         $text = common_config('site', 'notice');
474         if ($text) {
475             $this->elementStart('dl', array('id' => 'site_notice',
476                                             'class' => 'system_notice'));
477             $this->element('dt', null, _('Site notice'));
478             $this->elementStart('dd', null);
479             $this->raw($text);
480             $this->elementEnd('dd');
481             $this->elementEnd('dl');
482         }
483     }
484
485     /**
486      * Show notice form.
487      *
488      * MAY overload if no notice form needed... or direct message box????
489      *
490      * @return nothing
491      */
492     function showNoticeForm()
493     {
494         $notice_form = new NoticeForm($this);
495         $notice_form->show();
496     }
497
498     /**
499      * Show anonymous message.
500      *
501      * SHOULD overload
502      *
503      * @return nothing
504      */
505     function showAnonymousMessage()
506     {
507         // needs to be defined by the class
508     }
509
510     /**
511      * Show core.
512      *
513      * Shows local navigation, content block and aside.
514      *
515      * @return nothing
516      */
517     function showCore()
518     {
519         $this->elementStart('div', array('id' => 'core'));
520         if (Event::handle('StartShowLocalNavBlock', array($this))) {
521             $this->showLocalNavBlock();
522             Event::handle('EndShowLocalNavBlock', array($this));
523         }
524         if (Event::handle('StartShowContentBlock', array($this))) {
525             $this->showContentBlock();
526             Event::handle('EndShowContentBlock', array($this));
527         }
528         $this->showAside();
529         $this->elementEnd('div');
530     }
531
532     /**
533      * Show local navigation block.
534      *
535      * @return nothing
536      */
537     function showLocalNavBlock()
538     {
539         $this->elementStart('dl', array('id' => 'site_nav_local_views'));
540         $this->element('dt', null, _('Local views'));
541         $this->elementStart('dd');
542         $this->showLocalNav();
543         $this->elementEnd('dd');
544         $this->elementEnd('dl');
545     }
546
547     /**
548      * Show local navigation.
549      *
550      * SHOULD overload
551      *
552      * @return nothing
553      */
554     function showLocalNav()
555     {
556         // does nothing by default
557     }
558
559     /**
560      * Show content block.
561      *
562      * @return nothing
563      */
564     function showContentBlock()
565     {
566         $this->elementStart('div', array('id' => 'content'));
567         $this->showPageTitle();
568         $this->showPageNoticeBlock();
569         $this->elementStart('div', array('id' => 'content_inner'));
570         // show the actual content (forms, lists, whatever)
571         $this->showContent();
572         $this->elementEnd('div');
573         $this->elementEnd('div');
574     }
575
576     /**
577      * Show page title.
578      *
579      * @return nothing
580      */
581     function showPageTitle()
582     {
583         $this->element('h1', null, $this->title());
584     }
585
586     /**
587      * Show page notice block.
588      *
589      * Only show the block if a subclassed action has overrided
590      * Action::showPageNotice(), or an event handler is registered for
591      * the StartShowPageNotice event, in which case we assume the
592      * 'page_notice' definition list is desired.  This is to prevent
593      * empty 'page_notice' definition lists from being output everywhere.
594      *
595      * @return nothing
596      */
597     function showPageNoticeBlock()
598     {
599         $rmethod = new ReflectionMethod($this, 'showPageNotice');
600         $dclass = $rmethod->getDeclaringClass()->getName();
601
602         if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
603
604             $this->elementStart('dl', array('id' => 'page_notice',
605                                             'class' => 'system_notice'));
606             $this->element('dt', null, _('Page notice'));
607             $this->elementStart('dd');
608             if (Event::handle('StartShowPageNotice', array($this))) {
609                 $this->showPageNotice();
610                 Event::handle('EndShowPageNotice', array($this));
611             }
612             $this->elementEnd('dd');
613             $this->elementEnd('dl');
614         }
615     }
616
617     /**
618      * Show page notice.
619      *
620      * SHOULD overload (unless there's not a notice)
621      *
622      * @return nothing
623      */
624     function showPageNotice()
625     {
626     }
627
628     /**
629      * Show content.
630      *
631      * MUST overload (unless there's not a notice)
632      *
633      * @return nothing
634      */
635     function showContent()
636     {
637     }
638
639     /**
640      * Show Aside.
641      *
642      * @return nothing
643      */
644
645     function showAside()
646     {
647         $this->elementStart('div', array('id' => 'aside_primary',
648                                          'class' => 'aside'));
649         if (Event::handle('StartShowExportData', array($this))) {
650             $this->showExportData();
651             Event::handle('EndShowExportData', array($this));
652         }
653         if (Event::handle('StartShowSections', array($this))) {
654             $this->showSections();
655             Event::handle('EndShowSections', array($this));
656         }
657         $this->elementEnd('div');
658     }
659
660     /**
661      * Show export data feeds.
662      *
663      * @return void
664      */
665
666     function showExportData()
667     {
668         $feeds = $this->getFeeds();
669         if ($feeds) {
670             $fl = new FeedList($this);
671             $fl->show($feeds);
672         }
673     }
674
675     /**
676      * Show sections.
677      *
678      * SHOULD overload
679      *
680      * @return nothing
681      */
682     function showSections()
683     {
684         // for each section, show it
685     }
686
687     /**
688      * Show footer.
689      *
690      * @return nothing
691      */
692     function showFooter()
693     {
694         $this->elementStart('div', array('id' => 'footer'));
695         $this->showSecondaryNav();
696         $this->showLicenses();
697         $this->elementEnd('div');
698     }
699
700     /**
701      * Show secondary navigation.
702      *
703      * @return nothing
704      */
705     function showSecondaryNav()
706     {
707         $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
708         $this->element('dt', null, _('Secondary site navigation'));
709         $this->elementStart('dd', null);
710         $this->elementStart('ul', array('class' => 'nav'));
711         if (Event::handle('StartSecondaryNav', array($this))) {
712             $this->menuItem(common_local_url('doc', array('title' => 'help')),
713                             _('Help'));
714             $this->menuItem(common_local_url('doc', array('title' => 'about')),
715                             _('About'));
716             $this->menuItem(common_local_url('doc', array('title' => 'faq')),
717                             _('FAQ'));
718             $bb = common_config('site', 'broughtby');
719             if (!empty($bb)) {
720                 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
721                                 _('TOS'));
722             }
723             $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
724                             _('Privacy'));
725             $this->menuItem(common_local_url('doc', array('title' => 'source')),
726                             _('Source'));
727             $this->menuItem(common_local_url('doc', array('title' => 'contact')),
728                             _('Contact'));
729             $this->menuItem(common_local_url('doc', array('title' => 'badge')),
730                             _('Badge'));
731             Event::handle('EndSecondaryNav', array($this));
732         }
733         $this->elementEnd('ul');
734         $this->elementEnd('dd');
735         $this->elementEnd('dl');
736     }
737
738     /**
739      * Show licenses.
740      *
741      * @return nothing
742      */
743     function showLicenses()
744     {
745         $this->elementStart('dl', array('id' => 'licenses'));
746         $this->showStatusNetLicense();
747         $this->showContentLicense();
748         $this->elementEnd('dl');
749     }
750
751     /**
752      * Show StatusNet license.
753      *
754      * @return nothing
755      */
756     function showStatusNetLicense()
757     {
758         $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
759         $this->elementStart('dd', null);
760         if (common_config('site', 'broughtby')) {
761             $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
762         } else {
763             $instr = _('**%%site.name%%** is a microblogging service. ');
764         }
765         $instr .= sprintf(_('It runs the [StatusNet](http://status.net/) microblogging software, version %s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), STATUSNET_VERSION);
766         $output = common_markup_to_html($instr);
767         $this->raw($output);
768         $this->elementEnd('dd');
769         // do it
770     }
771
772     /**
773      * Show content license.
774      *
775      * @return nothing
776      */
777     function showContentLicense()
778     {
779         $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
780         $this->elementStart('dd', array('id' => 'site_content_license_cc'));
781         $this->elementStart('p');
782         $this->element('img', array('id' => 'license_cc',
783                                     'src' => common_config('license', 'image'),
784                                     'alt' => common_config('license', 'title'),
785                                     'width' => '80',
786                                     'height' => '15'));
787         //TODO: This is dirty: i18n
788         $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
789         $this->element('a', array('class' => 'license',
790                                   'rel' => 'external license',
791                                   'href' => common_config('license', 'url')),
792                        common_config('license', 'title'));
793         $this->text(_('license.'));
794         $this->elementEnd('p');
795         $this->elementEnd('dd');
796     }
797
798     /**
799      * Return last modified, if applicable.
800      *
801      * MAY override
802      *
803      * @return string last modified http header
804      */
805     function lastModified()
806     {
807         // For comparison with If-Last-Modified
808         // If not applicable, return null
809         return null;
810     }
811
812     /**
813      * Return etag, if applicable.
814      *
815      * MAY override
816      *
817      * @return string etag http header
818      */
819     function etag()
820     {
821         return null;
822     }
823
824     /**
825      * Return true if read only.
826      *
827      * MAY override
828      *
829      * @param array $args other arguments
830      *
831      * @return boolean is read only action?
832      */
833
834     function isReadOnly($args)
835     {
836         return false;
837     }
838
839     /**
840      * Returns query argument or default value if not found
841      *
842      * @param string $key requested argument
843      * @param string $def default value to return if $key is not provided
844      *
845      * @return boolean is read only action?
846      */
847     function arg($key, $def=null)
848     {
849         if (array_key_exists($key, $this->args)) {
850             return $this->args[$key];
851         } else {
852             return $def;
853         }
854     }
855
856     /**
857      * Returns trimmed query argument or default value if not found
858      *
859      * @param string $key requested argument
860      * @param string $def default value to return if $key is not provided
861      *
862      * @return boolean is read only action?
863      */
864     function trimmed($key, $def=null)
865     {
866         $arg = $this->arg($key, $def);
867         return is_string($arg) ? trim($arg) : $arg;
868     }
869
870     /**
871      * Handler method
872      *
873      * @param array $argarray is ignored since it's now passed in in prepare()
874      *
875      * @return boolean is read only action?
876      */
877     function handle($argarray=null)
878     {
879         header('Vary: Accept-Encoding,Cookie');
880         $lm   = $this->lastModified();
881         $etag = $this->etag();
882         if ($etag) {
883             header('ETag: ' . $etag);
884         }
885         if ($lm) {
886             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
887             if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
888                 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
889                 $ims = strtotime($if_modified_since);
890                 if ($lm <= $ims) {
891                     $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
892                       $_SERVER['HTTP_IF_NONE_MATCH'] : null;
893                     if (!$if_none_match ||
894                         !$etag ||
895                         $this->_hasEtag($etag, $if_none_match)) {
896                         header('HTTP/1.1 304 Not Modified');
897                         // Better way to do this?
898                         exit(0);
899                     }
900                 }
901             }
902         }
903     }
904
905     /**
906      * HasĀ etag? (private)
907      *
908      * @param string $etag          etag http header
909      * @param string $if_none_match ifNoneMatch http header
910      *
911      * @return boolean
912      */
913
914     function _hasEtag($etag, $if_none_match)
915     {
916         $etags = explode(',', $if_none_match);
917         return in_array($etag, $etags) || in_array('*', $etags);
918     }
919
920     /**
921      * Boolean understands english (yes, no, true, false)
922      *
923      * @param string $key query key we're interested in
924      * @param string $def default value
925      *
926      * @return boolean interprets yes/no strings as boolean
927      */
928     function boolean($key, $def=false)
929     {
930         $arg = strtolower($this->trimmed($key));
931
932         if (is_null($arg)) {
933             return $def;
934         } else if (in_array($arg, array('true', 'yes', '1'))) {
935             return true;
936         } else if (in_array($arg, array('false', 'no', '0'))) {
937             return false;
938         } else {
939             return $def;
940         }
941     }
942
943     /**
944      * Server error
945      *
946      * @param string  $msg  error message to display
947      * @param integer $code http error code, 500 by default
948      *
949      * @return nothing
950      */
951
952     function serverError($msg, $code=500)
953     {
954         $action = $this->trimmed('action');
955         common_debug("Server error '$code' on '$action': $msg", __FILE__);
956         throw new ServerException($msg, $code);
957     }
958
959     /**
960      * Client error
961      *
962      * @param string  $msg  error message to display
963      * @param integer $code http error code, 400 by default
964      *
965      * @return nothing
966      */
967
968     function clientError($msg, $code=400)
969     {
970         $action = $this->trimmed('action');
971         common_debug("User error '$code' on '$action': $msg", __FILE__);
972         throw new ClientException($msg, $code);
973     }
974
975     /**
976      * Returns the current URL
977      *
978      * @return string current URL
979      */
980
981     function selfUrl()
982     {
983         $action = $this->trimmed('action');
984         $args   = $this->args;
985         unset($args['action']);
986         if (common_config('site', 'fancy')) {
987             unset($args['p']);
988         }
989         if (array_key_exists('submit', $args)) {
990             unset($args['submit']);
991         }
992         foreach (array_keys($_COOKIE) as $cookie) {
993             unset($args[$cookie]);
994         }
995
996         return common_local_url($action, $args);
997     }
998
999     /**
1000      * Generate a menu item
1001      *
1002      * @param string  $url         menu URL
1003      * @param string  $text        menu name
1004      * @param string  $title       title attribute, null by default
1005      * @param boolean $is_selected current menu item, false by default
1006      * @param string  $id          element id, null by default
1007      *
1008      * @return nothing
1009      */
1010     function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1011     {
1012         // Added @id to li for some control.
1013         // XXX: We might want to move this to htmloutputter.php
1014         $lattrs = array();
1015         if ($is_selected) {
1016             $lattrs['class'] = 'current';
1017         }
1018
1019         (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1020
1021         $this->elementStart('li', $lattrs);
1022         $attrs['href'] = $url;
1023         if ($title) {
1024             $attrs['title'] = $title;
1025         }
1026         $this->element('a', $attrs, $text);
1027         $this->elementEnd('li');
1028     }
1029
1030     /**
1031      * Generate pagination links
1032      *
1033      * @param boolean $have_before is there something before?
1034      * @param boolean $have_after  is there something after?
1035      * @param integer $page        current page
1036      * @param string  $action      current action
1037      * @param array   $args        rest of query arguments
1038      *
1039      * @return nothing
1040      */
1041     function pagination($have_before, $have_after, $page, $action, $args=null)
1042     {
1043         // Does a little before-after block for next/prev page
1044         if ($have_before || $have_after) {
1045             $this->elementStart('div', array('class' => 'pagination'));
1046             $this->elementStart('dl', null);
1047             $this->element('dt', null, _('Pagination'));
1048             $this->elementStart('dd', null);
1049             $this->elementStart('ul', array('class' => 'nav'));
1050         }
1051         if ($have_before) {
1052             $pargs   = array('page' => $page-1);
1053             $this->elementStart('li', array('class' => 'nav_prev'));
1054             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1055                                       'rel' => 'prev'),
1056                            _('After'));
1057             $this->elementEnd('li');
1058         }
1059         if ($have_after) {
1060             $pargs   = array('page' => $page+1);
1061             $this->elementStart('li', array('class' => 'nav_next'));
1062             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1063                                       'rel' => 'next'),
1064                            _('Before'));
1065             $this->elementEnd('li');
1066         }
1067         if ($have_before || $have_after) {
1068             $this->elementEnd('ul');
1069             $this->elementEnd('dd');
1070             $this->elementEnd('dl');
1071             $this->elementEnd('div');
1072         }
1073     }
1074
1075     /**
1076      * An array of feeds for this action.
1077      *
1078      * Returns an array of potential feeds for this action.
1079      *
1080      * @return array Feed object to show in head and links
1081      */
1082
1083     function getFeeds()
1084     {
1085         return null;
1086     }
1087
1088     /**
1089      * A design for this action
1090      *
1091      * @return Design a design object to use
1092      */
1093
1094     function getDesign()
1095     {
1096         return Design::siteDesign();
1097     }
1098 }