Balloon\App\Notification\Api\v1\Notification

Complexity

Total Complexity

14

Size/Duplication

Total Lines	252
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	get()	0	18	2
A	delete()	0	6	1
A	post()	0	7	1
A	postBroadcast()	0	14	2
A	postMail()	0	11	1
B	postSubscribe()	0	33	6

<?php

declare(strict_types=1);

/**
 * Balloon
 *
 * @author      Raffael Sahli <sahli@gyselroth.net>
 * @copyright   Copryright (c) 2012-2017 gyselroth GmbH (https://gyselroth.com)
 * @license     GPL-3.0 https://opensource.org/licenses/GPL-3.0
 */

namespace Balloon\App\Notification\Api\v1;

use Balloon\Api\Controller;
use Balloon\App\Notification\Notifier;
use Balloon\Async\Mail;
use Balloon\Filesystem;
use Balloon\Filesystem\Acl\Exception\Forbidden as ForbiddenException;
use Balloon\Server;
use Balloon\Server\User;
use Micro\Http\Response;
use MongoDB\BSON\ObjectId;
use Psr\Log\LoggerInterface;
use TaskScheduler\Async;
use Zend\Mail\Message;

class Notification extends Controller
{
    /**
     * Notifier.
     *
     * @var Notifier
     */
    protected $notifier;

    /**
     * User.
     *
     * @var User
     */
    protected $user;

    /**
     * Filesystem.
     *
     * @var Filesystem
     */
    protected $fs;

    /**
     * Server.
     *
     * @var Server
     */
    protected $server;

    /**
     * Async.
     *
     * @var Async
     */
    protected $async;

    /**
     * Logger.
     *
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * Constructor.
     *
     * @param Notifier        $notifier
     * @param Server          $server
     * @param Async           $async
     * @param LoggerInterface $logger
     */
    public function __construct(Notifier $notifier, Server $server, Async $async, LoggerInterface $logger)
    {
        $this->notifier = $notifier;
        $this->user = $server->getIdentity();
        $this->fs = $server->getFilesystem();
        $this->server = $server;
        $this->async = $async;
        $this->logger = $logger;
    }

    /**
     * @api {get} /api/v1/notification Get notifications
     * @apiVersion 1.0.0
     * @apiName get
     * @apiGroup App\Notification
     * @apiPermission none
     * @apiDescription Fetch my nofitifications
     *
     * @apiExample (cURL) exmaple:
     * curl -XGET "https://SERVER/api/v1/user/notification"
     *
     * @apiSuccessExample {string} Success-Response:
     * HTTP/1.1 200 OK
     * {
     *      "status": 200,
     *      "data": [{
     *          "message": "Hi there, this is a notification"
     *      }]
     * }
     */
    public function get(): Response
    {
        $body = [];
        foreach ($this->notifier->getNotifications($this->user) as $message) {
            $note = $message;
            $note['id'] = (string) $note['_id'];
            unset($note['_id'], $note['receiver']);

            $note['sender'] = $this->server->getUserById($note['sender'])->getAttribute([
                'id',
                'username',
            ]);

            $body[] = $note;
        }

        return (new Response())->setCode(200)->setBody($body);
    }

    /**
     * @api {delete} /api/v1/notification Delete notification
     * @apiVersion 1.0.0
     * @apiName get
     * @apiGroup App\Notification
     * @apiPermission none
     * @apiDescription Fetch my nofitifications
     *
     * @apiExample (cURL) exmaple:
     * curl -XGET "https://SERVER/api/v1/user/notification"
     *
     * @apiSuccessExample {string} Success-Response:
     * HTTP/1.1 204 No Content
     */
    public function delete(string $id): Response
    {
        $this->notifier->deleteNotification($this->user, new ObjectId($id));

        return (new Response())->setCode(204);
    }

    /**
     * @api {post} /api/v1/user/notification/broadcast Post a notification to all users (or to a bunch of users)
     * @apiVersion 1.0.0
     * @apiName get
     * @apiGroup App\Notification
     * @apiPermission admin
     * @apiDescription Send notification
     *
     * @apiExample (cURL) exmaple:
     * curl -XPOST "https://SERVER/api/v1/user/notification/broadcast"
     *
     * @apiSuccessExample {string} Success-Response:
     * HTTP/1.1 204 No Content
     */
    public function post(array $receiver, string $subject, string $body): Response
    {
        $users = $this->server->getUsersById($receiver);

$users is not used, you could remove the assignment.

        $this->notifier->notify($receiver, $this->user, $subject, $body);

        return (new Response())->setCode(204);
    }

    /**
     * @api {post} /api/v1/notification/broadcast Post a notification to all users (or to a bunch of users)
     * @apiVersion 1.0.0
     * @apiName get
     * @apiGroup App\Notification
     * @apiPermission admin
     * @apiDescription Send notification
     *
     * @apiExample (cURL) exmaple:
     * curl -XPOST "https://SERVER/api/v1/user/notification/broadcast"
     *
     * @apiSuccessExample {string} Success-Response:
     * HTTP/1.1 204 No Content
     */
    public function postBroadcast(string $subject, string $body): Response
    {
        if (!$this->user->isAdmin()) {
            throw new ForbiddenException(
                'submitted parameters require to have admin privileges',
                    ForbiddenException::ADMIN_PRIV_REQUIRED
                );
        }

        $users = $this->server->getUsersByFilter([]);

The method getUsersByFilter() does not exist on Balloon\Server. Did you maybe mean getUsers()?

        $this->notifier->notify($users, $this->user, $subject, $body);

        return (new Response())->setCode(204);
    }

    /**
     * @api {post} /api/v1/notification/mail Send a normal mail message
     * @apiVersion 1.0.0
     * @apiName get
     * @apiGroup App\Notification
     * @apiPermission none
     * @apiDescription Send mail
     *
     * @apiExample (cURL) exmaple:
     * curl -XGET "https://SERVER/api/v1/user/notification"
     *
     * @apiSuccessExample {string} Success-Response:
     * HTTP/1.1 204 No Content
     */
    public function postMail(array $receiver, string $subject, string $body)
    {
        $mail = new Message();
        $mail->setBody($body);
        $mail->setFrom($this->user->getAttribute('username'), $this->user->getAttribute('mail'));
        $mail->setSubject($subject);
        $mail->setBcc($receiver);
        $this->async->addJob(Mail::class, ['mail' => $mail->toString()]);

        return (new Response())->setCode(204);
    }

    /**
     * @api {post} /api/v1/node/subscribe Subscribe for node updates
     * @apiVersion 1.0.0
     * @apiName get
     * @apiGroup App\Notification
     * @apiPermission none
     * @apiDescription Receive node updates
     * @apiUse _getNodes
     * @apiUse _multiError
     *
     * @apiExample (cURL) exmaple:
     * curl -XPOST "https://SERVER/api/v1/node/subscribe"
     *
     * @apiSuccessExample {string} Success-Response:
     * HTTP/1.1 204 No Content
     *
     * @param null|mixed $id
     * @param null|mixed $p
     */
    public function postSubscribe($id = null, $p = null, bool $subscribe = true)
    {
        if (is_array($id) || is_array($p)) {
            foreach ($this->fs->findNodesById($id) as $node) {
                try {
                    $this->notifier->subscribe($this->fs->getNode($id, $p), $subscribe);
                } catch (\Exception $e) {
                    $failures[] = [

$failures was never initialized. Although not strictly required by PHP, it is generally a good practice to add $failures = array(); before regardless.

                        'id' => (string) $node->getId(),
                        'name' => $node->getName(),
                        'error' => get_class($e),
                        'message' => $e->getMessage(),
                        'code' => $e->getCode(),
                    ];

                    $this->logger->debug('failed subscribe node in multi node request ['.$node->getId().']', [
                        'category' => get_class($this),
                        'exception' => $e,
                    ]);
                }
            }

            if (empty($failures)) {
                return (new Response())->setCode(204);
            }

            return (new Response())->setcode(400)->setBody($failures);
        }

        $this->notifier->subscribe($this->fs->getNode($id, $p), $subscribe);

        return (new Response())->setCode(204);
    }
}