actions/apioauthpin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Action for displaying an OAuth verifier pin
   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    Zach Copley <zach@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Class for displaying an OAuth verifier pin
  36  *
  37  * XXX: I'm pretty sure we don't need to check the logged in state here. -- Zach
  38  *
  39  * @category Action
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45 class ApiOAuthPinAction extends InfoAction
  46 {
  47     function __construct($title, $message, $verifier, $desktopMode = false)
  48     {
  49         $this->verifier    = $verifier;
  50         $this->title       = $title;
  51         $this->desktopMode = $desktopMode;
  52         parent::__construct($title, $message);
  53     }
  54
  55     /**
  56      * Show body - override to add a special CSS class for the pin pages's
  57      * "desktop mode" (minimal display)
  58      *
  59      * Calls template methods
  60      *
  61      * @return nothing
  62      */
  63     function showBody()
  64     {
  65         $bodyClasses = array();
  66
  67         if ($this->desktopMode) {
  68             $bodyClasses[] = 'oauth-desktop-mode';
  69         }
  70
  71         if (common_current_user()) {
  72             $bodyClasses[] = 'user_in';
  73         }
  74
  75         $attrs = array('id' => strtolower($this->trimmed('action')));
  76
  77         if (!empty($bodyClasses)) {
  78             $attrs['class'] = implode(' ', $bodyClasses);
  79         }
  80
  81         $this->elementStart('body', $attrs);
  82
  83         $this->elementStart('div', array('id' => 'wrap'));
  84         if (Event::handle('StartShowHeader', array($this))) {
  85             $this->showHeader();
  86             Event::handle('EndShowHeader', array($this));
  87         }
  88         $this->showCore();
  89         if (Event::handle('StartShowFooter', array($this))) {
  90             $this->showFooter();
  91             Event::handle('EndShowFooter', array($this));
  92         }
  93         $this->elementEnd('div');
  94         $this->showScripts();
  95         $this->elementEnd('body');
  96     }
  97
  98     /**
  99      * A local menu
 100      *
 101      * Shows different login/register actions.
 102      *
 103      * @return void
 104      */
 105     function showLocalNav()
 106     {
 107         // NOP
 108     }
 109
 110     /*
 111      * Override - suppress output in "desktop" mode
 112      */
 113     function showHeader()
 114     {
 115         if ($this->desktopMode == false) {
 116             parent::showHeader();
 117         }
 118     }
 119
 120     /*
 121      * Override - suppress output in "desktop" mode
 122      */
 123     function showAside()
 124     {
 125         if ($this->desktopMode == false) {
 126             parent::showAside();
 127         }
 128     }
 129
 130     /*
 131      * Override - suppress output in "desktop" mode
 132      */
 133     function showFooter()
 134     {
 135         if ($this->desktopMode == false) {
 136             parent::showFooter();
 137         }
 138     }
 139
 140     /**
 141      * Show site notice.
 142      *
 143      * @return nothing
 144      */
 145     function showSiteNotice()
 146     {
 147         // NOP
 148     }
 149
 150     /**
 151      * Show notice form.
 152      *
 153      * Show the form for posting a new notice
 154      *
 155      * @return nothing
 156      */
 157     function showNoticeForm()
 158     {
 159         // NOP
 160     }
 161
 162     /**
 163      * Display content.
 164      *
 165      * @return nothing
 166      */
 167     function showContent()
 168     {
 169         $this->element('div', array('class' => 'info'), $this->message);
 170         $this->element('div', array('id' => 'oauth_pin'), $this->verifier);
 171     }
 172 }