lib/facebookaction.php

   1 <?php
   2 /**
   3  * Laconica, the distributed open-source microblogging tool
   4  *
   5  * Low-level generator for HTML
   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  Faceboook
  23  * @package   Laconica
  24  * @author    Zach Copley <zach@controlyourself.ca>
  25  * @copyright 2008 Control Yourself, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://laconi.ca/
  28  */
  29
  30 if (!defined('LACONICA'))
  31 {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/facebookutil.php';
  36 require_once INSTALLDIR.'/lib/noticeform.php';
  37
  38
  39 class FacebookAction extends Action
  40 {
  41
  42     var $facebook = null;
  43     var $fbuid    = null;
  44     var $flink    = null;
  45     var $action   = null;
  46     var $app_uri  = null;
  47     var $app_name = null;
  48
  49     /**
  50      * Constructor
  51      *
  52      * Just wraps the HTMLOutputter constructor.
  53      *
  54      * @param string  $output URI to output to, default = stdout
  55      * @param boolean $indent Whether to indent output, default true
  56      *
  57      * @see XMLOutputter::__construct
  58      * @see HTMLOutputter::__construct
  59      */
  60     function __construct($output='php://output', $indent=true, $facebook=null, $flink=null)
  61     {
  62         parent::__construct($output, $indent);
  63
  64         $this->facebook = $facebook;
  65         $this->flink = $flink;
  66
  67         if ($this->flink) {
  68             $this->fbuid = $flink->foreign_id;
  69             $this->user = $flink->getUser();
  70         }
  71
  72         $this->args = array();
  73     }
  74
  75     function prepare($argarray)
  76     {
  77         parent::prepare($argarray);
  78
  79         $this->facebook = getFacebook();
  80         $this->fbuid = $this->facebook->require_login();
  81
  82         $this->action = $this->trimmed('action');
  83
  84         $app_props = $this->facebook->api_client->Admin_getAppProperties(
  85                 array('canvas_name', 'application_name'));
  86
  87         $this->app_uri = 'http://apps.facebook.com/' . $app_props['canvas_name'];
  88         $this->app_name = $app_props['application_name'];
  89
  90         $this->flink = Foreign_link::getByForeignID($this->fbuid, FACEBOOK_SERVICE);
  91
  92         return true;
  93
  94     }
  95
  96     function showStylesheets()
  97     {
  98
  99         $this->element('link', array('rel' => 'stylesheet',
 100                                      'type' => 'text/css',
 101                                      'href' => getFacebookBaseCSS()));
 102
 103         $this->element('link', array('rel' => 'stylesheet',
 104                                      'type' => 'text/css',
 105                                      'href' => getFacebookThemeCSS()));
 106     }
 107
 108     function showScripts()
 109     {
 110         $this->element('script', array('type' => 'text/javascript',
 111                                        'src' => getFacebookJS()),
 112                        ' ');
 113     }
 114
 115     /**
 116      * Start an Facebook ready HTML document
 117      *
 118      *  For Facebook we don't want to actually output any headers,
 119      *  DTD info, etc.
 120      *
 121      * If $type isn't specified, will attempt to do content negotiation.
 122      *
 123      * @param string $type MIME type to use; default is to do negotation.
 124      *
 125      * @return void
 126      */
 127
 128     function startHTML($type=null)
 129     {
 130         $this->elementStart('div', array('class' => 'facebook-page'));
 131     }
 132
 133     /**
 134     *  Ends a Facebook ready HTML document
 135     *
 136     *  @return void
 137     */
 138     function endHTML()
 139     {
 140         $this->elementEnd('div');
 141         $this->endXML();
 142     }
 143
 144     /**
 145      * Show notice form.
 146      *
 147      * MAY overload if no notice form needed... or direct message box????
 148      *
 149      * @return nothing
 150      */
 151     function showNoticeForm()
 152     {
 153         // don't do it for most of the Facebook pages
 154     }
 155
 156     function showBody()
 157     {
 158         $this->elementStart('div', 'wrap');
 159         $this->showHeader();
 160         $this->showCore();
 161         $this->showFooter();
 162         $this->elementEnd('div');
 163     }
 164
 165     function showAside()
 166     {
 167     }
 168
 169     function showHead($error, $success)
 170     {
 171         $this->showStylesheets();
 172         $this->showScripts();
 173
 174         if ($error) {
 175             $this->element("h1", null, $error);
 176         }
 177
 178         if ($success) {
 179             $this->element("h1", null, $success);
 180         }
 181
 182         $this->elementStart('fb:if-section-not-added', array('section' => 'profile'));
 183         $this->elementStart('span', array('id' => 'add_to_profile'));
 184         $this->element('fb:add-section-button', array('section' => 'profile'));
 185         $this->elementEnd('span');
 186         $this->elementEnd('fb:if-section-not-added');
 187
 188     }
 189
 190
 191     // Make this into a widget later
 192     function showLocalNav()
 193     {
 194
 195         $this->elementStart('ul', array('class' => 'nav'));
 196
 197         $this->elementStart('li', array('class' =>
 198             ($this->action == 'facebookhome') ? 'current' : 'facebook_home'));
 199         $this->element('a',
 200             array('href' => 'index.php', 'title' => _('Home')), _('Home'));
 201         $this->elementEnd('li');
 202
 203         $this->elementStart('li',
 204             array('class' =>
 205                 ($this->action == 'facebookinvite') ? 'current' : 'facebook_invite'));
 206         $this->element('a',
 207             array('href' => 'invite.php', 'title' => _('Invite')), _('Invite'));
 208         $this->elementEnd('li');
 209
 210         $this->elementStart('li',
 211             array('class' =>
 212                 ($this->action == 'facebooksettings') ? 'current' : 'facebook_settings'));
 213         $this->element('a',
 214             array('href' => 'settings.php',
 215                 'title' => _('Settings')), _('Settings'));
 216         $this->elementEnd('li');
 217
 218         $this->elementEnd('ul');
 219
 220     }
 221
 222     /**
 223      * Show primary navigation.
 224      *
 225      * @return nothing
 226      */
 227     function showPrimaryNav()
 228     {
 229         // we don't want to show anything for this
 230     }
 231
 232     /**
 233      * Show header of the page.
 234      *
 235      * Calls template methods
 236      *
 237      * @return nothing
 238      */
 239     function showHeader()
 240     {
 241         $this->elementStart('div', array('id' => 'header'));
 242         $this->showLogo();
 243         $this->showNoticeForm();
 244         $this->showPrimaryNav();
 245         $this->elementEnd('div');
 246     }
 247
 248     /**
 249      * Show page, a template method.
 250      *
 251      * @return nothing
 252      */
 253     function showPage($error = null, $success = null)
 254     {
 255         $this->startHTML();
 256         $this->showHead($error, $success);
 257         $this->showBody();
 258         $this->endHTML();
 259     }
 260
 261
 262     function showInstructions()
 263     {
 264
 265         $this->elementStart('dl', array('class' => 'system_notice'));
 266         $this->element('dt', null, 'Page Notice');
 267
 268         $loginmsg_part1 = _('To use the %s Facebook Application you need to login ' .
 269             'with your username and password. Don\'t have a username yet? ');
 270
 271         $loginmsg_part2 = _(' a new account.');
 272
 273         $this->elementStart('dd');
 274         $this->elementStart('p');
 275         $this->text(sprintf($loginmsg_part1, common_config('site', 'name')));
 276         $this->element('a',
 277             array('href' => common_local_url('register')), _('Register'));
 278         $this->text($loginmsg_part2);
 279         $this->elementEnd('dd');
 280         $this->elementEnd('dl');
 281     }
 282
 283
 284     function showLoginForm($msg = null)
 285     {
 286
 287         $this->elementStart('div', array('class' => 'content'));
 288         $this->element('h1', null, _('Login'));
 289
 290         if ($msg) {
 291              $this->element('fb:error', array('message' => $msg));
 292         }
 293
 294         $this->showInstructions();
 295
 296         $this->elementStart('div', array('id' => 'content_inner'));
 297
 298         $this->elementStart('form', array('method' => 'post',
 299                                                'class' => 'form_settings',
 300                                                'id' => 'login',
 301                                                'action' => 'index.php'));
 302
 303         $this->elementStart('fieldset');
 304         $this->element('legend', null, _('Login to site'));
 305
 306         $this->elementStart('ul', array('class' => 'form_datas'));
 307         $this->elementStart('li');
 308         $this->input('nickname', _('Nickname'));
 309         $this->elementEnd('li');
 310         $this->elementStart('li');
 311         $this->password('password', _('Password'));
 312         $this->elementEnd('li');
 313         $this->elementEnd('ul');
 314
 315         $this->submit('submit', _('Login'));
 316         $this->elementEnd('form');
 317
 318         $this->elementStart('p');
 319         $this->element('a', array('href' => common_local_url('recoverpassword')),
 320                        _('Lost or forgotten password?'));
 321         $this->elementEnd('p');
 322
 323         $this->elementEnd('div');
 324
 325     }
 326
 327
 328     function updateProfileBox($notice)
 329     {
 330
 331         // Need to include inline CSS for styling the Profile box
 332
 333         $style = '<style>
 334          .entry-title .vcard .photo {
 335          float:left;
 336          display:inline;
 337          }
 338          .entry-title .vcard .nickname {
 339          margin-left:5px;
 340          }
 341
 342          .entry-title p.entry-content {
 343          display:inline;
 344          margin-left:5px;
 345          }
 346
 347          div.entry-content dl,
 348          div.entry-content dt,
 349          div.entry-content dd {
 350          display:inline;
 351          }
 352
 353          div.entry-content dt,
 354          div.entry-content dd {
 355          display:inline;
 356          margin-left:5px;
 357          }
 358          div.entry-content dl.timestamp dt {
 359          display:none;
 360          }
 361          div.entry-content dd a {
 362          display:inline-block;
 363          }
 364          </style>';
 365
 366         $this->xw->openMemory();
 367
 368         $item = new FacebookNoticeListItem($notice, $this);
 369         $item->show();
 370
 371         $fbml = "<fb:wide>$style " . $this->xw->outputMemory(false) . "</fb:wide>";
 372         $fbml .= "<fb:narrow>$style " . $this->xw->outputMemory(false) . "</fb:narrow>";
 373
 374         $fbml_main = "<fb:narrow>$style " . $this->xw->outputMemory(false) . "</fb:narrow>";
 375
 376         $this->facebook->api_client->profile_setFBML(null, $this->fbuid, $fbml, null, null, $fbml_main);
 377
 378         $this->xw->openURI('php://output');
 379     }
 380
 381
 382     /**
 383      * Generate pagination links
 384      *
 385      * @param boolean $have_before is there something before?
 386      * @param boolean $have_after  is there something after?
 387      * @param integer $page        current page
 388      * @param string  $action      current action
 389      * @param array   $args        rest of query arguments
 390      *
 391      * @return nothing
 392      */
 393     function pagination($have_before, $have_after, $page, $action, $args=null)
 394     {
 395         // Does a little before-after block for next/prev page
 396         if ($have_before || $have_after) {
 397             $this->elementStart('div', array('class' => 'pagination'));
 398             $this->elementStart('dl', null);
 399             $this->element('dt', null, _('Pagination'));
 400             $this->elementStart('dd', null);
 401             $this->elementStart('ul', array('class' => 'nav'));
 402         }
 403         if ($have_before) {
 404             $pargs   = array('page' => $page-1);
 405             $newargs = $args ? array_merge($args, $pargs) : $pargs;
 406             $this->elementStart('li', array('class' => 'nav_prev'));
 407             $this->element('a', array('href' => "$this->app_uri/$action?page=$newargs[page]", 'rel' => 'prev'),
 408                            _('After'));
 409             $this->elementEnd('li');
 410         }
 411         if ($have_after) {
 412             $pargs   = array('page' => $page+1);
 413             $newargs = $args ? array_merge($args, $pargs) : $pargs;
 414             $this->elementStart('li', array('class' => 'nav_next'));
 415             $this->element('a', array('href' => "$this->app_uri/$action?page=$newargs[page]", 'rel' => 'next'),
 416                            _('Before'));
 417             $this->elementEnd('li');
 418         }
 419         if ($have_before || $have_after) {
 420             $this->elementEnd('ul');
 421             $this->elementEnd('dd');
 422             $this->elementEnd('dl');
 423             $this->elementEnd('div');
 424         }
 425     }
 426
 427
 428 }
 429
 430 class FacebookNoticeForm extends NoticeForm
 431 {
 432
 433     var $post_action = null;
 434
 435     /**
 436      * Constructor
 437      *
 438      * @param HTMLOutputter $out     output channel
 439      * @param string        $action  action to return to, if any
 440      * @param string        $content content to pre-fill
 441      */
 442
 443     function __construct($out=null, $action=null, $content=null,
 444         $post_action=null, $user=null)
 445     {
 446         parent::__construct($out, $action, $content, $user);
 447         $this->post_action = $post_action;
 448     }
 449
 450     /**
 451      * Action of the form
 452      *
 453      * @return string URL of the action
 454      */
 455
 456     function action()
 457     {
 458         return $this->post_action;
 459     }
 460
 461 }
 462
 463 class FacebookNoticeList extends NoticeList
 464 {
 465     /**
 466      * show the list of notices
 467      *
 468      * "Uses up" the stream by looping through it. So, probably can't
 469      * be called twice on the same list.
 470      *
 471      * @return int count of notices listed.
 472      */
 473
 474     function show()
 475     {
 476         $this->out->elementStart('div', array('id' =>'notices_primary'));
 477         $this->out->element('h2', null, _('Notices'));
 478         $this->out->elementStart('ul', array('class' => 'notices'));
 479
 480         $cnt = 0;
 481
 482         while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
 483             $cnt++;
 484
 485             if ($cnt > NOTICES_PER_PAGE) {
 486                 break;
 487             }
 488
 489             $item = $this->newListItem($this->notice);
 490             $item->show();
 491         }
 492
 493         $this->out->elementEnd('ul');
 494         $this->out->elementEnd('div');
 495
 496         return $cnt;
 497     }
 498
 499     /**
 500      * returns a new list item for the current notice
 501      *
 502      * Overridden to return a Facebook specific list item.
 503      *
 504      * @param Notice $notice the current notice
 505      *
 506      * @return FacebookNoticeListItem a list item for displaying the notice
 507      * formatted for display in the Facebook App.
 508      */
 509
 510     function newListItem($notice)
 511     {
 512         return new FacebookNoticeListItem($notice, $this);
 513     }
 514
 515 }
 516
 517 class FacebookNoticeListItem extends NoticeListItem
 518 {
 519     /**
 520      * recipe function for displaying a single notice in the Facebook App.
 521      *
 522      * Overridden to strip out some of the controls that we don't
 523      * want to be available.
 524      *
 525      * @return void
 526      */
 527
 528     function show()
 529     {
 530         $this->showStart();
 531
 532         $this->out->elementStart('div', 'entry-title');
 533         $this->showAuthor();
 534         $this->showContent();
 535         $this->out->elementEnd('div');
 536
 537         $this->out->elementStart('div', 'entry-content');
 538         $this->showNoticeLink();
 539         $this->showNoticeSource();
 540         $this->showReplyTo();
 541         $this->out->elementEnd('div');
 542
 543         $this->showEnd();
 544     }
 545
 546     function showNoticeLink()
 547     {
 548         $noticeurl = common_local_url('shownotice',
 549                                       array('notice' => $this->notice->id));
 550         // XXX: we need to figure this out better. Is this right?
 551         if (strcmp($this->notice->uri, $noticeurl) != 0 &&
 552             preg_match('/^http/', $this->notice->uri)) {
 553             $noticeurl = $this->notice->uri;
 554         }
 555
 556         $this->out->elementStart('dl', 'timestamp');
 557         $this->out->element('dt', null, _('Published'));
 558         $this->out->elementStart('dd', null);
 559         $this->out->elementStart('a', array('rel' => 'bookmark',
 560                                         'href' => $noticeurl));
 561         $dt = common_date_iso8601($this->notice->created);
 562         $this->out->element('abbr', array('class' => 'published',
 563                                      'title' => $dt),
 564         common_date_string($this->notice->created));
 565         $this->out->elementEnd('a');
 566         $this->out->elementEnd('dd');
 567         $this->out->elementEnd('dl');
 568     }
 569
 570 }