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
  46 class ApiOauthPinAction extends InfoAction
  47 {
  48     function __construct($title, $message, $verifier, $desktopMode = false)
  49     {
  50         $this->verifier    = $verifier;
  51         $this->title       = $title;
  52         $this->desktopMode = $desktopMode;
  53         parent::__construct($title, $message);
  54     }
  55
  56     /**
  57      * Show body - override to add a special CSS class for the pin pages's
  58      * "desktop mode" (minimal display)
  59      *
  60      * Calls template methods
  61      *
  62      * @return nothing
  63      */
  64     function showBody()
  65     {
  66         $bodyClasses = array();
  67
  68         if ($this->desktopMode) {
  69             $bodyClasses[] = 'oauth-desktop-mode';
  70         }
  71
  72         if (common_current_user()) {
  73             $bodyClasses[] = 'user_in';
  74         }
  75
  76         $attrs = array('id' => strtolower($this->trimmed('action')));
  77
  78         if (!empty($bodyClasses)) {
  79             $attrs['class'] = implode(' ', $bodyClasses);
  80         }
  81
  82         $this->elementStart('body', $attrs);
  83
  84         $this->elementStart('div', array('id' => 'wrap'));
  85         if (Event::handle('StartShowHeader', array($this))) {
  86             $this->showHeader();
  87             Event::handle('EndShowHeader', array($this));
  88         }
  89         $this->showCore();
  90         if (Event::handle('StartShowFooter', array($this))) {
  91             $this->showFooter();
  92             Event::handle('EndShowFooter', array($this));
  93         }
  94         $this->elementEnd('div');
  95         $this->showScripts();
  96         $this->elementEnd('body');
  97     }
  98
  99     /**
 100      * A local menu
 101      *
 102      * Shows different login/register actions.
 103      *
 104      * @return void
 105      */
 106     function showLocalNav()
 107     {
 108         // NOP
 109     }
 110
 111     /*
 112      * Override - suppress output in "desktop" mode
 113      */
 114     function showHeader()
 115     {
 116         if ($this->desktopMode == false) {
 117             parent::showHeader();
 118         }
 119     }
 120
 121     /*
 122      * Override - suppress output in "desktop" mode
 123      */
 124     function showAside()
 125     {
 126         if ($this->desktopMode == false) {
 127             parent::showAside();
 128         }
 129     }
 130
 131     /*
 132      * Override - suppress output in "desktop" mode
 133      */
 134     function showFooter()
 135     {
 136         if ($this->desktopMode == false) {
 137             parent::showFooter();
 138         }
 139     }
 140
 141     /**
 142      * Show site notice.
 143      *
 144      * @return nothing
 145      */
 146     function showSiteNotice()
 147     {
 148         // NOP
 149     }
 150
 151     /**
 152      * Show notice form.
 153      *
 154      * Show the form for posting a new notice
 155      *
 156      * @return nothing
 157      */
 158     function showNoticeForm()
 159     {
 160         // NOP
 161     }
 162
 163     /**
 164      * Display content.
 165      *
 166      * @return nothing
 167      */
 168     function showContent()
 169     {
 170         $this->element('div', array('class' => 'info'), $this->message);
 171         $this->element('div', array('id' => 'oauth_pin'), $this->verifier);
 172     }
 173 }