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

MobileProfilePlugin.php 13.8 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
{
52 53 54
    public $DTD            = null;
    public $serveMobile    = false;
    public $mobileFeatures = array();
55 56 57

    function __construct($DTD='http://www.wapforum.org/DTD/xhtml-mobile10.dtd')
    {
58
        $this->DTD = $DTD;
59 60 61 62 63 64 65

        parent::__construct();
    }


    function onStartShowHTML($action)
    {
Sarven Capadisli's avatar
Sarven Capadisli committed
66

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
        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);
            }
        }

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

84 85 86 87
        // 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'])) {
88 89

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

                // XXX: Browser sniffing sucks
99

100
                // I really don't like going through this every page, 
Sarven Capadisli's avatar
Sarven Capadisli committed
101
                // perhaps use $_SESSION or cookies
102

Sarven Capadisli's avatar
Sarven Capadisli committed
103
                // May be better to group the devices in terms of 
104 105 106 107 108
                // 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?

109
                $this->mobiledevices = array(
Sarven Capadisli's avatar
Sarven Capadisli committed
110 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
                    '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'
                );
157 158 159

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

160
                foreach ($this->mobiledevices as $md) {
161
                    if (strstr($httpuseragent, $md) !== false) {
Sarven Capadisli's avatar
Sarven Capadisli committed
162
                        $this->setMobileFeatures($httpuseragent);
163

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

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

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

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

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
        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;
    }


204 205 206 207 208 209 210 211
    function setMobileFeatures($useragent)
    {
        $mobiledeviceInputFileType = array(
            'nokia'
        );

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

212
        foreach ($mobiledeviceInputFileType as $md) {
213 214 215 216 217 218 219 220
            if (strstr($useragent, $md) !== false) {
                $this->mobileFeatures['inputfiletype'] = true;
                break;
            }
        }
    }


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

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


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

242
        if (file_exists(Theme::file('css/mp-screen.css'))) {
243
            $action->cssLink('css/mp-screen.css', null, 'screen');
244
        } else {
245 246 247 248 249 250
            $action->element('link', array('rel' => 'stylesheet',
                                         'type' => 'text/css',
                                         'href' => common_path('plugins/MobileProfile/mp-screen.css') . '?version=' . STATUSNET_VERSION,
                                         'media' => 'screen'));
        }

251
        if (file_exists(Theme::file('css/mp-handheld.css'))) {
252
            $action->cssLink('css/mp-handheld.css', null, 'handheld');
253
        } else {
254 255 256 257 258 259 260 261 262
            $action->element('link', array('rel' => 'stylesheet',
                                         'type' => 'text/css',
                                         'href' => common_path('plugins/MobileProfile/mp-handheld.css') . '?version=' . STATUSNET_VERSION,
                                         'media' => 'handheld'));
        }

        return false;
    }

263

Sarven Capadisli's avatar
Sarven Capadisli committed
264 265 266 267 268 269 270
    function onStartShowHeader($action)
    {
        if (!$this->serveMobile) {
            return true;
        }

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

        return false;
Sarven Capadisli's avatar
Sarven Capadisli committed
279 280 281
    }


Sarven Capadisli's avatar
Sarven Capadisli committed
282 283 284 285 286 287
    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') || 
288 289
            file_exists(Theme::file('logo.png')) || 
            file_exists(Theme::file('mobilelogo.gif'))) {
Sarven Capadisli's avatar
Sarven Capadisli committed
290 291 292

            $action->element('img', array('class' => 'photo',
                'src' => (common_config('site', 'mobilelogo')) ? common_config('site', 'mobilelogo') : 
293
                            ((file_exists(Theme::file('mobilelogo.png'))) ? (Theme::path('mobilelogo.png')) : Theme::path('logo.png')),
Sarven Capadisli's avatar
Sarven Capadisli committed
294 295 296 297 298 299 300 301
                'alt' => common_config('site', 'name')));
        }
        $action->element('span', array('class' => 'fn org'), common_config('site', 'name'));
        $action->elementEnd('a');
        $action->elementEnd('address');
    }


302 303 304
    function _showPrimaryNav($action)
    {
        $user    = common_current_user();
Sarven Capadisli's avatar
Sarven Capadisli committed
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
        $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'));
330
        } else {
Sarven Capadisli's avatar
Sarven Capadisli committed
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
            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
346 347 348 349 350 351 352
    function onStartShowNoticeFormData($form)
    {
        if (!$this->serveMobile) {
            return true;
        }

        $form->out->element('textarea', array('id' => 'notice_data-text',
353
                                              'cols' => 15,
Sarven Capadisli's avatar
Sarven Capadisli committed
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
                                              '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')) {
369 370 371 372 373 374 375 376
            if ($this->mobileFeatures['inputfiletype']) {
                $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'));
            }
Sarven Capadisli's avatar
Sarven Capadisli committed
377 378 379 380 381 382 383 384 385 386
        }
        if ($form->action) {
            $form->out->hidden('notice_return-to', $form->action, 'returnto');
        }
        $form->out->hidden('notice_in-reply-to', $form->inreplyto, 'inreplyto');

        return false;
    }


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


    function onStartShowScripts($action)
    {

    }

400 401 402 403 404 405 406 407 408 409 410 411 412 413 414

    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 {
415
            $proto      = 'http';
416 417 418 419 420
            $serverpart = common_config('site', 'mobileserver');
        }

        return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
    }
421 422 423 424
}


?>