2014-06-24 22:52:54 +09:00
|
|
|
<?php
|
2019-09-11 15:46:30 +09:00
|
|
|
// This file is part of GNU social - https://www.gnu.org/software/social
|
|
|
|
//
|
|
|
|
// GNU social 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.
|
|
|
|
//
|
|
|
|
// GNU social 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 GNU social. If not, see <http://www.gnu.org/licenses/>.
|
2014-06-24 22:52:54 +09:00
|
|
|
|
|
|
|
/**
|
2019-09-11 15:46:30 +09:00
|
|
|
* @package Favorite
|
|
|
|
* @author Mikael Nordfeldth <mmn@hethane.se>
|
|
|
|
* @copyright 2014 Free Software Foundation, Inc http://www.fsf.org
|
|
|
|
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
|
2014-06-24 22:52:54 +09:00
|
|
|
*/
|
2019-09-11 15:46:30 +09:00
|
|
|
|
|
|
|
defined('GNUSOCIAL') || die();
|
|
|
|
|
2019-08-12 23:03:30 +09:00
|
|
|
class FavoriteModule extends ActivityVerbHandlerModule
|
2014-06-24 22:52:54 +09:00
|
|
|
{
|
2019-06-03 09:56:52 +09:00
|
|
|
const PLUGIN_VERSION = '2.0.0';
|
|
|
|
|
2014-07-28 06:25:49 +09:00
|
|
|
protected $email_notify_fave = 1;
|
2014-07-14 00:13:05 +09:00
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
public function tag()
|
|
|
|
{
|
|
|
|
return 'favorite';
|
|
|
|
}
|
|
|
|
|
|
|
|
public function types()
|
|
|
|
{
|
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
|
|
|
public function verbs()
|
|
|
|
{
|
2015-03-10 23:39:35 +09:00
|
|
|
return array(ActivityVerb::FAVORITE, ActivityVerb::LIKE,
|
|
|
|
ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE);
|
2014-06-27 20:58:35 +09:00
|
|
|
}
|
2015-03-10 23:39:35 +09:00
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
public function onCheckSchema()
|
|
|
|
{
|
|
|
|
$schema = Schema::get();
|
|
|
|
$schema->ensureTable('fave', Fave::schemaDef());
|
|
|
|
return true;
|
|
|
|
}
|
2014-07-14 00:13:05 +09:00
|
|
|
|
2015-02-04 05:58:58 +09:00
|
|
|
public function initialize()
|
|
|
|
{
|
|
|
|
common_config_set('email', 'notify_fave', $this->email_notify_fave);
|
|
|
|
}
|
|
|
|
|
2014-07-14 00:13:05 +09:00
|
|
|
public function onStartUpgrade()
|
|
|
|
{
|
|
|
|
// This is a migration feature that will make sure we move
|
|
|
|
// certain User preferences to the Profile_prefs table.
|
|
|
|
// Introduced after commit b5fd2a048fc621ea05d756caba17275ab3dd0af4
|
|
|
|
// on Sun Jul 13 16:30:37 2014 +0200
|
|
|
|
$user = new User();
|
|
|
|
$user->whereAdd('emailnotifyfav IS NOT NULL');
|
|
|
|
if ($user->find()) {
|
|
|
|
printfnq("Detected old User table (emailnotifyfav IS NOT NULL). Moving 'emailnotifyfav' property to Profile_prefs...");
|
2014-11-27 22:46:10 +09:00
|
|
|
// First we'll make sure Profile_prefs exists
|
|
|
|
$schema = Schema::get();
|
|
|
|
$schema->ensureTable('profile_prefs', Profile_prefs::schemaDef());
|
|
|
|
|
2014-07-14 00:13:05 +09:00
|
|
|
// Make sure we have our own tables setup properly
|
|
|
|
while ($user->fetch()) {
|
|
|
|
$user->setPref('email', 'notify_fave', $user->emailnotifyfav);
|
|
|
|
$orig = clone($user);
|
|
|
|
$user->emailnotifyfav = 'null'; // flag this preference as migrated
|
|
|
|
$user->update($orig);
|
|
|
|
}
|
|
|
|
printfnq("DONE.\n");
|
|
|
|
}
|
|
|
|
}
|
2015-03-10 23:39:35 +09:00
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
public function onEndUpgrade()
|
|
|
|
{
|
|
|
|
printfnq("Ensuring all faves have a URI...");
|
2015-03-10 23:39:35 +09:00
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
$fave = new Fave();
|
|
|
|
$fave->whereAdd('uri IS NULL');
|
2015-03-10 23:39:35 +09:00
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
if ($fave->find()) {
|
|
|
|
while ($fave->fetch()) {
|
|
|
|
try {
|
|
|
|
$fave->decache();
|
2019-09-11 15:46:30 +09:00
|
|
|
$fave->query(sprintf(
|
|
|
|
"UPDATE fave SET uri = '%s', modified = TIMESTAMP '%s' " .
|
|
|
|
'WHERE user_id = %d AND notice_id = %d',
|
|
|
|
Fave::newUri($fave->getActor(), $fave->getTarget(), $fave->modified),
|
|
|
|
common_sql_date(strtotime($fave->modified)),
|
|
|
|
$fave->user_id,
|
|
|
|
$fave->notice_id
|
|
|
|
));
|
2014-06-27 20:58:35 +09:00
|
|
|
} catch (Exception $e) {
|
|
|
|
common_log(LOG_ERR, "Error updating fave URI: " . $e->getMessage());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2015-03-10 23:39:35 +09:00
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
printfnq("DONE.\n");
|
|
|
|
}
|
|
|
|
|
2014-06-24 22:52:54 +09:00
|
|
|
public function onRouterInitialized(URLMapper $m)
|
|
|
|
{
|
|
|
|
// Web UI actions
|
2019-09-11 15:46:30 +09:00
|
|
|
$m->connect(
|
|
|
|
'main/favor',
|
|
|
|
['action' => 'favor']
|
|
|
|
);
|
|
|
|
$m->connect(
|
|
|
|
'main/disfavor',
|
|
|
|
['action' => 'disfavor']
|
|
|
|
);
|
2014-06-24 22:52:54 +09:00
|
|
|
|
|
|
|
if (common_config('singleuser', 'enabled')) {
|
|
|
|
$nickname = User::singleUserNickname();
|
|
|
|
|
2019-09-11 15:46:30 +09:00
|
|
|
$m->connect(
|
|
|
|
'favorites',
|
|
|
|
[
|
|
|
|
'action' => 'showfavorites',
|
|
|
|
'nickname' => $nickname,
|
|
|
|
]
|
|
|
|
);
|
|
|
|
$m->connect(
|
|
|
|
'favoritesrss',
|
|
|
|
[
|
|
|
|
'action' => 'favoritesrss',
|
|
|
|
'nickname' => $nickname,
|
|
|
|
]
|
|
|
|
);
|
2014-06-24 22:52:54 +09:00
|
|
|
} else {
|
2019-09-11 15:46:30 +09:00
|
|
|
$m->connect(
|
|
|
|
'favoritedrss',
|
|
|
|
['action' => 'favoritedrss']
|
|
|
|
);
|
|
|
|
$m->connect(
|
|
|
|
'favorited/',
|
|
|
|
['action' => 'favorited']
|
|
|
|
);
|
|
|
|
$m->connect(
|
|
|
|
'favorited',
|
|
|
|
['action' => 'favorited']
|
|
|
|
);
|
|
|
|
|
|
|
|
$m->connect(
|
|
|
|
':nickname/favorites',
|
|
|
|
['action' => 'showfavorites'],
|
|
|
|
['nickname' => Nickname::DISPLAY_FMT]
|
|
|
|
);
|
|
|
|
$m->connect(
|
|
|
|
':nickname/favorites/rss',
|
|
|
|
['action' => 'favoritesrss'],
|
|
|
|
['nickname' => Nickname::DISPLAY_FMT]
|
|
|
|
);
|
2014-06-24 22:52:54 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
// Favorites for API
|
2019-09-11 15:46:30 +09:00
|
|
|
$m->connect(
|
|
|
|
'api/favorites/create.:format',
|
|
|
|
['action' => 'ApiFavoriteCreate'],
|
|
|
|
['format' => '(xml|json)']
|
|
|
|
);
|
|
|
|
$m->connect(
|
|
|
|
'api/favorites/destroy.:format',
|
|
|
|
['action' => 'ApiFavoriteDestroy'],
|
|
|
|
['format' => '(xml|json)']
|
|
|
|
);
|
|
|
|
$m->connect(
|
|
|
|
'api/favorites/list.:format',
|
|
|
|
['action' => 'ApiTimelineFavorites'],
|
|
|
|
['format' => '(xml|json|rss|atom|as)']
|
|
|
|
);
|
|
|
|
$m->connect(
|
|
|
|
'api/favorites/:id.:format',
|
|
|
|
['action' => 'ApiTimelineFavorites'],
|
|
|
|
[
|
|
|
|
'id' => Nickname::INPUT_FMT,
|
|
|
|
'format' => '(xml|json|rss|atom|as)',
|
|
|
|
]
|
|
|
|
);
|
|
|
|
$m->connect(
|
|
|
|
'api/favorites.:format',
|
|
|
|
['action' => 'ApiTimelineFavorites'],
|
|
|
|
['format' => '(xml|json|rss|atom|as)']
|
|
|
|
);
|
|
|
|
$m->connect(
|
|
|
|
'api/favorites/create/:id.:format',
|
|
|
|
['action' => 'ApiFavoriteCreate'],
|
|
|
|
[
|
|
|
|
'id' => '[0-9]+',
|
|
|
|
'format' => '(xml|json)',
|
|
|
|
]
|
|
|
|
);
|
|
|
|
$m->connect(
|
|
|
|
'api/favorites/destroy/:id.:format',
|
|
|
|
['action' => 'ApiFavoriteDestroy'],
|
|
|
|
[
|
|
|
|
'id' => '[0-9]+',
|
|
|
|
'format' => '(xml|json)',
|
|
|
|
]
|
|
|
|
);
|
2014-06-24 22:52:54 +09:00
|
|
|
|
|
|
|
// AtomPub API
|
2019-09-11 15:46:30 +09:00
|
|
|
$m->connect(
|
|
|
|
'api/statusnet/app/favorites/:profile/:notice.atom',
|
|
|
|
['action' => 'AtomPubShowFavorite'],
|
|
|
|
[
|
|
|
|
'profile' => '[0-9]+',
|
|
|
|
'notice' => '[0-9]+',
|
|
|
|
]
|
|
|
|
);
|
|
|
|
|
|
|
|
$m->connect(
|
|
|
|
'api/statusnet/app/favorites/:profile.atom',
|
|
|
|
['action' => 'AtomPubFavoriteFeed'],
|
|
|
|
['profile' => '[0-9]+']
|
|
|
|
);
|
2014-06-24 22:52:54 +09:00
|
|
|
|
|
|
|
// Required for qvitter API
|
2019-09-11 15:46:30 +09:00
|
|
|
$m->connect(
|
|
|
|
'api/statuses/favs/:id.:format',
|
|
|
|
['action' => 'ApiStatusesFavs'],
|
|
|
|
[
|
|
|
|
'id' => '[0-9]+',
|
|
|
|
'format' => '(xml|json)',
|
|
|
|
]
|
|
|
|
);
|
2014-06-24 22:52:54 +09:00
|
|
|
}
|
|
|
|
|
2019-08-02 10:50:48 +09:00
|
|
|
// FIXME: Set this to abstract public in lib/modules/ActivityHandlerPlugin.php when all plugins have migrated!
|
2015-03-10 23:39:35 +09:00
|
|
|
protected function saveObjectFromActivity(Activity $act, Notice $stored, array $options=array())
|
2014-07-02 06:25:58 +09:00
|
|
|
{
|
|
|
|
assert($this->isMyActivity($act));
|
2014-07-02 07:22:27 +09:00
|
|
|
|
|
|
|
// We must have an objects[0] here because in isMyActivity we require the count to be == 1
|
|
|
|
$actobj = $act->objects[0];
|
|
|
|
|
2014-07-15 21:12:39 +09:00
|
|
|
$object = Fave::saveActivityObject($actobj, $stored);
|
2015-03-13 06:17:08 +09:00
|
|
|
|
2014-07-02 06:25:58 +09:00
|
|
|
return $object;
|
|
|
|
}
|
|
|
|
|
2019-08-02 10:50:48 +09:00
|
|
|
// FIXME: Put this in lib/modules/ActivityHandlerPlugin.php when we're ready
|
2014-07-28 17:02:53 +09:00
|
|
|
// with the other microapps/activityhandlers as well.
|
|
|
|
// Also it should be StartNoticeAsActivity (with a prepped Activity, including ->context etc.)
|
|
|
|
public function onEndNoticeAsActivity(Notice $stored, Activity $act, Profile $scoped=null)
|
|
|
|
{
|
|
|
|
if (!$this->isMyNotice($stored)) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->extendActivity($stored, $act, $scoped);
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
|
|
|
|
{
|
|
|
|
Fave::extendActivity($stored, $act, $scoped);
|
|
|
|
}
|
2014-07-02 06:25:58 +09:00
|
|
|
|
2014-07-02 18:37:46 +09:00
|
|
|
public function activityObjectFromNotice(Notice $notice)
|
|
|
|
{
|
2014-07-02 06:25:58 +09:00
|
|
|
$fave = Fave::fromStored($notice);
|
|
|
|
return $fave->asActivityObject();
|
2014-07-02 18:37:46 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
public function deleteRelated(Notice $notice)
|
|
|
|
{
|
2014-07-02 06:25:58 +09:00
|
|
|
try {
|
|
|
|
$fave = Fave::fromStored($notice);
|
|
|
|
$fave->delete();
|
|
|
|
} catch (NoResultException $e) {
|
|
|
|
// Cool, no problem. We wanted to get rid of it anyway.
|
|
|
|
}
|
2014-07-02 18:37:46 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
// API stuff
|
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
/**
|
|
|
|
* Typically just used to fill out Twitter-compatible API status data.
|
|
|
|
*
|
|
|
|
* FIXME: Make all the calls before this end up with a Notice instead of ArrayWrapper please...
|
|
|
|
*/
|
|
|
|
public function onNoticeSimpleStatusArray($notice, array &$status, Profile $scoped=null, array $args=array())
|
|
|
|
{
|
|
|
|
if ($scoped instanceof Profile) {
|
|
|
|
$status['favorited'] = Fave::existsForProfile($notice, $scoped);
|
|
|
|
} else {
|
|
|
|
$status['favorited'] = false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2014-06-28 20:11:03 +09:00
|
|
|
public function onTwitterUserArray(Profile $profile, array &$userdata, Profile $scoped=null, array $args=array())
|
|
|
|
{
|
|
|
|
$userdata['favourites_count'] = Fave::countByProfile($profile);
|
|
|
|
}
|
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
/**
|
|
|
|
* Typically just used to fill out StatusNet specific data in API calls in the referenced $info array.
|
|
|
|
*/
|
|
|
|
public function onStatusNetApiNoticeInfo(Notice $notice, array &$info, Profile $scoped=null, array $args=array())
|
|
|
|
{
|
|
|
|
if ($scoped instanceof Profile) {
|
|
|
|
$info['favorite'] = Fave::existsForProfile($notice, $scoped) ? 'true' : 'false';
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
2015-03-10 23:39:35 +09:00
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
public function onNoticeDeleteRelated(Notice $notice)
|
|
|
|
{
|
2014-07-02 18:37:46 +09:00
|
|
|
parent::onNoticeDeleteRelated($notice);
|
|
|
|
|
2014-07-02 06:25:58 +09:00
|
|
|
// The below algorithm is because we want to delete fave
|
|
|
|
// activities on any notice which _has_ faves, and not as
|
|
|
|
// in the parent function only ones that _are_ faves.
|
2014-07-02 18:37:46 +09:00
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
$fave = new Fave();
|
|
|
|
$fave->notice_id = $notice->id;
|
|
|
|
|
|
|
|
if ($fave->find()) {
|
|
|
|
while ($fave->fetch()) {
|
|
|
|
$fave->delete();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$fave->free();
|
|
|
|
}
|
|
|
|
|
2015-03-09 23:01:05 +09:00
|
|
|
public function onProfileDeleteRelated(Profile $profile, array &$related)
|
2014-06-28 20:11:03 +09:00
|
|
|
{
|
|
|
|
$fave = new Fave();
|
2015-03-09 23:01:05 +09:00
|
|
|
$fave->user_id = $profile->id;
|
2014-06-28 20:11:03 +09:00
|
|
|
$fave->delete(); // Will perform a DELETE matching "user_id = {$user->id}"
|
2015-03-09 23:01:05 +09:00
|
|
|
$fave->free();
|
2014-06-28 20:11:03 +09:00
|
|
|
|
2015-03-09 23:01:05 +09:00
|
|
|
Fave::blowCacheForProfileId($profile->id);
|
2014-06-28 20:11:03 +09:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
public function onStartNoticeListPrefill(array &$notices, array $notice_ids, Profile $scoped=null)
|
|
|
|
{
|
|
|
|
// prefill array of objects, before pluginfication it was Notice::fillFaves($notices)
|
|
|
|
Fave::fillFaves($notice_ids);
|
|
|
|
|
|
|
|
// DB caching
|
|
|
|
if ($scoped instanceof Profile) {
|
|
|
|
Fave::pivotGet('notice_id', $notice_ids, array('user_id' => $scoped->id));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* show the "favorite" form in the notice options element
|
|
|
|
* FIXME: Don't let a NoticeListItemAdapter slip in here (or extend that from NoticeListItem)
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function onStartShowNoticeOptionItems($nli)
|
|
|
|
{
|
|
|
|
if (Event::handle('StartShowFaveForm', array($nli))) {
|
|
|
|
$scoped = Profile::current();
|
|
|
|
if ($scoped instanceof Profile) {
|
|
|
|
if (Fave::existsForProfile($nli->notice, $scoped)) {
|
|
|
|
$disfavor = new DisfavorForm($nli->out, $nli->notice);
|
|
|
|
$disfavor->show();
|
|
|
|
} else {
|
|
|
|
$favor = new FavorForm($nli->out, $nli->notice);
|
|
|
|
$favor->show();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Event::handle('EndShowFaveForm', array($nli));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-09-29 22:17:38 +09:00
|
|
|
protected function showNoticeListItem(NoticeListItem $nli)
|
2014-07-04 21:14:49 +09:00
|
|
|
{
|
|
|
|
// pass
|
|
|
|
}
|
|
|
|
public function openNoticeListItemElement(NoticeListItem $nli)
|
|
|
|
{
|
|
|
|
// pass
|
|
|
|
}
|
|
|
|
public function closeNoticeListItemElement(NoticeListItem $nli)
|
|
|
|
{
|
|
|
|
// pass
|
|
|
|
}
|
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
|
|
|
|
{
|
|
|
|
$fave = new Fave();
|
2015-01-23 19:58:11 +09:00
|
|
|
$fave->user_id = $uas->getUser()->id;
|
2014-06-27 20:58:35 +09:00
|
|
|
|
|
|
|
if (!empty($uas->after)) {
|
|
|
|
$fave->whereAdd("modified > '" . common_sql_date($uas->after) . "'");
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($fave->find()) {
|
|
|
|
while ($fave->fetch()) {
|
2015-02-13 19:52:29 +09:00
|
|
|
$objs[] = clone($fave);
|
2014-06-27 20:58:35 +09:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-02-13 19:52:29 +09:00
|
|
|
return true;
|
2014-06-27 20:58:35 +09:00
|
|
|
}
|
|
|
|
|
2015-03-13 03:49:20 +09:00
|
|
|
public function onEndShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
|
2014-06-27 20:58:35 +09:00
|
|
|
{
|
|
|
|
if ($nli instanceof ThreadedNoticeListSubItem) {
|
|
|
|
// The sub-items are replies to a conversation, thus we use different HTML elements etc.
|
|
|
|
$item = new ThreadedNoticeListInlineFavesItem($notice, $nli->out);
|
|
|
|
} else {
|
|
|
|
$item = new ThreadedNoticeListFavesItem($notice, $nli->out);
|
|
|
|
}
|
|
|
|
$threadActive = $item->show() || $threadActive;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2015-02-04 00:28:33 +09:00
|
|
|
public function onEndFavorNotice(Profile $actor, Notice $target)
|
|
|
|
{
|
|
|
|
try {
|
|
|
|
$notice_author = $target->getProfile();
|
|
|
|
// Don't notify ourselves of our own favorite on our own notice,
|
|
|
|
// or if it's a remote user (since we don't know their email addresses etc.)
|
|
|
|
if ($notice_author->id == $actor->id || !$notice_author->isLocal()) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
$local_user = $notice_author->getUser();
|
|
|
|
mail_notify_fave($local_user, $actor, $target);
|
|
|
|
} catch (Exception $e) {
|
|
|
|
// Mm'kay, probably not a local user. Let's skip this favor notification.
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-06-27 20:58:35 +09:00
|
|
|
/**
|
|
|
|
* EndInterpretCommand for FavoritePlugin will handle the 'fav' command
|
|
|
|
* using the class FavCommand.
|
|
|
|
*
|
|
|
|
* @param string $cmd Command being run
|
|
|
|
* @param string $arg Rest of the message (including address)
|
|
|
|
* @param User $user User sending the message
|
|
|
|
* @param Command &$result The resulting command object to be run.
|
|
|
|
*
|
|
|
|
* @return boolean hook value
|
|
|
|
*/
|
|
|
|
public function onStartInterpretCommand($cmd, $arg, $user, &$result)
|
|
|
|
{
|
|
|
|
if ($result === false && $cmd == 'fav') {
|
|
|
|
if (empty($arg)) {
|
|
|
|
$result = null;
|
|
|
|
} else {
|
2014-11-08 00:23:47 +09:00
|
|
|
list($other, $extra) = CommandInterpreter::split_arg($arg);
|
2014-06-27 20:58:35 +09:00
|
|
|
if (!empty($extra)) {
|
|
|
|
$result = null;
|
|
|
|
} else {
|
|
|
|
$result = new FavCommand($user, $other);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function onHelpCommandMessages(HelpCommand $help, array &$commands)
|
|
|
|
{
|
|
|
|
// TRANS: Help message for IM/SMS command "fav <nickname>".
|
|
|
|
$commands['fav <nickname>'] = _m('COMMANDHELP', "add user's last notice as a 'fave'");
|
|
|
|
// TRANS: Help message for IM/SMS command "fav #<notice_id>".
|
|
|
|
$commands['fav #<notice_id>'] = _m('COMMANDHELP', "add notice with the given id as a 'fave'");
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Are we allowed to perform a certain command over the API?
|
|
|
|
*/
|
2014-11-08 00:13:45 +09:00
|
|
|
public function onCommandSupportedAPI(Command $cmd, &$supported)
|
2014-06-27 20:58:35 +09:00
|
|
|
{
|
|
|
|
$supported = $supported || $cmd instanceof FavCommand;
|
|
|
|
}
|
|
|
|
|
2014-07-14 00:13:05 +09:00
|
|
|
// Form stuff (settings etc.)
|
|
|
|
|
|
|
|
public function onEndEmailFormData(Action $action, Profile $scoped)
|
|
|
|
{
|
2015-02-04 05:58:58 +09:00
|
|
|
$emailfave = $scoped->getConfigPref('email', 'notify_fave') ? 1 : 0;
|
2014-07-14 00:13:05 +09:00
|
|
|
|
|
|
|
$action->elementStart('li');
|
2019-09-11 15:46:30 +09:00
|
|
|
$action->checkbox(
|
|
|
|
'email-notify_fave',
|
|
|
|
// TRANS: Checkbox label in e-mail preferences form.
|
|
|
|
_('Send me email when someone adds my notice as a favorite.'),
|
|
|
|
$emailfave
|
|
|
|
);
|
2014-07-14 00:13:05 +09:00
|
|
|
$action->elementEnd('li');
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function onStartEmailSaveForm(Action $action, Profile $scoped)
|
|
|
|
{
|
2015-03-08 05:57:43 +09:00
|
|
|
$emailfave = $action->booleanintstring('email-notify_fave');
|
2014-07-14 00:13:05 +09:00
|
|
|
try {
|
|
|
|
if ($emailfave == $scoped->getPref('email', 'notify_fave')) {
|
|
|
|
// No need to update setting
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
} catch (NoResultException $e) {
|
|
|
|
// Apparently there's no previously stored setting, then continue to save it as it is now.
|
|
|
|
}
|
|
|
|
|
|
|
|
$scoped->setPref('email', 'notify_fave', $emailfave);
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2014-06-28 20:11:03 +09:00
|
|
|
// Layout stuff
|
|
|
|
|
|
|
|
public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
|
|
|
|
{
|
2019-09-11 15:46:30 +09:00
|
|
|
$menu->out->menuItem(
|
|
|
|
common_local_url('showfavorites', ['nickname' => $target->getNickname()]),
|
|
|
|
// TRANS: Menu item in personal group navigation menu.
|
|
|
|
_m('MENU', 'Favorites'),
|
|
|
|
// @todo i18n FIXME: Need to make this two messages.
|
|
|
|
// TRANS: Menu item title in personal group navigation menu.
|
|
|
|
// TRANS: %s is a username.
|
|
|
|
sprintf(_('%s\'s favorite notices'), $target->getBestName()),
|
|
|
|
($scoped instanceof Profile && $target->id === $scoped->id && $menu->actionName === 'showfavorites'),
|
|
|
|
'nav_timeline_favorites'
|
|
|
|
);
|
2014-06-28 20:11:03 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
public function onEndPublicGroupNav(Menu $menu)
|
|
|
|
{
|
|
|
|
if (!common_config('singleuser', 'enabled')) {
|
|
|
|
// TRANS: Menu item in search group navigation panel.
|
2019-09-11 15:46:30 +09:00
|
|
|
$menu->out->menuItem(
|
|
|
|
common_local_url('favorited'),
|
|
|
|
_m('MENU', 'Popular'),
|
|
|
|
// TRANS: Menu item title in search group navigation panel.
|
|
|
|
_('Popular notices'),
|
|
|
|
($menu->actionName === 'favorited'),
|
|
|
|
'nav_timeline_favorited'
|
|
|
|
);
|
2014-06-28 20:11:03 +09:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-06-28 23:09:46 +09:00
|
|
|
public function onEndShowSections(Action $action)
|
|
|
|
{
|
|
|
|
if (!$action->isAction(array('all', 'public'))) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!common_config('performance', 'high')) {
|
|
|
|
$section = new PopularNoticeSection($action, $action->getScoped());
|
|
|
|
$section->show();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-03-10 23:39:35 +09:00
|
|
|
protected function getActionTitle(ManagedAction $action, $verb, Notice $target, Profile $scoped)
|
|
|
|
{
|
|
|
|
return Fave::existsForProfile($target, $scoped)
|
|
|
|
// TRANS: Page/dialog box title when a notice is marked as favorite already
|
|
|
|
? _m('TITLE', 'Unmark notice as favorite')
|
|
|
|
// TRANS: Page/dialog box title when a notice is not marked as favorite
|
|
|
|
: _m('TITLE', 'Mark notice as favorite');
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function doActionPreparation(ManagedAction $action, $verb, Notice $target, Profile $scoped)
|
|
|
|
{
|
|
|
|
if ($action->isPost()) {
|
|
|
|
// The below tests are only for presenting to the user. POSTs which inflict
|
2019-09-11 15:46:30 +09:00
|
|
|
// duplicate favorite entries are handled with AlreadyFulfilledException.
|
2015-03-10 23:39:35 +09:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
$exists = Fave::existsForProfile($target, $scoped);
|
|
|
|
$expected_verb = $exists ? ActivityVerb::UNFAVORITE : ActivityVerb::FAVORITE;
|
|
|
|
|
|
|
|
switch (true) {
|
2015-09-10 22:27:40 +09:00
|
|
|
case $exists && ActivityUtils::compareVerbs($verb, array(ActivityVerb::FAVORITE, ActivityVerb::LIKE)):
|
|
|
|
case !$exists && ActivityUtils::compareVerbs($verb, array(ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE)):
|
2019-09-11 15:46:30 +09:00
|
|
|
common_redirect(common_local_url(
|
|
|
|
'activityverb',
|
|
|
|
[
|
|
|
|
'id' => $target->getID(),
|
|
|
|
'verb' => ActivityUtils::resolveUri($expected_verb, true),
|
|
|
|
]
|
|
|
|
));
|
2015-03-10 23:39:35 +09:00
|
|
|
break;
|
|
|
|
default:
|
|
|
|
// No need to redirect as we are on the correct action already.
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function doActionPost(ManagedAction $action, $verb, Notice $target, Profile $scoped)
|
|
|
|
{
|
|
|
|
switch (true) {
|
2015-09-10 22:27:40 +09:00
|
|
|
case ActivityUtils::compareVerbs($verb, array(ActivityVerb::FAVORITE, ActivityVerb::LIKE)):
|
2015-03-10 23:39:35 +09:00
|
|
|
Fave::addNew($scoped, $target);
|
|
|
|
break;
|
2015-09-10 22:27:40 +09:00
|
|
|
case ActivityUtils::compareVerbs($verb, array(ActivityVerb::UNFAVORITE, ActivityVerb::UNLIKE)):
|
2015-03-10 23:39:35 +09:00
|
|
|
Fave::removeEntry($scoped, $target);
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
throw new ServerException('ActivityVerb POST not handled by plugin that was supposed to do it.');
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
protected function getActivityForm(ManagedAction $action, $verb, Notice $target, Profile $scoped)
|
|
|
|
{
|
|
|
|
return Fave::existsForProfile($target, $scoped)
|
|
|
|
? new DisfavorForm($action, $target)
|
|
|
|
: new FavorForm($action, $target);
|
|
|
|
}
|
|
|
|
|
2019-08-12 23:03:30 +09:00
|
|
|
public function onModuleVersion(array &$versions): bool
|
2014-06-24 22:52:54 +09:00
|
|
|
{
|
|
|
|
$versions[] = array('name' => 'Favorite',
|
2019-06-03 09:56:52 +09:00
|
|
|
'version' => self::PLUGIN_VERSION,
|
2014-06-24 22:52:54 +09:00
|
|
|
'author' => 'Mikael Nordfeldth',
|
|
|
|
'homepage' => 'http://gnu.io/',
|
|
|
|
'rawdescription' =>
|
|
|
|
// TRANS: Plugin description.
|
|
|
|
_m('Favorites (likes) using ActivityStreams.'));
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
2015-02-04 00:28:33 +09:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Notify a user that one of their notices has been chosen as a 'fave'
|
|
|
|
*
|
|
|
|
* @param User $rcpt The user whose notice was faved
|
|
|
|
* @param Profile $sender The user who faved the notice
|
|
|
|
* @param Notice $notice The notice that was faved
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
function mail_notify_fave(User $rcpt, Profile $sender, Notice $notice)
|
|
|
|
{
|
2015-02-04 05:58:58 +09:00
|
|
|
if (!$rcpt->receivesEmailNotifications() || !$rcpt->getConfigPref('email', 'notify_fave')) {
|
2015-02-04 00:28:33 +09:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
// This test is actually "if the sender is sandboxed"
|
|
|
|
if (!$sender->hasRight(Right::EMAILONFAVE)) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($rcpt->hasBlocked($sender)) {
|
|
|
|
// If the author has blocked us, don't spam them with a notification.
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
// We need the global mail.php for various mail related functions below.
|
2019-08-23 21:36:02 +09:00
|
|
|
require_once INSTALLDIR . '/lib/util/mail.php';
|
2015-02-04 00:28:33 +09:00
|
|
|
|
|
|
|
$bestname = $sender->getBestName();
|
|
|
|
|
|
|
|
common_switch_locale($rcpt->language);
|
|
|
|
|
|
|
|
// TRANS: Subject for favorite notification e-mail.
|
|
|
|
// TRANS: %1$s is the adding user's long name, %2$s is the adding user's nickname.
|
|
|
|
$subject = sprintf(_('%1$s (@%2$s) added your notice as a favorite'), $bestname, $sender->getNickname());
|
|
|
|
|
|
|
|
// TRANS: Body for favorite notification e-mail.
|
|
|
|
// TRANS: %1$s is the adding user's long name, $2$s is the date the notice was created,
|
|
|
|
// TRANS: %3$s is a URL to the faved notice, %4$s is the faved notice text,
|
|
|
|
// TRANS: %5$s is a URL to all faves of the adding user, %6$s is the StatusNet sitename,
|
|
|
|
// TRANS: %7$s is the adding user's nickname.
|
2019-09-11 15:46:30 +09:00
|
|
|
$body = sprintf(
|
|
|
|
_("%1\$s (@%7\$s) just added your notice from %2\$s".
|
|
|
|
" as one of their favorites.\n\n" .
|
|
|
|
"The URL of your notice is:\n\n" .
|
|
|
|
"%3\$s\n\n" .
|
|
|
|
"The text of your notice is:\n\n" .
|
|
|
|
"%4\$s\n\n" .
|
|
|
|
"You can see the list of %1\$s's favorites here:\n\n" .
|
|
|
|
"%5\$s"),
|
|
|
|
$bestname,
|
|
|
|
common_exact_date($notice->created),
|
|
|
|
common_local_url('shownotice', ['notice' => $notice->id]),
|
|
|
|
$notice->content,
|
|
|
|
common_local_url('showfavorites', ['nickname' => $sender->getNickname()]),
|
|
|
|
common_config('site', 'name'),
|
|
|
|
$sender->getNickname()
|
|
|
|
) .
|
2015-02-04 00:28:33 +09:00
|
|
|
mail_footer_block();
|
|
|
|
|
|
|
|
$headers = _mail_prepare_headers('fave', $rcpt->getNickname(), $sender->getNickname());
|
|
|
|
|
|
|
|
common_switch_locale();
|
|
|
|
mail_to_user($rcpt, $subject, $body, $headers);
|
|
|
|
}
|