We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

MobileProfilePlugin.php 13.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * XHTML Mobile Profile plugin that uses WAP 2.0 Plugin
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Plugin
 * @package   StatusNet
 * @author    Sarven Capadisli <csarven@status.net>
 * @copyright 2009 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET') && !defined('LACONICA')) {
    exit(1);
}

define('PAGE_TYPE_PREFS',
35
       'application/vnd.wap.xhtml+xml, application/xhtml+xml, text/html;q=0.9');
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

require_once INSTALLDIR.'/plugins/Mobile/WAP20Plugin.php';


/**
 * Superclass for plugin to output XHTML Mobile Profile
 *
 * @category Plugin
 * @package  StatusNet
 * @author   Sarven Capadisli <csarven@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */

class MobileProfilePlugin extends WAP20Plugin
{
Sarven Capadisli's avatar
Sarven Capadisli committed
52
    public $DTD             = null;
53
    public $serveMobile     = false;
54
    public $mobileFeatures  = array();
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80

    function __construct($DTD='http://www.wapforum.org/DTD/xhtml-mobile10.dtd')
    {
        $this->DTD       = $DTD;

        parent::__construct();
    }


    function onStartShowHTML($action)
    {
        if (!$type) {
            $httpaccept = isset($_SERVER['HTTP_ACCEPT']) ?
              $_SERVER['HTTP_ACCEPT'] : null;

            $cp = common_accept_to_prefs($httpaccept);
            $sp = common_accept_to_prefs(PAGE_TYPE_PREFS);

            $type = common_negotiate_type($cp, $sp);

            if (!$type) {
                throw new ClientException(_('This page is not available in a '.
                                            'media type you accept'), 406);
            }
        }

81
        // XXX: This should probably graduate to WAP20Plugin
82

83 84 85 86
        // If they are on the mobile site, serve them MP
        if ((common_config('site', 'mobileserver').'/'.
             common_config('site', 'path').'/' == 
            $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'])) {
87 88 89 90

            $this->serveMobile = true;
        }
        else {
91 92 93 94 95 96 97 98 99
            // If they like the WAP 2.0 mimetype, serve them MP
            if (strstr('application/vnd.wap.xhtml+xml', $type) !== false) {
                $this->serveMobile = true;
            }
            else {
                // If they are a mobile device that supports WAP 2.0, 
                // serve them MP

                // XXX: Browser sniffing sucks
100

101 102
                // I really don't like going through this every page, 
                // find a better way
103 104 105 106 107 108 109

                // May be better to categorize the devices in terms of 
                // low,mid,high-end

                // Or, detect the mobile devices based on their support for 
                // MP 1.0, 1.1, or 1.2 may be ideal. Possible?

110
                $this->mobiledevices = array(
Sarven Capadisli's avatar
Sarven Capadisli committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
                    'alcatel',
                    'android',
                    'audiovox',
                    'au-mic,',
                    'avantgo',
                    'blackberry',
                    'blazer',
                    'cldc-',
                    'danger',
                    'epoc',
                    'ericsson',
                    'ericy',
                    'iphone',
                    'ipaq',
                    'ipod',
                    'j2me',
                    'lg',
                    'midp-',
                    'mobile',
                    'mot',
                    'netfront',
                    'nitro',
                    'nokia',
                    'opera mini',
                    'palm',
                    'palmsource',
                    'panasonic',
                    'philips',
                    'pocketpc',
                    'portalmmm',
                    'rover',
                    'samsung',
                    'sanyo',
                    'series60',
                    'sharp',
                    'sie-',
                    'smartphone',
                    'sony',
                    'symbian',
                    'up.browser',
                    'up.link',
                    'up.link',
                    'vodafone',
                    'wap1',
                    'wap2',
                    'windows ce'
                );
158 159 160

                $httpuseragent = strtolower($_SERVER['HTTP_USER_AGENT']);

161 162
                foreach($this->mobiledevices as $md) {
                    if (strstr($httpuseragent, $md) !== false) {
163 164
                        setMobileFeatures($httpuseragent);

165 166 167 168 169 170 171 172 173
                        $this->serveMobile = true;
                        break;
                    }
                }
            }

            // If they are okay with MP, and the site has a mobile server, 
            // redirect there
            if ($this->serveMobile && 
174
                common_config('site', 'mobileserver') !== false &&
175 176
                (common_config('site', 'mobileserver') != 
                    common_config('site', 'server'))) {
177

178 179
                // FIXME: Redirect to equivalent page on mobile site instead
                header("Location: ".$this->_common_path(''));
180 181
                exit();
            }
182 183
        }

184 185 186 187
        if (!$this->serveMobile) {
            return true;
        }

188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
        header('Content-Type: '.$type);

        $action->extraHeaders();

        $action->startXML('html',
                        '-//WAPFORUM//DTD XHTML Mobile 1.0//EN',
                        $this->DTD);

        $language = $action->getLanguage();

        $action->elementStart('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
                                            'xml:lang' => $language));

        return false;
    }


205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
    function setMobileFeatures($useragent)
    {
        /* List of devices that support input type="file" */
        $mobiledeviceInputFileType = array(
            'nokia'
        );

        $this->mobileFeatures['inputfiletype'] = false;

        foreach($mobiledeviceInputFileType as $md) {
            if (strstr($useragent, $md) !== false) {
                $this->mobileFeatures['inputfiletype'] = true;
                break;
            }
        }
    }


223 224
    function onStartShowHeadElements($action)
    {
Sarven Capadisli's avatar
Sarven Capadisli committed
225 226 227 228 229 230 231 232 233 234 235 236 237
        if (!$action->serveMobile) {
            return true;
        }

        $action->showTitle();
        $action->showShortcutIcon();
        $action->showStylesheets();
        $action->showFeeds();
        $action->showDescription();
        $action->extraHead();
    }


238 239
    function onStartShowStatusNetStyles($action)
    {
Sarven Capadisli's avatar
Sarven Capadisli committed
240
        if (!$this->serveMobile) {
241 242 243
            return true;
        }

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
        if (file_exists(theme_file('css/mp-screen.css'))) {
            $action->cssLink('css/mp-screen.css', null, 'screen');
        }
        else {
            $action->element('link', array('rel' => 'stylesheet',
                                         'type' => 'text/css',
                                         'href' => common_path('plugins/MobileProfile/mp-screen.css') . '?version=' . STATUSNET_VERSION,
                                         'media' => 'screen'));
        }

        if (file_exists(theme_file('css/mp-handheld.css'))) {
            $action->cssLink('css/mp-handheld.css', null, 'handheld');
        }
        else {
            $action->element('link', array('rel' => 'stylesheet',
                                         'type' => 'text/css',
                                         'href' => common_path('plugins/MobileProfile/mp-handheld.css') . '?version=' . STATUSNET_VERSION,
                                         'media' => 'handheld'));
        }

        return false;
    }

267

Sarven Capadisli's avatar
Sarven Capadisli committed
268 269 270 271 272 273 274
    function onStartShowHeader($action)
    {
        if (!$this->serveMobile) {
            return true;
        }

        $action->elementStart('div', array('id' => 'header'));
Sarven Capadisli's avatar
Sarven Capadisli committed
275
        $this->_showLogo($action);
Sarven Capadisli's avatar
Sarven Capadisli committed
276
        $this->_showPrimaryNav($action);
Sarven Capadisli's avatar
Sarven Capadisli committed
277 278 279 280
        if (common_logged_in()) {
            $action->showNoticeForm();
        }
        $action->elementEnd('div');
281 282

        return false;
Sarven Capadisli's avatar
Sarven Capadisli committed
283 284 285
    }


Sarven Capadisli's avatar
Sarven Capadisli committed
286 287 288 289 290 291 292 293 294 295 296
    function _showLogo($action)
    {
        $action->elementStart('address', 'vcard');
        $action->elementStart('a', array('class' => 'url home bookmark',
                                       'href' => common_local_url('public')));
        if (common_config('site', 'mobilelogo') || 
            file_exists(theme_file('logo.png')) || 
            file_exists(theme_file('mobilelogo.gif'))) {

            $action->element('img', array('class' => 'photo',
                'src' => (common_config('site', 'mobilelogo')) ? common_config('site', 'mobilelogo') : 
297
                            ((file_exists(theme_file('mobilelogo.png'))) ? (theme_path('mobilelogo.png')) : theme_path('logo.png')),
Sarven Capadisli's avatar
Sarven Capadisli committed
298 299 300 301 302 303 304 305
                'alt' => common_config('site', 'name')));
        }
        $action->element('span', array('class' => 'fn org'), common_config('site', 'name'));
        $action->elementEnd('a');
        $action->elementEnd('address');
    }


Sarven Capadisli's avatar
Sarven Capadisli committed
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
    function _showPrimaryNav($action) {
        $user = common_current_user();
        $connect = '';
        if (common_config('xmpp', 'enabled')) {
            $connect = 'imsettings';
        } else if (common_config('sms', 'enabled')) {
            $connect = 'smssettings';
        } else if (common_config('twitter', 'enabled')) {
            $connect = 'twittersettings';
        }

        $action->elementStart('ul', array('id' => 'site_nav_global_primary'));
        if ($user) {
            $action->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
                            _('Home'));
            $action->menuItem(common_local_url('profilesettings'),
                            _('Account'));
            if ($connect) {
                $action->menuItem(common_local_url($connect),
                                _('Connect'));
            }
            if (common_config('invite', 'enabled')) {
                $action->menuItem(common_local_url('invite'),
                                _('Invite'));
            }
            $action->menuItem(common_local_url('logout'),
                            _('Logout'));
        }
        else {
            if (!common_config('site', 'closed')) {
                $action->menuItem(common_local_url('register'),
                                _('Register'));
            }
            $action->menuItem(common_local_url('login'),
                            _('Login'));
        }
        if ($user || !common_config('site', 'private')) {
            $action->menuItem(common_local_url('peoplesearch'),
                            _('Search'));
        }
        $action->elementEnd('ul');
    }


Sarven Capadisli's avatar
Sarven Capadisli committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    function onStartShowNoticeFormData($form)
    {
        if (!$this->serveMobile) {
            return true;
        }

        $form->out->element('textarea', array('id' => 'notice_data-text',
                                              'cols' => 35,
                                              'rows' => 4,
                                              'name' => 'status_textarea'),
                            ($form->content) ? $form->content : '');

        $contentLimit = Notice::maxContent();

        $form->out->element('script', array('type' => 'text/javascript'),
                            'maxLength = ' . $contentLimit . ';');

        if ($contentLimit > 0) {
            $form->out->element('div', array('id' => 'notice_text-count'),
                                $contentLimit);
        }

        if (common_config('attachments', 'uploads')) {
            $form->out->element('label', array('for' => 'notice_data-attach'),_('Attach'));
            $form->out->element('input', array('id' => 'notice_data-attach',
                                               'type' => 'file',
                                               'name' => 'attach',
                                               'title' => _('Attach a file')));
            $form->out->hidden('MAX_FILE_SIZE', common_config('attachments', 'file_quota'));
        }
        if ($form->action) {
            $form->out->hidden('notice_return-to', $form->action, 'returnto');
        }
        $form->out->hidden('notice_in-reply-to', $form->inreplyto, 'inreplyto');

        return false;
    }


389 390
    function onStartShowAside($action)
    {
Sarven Capadisli's avatar
Sarven Capadisli committed
391 392 393
        if ($this->serveMobile) {
            return false;
        }
394 395 396 397 398 399 400 401
    }


    function onStartShowScripts($action)
    {

    }

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422

    function _common_path($relative, $ssl=false)
    {
        $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';

        if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
            || common_config('site', 'ssl') === 'always') {
            $proto = 'https';
            if (is_string(common_config('site', 'sslserver')) &&
                mb_strlen(common_config('site', 'sslserver')) > 0) {
                $serverpart = common_config('site', 'sslserver');
            } else {
                $serverpart = common_config('site', 'mobileserver');
            }
        } else {
            $proto = 'http';
            $serverpart = common_config('site', 'mobileserver');
        }

        return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
    }
423 424 425 426
}


?>