Show social activities as notices and activity streams objects
This commit is contained in:
Evan Prodromou
commit
8497d2960a
293
ActivityPlugin.php
Normal file
293
ActivityPlugin.php
Normal file
|
|
@ -0,0 +1,293 @@
|
|||
<?php
|
||||
/**
|
||||
* StatusNet - the distributed open-source microblogging tool
|
||||
* Copyright (C) 2010, StatusNet, Inc.
|
||||
*
|
||||
* Shows social activities in the output feed
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
* @category Activity
|
||||
* @package StatusNet
|
||||
* @author Evan Prodromou <evan@status.net>
|
||||
* @copyright 2010 StatusNet, Inc.
|
||||
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
|
||||
* @link http://status.net/
|
||||
*/
|
||||
|
||||
if (!defined('STATUSNET')) {
|
||||
// This check helps protect against security problems;
|
||||
// your code file can't be executed directly from the web.
|
||||
exit(1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Activity plugin main class
|
||||
*
|
||||
* @category Activity
|
||||
* @package StatusNet
|
||||
* @author Evan Prodromou <evan@status.net>
|
||||
* @copyright 2010 StatusNet, Inc.
|
||||
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
|
||||
* @link http://status.net/
|
||||
*/
|
||||
|
||||
class ActivityPlugin 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()
|
||||
{
|
||||
$schema = Schema::get();
|
||||
|
||||
// For storing the activity part of a notice
|
||||
|
||||
$schema->ensureTable('notice_activity',
|
||||
array(new ColumnDef('notice_id', 'integer', null,
|
||||
false, 'PRI'),
|
||||
new ColumnDef('verb', 'varchar', 255,
|
||||
false, 'MUL'),
|
||||
new ColumnDef('object', 'varchar', 255,
|
||||
true, 'MUL')));
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
function onAutoload($cls)
|
||||
{
|
||||
$dir = dirname(__FILE__);
|
||||
|
||||
switch ($cls)
|
||||
{
|
||||
case 'Notice_activity':
|
||||
include_once $dir . '/'.$cls.'.php';
|
||||
return false;
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
function onEndSubscribe($subscriber, $other)
|
||||
{
|
||||
$user = User::staticGet('id', $subscriber->id);
|
||||
if (!empty($user)) {
|
||||
$rendered = sprintf(_m('<em>Started following <a href="%s">%s</a></em>.'),
|
||||
$other->profileurl,
|
||||
$other->getBestName());
|
||||
$content = sprintf(_m('Started following %s.'),
|
||||
$other->getBestName());
|
||||
|
||||
$notice = Notice::saveNew($user->id,
|
||||
$content,
|
||||
'activity',
|
||||
array('rendered' => $rendered));
|
||||
|
||||
Notice_activity::setActivity($notice->id,
|
||||
ActivityVerb::FOLLOW,
|
||||
$other->getUri());
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
function onEndUnsubscribe($subscriber, $other)
|
||||
{
|
||||
$user = User::staticGet('id', $subscriber->id);
|
||||
if (!empty($user)) {
|
||||
$rendered = sprintf(_m('<em>Stopped following <a href="%s">%s</a></em>.'),
|
||||
$other->profileurl,
|
||||
$other->getBestName());
|
||||
$content = sprintf(_m('Stopped following %s.'),
|
||||
$other->getBestName());
|
||||
|
||||
$notice = Notice::saveNew($user->id,
|
||||
$content,
|
||||
'activity',
|
||||
array('rendered' => $rendered));
|
||||
|
||||
Notice_activity::setActivity($notice->id,
|
||||
ActivityVerb::UNFOLLOW,
|
||||
$other->getUri());
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
function onEndFavorNotice($profile, $notice)
|
||||
{
|
||||
$user = User::staticGet('id', $profile->id);
|
||||
|
||||
if (!empty($user)) {
|
||||
$author = Profile::staticGet('id', $notice->profile_id);
|
||||
$rendered = sprintf(_m('<em>Liked <a href="%s">%s\'s status</a></em>.'),
|
||||
$notice->bestUrl(),
|
||||
$author->getBestName());
|
||||
$content = sprintf(_m('Liked %s\'s status.'),
|
||||
$author->getBestName());
|
||||
|
||||
$notice = Notice::saveNew($user->id,
|
||||
$content,
|
||||
'activity',
|
||||
array('rendered' => $rendered));
|
||||
|
||||
Notice_activity::setActivity($notice->id,
|
||||
ActivityVerb::FAVORITE,
|
||||
$notice->uri);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
function onEndDisfavorNotice($profile, $notice)
|
||||
{
|
||||
$user = User::staticGet('id', $profile->id);
|
||||
|
||||
if (!empty($user)) {
|
||||
$author = Profile::staticGet('id', $notice->profile_id);
|
||||
$rendered = sprintf(_m('<em>Stopped liking <a href="%s">%s\'s status</a></em>.'),
|
||||
$notice->bestUrl(),
|
||||
$author->getBestName());
|
||||
$content = sprintf(_m('Stopped liking %s\'s status.'),
|
||||
$author->getBestName());
|
||||
|
||||
$notice = Notice::saveNew($user->id,
|
||||
$content,
|
||||
'activity',
|
||||
array('rendered' => $rendered));
|
||||
|
||||
Notice_activity::setActivity($notice->id,
|
||||
ActivityVerb::UNFAVORITE,
|
||||
$notice->uri);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
function onEndJoinGroup($group, $user)
|
||||
{
|
||||
$rendered = sprintf(_m('<em>Joined the group "<a href="%s">%s</a>"</em>.'),
|
||||
$group->homeUrl(),
|
||||
$group->getBestName());
|
||||
$content = sprintf(_m('Joined the group %s.'),
|
||||
$group->getBestName());
|
||||
|
||||
$notice = Notice::saveNew($user->id,
|
||||
$content,
|
||||
'activity',
|
||||
array('rendered' => $rendered));
|
||||
|
||||
Notice_activity::setActivity($notice->id,
|
||||
ActivityVerb::JOIN,
|
||||
$group->getUri());
|
||||
return true;
|
||||
}
|
||||
|
||||
function onEndLeaveGroup($group, $user)
|
||||
{
|
||||
$rendered = sprintf(_m('<em>Left the group "<a href="%s">%s</a>"</em>.'),
|
||||
$group->homeUrl(),
|
||||
$group->getBestName());
|
||||
$content = sprintf(_m('Left the group "%s".'),
|
||||
$group->getBestName());
|
||||
|
||||
$notice = Notice::saveNew($user->id,
|
||||
$content,
|
||||
'activity',
|
||||
array('rendered' => $rendered));
|
||||
|
||||
Notice_activity::setActivity($notice->id,
|
||||
ActivityVerb::LEAVE,
|
||||
$group->getUri());
|
||||
return true;
|
||||
}
|
||||
|
||||
function onStartActivityVerb(&$notice, &$xs, &$verb)
|
||||
{
|
||||
$act = Notice_activity::staticGet('notice_id', $notice->id);
|
||||
|
||||
if (!empty($act)) {
|
||||
$this->debug("Have an activity ({$act->notice_id}, {$act->verb}, {$act->object})");
|
||||
$verb = $act->verb;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
function onStartActivityDefaultObjectType(&$notice, &$xs, &$type)
|
||||
{
|
||||
$act = Notice_activity::staticGet('notice_id', $notice->id);
|
||||
|
||||
if (!empty($act)) {
|
||||
$this->debug("Have an activity ({$act->notice_id}, {$act->verb}, {$act->object})");
|
||||
// no default object
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
function onStartActivityObjects(&$notice, &$xs, &$objects)
|
||||
{
|
||||
$act = Notice_activity::staticGet('notice_id', $notice->id);
|
||||
|
||||
if (!empty($act)) {
|
||||
$this->debug("Have an activity ({$act->notice_id}, {$act->verb}, {$act->object})");
|
||||
switch ($act->verb)
|
||||
{
|
||||
case ActivityVerb::FOLLOW:
|
||||
case ActivityVerb::UNFOLLOW:
|
||||
$profile = Profile::fromURI($act->object);
|
||||
if (!empty($profile)) {
|
||||
$objects[] = ActivityObject::fromProfile($profile);
|
||||
}
|
||||
break;
|
||||
case ActivityVerb::FAVORITE:
|
||||
case ActivityVerb::UNFAVORITE:
|
||||
$notice = Notice::staticGet('uri', $act->object);
|
||||
if (!empty($notice)) {
|
||||
$objects[] = $notice->asActivity();
|
||||
}
|
||||
break;
|
||||
case ActivityVerb::JOIN:
|
||||
case ActivityVerb::LEAVE:
|
||||
$group = User_group::staticGet('uri', $act->object);
|
||||
if (!empty($notice)) {
|
||||
$objects[] = ActivityObject::fromGroup($group);
|
||||
}
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
function onPluginVersion(&$versions)
|
||||
{
|
||||
$versions[] = array('name' => 'Activity',
|
||||
'version' => self::VERSION,
|
||||
'author' => 'Evan Prodromou',
|
||||
'homepage' => 'http://status.net/wiki/Plugin:Activity',
|
||||
'rawdescription' =>
|
||||
_m('Emits notices when social activities happen.'));
|
||||
return true;
|
||||
}
|
||||
}
|
||||
155
Notice_activity.php
Normal file
155
Notice_activity.php
Normal file
|
|
@ -0,0 +1,155 @@
|
|||
<?php
|
||||
/**
|
||||
* Data class for saving social activities as notices
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* @category Data
|
||||
* @package StatusNet
|
||||
* @author Evan Prodromou <evan@status.net>
|
||||
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
|
||||
* @link http://status.net/
|
||||
*
|
||||
* StatusNet - the distributed open-source microblogging tool
|
||||
* Copyright (C) 2009, StatusNet, Inc.
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
if (!defined('STATUSNET')) {
|
||||
exit(1);
|
||||
}
|
||||
|
||||
require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
|
||||
|
||||
/**
|
||||
* Data class for saving social activities as notices
|
||||
*
|
||||
* @category Action
|
||||
* @package StatusNet
|
||||
* @author Evan Prodromou <evan@status.net>
|
||||
* @license http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
|
||||
* @link http://status.net/
|
||||
*
|
||||
* @see DB_DataObject
|
||||
*/
|
||||
|
||||
class Notice_activity extends Memcached_DataObject
|
||||
{
|
||||
public $__table = 'notice_activity'; // table name
|
||||
|
||||
public $notice_id; // int(4) primary_key not_null
|
||||
public $verb; // varchar(255)
|
||||
public $object; // varchar(255)
|
||||
|
||||
/**
|
||||
* Get an instance by key
|
||||
*
|
||||
* This is a utility method to get a single instance with a given key value.
|
||||
*
|
||||
* @param string $k Key to use to lookup (usually 'notice_id' for this class)
|
||||
* @param mixed $v Value to lookup
|
||||
*
|
||||
* @return Notice_activity object found, or null for no hits
|
||||
*
|
||||
*/
|
||||
|
||||
function staticGet($k, $v=null)
|
||||
{
|
||||
common_debug("Notice_activity::staticGet($k, $v)");
|
||||
$result = Memcached_DataObject::staticGet('Notice_activity', $k, $v);
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* return table definition for DB_DataObject
|
||||
*
|
||||
* DB_DataObject needs to know something about the table to manipulate
|
||||
* instances. This method provides all the DB_DataObject needs to know.
|
||||
*
|
||||
* @return array array of column definitions
|
||||
*/
|
||||
function table()
|
||||
{
|
||||
return array('notice_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
|
||||
'verb' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
|
||||
'object' => DB_DATAOBJECT_STR);
|
||||
}
|
||||
|
||||
/**
|
||||
* return key definitions for DB_DataObject
|
||||
*
|
||||
* DB_DataObject needs to know about keys that the table has, since it
|
||||
* won't appear in StatusNet's own keys list. In most cases, this will
|
||||
* simply reference your keyTypes() function.
|
||||
*
|
||||
* @return array list of key field names
|
||||
*/
|
||||
|
||||
function keys()
|
||||
{
|
||||
return array_keys($this->keyTypes());
|
||||
}
|
||||
|
||||
/**
|
||||
* return key definitions for Memcached_DataObject
|
||||
*
|
||||
* Our caching system uses the same key definitions, but uses a different
|
||||
* method to get them. This key information is used to store and clear
|
||||
* cached data, so be sure to list any key that will be used for static
|
||||
* lookups.
|
||||
*
|
||||
* @return array associative array of key definitions, field name to type:
|
||||
* 'K' for primary key: for compound keys, add an entry for each component;
|
||||
* 'U' for unique keys: compound keys are not well supported here.
|
||||
*/
|
||||
function keyTypes()
|
||||
{
|
||||
return array('notice_id' => 'K');
|
||||
}
|
||||
|
||||
/**
|
||||
* Magic formula for non-autoincrementing integer primary keys
|
||||
*
|
||||
* If a table has a single integer column as its primary key, DB_DataObject
|
||||
* assumes that the column is auto-incrementing and makes a sequence table
|
||||
* to do this incrementation. Since we don't need this for our class, we
|
||||
* overload this method and return the magic formula that DB_DataObject needs.
|
||||
*
|
||||
* @return array magic three-false array that stops auto-incrementing.
|
||||
*/
|
||||
|
||||
function sequenceKey()
|
||||
{
|
||||
return array(false, false, false);
|
||||
}
|
||||
|
||||
static function setActivity($notice_id, $verb, $object=null)
|
||||
{
|
||||
$act = self::staticGet('notice_id', $notice_id);
|
||||
|
||||
if (empty($act)) {
|
||||
$act = new Notice_activity();
|
||||
$act->notice_id = $notice_id;
|
||||
$act->verb = $verb;
|
||||
$act->object = $object;
|
||||
$act->insert();
|
||||
} else {
|
||||
$orig = clone($act);
|
||||
$act->verb = $verb;
|
||||
$act->object = $object;
|
||||
$act->update($orig);
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user