GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

PHPCS BookmarkPlugin.php

Browse Source
This commit is contained in:
Evan Prodromou 2010-12-21 10:13:20 -05:00
parent 331639d6e4
commit c96faf065d
1 changed files with 229 additions and 185 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

414
plugins/Bookmark/BookmarkPlugin.php
View File

@ -29,7 +29,7 @@
*/ */
if (!defined('STATUSNET')) { if (!defined('STATUSNET')) {
exit(1); exit(1);
} }
/** /**
@ -46,219 +46,263 @@ if (!defined('STATUSNET')) {
class BookmarkPlugin extends Plugin class BookmarkPlugin extends Plugin
{ {
/** const VERSION = '0.1';
* Database schema setup
*
* @see Schema
* @see ColumnDef
*
* @return boolean hook value; true means continue processing, false means stop.
*/
function onCheckSchema() /**
{ * Database schema setup
$schema = Schema::get(); *
* @see Schema
* @see ColumnDef
*
* @return boolean hook value; true means continue processing, false means stop.
*/
// For storing user-submitted flags on profiles function onCheckSchema()
{
$schema = Schema::get();
$schema->ensureTable('notice_bookmark', // For storing user-submitted flags on profiles
array(new ColumnDef('notice_id',
'integer',
null,
false,
'PRI'),
new ColumnDef('title',
'varchar',
255),
new ColumnDef('description',
'text')));
return true; $schema->ensureTable('notice_bookmark',
} array(new ColumnDef('notice_id',
'integer',
null,
false,
'PRI'),
new ColumnDef('title',
'varchar',
255),
new ColumnDef('description',
'text')));
function onNoticeDeleteRelated($notice) return true;
{ }
$nb = Notice_bookmark::staticGet('notice_id', $notice->id);
if (!empty($nb)) { /**
$nb->delete(); * When a notice is deleted, delete the related Notice_bookmark
} *
* @param Notice $notice Notice being deleted
*
* @return boolean hook value
*/
return true; function onNoticeDeleteRelated($notice)
} {
$nb = Notice_bookmark::staticGet('notice_id', $notice->id);
function onEndShowStyles($action) if (!empty($nb)) {
{ $nb->delete();
$action->style('.bookmark_tags li { display: inline; }'); }
$action->style('.bookmark_mentions li { display: inline; }');
return true;
}
/** return true;
* Load related modules when needed }
*
* @param string $cls Name of the class to be loaded
*
* @return boolean hook value; true means continue processing, false means stop.
*/
function onAutoload($cls) /**
{ * Show the CSS necessary for this plugin
$dir = dirname(__FILE__); *
* @param Action $action the action being run
*
* @return boolean hook value
*/
switch ($cls) function onEndShowStyles($action)
{ {
case 'NewbookmarkAction': $action->style('.bookmark_tags li { display: inline; }');
include_once $dir.'/newbookmark.php'; $action->style('.bookmark_mentions li { display: inline; }');
return false; return true;
case 'Notice_bookmark': }
include_once $dir.'/'.$cls.'.php';
return false; /**
case 'BookmarkForm': * Load related modules when needed
case 'DeliciousBackupImporter': *
include_once $dir.'/'.strtolower($cls).'.php'; * @param string $cls Name of the class to be loaded
return false; *
default: * @return boolean hook value; true means continue processing, false means stop.
return true; */
function onAutoload($cls)
{
$dir = dirname(__FILE__);
switch ($cls)
{
case 'NewbookmarkAction':
include_once $dir.'/newbookmark.php';
return false;
case 'Notice_bookmark':
include_once $dir.'/'.$cls.'.php';
return false;
case 'BookmarkForm':
case 'DeliciousBackupImporter':
include_once $dir.'/'.strtolower($cls).'.php';
return false;
default:
return true;
}
}
/**
* Map URLs to actions
*
* @param Net_URL_Mapper $m path-to-action mapper
*
* @return boolean hook value; true means continue processing, false means stop.
*/
function onRouterInitialized($m)
{
$m->connect('main/bookmark/new',
array('action' => 'newbookmark'),
array('id' => '[0-9]+'));
return true;
}
/**
* Output the HTML for a bookmark in a list
*
* @param NoticeListItem $nli The list item being shown.
*
* @return boolean hook value
*/
function onStartShowNoticeItem($nli)
{
$nb = Notice_bookmark::staticGet('notice_id',
$nli->notice->id);
if (!empty($nb)) {
$att = $nli->notice->attachments();
$nli->out->elementStart('h3');
$nli->out->element('a',
array('href' => $att[0]->url),
$nb->title);
$nli->out->elementEnd('h3');
$nli->out->element('p',
array('class' => 'bookmark_description'),
$nb->description);
$nli->out->elementStart('p');
$nli->out->element('a', array('href' => $nli->profile->profileurl,
'class' => 'bookmark_author',
'title' => $nli->profile->getBestName()),
$nli->profile->getBestName());
$nli->out->elementEnd('p');
$tags = $nli->notice->getTags();
$nli->out->elementStart('ul', array('class' => 'bookmark_tags'));
foreach ($tags as $tag) {
$nli->out->elementStart('li');
$nli->out->element('a',
array('rel' => 'tag',
'href' => Notice_tag::url($tag)),
$tag);
$nli->out->elementEnd('li');
$nli->out->text(' ');
} }
} $nli->out->elementEnd('ul');
$replies = $nli->notice->getReplies();
if (!empty($replies)) {
$nli->out->elementStart('ul', array('class' => 'bookmark_mentions'));
foreach ($replies as $reply) {
$other = Profile::staticGet('id', $reply);
$nli->out->elementStart('li');
$nli->out->element('a', array('rel' => 'tag',
'href' => $other->profileurl,
'title' => $other->getBestName()),
sprintf('for:%s', $other->nickname));
$nli->out->elementEnd('li');
$nli->out->text(' ');
}
$nli->out->elementEnd('ul');
}
return false;
}
return true;
}
/** /**
* Map URLs to actions * Render a notice as a Bookmark object
* *
* @param Net_URL_Mapper $m path-to-action mapper * @param Notice $notice Notice to render
* * @param ActivityObject &$object Empty object to fill
* @return boolean hook value; true means continue processing, false means stop. *
*/ * @return boolean hook value
*/
function onStartActivityObjectFromNotice($notice, &$object)
{
$nb = Notice_bookmark::staticGet('notice_id',
$notice->id);
if (!empty($nb)) {
function onRouterInitialized($m) $object->id = $notice->uri;
{ $object->type = ActivityObject::BOOKMARK;
$m->connect('main/bookmark/new', $object->title = $nb->title;
array('action' => 'newbookmark'), $object->summary = $nb->description;
array('id' => '[0-9]+'));
return true;
}
function onStartShowNoticeItem($nli)
{
$nb = Notice_bookmark::staticGet('notice_id',
$nli->notice->id);
if (!empty($nb)) {
$att = $nli->notice->attachments();
$nli->out->elementStart('h3');
$nli->out->element('a',
array('href' => $att[0]->url),
$nb->title);
$nli->out->elementEnd('h3');
$nli->out->element('p',
array('class' => 'bookmark_description'),
$nb->description);
$nli->out->elementStart('p');
$nli->out->element('a', array('href' => $nli->profile->profileurl,
'class' => 'bookmark_author',
'title' => $nli->profile->getBestName()),
$nli->profile->getBestName());
$nli->out->elementEnd('p');
$tags = $nli->notice->getTags();
$nli->out->elementStart('ul', array('class' => 'bookmark_tags'));
foreach ($tags as $tag) {
$nli->out->elementStart('li');
$nli->out->element('a',
array('rel' => 'tag',
'href' => Notice_tag::url($tag)),
$tag);
$nli->out->elementEnd('li');
$nli->out->text(' ');
}
$nli->out->elementEnd('ul');
$replies = $nli->notice->getReplies();
if (!empty($replies)) {
$nli->out->elementStart('ul', array('class' => 'bookmark_mentions'));
foreach ($replies as $reply) {
$other = Profile::staticGet('id', $reply);
$nli->out->elementStart('li');
$nli->out->element('a', array('rel' => 'tag',
'href' => $other->profileurl,
'title' => $other->getBestName()),
sprintf('for:%s', $other->nickname));
$nli->out->elementEnd('li');
$nli->out->text(' ');
}
$nli->out->elementEnd('ul');
}
return false;
}
return true;
}
function onStartActivityObjectFromNotice($notice, &$object)
{
$nb = Notice_bookmark::staticGet('notice_id',
$notice->id);
if (!empty($nb)) {
$object->id = $notice->uri;
$object->type = ActivityObject::BOOKMARK;
$object->title = $nb->title;
$object->summary = $nb->description;
$object->link = $notice->bestUrl(); $object->link = $notice->bestUrl();
// Attributes of the URL // Attributes of the URL
$attachments = $notice->attachments(); $attachments = $notice->attachments();
if (count($attachments) != 1) { if (count($attachments) != 1) {
throw new ServerException(_('Bookmark notice with the wrong number of attachments.')); throw new ServerException(_('Bookmark notice with the '.
} 'wrong number of attachments.'));
}
$target = $attachments[0]; $target = $attachments[0];
$attrs = array('rel' => 'related', $attrs = array('rel' => 'related',
'href' => $target->url); 'href' => $target->url);
if (!empty($target->title)) { if (!empty($target->title)) {
$attrs['title'] = $target->title; $attrs['title'] = $target->title;
} }
$object->extra[] = array('link', $attrs); $object->extra[] = array('link', $attrs);
// Attributes of the thumbnail, if any // Attributes of the thumbnail, if any
$thumbnail = $target->getThumbnail(); $thumbnail = $target->getThumbnail();
if (!empty($thumbnail)) { if (!empty($thumbnail)) {
$tattrs = array('rel' => 'preview', $tattrs = array('rel' => 'preview',
'href' => $thumbnail->url); 'href' => $thumbnail->url);
if (!empty($thumbnail->width)) { if (!empty($thumbnail->width)) {
$tattrs['media:width'] = $thumbnail->width; $tattrs['media:width'] = $thumbnail->width;
} }
if (!empty($thumbnail->height)) { if (!empty($thumbnail->height)) {
$tattrs['media:height'] = $thumbnail->height; $tattrs['media:height'] = $thumbnail->height;
} }
$object->extra[] = array('link', $attrs); $object->extra[] = array('link', $attrs);
} }
return false; return false;
} }
return true; return true;
} }
function onPluginVersion(&$versions) /**
{ * Plugin version data
$versions[] = array('name' => 'Sample', *
'version' => STATUSNET_VERSION, * @param array &$versions array of version data
'author' => 'Evan Prodromou', *
'homepage' => 'http://status.net/wiki/Plugin:Bookmark', * @return value
'rawdescription' => */
_m('Simple extension for supporting bookmarks.'));
return true; function onPluginVersion(&$versions)
} {
$versions[] = array('name' => 'Sample',
'version' => self::VERSION,
'author' => 'Evan Prodromou',
'homepage' => 'http://status.net/wiki/Plugin:Bookmark',
'rawdescription' =>
_m('Simple extension for supporting bookmarks.'));
return true;
}
} }