* The method is disabled unless the user is #1, the first user of the system
*
* @category Plugin
- * @package Laconica
+ * @package StatusNet
* @author Brian Hendrickson <brian@megapump.com>
* @copyright 2009 Megapump, 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('LACONICA')) {
+if (!defined('STATUSNET')) {
exit(1);
}
define('TEMPLATEPLUGIN_VERSION', '0.1');
class TemplatePlugin 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 ) {
+ function onRouterInitialized( $m ) {
$m->connect( 'template/update', array(
'action' => 'template',
));
}
-
-
+
// <%styles%>
// <%scripts%>
// <%search%>
$act->extraHead();
$this->blocks['head'] = $act->xw->flush();
$act->showStylesheets();
- $this->blocks['styles'] = $act->xw->flush();
+ $this->blocks['styles'] = $act->xw->flush();
$act->showScripts();
- $this->blocks['scripts'] = $act->xw->flush();
+ $this->blocks['scripts'] = $act->xw->flush();
$act->showFeeds();
- $this->blocks['feeds'] = $act->xw->flush();
+ $this->blocks['feeds'] = $act->xw->flush();
$act->showOpenSearch();
- $this->blocks['search'] = $act->xw->flush();
+ $this->blocks['search'] = $act->xw->flush();
$act->showDescription();
$this->blocks['description'] = $act->xw->flush();
return false;
}
-
+
// <%bodytext%>
function onStartShowContentBlock( &$act ) {
$this->clear_xmlWriter($act);
function onEndShowContentBlock( &$act ) {
$this->blocks['bodytext'] = $act->xw->flush();
}
-
+
// <%localnav%>
function onStartShowLocalNavBlock( &$act ) {
$this->clear_xmlWriter($act);
function onEndShowLocalNavBlock( &$act ) {
$this->blocks['localnav'] = $act->xw->flush();
}
-
+
// <%export%>
function onStartShowExportData( &$act ) {
$this->clear_xmlWriter($act);
function onEndShowExportData( &$act ) {
$this->blocks['export'] = $act->xw->flush();
}
-
+
// <%subscriptions%>
// <%subscribers%>
// <%groups%>
}
return false;
}
-
+
// <%logo%>
// <%nav%>
// <%notice%>
$this->blocks['noticeform'] = $act->xw->flush();
return false;
}
-
+
// <%secondarynav%>
// <%licenses%>
function onStartShowFooter( &$act ) {
$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 laconica config:
+ // unless statusnet config:
// $config['template']['mode'] = 'html';
if (!(common_config('template', 'mode') == 'html')) {
- $tpl_file = 'tpl/index.php';
+ $tpl_file = $this->templateFolder() . '/index.php';
$tags = array_merge($vars,$this->blocks);
include $tpl_file;
return;
}
-
- $tpl_file = 'tpl/index.html';
-
+
+ $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);
}
-
+
}
/**
* parameter "template", containing the new template code
*
* @category Plugin
- * @package Laconica
+ * @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 TemplateAction extends Action
{
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="Laconica API"');
-
+ 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);
-
+ $this->clientError(_('Only User #1 can update the template.'), $code = 401);
+
// open the old template
- $tpl_file = 'tpl/index.html';
+ $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 onPluginVersion(&$versions)
+ {
+ $versions[] = array('name' => 'Template',
+ 'version' => TEMPLATEPLUGIN_VERSION,
+ 'author' => 'Brian Hendrickson',
+ 'homepage' => 'http://status.net/wiki/Plugin:Template',
+ 'rawdescription' =>
+ _m('Use an HTML template for Web output.'));
+ return true;
+ }
+
}
/**
- * Function for retrieving a laconica display section
+ * 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 Laconica
+ * @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/