if (!defined('GNUSOCIAL')) { exit(1); }
/**
- * @package UI
+ * @package Activity
* @maintainer Mikael Nordfeldth <mmn@hethane.se>
*/
-class FavoritePlugin extends Plugin
+class FavoritePlugin extends ActivityHandlerPlugin
{
+ protected $email_notify_fave = 1;
+
+ public function tag()
+ {
+ return 'favorite';
+ }
+
+ public function types()
+ {
+ return array();
+ }
+
+ public function verbs()
+ {
+ return array(ActivityVerb::FAVORITE);
+ }
+
+ public function onCheckSchema()
+ {
+ $schema = Schema::get();
+ $schema->ensureTable('fave', Fave::schemaDef());
+ return true;
+ }
+
+ public function initialize()
+ {
+ common_config_set('email', 'notify_fave', $this->email_notify_fave);
+ }
+
+ 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...");
+ // First we'll make sure Profile_prefs exists
+ $schema = Schema::get();
+ $schema->ensureTable('profile_prefs', Profile_prefs::schemaDef());
+
+ // 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");
+ }
+ }
+
+ public function onEndUpgrade()
+ {
+ printfnq("Ensuring all faves have a URI...");
+
+ $fave = new Fave();
+ $fave->whereAdd('uri IS NULL');
+
+ if ($fave->find()) {
+ while ($fave->fetch()) {
+ try {
+ $fave->decache();
+ $fave->query(sprintf('UPDATE fave '.
+ 'SET uri = "%s", '.
+ ' modified = "%s" '.
+ 'WHERE user_id = %d '.
+ 'AND notice_id = %d',
+ Fave::newUri($fave->user_id, $fave->notice_id, $fave->modified),
+ common_sql_date(strtotime($fave->modified)),
+ $fave->user_id,
+ $fave->notice_id));
+ } catch (Exception $e) {
+ common_log(LOG_ERR, "Error updating fave URI: " . $e->getMessage());
+ }
+ }
+ }
+
+ printfnq("DONE.\n");
+ }
+
public function onRouterInitialized(URLMapper $m)
{
// Web UI actions
'format' => '(xml|json)'));
}
+ // FIXME: Set this to abstract public in lib/activityhandlerplugin.php ddwhen all plugins have migrated!
+ protected function saveObjectFromActivity(Activity $act, Notice $stored, array $options=array())
+ {
+ assert($this->isMyActivity($act));
+
+ // If empty, we should've created it ourselves on our node.
+ if (!isset($options['created'])) {
+ $options['created'] = !empty($act->time) ? common_sql_date($act->time) : common_sql_now();
+ }
+
+ // We must have an objects[0] here because in isMyActivity we require the count to be == 1
+ $actobj = $act->objects[0];
+
+ $object = Fave::saveActivityObject($actobj, $stored);
+ return $object;
+ }
+
+ // FIXME: Put this in lib/activityhandlerplugin.php when we're ready
+ // 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;
+ }
+
+ common_debug('Extending activity '.$stored->id.' with '.get_called_class());
+ $this->extendActivity($stored, $act, $scoped);
+ return false;
+ }
+
+ public function extendActivity(Notice $stored, Activity $act, Profile $scoped=null)
+ {
+ Fave::extendActivity($stored, $act, $scoped);
+ }
+
+ public function activityObjectFromNotice(Notice $notice)
+ {
+ $fave = Fave::fromStored($notice);
+ return $fave->asActivityObject();
+ }
+
+ public function deleteRelated(Notice $notice)
+ {
+ try {
+ $fave = Fave::fromStored($notice);
+ $fave->delete();
+ } catch (NoResultException $e) {
+ // Cool, no problem. We wanted to get rid of it anyway.
+ }
+ }
+
+ // API stuff
+
+ /**
+ * 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;
+ }
+
+ public function onTwitterUserArray(Profile $profile, array &$userdata, Profile $scoped=null, array $args=array())
+ {
+ $userdata['favourites_count'] = Fave::countByProfile($profile);
+ }
+
+ /**
+ * 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;
+ }
+
+ public function onNoticeDeleteRelated(Notice $notice)
+ {
+ parent::onNoticeDeleteRelated($notice);
+
+ // 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.
+
+ $fave = new Fave();
+ $fave->notice_id = $notice->id;
+
+ if ($fave->find()) {
+ while ($fave->fetch()) {
+ $fave->delete();
+ }
+ }
+
+ $fave->free();
+ }
+
+ public function onUserDeleteRelated(User $user, array &$related)
+ {
+ $fave = new Fave();
+ $fave->user_id = $user->id;
+ $fave->delete(); // Will perform a DELETE matching "user_id = {$user->id}"
+
+ Fave::blowCacheForProfileId($user->id);
+ return true;
+ }
+
+ 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));
+ }
+ }
+
+ public function showNoticeListItem(NoticeListItem $nli)
+ {
+ // pass
+ }
+ public function openNoticeListItemElement(NoticeListItem $nli)
+ {
+ // pass
+ }
+ public function closeNoticeListItemElement(NoticeListItem $nli)
+ {
+ // pass
+ }
+
+ public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
+ {
+ $fave = new Fave();
+ $fave->user_id = $uas->getUser()->id;
+
+ if (!empty($uas->after)) {
+ $fave->whereAdd("modified > '" . common_sql_date($uas->after) . "'");
+ }
+
+ if ($fave->find()) {
+ while ($fave->fetch()) {
+ $objs[] = clone($fave);
+ }
+ }
+
+ return true;
+ }
+
+ public function onStartShowThreadedNoticeTailItems(NoticeListItem $nli, Notice $notice, &$threadActive)
+ {
+ 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;
+ }
+
+ 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.
+ }
+ }
+
+ /**
+ * 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 {
+ list($other, $extra) = CommandInterpreter::split_arg($arg);
+ 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?
+ */
+ public function onCommandSupportedAPI(Command $cmd, &$supported)
+ {
+ $supported = $supported || $cmd instanceof FavCommand;
+ }
+
+ // Form stuff (settings etc.)
+
+ public function onEndEmailFormData(Action $action, Profile $scoped)
+ {
+ $emailfave = $scoped->getConfigPref('email', 'notify_fave') ? 1 : 0;
+
+ $action->elementStart('li');
+ $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);
+ $action->elementEnd('li');
+
+ return true;
+ }
+
+ public function onStartEmailSaveForm(Action $action, Profile $scoped)
+ {
+ $emailfave = $action->boolean('email-notify_fave') ? 1 : 0;
+ 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;
+ }
+
+ // Layout stuff
+
+ public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
+ {
+ $menu->out->menuItem(common_local_url('showfavorites', array('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');
+ }
+
+ public function onEndPublicGroupNav(Menu $menu)
+ {
+ if (!common_config('singleuser', 'enabled')) {
+ // TRANS: Menu item in search group navigation panel.
+ $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');
+ }
+ }
+
+ 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();
+ }
+ }
+
public function onPluginVersion(array &$versions)
{
$versions[] = array('name' => 'Favorite',
return true;
}
}
+
+/**
+ * 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)
+{
+ if (!$rcpt->receivesEmailNotifications() || !$rcpt->getConfigPref('email', 'notify_fave')) {
+ 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.
+ require_once INSTALLDIR.'/lib/mail.php';
+
+ $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.
+ $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',
+ array('notice' => $notice->id)),
+ $notice->content,
+ common_local_url('showfavorites',
+ array('nickname' => $sender->getNickname())),
+ common_config('site', 'name'),
+ $sender->getNickname()) .
+ mail_footer_block();
+
+ $headers = _mail_prepare_headers('fave', $rcpt->getNickname(), $sender->getNickname());
+
+ common_switch_locale();
+ mail_to_user($rcpt, $subject, $body, $headers);
+}