plugins/Template/TemplatePlugin.php

   1 <?php
   2 /**
   3  * Plugin to render old skool templates
   4  *
   5  * Captures rendered parts from the output buffer, passes them through a template file: tpl/index.html
   6  * Adds an API method at index.php/template/update which lets you overwrite the template file
   7  * Requires username/password and a single POST parameter called "template"
   8  * The method is disabled unless the user is #1, the first user of the system
   9  *
  10  * @category  Plugin
  11  * @package   StatusNet
  12  * @author    Brian Hendrickson <brian@megapump.com>
  13  * @copyright 2009 Megapump, Inc.
  14  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  15  * @link      http://megapump.com/
  16  */
  17
  18 if (!defined('STATUSNET')) {
  19     exit(1);
  20 }
  21
  22 define('TEMPLATEPLUGIN_VERSION', '0.1');
  23
  24 class TemplatePlugin extends Plugin {
  25   var $blocks = array();
  26
  27   function __construct() {
  28     parent::__construct();
  29   }
  30
  31   // capture the RouterInitialized event
  32   // and connect a new API method
  33   // for updating the template
  34   function onRouterInitialized( $m ) {
  35     $m->connect( 'template/update', array(
  36       'action'      => 'template',
  37     ));
  38   }
  39
  40   /**
  41    <%styles%>
  42    <%scripts%>
  43    <%search%>
  44    <%feeds%>
  45    <%description%>
  46    <%head%>
  47   */
  48   function onStartShowHead( &$act ) {
  49     $this->clear_xmlWriter($act);
  50     $act->extraHead();
  51     $this->blocks['head'] = $act->xw->flush();
  52     $act->showStylesheets();
  53     $this->blocks['styles'] = $act->xw->flush();
  54     $act->showScripts();
  55     $this->blocks['scripts'] = $act->xw->flush();
  56     $act->showFeeds();
  57     $this->blocks['feeds'] = $act->xw->flush();
  58     $act->showOpenSearch();
  59     $this->blocks['search'] = $act->xw->flush();
  60     $act->showDescription();
  61     $this->blocks['description'] = $act->xw->flush();
  62     return false;
  63   }
  64
  65   // <%bodytext%>
  66   function onStartShowContentBlock( &$act ) {
  67     $this->clear_xmlWriter($act);
  68     return true;
  69   }
  70   function onEndShowContentBlock( &$act ) {
  71     $this->blocks['bodytext'] = $act->xw->flush();
  72   }
  73
  74   // <%localnav%>
  75   function onStartShowLocalNavBlock( &$act ) {
  76     $this->clear_xmlWriter($act);
  77     return true;
  78   }
  79   function onEndShowLocalNavBlock( &$act ) {
  80     $this->blocks['localnav'] = $act->xw->flush();
  81   }
  82
  83   // <%export%>
  84   function onStartShowExportData( &$act ) {
  85     $this->clear_xmlWriter($act);
  86     return true;
  87   }
  88   function onEndShowExportData( &$act ) {
  89     $this->blocks['export'] = $act->xw->flush();
  90   }
  91
  92   // <%subscriptions%>
  93   // <%subscribers%>
  94   // <%groups%>
  95   // <%statistics%>
  96   // <%cloud%>
  97   // <%groupmembers%>
  98   // <%groupstatistics%>
  99   // <%groupcloud%>
 100   // <%popular%>
 101   // <%groupsbyposts%>
 102   // <%featuredusers%>
 103   // <%groupsbymembers%>
 104   function onStartShowSections( &$act ) {
 105     global $action;
 106     $this->clear_xmlWriter($act);
 107     switch ($action) {
 108       case "showstream":
 109         $act->showSubscriptions();
 110         $this->blocks['subscriptions'] = $act->xw->flush();
 111         $act->showSubscribers();
 112         $this->blocks['subscribers'] = $act->xw->flush();
 113         $act->showGroups();
 114         $this->blocks['groups'] = $act->xw->flush();
 115         $act->showStatistics();
 116         $this->blocks['statistics'] = $act->xw->flush();
 117         $cloud = new PersonalTagCloudSection($act, $act->user);
 118         $cloud->show();
 119         $this->blocks['cloud'] = $act->xw->flush();
 120         break;
 121       case "showgroup":
 122         $act->showMembers();
 123         $this->blocks['groupmembers'] = $act->xw->flush();
 124         $act->showStatistics();
 125         $this->blocks['groupstatistics'] = $act->xw->flush();
 126         $cloud = new GroupTagCloudSection($act, $act->group);
 127         $cloud->show();
 128         $this->blocks['groupcloud'] = $act->xw->flush();
 129         break;
 130       case "public":
 131         $pop = new PopularNoticeSection($act);
 132         $pop->show();
 133         $this->blocks['popular'] = $act->xw->flush();
 134         $gbp = new GroupsByPostsSection($act);
 135         $gbp->show();
 136         $this->blocks['groupsbyposts'] = $act->xw->flush();
 137         $feat = new FeaturedUsersSection($act);
 138         $feat->show();
 139         $this->blocks['featuredusers'] = $act->xw->flush();
 140         break;
 141       case "groups":
 142         $gbp = new GroupsByPostsSection($act);
 143         $gbp->show();
 144         $this->blocks['groupsbyposts'] = $act->xw->flush();
 145         $gbm = new GroupsByMembersSection($act);
 146         $gbm->show();
 147         $this->blocks['groupsbymembers'] = $act->xw->flush();
 148         break;
 149     }
 150     return false;
 151   }
 152
 153   // <%logo%>
 154   // <%nav%>
 155   // <%notice%>
 156   // <%noticeform%>
 157   function onStartShowHeader( &$act ) {
 158     $this->clear_xmlWriter($act);
 159     $act->showLogo();
 160     $this->blocks['logo'] = $act->xw->flush();
 161     $act->showPrimaryNav();
 162     $this->blocks['nav'] = $act->xw->flush();
 163     $act->showSiteNotice();
 164     $this->blocks['notice'] = $act->xw->flush();
 165     if (common_logged_in()) {
 166         $act->showNoticeForm();
 167     } else {
 168         $act->showAnonymousMessage();
 169     }
 170     $this->blocks['noticeform'] = $act->xw->flush();
 171     return false;
 172   }
 173
 174   // <%secondarynav%>
 175   // <%licenses%>
 176   function onStartShowFooter( &$act ) {
 177     $this->clear_xmlWriter($act);
 178     $act->showSecondaryNav();
 179     $this->blocks['secondarynav'] = $act->xw->flush();
 180     $act->showLicenses();
 181     $this->blocks['licenses'] = $act->xw->flush();
 182     return false;
 183   }
 184
 185   // capture the EndHTML event
 186   // and include the template
 187   function onEndEndHTML($act) {
 188     global $action, $tags;
 189
 190     // set the action and title values
 191     $vars = array(
 192       'action'=>$action,
 193       'title'=>$act->title(). " - ". common_config('site', 'name')
 194     );
 195
 196     // use the PHP template
 197     // unless statusnet config:
 198     //   $config['template']['mode'] = 'html';
 199     if (!(common_config('template', 'mode') == 'html')) {
 200       $tpl_file = $this->templateFolder() . '/index.php';
 201       $tags = array_merge($vars,$this->blocks);
 202       include $tpl_file;
 203       return;
 204     }
 205
 206     $tpl_file = $this->templateFolder() . '/index.html';
 207
 208     // read the static template
 209     $output = file_get_contents( $tpl_file );
 210
 211     $tags = array();
 212
 213     // get a list of the <%tags%> in the template
 214     $pattern='/<%([a-z]+)%>/';
 215
 216     if ( 1 <= preg_match_all( $pattern, $output, $found ))
 217       $tags[] = $found;
 218
 219     // for each found tag, set its value from the rendered blocks
 220     foreach( $tags[0][1] as $pos=>$tag ) {
 221       if (isset($this->blocks[$tag]))
 222         $vars[$tag] = $this->blocks[$tag];
 223
 224       // didn't find a block for the tag
 225       elseif (!isset($vars[$tag]))
 226         $vars[$tag] = '';
 227     }
 228
 229     // replace the tags in the template
 230     foreach( $vars as $key=>$val )
 231       $output = str_replace( '<%'.$key.'%>', $val, $output );
 232
 233     echo $output;
 234
 235     return true;
 236
 237   }
 238   function templateFolder() {
 239     return 'tpl';
 240   }
 241
 242   // catching the StartShowHTML event to halt the rendering
 243   function onStartShowHTML( &$act ) {
 244     $this->clear_xmlWriter($act);
 245     return true;
 246   }
 247
 248   // clear the xmlWriter
 249   function clear_xmlWriter( &$act ) {
 250     $act->xw->openMemory();
 251     $act->xw->setIndent(true);
 252   }
 253 }
 254
 255 /**
 256  * Action for updating the template remotely
 257  *
 258  * "template/update" -- a POST method that requires a single
 259  * parameter "template", containing the new template code
 260  *
 261  * @category Plugin
 262  * @package  StatusNet
 263  * @author   Brian Hendrickson <brian@megapump.com>
 264  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 265  * @link     http://megapump.com/
 266  *
 267  */
 268 class TemplateAction extends Action
 269 {
 270   function prepare($args) {
 271     parent::prepare($args);
 272     return true;
 273   }
 274
 275   function handle($args) {
 276     parent::handle($args);
 277
 278     if (!isset($_SERVER['PHP_AUTH_USER'])) {
 279       // not authenticated, show login form
 280       header('WWW-Authenticate: Basic realm="StatusNet API"');
 281
 282       // cancelled the browser login form
 283       $this->clientError(_m('Authentication error!'), $code = 401);
 284     } else {
 285       $nick = $_SERVER['PHP_AUTH_USER'];
 286       $pass = $_SERVER['PHP_AUTH_PW'];
 287
 288       // check username and password
 289       $user = common_check_user($nick,$pass);
 290
 291       if ($user) {
 292         // verify that user is admin
 293         if (!($user->id == 1))
 294           $this->clientError(_m('Only User #1 can update the template.'), $code = 401);
 295
 296         // open the old template
 297         $tpl_file = $this->templateFolder() . '/index.html';
 298         $fp = fopen( $tpl_file, 'w+' );
 299
 300         // overwrite with the new template
 301         fwrite($fp, $this->arg('template'));
 302         fclose($fp);
 303
 304         header('HTTP/1.1 200 OK');
 305         header('Content-type: text/plain');
 306         print "Template Updated!";
 307       } else {
 308         // bad username and password
 309         $this->clientError(_m('Authentication error!'), $code = 401);
 310       }
 311
 312     }
 313   }
 314     function onPluginVersion(&$versions)
 315     {
 316         $versions[] = array('name' => 'Template',
 317                             'version' => TEMPLATEPLUGIN_VERSION,
 318                             'author' => 'Brian Hendrickson',
 319                             'homepage' => 'http://status.net/wiki/Plugin:Template',
 320                             'rawdescription' =>
 321                             // TRANS: Plugin description.
 322                             _m('Use an HTML template for Web output.'));
 323         return true;
 324     }
 325
 326 }
 327
 328 /**
 329  * Function for retrieving a statusnet display section
 330  *
 331  * requires one parameter, the name of the section
 332  * section names are listed in the comments of the TemplatePlugin class
 333  *
 334  * @category Plugin
 335  * @package  StatusNet
 336  * @author   Brian Hendrickson <brian@megapump.com>
 337  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 338  * @link     http://megapump.com/
 339  *
 340  */
 341 function section($tagname) {
 342   global $tags;
 343   if (isset($tags[$tagname]))
 344     return $tags[$tagname];
 345 }