1
0
mirror of https://github.com/flarum/core.git synced 2025-08-22 08:04:37 +02:00

Update for new API

This commit is contained in:
Toby Zerner
2015-07-23 16:40:54 +09:30
parent 5ea3579f76
commit 3729a91be3
34 changed files with 712 additions and 406 deletions

View File

@@ -0,0 +1,18 @@
<?php namespace Flarum\Subscriptions;
use Flarum\Support\Extension as BaseExtension;
use Illuminate\Events\Dispatcher;
class Extension extends BaseExtension
{
public function boot(Dispatcher $events)
{
$this->loadViewsFrom(__DIR__.'/../views', 'subscriptions');
$events->subscribe('Flarum\Subscriptions\Listeners\AddClientAssets');
$events->subscribe('Flarum\Subscriptions\Listeners\AddApiAttributes');
$events->subscribe('Flarum\Subscriptions\Listeners\PersistSubscriptionData');
$events->subscribe('Flarum\Subscriptions\Listeners\NotifyNewPosts');
$events->subscribe('Flarum\Subscriptions\Listeners\HideIgnoredDiscussions');
}
}

View File

@@ -0,0 +1,24 @@
<?php namespace Flarum\Subscriptions\Gambits;
use Flarum\Core\Search\Search;
use Flarum\Core\Search\RegexGambit;
class SubscriptionGambit extends RegexGambit
{
protected $pattern = 'is:(follow|ignor)(?:ing|ed)';
protected function conditions(Search $search, array $matches, $negate)
{
$actor = $search->getActor();
// might be better as `id IN (subquery)`?
$method = $negate ? 'whereNotExists' : 'whereExists';
$search->getQuery()->$method(function ($query) use ($actor, $matches) {
$query->select(app('db')->raw(1))
->from('users_discussions')
->whereRaw('discussion_id = discussions.id')
->where('user_id', $actor->id)
->where('subscription', $matches[1] === 'follow' ? 'follow' : 'ignore');
});
}
}

View File

@@ -1,31 +0,0 @@
<?php namespace Flarum\Subscriptions\Handlers;
use Flarum\Core\Events\DiscussionWillBeSaved;
class SubscriptionSaver
{
public function subscribe($events)
{
$events->listen('Flarum\Core\Events\DiscussionWillBeSaved', __CLASS__.'@whenDiscussionWillBeSaved');
}
public function whenDiscussionWillBeSaved(DiscussionWillBeSaved $event)
{
$discussion = $event->discussion;
$data = $event->command->data;
if (isset($data['subscription'])) {
$user = $event->command->user;
$subscription = $data['subscription'];
$state = $discussion->stateFor($user);
if (! in_array($subscription, ['follow', 'ignore'])) {
$subscription = null;
}
$state->subscription = $subscription;
$state->save();
}
}
}

View File

@@ -1,26 +0,0 @@
<?php namespace Flarum\Subscriptions\Handlers;
use Flarum\Core\Events\DiscussionSearchWillBePerformed;
class SubscriptionSearchModifier
{
public function subscribe($events)
{
$events->listen('Flarum\Core\Events\DiscussionSearchWillBePerformed', __CLASS__.'@filterIgnored');
}
public function filterIgnored(DiscussionSearchWillBePerformed $event)
{
if (! $event->criteria->query) {
// might be better as `id IN (subquery)`?
$user = $event->criteria->user;
$event->searcher->getQuery()->whereNotExists(function ($query) use ($user) {
$query->select(app('db')->raw(1))
->from('users_discussions')
->whereRaw('discussion_id = discussions.id')
->where('user_id', $user->id)
->where('subscription', 'ignore');
});
}
}
}

View File

@@ -0,0 +1,21 @@
<?php namespace Flarum\Subscriptions\Listeners;
use Flarum\Events\ApiAttributes;
use Illuminate\Contracts\Events\Dispatcher;
use Flarum\Api\Serializers\DiscussionSerializer;
class AddApiAttributes
{
public function subscribe(Dispatcher $events)
{
$events->listen(ApiAttributes::class, __CLASS__.'@addAttributes');
}
public function addAttributes(ApiAttributes $event)
{
if ($event->serializer instanceof DiscussionSerializer &&
($state = $event->model->state)) {
$event->attributes['subscription'] = $state->subscription ?: false;
}
}
}

View File

@@ -0,0 +1,51 @@
<?php namespace Flarum\Subscriptions\Listeners;
use Flarum\Events\RegisterLocales;
use Flarum\Events\BuildClientView;
use Flarum\Events\RegisterForumRoutes;
use Illuminate\Contracts\Events\Dispatcher;
class AddClientAssets
{
public function subscribe(Dispatcher $events)
{
$events->listen(RegisterLocales::class, __CLASS__.'@addLocale');
$events->listen(BuildClientView::class, __CLASS__.'@addAssets');
$events->listen(RegisterForumRoutes::class, __CLASS__.'@addRoutes');
}
public function addLocale(RegisterLocales $event)
{
$event->addTranslations('en', __DIR__.'/../../locale/en.yml');
}
public function addAssets(BuildClientView $event)
{
$event->forumAssets([
__DIR__.'/../../js/forum/dist/extension.js',
__DIR__.'/../../less/forum/extension.less'
]);
$event->forumBootstrapper('subscriptions/main');
$event->forumTranslations([
'subscriptions.following',
'subscriptions.ignoring',
'subscriptions.follow',
'subscriptions.unfollow',
'subscriptions.ignore',
'subscriptions.notify_new_post',
'subscriptions.new_post_notification',
'subscriptions.not_following',
'subscriptions.not_following_description',
'subscriptions.following_description',
'subscriptions.ignoring_description',
'subscriptions.unignore'
]);
}
public function addRoutes(RegisterForumRoutes $event)
{
$event->get('/following', 'flarum.forum.following');
}
}

View File

@@ -0,0 +1,33 @@
<?php namespace Flarum\Subscriptions\Listeners;
use Flarum\Events\RegisterDiscussionGambits;
use Flarum\Events\DiscussionSearchWillBePerformed;
class HideIgnoredDiscussions
{
public function subscribe($events)
{
$events->listen(RegisterDiscussionGambits::class, __CLASS__.'@addGambit');
$events->listen(DiscussionSearchWillBePerformed::class, __CLASS__.'@filterIgnored');
}
public function addGambit(RegisterDiscussionGambits $event)
{
$event->gambits->add('Flarum\Subscriptions\Gambits\SubscriptionGambit');
}
public function filterIgnored(DiscussionSearchWillBePerformed $event)
{
if (! $event->criteria->query) {
// might be better as `id IN (subquery)`?
$actor = $event->search->getActor();
$event->search->getQuery()->whereNotExists(function ($query) use ($actor) {
$query->select(app('flarum.db')->raw(1))
->from('users_discussions')
->whereRaw('discussion_id = discussions.id')
->where('user_id', $actor->id)
->where('subscription', 'ignore');
});
}
}
}

View File

@@ -1,14 +1,15 @@
<?php namespace Flarum\Subscriptions\Handlers;
<?php namespace Flarum\Subscriptions\Listeners;
use Flarum\Subscriptions\NewPostNotification;
use Flarum\Core\Events\PostWasPosted;
use Flarum\Core\Events\PostWasHidden;
use Flarum\Core\Events\PostWasRestored;
use Flarum\Core\Events\PostWasDeleted;
use Flarum\Subscriptions\Notifications\NewPostBlueprint;
use Flarum\Events\RegisterNotificationTypes;
use Flarum\Events\PostWasPosted;
use Flarum\Events\PostWasHidden;
use Flarum\Events\PostWasRestored;
use Flarum\Events\PostWasDeleted;
use Flarum\Core\Notifications\NotificationSyncer;
use Illuminate\Contracts\Events\Dispatcher;
class NewPostNotifier
class NotifyNewPosts
{
protected $notifications;
@@ -17,20 +18,26 @@ class NewPostNotifier
$this->notifications = $notifications;
}
/**
* Register the listeners for the subscriber.
*
* @param \Illuminate\Contracts\Events\Dispatcher $events
*/
public function subscribe(Dispatcher $events)
{
$events->listen(RegisterNotificationTypes::class, __CLASS__.'@addNotificationType');
// Register with '1' as priority so this runs before discussion metadata
// is updated, as we need to compare the user's last read number to that
// of the previous post.
$events->listen('Flarum\Core\Events\PostWasPosted', __CLASS__.'@whenPostWasPosted', 1);
$events->listen('Flarum\Core\Events\PostWasHidden', __CLASS__.'@whenPostWasHidden');
$events->listen('Flarum\Core\Events\PostWasRestored', __CLASS__.'@whenPostWasRestored');
$events->listen('Flarum\Core\Events\PostWasDeleted', __CLASS__.'@whenPostWasDeleted');
$events->listen(PostWasPosted::class, __CLASS__.'@whenPostWasPosted', 1);
$events->listen(PostWasHidden::class, __CLASS__.'@whenPostWasHidden');
$events->listen(PostWasRestored::class, __CLASS__.'@whenPostWasRestored');
$events->listen(PostWasDeleted::class, __CLASS__.'@whenPostWasDeleted');
}
public function addNotificationType(RegisterNotificationTypes $event)
{
$event->register(
NewPostBlueprint::class,
'Flarum\Api\Serializers\DiscussionBasicSerializer',
['alert', 'email']
);
}
public function whenPostWasPosted(PostWasPosted $event)
@@ -67,6 +74,6 @@ class NewPostNotifier
protected function getNotification($post)
{
return new NewPostNotification($post);
return new NewPostBlueprint($post);
}
}

View File

@@ -0,0 +1,31 @@
<?php namespace Flarum\Subscriptions\Listeners;
use Flarum\Events\DiscussionWillBeSaved;
class PersistSubscriptionData
{
public function subscribe($events)
{
$events->listen(DiscussionWillBeSaved::class, __CLASS__.'@whenDiscussionWillBeSaved');
}
public function whenDiscussionWillBeSaved(DiscussionWillBeSaved $event)
{
$discussion = $event->discussion;
$data = $event->data;
if (isset($data['attributes']['subscription'])) {
$actor = $event->actor;
$subscription = $data['attributes']['subscription'];
$state = $discussion->stateFor($actor);
if (! in_array($subscription, ['follow', 'ignore'])) {
$subscription = null;
}
$state->subscription = $subscription;
$state->save();
}
}
}

View File

@@ -1,10 +1,11 @@
<?php namespace Flarum\Subscriptions;
<?php namespace Flarum\Subscriptions\Notifications;
use Flarum\Core\Models\Post;
use Flarum\Core\Models\User;
use Flarum\Core\Notifications\NotificationAbstract;
use Flarum\Core\Posts\Post;
use Flarum\Core\Users\User;
use Flarum\Core\Notifications\Blueprint;
use Flarum\Core\Notifications\MailableBlueprint;
class NewPostNotification extends NotificationAbstract
class NewPostBlueprint implements Blueprint, MailableBlueprint
{
public $post;
@@ -30,7 +31,7 @@ class NewPostNotification extends NotificationAbstract
public function getEmailView()
{
return ['text' => 'flarum-subscriptions::emails.newPost'];
return ['text' => 'subscriptions::emails.newPost'];
}
public function getEmailSubject()
@@ -45,11 +46,6 @@ class NewPostNotification extends NotificationAbstract
public static function getSubjectModel()
{
return 'Flarum\Core\Models\Discussion';
}
public static function isEmailable()
{
return true;
return 'Flarum\Core\Discussions\Discussion';
}
}

View File

@@ -1,37 +0,0 @@
<?php namespace Flarum\Subscriptions;
use Flarum\Core\Search\SearcherInterface;
use Flarum\Core\Search\GambitAbstract;
class SubscriptionGambit extends GambitAbstract
{
/**
* The gambit's regex pattern.
*
* @var string
*/
protected $pattern = 'is:(follow|ignor)(?:ing|ed)';
/**
* Apply conditions to the searcher, given matches from the gambit's
* regex.
*
* @param array $matches The matches from the gambit's regex.
* @param \Flarum\Core\Search\SearcherInterface $searcher
* @return void
*/
protected function conditions(SearcherInterface $searcher, array $matches, $negate)
{
$user = $searcher->getUser();
// might be better as `id IN (subquery)`?
$method = $negate ? 'whereNotExists' : 'whereExists';
$searcher->getQuery()->$method(function ($query) use ($user, $matches) {
$query->select(app('db')->raw(1))
->from('users_discussions')
->whereRaw('discussion_id = discussions.id')
->where('user_id', $user->id)
->where('subscription', $matches[1] === 'follow' ? 'follow' : 'ignore');
});
}
}

View File

@@ -1,59 +0,0 @@
<?php namespace Flarum\Subscriptions;
use Flarum\Support\ServiceProvider;
use Flarum\Extend;
class SubscriptionsServiceProvider extends ServiceProvider
{
/**
* Bootstrap the application events.
*
* @return void
*/
public function boot()
{
$this->loadViewsFrom(__DIR__.'/../views', 'flarum-subscriptions');
$this->extend([
(new Extend\Locale('en'))->translations(__DIR__.'/../locale/en.yml'),
(new Extend\ForumClient())
->assets([
__DIR__.'/../js/dist/extension.js',
__DIR__.'/../less/extension.less'
])
->translations([
// Add the keys of translations you would like to be available
// for use by the JS client application.
])
->route('get', '/following', 'flarum.forum.following'),
(new Extend\ApiSerializer('Flarum\Api\Serializers\DiscussionSerializer'))
->attributes(function (&$attributes, $discussion, $user) {
if ($state = $discussion->stateFor($user)) {
$attributes['subscription'] = $state->subscription ?: false;
}
}),
new Extend\EventSubscriber('Flarum\Subscriptions\Handlers\SubscriptionSaver'),
new Extend\EventSubscriber('Flarum\Subscriptions\Handlers\SubscriptionSearchModifier'),
new Extend\EventSubscriber('Flarum\Subscriptions\Handlers\NewPostNotifier'),
new Extend\DiscussionGambit('Flarum\Subscriptions\SubscriptionGambit'),
(new Extend\NotificationType('Flarum\Subscriptions\NewPostNotification', 'Flarum\Api\Serializers\DiscussionBasicSerializer'))
->enableByDefault('alert')
->enableByDefault('email')
]);
}
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
//
}
}