summaryrefslogtreecommitdiff
path: root/plugins/GNUsocialTemplatePlugin.php
blob: 1287727aaf684f16ae53cd60559a9331a81a0cec (plain)
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
<?php
/**
 * Plugin to render GNU social
 *
 * Captures rendered parts from the output buffer, passes them through a template file: tpl/social.php
 * Adds an API method at index.php/template/update which lets you overwrite the template file
 * Requires username/password and a single POST parameter called "template"
 * The method is disabled unless the user is #1, the first user of the system
 *
 * @category  Plugin
 * @package   StatusNet
 * @author    Brian Hendrickson <brian@megapump.com>
 * @author    Matt Lee <mattl@cnuk.org>
 * @copyright 2009 Megapump, Inc.
 * @copyright 2010 Free Software Foundation, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://megapump.com/
 */

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

define('GNUSOCIAL_TEMPLATEPLUGIN_VERSION', '0.1.1');

class GNUsocialTemplatePlugin extends Plugin {

  var $blocks = array();

  function __construct() {
    parent::__construct();
  }

  // capture the RouterInitialized event
  // and connect a new API method
  // for updating the template
  function onRouterInitialized( $m ) {
    $m->connect( 'template/update', array(
      'action'      => 'template',
    ));
  }

  // <%styles%>
  // <%scripts%>
  // <%search%>
  // <%feeds%>
  // <%description%>
  // <%head%>
  function onStartShowHead( $act ) {
    $this->clear_xmlWriter($act);
    $act->extraHead();
    $this->blocks['head'] = $act->xw->flush();
    $act->showStylesheets();
    $this->blocks['styles'] = $act->xw->flush();
    $act->showScripts();
    $this->blocks['scripts'] = $act->xw->flush();
    $act->showFeeds();
    $this->blocks['feeds'] = $act->xw->flush();
    $act->showOpenSearch();
    $this->blocks['search'] = $act->xw->flush();
    $act->showDescription();
    $this->blocks['description'] = $act->xw->flush();
    return false;
  }

  // <%bodytext%>
  function onStartShowContentBlock( $act ) {
    $this->clear_xmlWriter($act);
    return true;
  }
  function onEndShowContentBlock( $act ) {
    $this->blocks['bodytext'] = $act->xw->flush();
  }

  // <%localnav%>
  function onStartShowLocalNavBlock( $act ) {
    $this->clear_xmlWriter($act);
    return true;
  }
  function onEndShowLocalNavBlock( $act ) {
    $this->blocks['localnav'] = $act->xw->flush();
  }

  // <%export%>
  function onStartShowExportData( $act ) {
    $this->clear_xmlWriter($act);
    return true;
  }
  function onEndShowExportData( $act ) {
    $this->blocks['export'] = $act->xw->flush();
  }

  // <%subscriptions%>
  // <%subscribers%>
  // <%groups%>
  // <%statistics%>
  // <%cloud%>
  // <%groupmembers%>
  // <%groupstatistics%>
  // <%groupcloud%>
  // <%popular%>
  // <%groupsbyposts%>
  // <%featuredusers%>
  // <%groupsbymembers%>
  function onStartShowSections( $act ) {
    global $action;
    $this->clear_xmlWriter($act);
    switch ($action) {
      case "showstream":
        $act->showSubscriptions();
        $this->blocks['subscriptions'] = $act->xw->flush();
        $act->showSubscribers();
        $this->blocks['subscribers'] = $act->xw->flush();
        $act->showGroups();
        $this->blocks['groups'] = $act->xw->flush();
        $act->showStatistics();
        $this->blocks['statistics'] = $act->xw->flush();
        $cloud = new PersonalTagCloudSection($act, $act->user);
        $cloud->show();
        $this->blocks['cloud'] = $act->xw->flush();
        break;
      case "showgroup":
        $act->showMembers();
        $this->blocks['groupmembers'] = $act->xw->flush();
        $act->showStatistics();
        $this->blocks['groupstatistics'] = $act->xw->flush();
        $cloud = new GroupTagCloudSection($act, $act->group);
        $cloud->show();
        $this->blocks['groupcloud'] = $act->xw->flush();
        break;
      case "public":
        $pop = new PopularNoticeSection($act);
        $pop->show();
        $this->blocks['popular'] = $act->xw->flush();
        $gbp = new GroupsByPostsSection($act);
        $gbp->show();
        $this->blocks['groupsbyposts'] = $act->xw->flush();
        $feat = new FeaturedUsersSection($act);
        $feat->show();
        $this->blocks['featuredusers'] = $act->xw->flush();
        break;
      case "groups":
        $gbp = new GroupsByPostsSection($act);
        $gbp->show();
        $this->blocks['groupsbyposts'] = $act->xw->flush();
        $gbm = new GroupsByMembersSection($act);
        $gbm->show();
        $this->blocks['groupsbymembers'] = $act->xw->flush();
        break;
    }
    return false;
  }

  // <%logo%>
  // <%nav%>
  // <%notice%>
  // <%noticeform%>
  function onStartShowHeader( $act ) {
    $this->clear_xmlWriter($act);
    $act->showLogo();
    $this->blocks['logo'] = $act->xw->flush();
    $act->showPrimaryNav();
    $this->blocks['nav'] = $act->xw->flush();
    $act->showSiteNotice();
    $this->blocks['notice'] = $act->xw->flush();
    if (common_logged_in()) {
        $act->showNoticeForm();
    } else {
        $act->showAnonymousMessage();
    }
    $this->blocks['noticeform'] = $act->xw->flush();
    return false;
  }

  // <%secondarynav%>
  // <%licenses%>
  function onStartShowFooter( $act ) {
    $this->clear_xmlWriter($act);
    $act->showSecondaryNav();
    $this->blocks['secondarynav'] = $act->xw->flush();
    $act->showLicenses();
    $this->blocks['licenses'] = $act->xw->flush();
    return false;
  }

  // capture the EndHTML event
  // and include the template
  function onEndEndHTML($act) {

    global $action, $tags;

    // set the action and title values
    $vars = array(
      'action'=>$action,
      'title'=>$act->title(). " - ". common_config('site', 'name')
    );

    // use the PHP template
    // unless statusnet config:
    //   $config['template']['mode'] = 'html';
    if (!(common_config('template', 'mode') == 'html')) {
      $tpl_file = $this->templateFolder() . '/social.php';
      $tags = array_merge($vars,$this->blocks);
      include $tpl_file;
      return;
    }

    $tpl_file = $this->templateFolder() . '/index.html';

    // read the static template
    $output = file_get_contents( $tpl_file );

    $tags = array();

    // get a list of the <%tags%> in the template
    $pattern='/<%([a-z]+)%>/';

    if ( 1 <= preg_match_all( $pattern, $output, $found ))
      $tags[] = $found;

    // for each found tag, set its value from the rendered blocks
    foreach( $tags[0][1] as $pos=>$tag ) {
      if (isset($this->blocks[$tag]))
        $vars[$tag] = $this->blocks[$tag];

      // didn't find a block for the tag
      elseif (!isset($vars[$tag]))
        $vars[$tag] = '';
    }

    // replace the tags in the template
    foreach( $vars as $key=>$val )
      $output = str_replace( '<%'.$key.'%>', $val, $output );

    echo $output;

    return true;

  }
  function templateFolder() {
    return 'tpl';
  }

  // catching the StartShowHTML event to halt the rendering
  function onStartShowHTML( $act ) {
    $this->clear_xmlWriter($act);
    return true;
  }

  // clear the xmlWriter
  function clear_xmlWriter( $act ) {
    $act->xw->openMemory();
    $act->xw->setIndent(true);
  }

    function onPluginVersion(&$versions)
    {
        $versions[] = array('name' => 'Template',
                            'version' => GNUSOCIAL_TEMPLATEPLUGIN_VERSION,
                            'author' => 'Brian Hendrickson',
                            'homepage' => 'http://status.net/wiki/Plugin:Template',
                            'rawdescription' =>
                            _m('Use an HTML template for Web output.'));
        return true;
    }

}

/**
 * Action for updating the template remotely
 *
 * "template/update" -- a POST method that requires a single
 * parameter "template", containing the new template code
 *
 * @category Plugin
 * @package  StatusNet
 * @author   Brian Hendrickson <brian@megapump.com>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://megapump.com/
 *
 */

class GNUsocialTemplateAction extends Action
{

  function prepare($args) {
    parent::prepare($args);
    return true;
  }

  function handle($args) {

    parent::handle($args);

    if (!isset($_SERVER['PHP_AUTH_USER'])) {

      // not authenticated, show login form
      header('WWW-Authenticate: Basic realm="StatusNet API"');

      // cancelled the browser login form
      $this->clientError(_('Authentication error!'), $code = 401);

    } else {

      $nick = $_SERVER['PHP_AUTH_USER'];
      $pass = $_SERVER['PHP_AUTH_PW'];

      // check username and password
      $user = common_check_user($nick,$pass);

      if ($user) {

        // verify that user is admin
        if (!($user->id == 1))
          $this->clientError(_('Only User #1 can update the template.'), $code = 401);

        // open the old template
        $tpl_file = $this->templateFolder() . '/index.html';
        $fp = fopen( $tpl_file, 'w+' );

        // overwrite with the new template
        fwrite($fp, $this->arg('template'));
        fclose($fp);

        header('HTTP/1.1 200 OK');
        header('Content-type: text/plain');
        print "Template Updated!";

      } else {

        // bad username and password
        $this->clientError(_('Authentication error!'), $code = 401);

      }

    }
  }

}

/**
 * Function for retrieving a statusnet display section
 *
 * requires one parameter, the name of the section
 * section names are listed in the comments of the TemplatePlugin class
 *
 * @category Plugin
 * @package  StatusNet
 * @author   Brian Hendrickson <brian@megapump.com>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://megapump.com/
 *
 */
if (!function_exists('section')) {
function section($tagname) {
  global $tags;
  if (isset($tags[$tagname]))
    return $tags[$tagname];
}
}