lib/plugin/JabberPresence.php

   1 <?php
   2
   3 /*
   4  * Copyright (C) 2004 $ThePhpWikiProgrammingTeam
   5  *
   6  * This file is part of PhpWiki.
   7  *
   8  * PhpWiki is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * PhpWiki is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 /**
  24  * A simple Jabber presence WikiPlugin.
  25  * http://wiki.crao.net/index.php/JabberPr%E9sence/Source
  26  * http://edgar.netflint.net/howto.php
  27  *
  28  * Usage:
  29  *  <<JabberPresence scripturl=http://edgar.netflint.net/status.php
  30  *                          jid=yourid@jabberserver type=html iconset=phpbb >>
  31  *
  32  * @author: Arnaud Fontaine
  33  */
  34
  35 if (!defined('MY_JABBER_ID'))
  36     define('MY_JABBER_ID', $GLOBALS['request']->_user->UserName() . "@jabber.com"); // or "@netflint.net"
  37
  38 class WikiPlugin_JabberPresence
  39     extends WikiPlugin
  40 {
  41     function getDescription()
  42     {
  43         return _("Display Jabber presence.");
  44     }
  45
  46     // Establish default values for each of this plugin's arguments.
  47     function getDefaultArguments()
  48     {
  49         return array('scripturl' => "http://edgar.netflint.net/status.php",
  50             'jid' => MY_JABBER_ID,
  51             'type' => 'image',
  52             'iconset' => "gabber");
  53     }
  54
  55     /**
  56      * @param WikiDB $dbi
  57      * @param string $argstr
  58      * @param WikiRequest $request
  59      * @param string $basepage
  60      * @return mixed
  61      */
  62     function run($dbi, $argstr, &$request, $basepage)
  63     {
  64         extract($this->getArgs($argstr, $request));
  65         // Any text that is returned will not be further transformed,
  66         // so use html where necessary.
  67         if (empty($jid))
  68             $html = HTML();
  69         else
  70             $html = HTML::img(array('src' => urlencode($scripturl) .
  71                 '&jid=' . urlencode($jid) .
  72                 '&type=' . urlencode($type) .
  73                 '&iconset=' . ($iconset),
  74                 'alt' => ""));
  75         return $html;
  76     }
  77 }
  78
  79 // Local Variables:
  80 // mode: php
  81 // tab-width: 8
  82 // c-basic-offset: 4
  83 // c-hanging-comment-ender-p: nil
  84 // indent-tabs-mode: nil
  85 // End: