gnu-social/plugins/DirectMessage/DirectMessagePlugin.php

<?php
/*
 * GNU Social - a federating social network
 * Copyright (C) 2014, Free Software Foundation, 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('GNUSOCIAL')) { exit(1); }

/**
 * @maintainer  Mikael Nordfeldth <mmn@hethane.se>
 */
class DirectMessagePlugin extends Plugin
{
    const PLUGIN_VERSION = '2.0.0';

    public function onCheckSchema()
    {
        $schema = Schema::get();
        $schema->ensureTable('message', Message::schemaDef());
        return true;
    }

    public function onRouterInitialized(URLMapper $m)
    {
        // web front-end actions
        $m->connect('message/new', ['action' => 'newmessage']);
        $m->connect('message/new?to=:to',
                    ['action' => 'newmessage'],
                    ['to' => Nickname::DISPLAY_FMT]);
        $m->connect('message/:message',
                    ['action' => 'showmessage'],
                    ['message' => '[0-9]+']);

        // direct messages
        $m->connect('api/direct_messages.:format',
                    ['action' => 'ApiDirectMessage'],
                    ['format' => '(xml|json|rss|atom)']);
        $m->connect('api/direct_messages/sent.:format',
                    ['action' => 'ApiDirectMessage',
                     'sent'   => true],
                    ['format' => '(xml|json|rss|atom)']);
        $m->connect('api/direct_messages/new.:format',
                    ['action' => 'ApiDirectMessageNew'],
                    ['format' => '(xml|json)']);

        return true;
    }

    public function onAppendUserActivityStreamObjects(UserActivityStream $uas, array &$objs)
    {
        // Messages _from_ the user
        $msgMap = Message::listGet('from_profile', array($uas->getUser()->id));
        $messages = $msgMap[$uas->getUser()->id];
        if (!empty($uas->after)) {
            $messages = array_filter($messages, array($uas, 'createdAfter'));
        }
        foreach ($messages as $message) {
            $objs[] = clone($message);
        }

        // Messages _to_ the user
        $msgMap = Message::listGet('to_profile', array($uas->getUser()->id));
        $messages = $msgMap[$uas->getUser()->id];
        if (!empty($uas->after)) {
            $messages = array_filter($messages, array($uas, 'createdAfter'));
        }
        foreach ($messages as $message) {
            $objs[] = clone($message);
        }

        return true;
    }

    /**
     * Are we allowed to perform a certain command over the API?
     */
    public function onCommandSupportedAPI(Command $cmd, &$supported)
    {
        $supported = $supported || $cmd instanceof MessageCommand;
        return true;
    }

    /**
     * EndInterpretCommand will handle the 'd' and 'dm' commands.
     *
     * @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)
    {
        $dm_cmds = array('d', 'dm');

        if ($result === false && in_array($cmd, $dm_cmds)) {
            if (!empty($arg)) {
                list($other, $extra) = CommandInterpreter::split_arg($arg);
                if (!empty($extra)) {
                    $result = new MessageCommand($user, $other, $extra);
                }
            }
            return false;
        }
        return true;
    }

    public function onEndPersonalGroupNav(Menu $menu, Profile $target, Profile $scoped=null)
    {
        if ($scoped instanceof Profile && $scoped->id == $target->id
                && !common_config('singleuser', 'enabled')) {

            $menu->out->menuItem(common_local_url('inbox', array('nickname' =>
                                                                 $target->getNickname())),
                                 // TRANS: Menu item in personal group navigation menu.
                                 _m('MENU','Messages'),
                                 // TRANS: Menu item title in personal group navigation menu.
                                 _('Your incoming messages'),
                                 $scoped->id === $target->id && $menu->actionName =='inbox');
        }
    }

    public function onEndProfilePageActionsElements(HTMLOutputter $out, Profile $profile)
    {
        $scoped = Profile::current();
        if (!$scoped instanceof Profile) {
            return true;
        }

        if ($profile->isLocal() && $scoped->mutuallySubscribed($profile)) {
            $out->elementStart('li', 'entity_send-a-message');
            $out->element('a', array('href' => common_local_url('newmessage', array('to' => $profile->id)),
                                     // TRANS: Link title for link on user profile.
                                     'title' => _('Send a direct message to this user.')),
                                // TRANS: Link text for link on user profile.
                                _m('BUTTON','Message'));
            $out->elementEnd('li');
        }
        return true;
    }

    public function onProfileDeleteRelated(Profile $profile, &$related)
    {
        $msg = new Message();
        $msg->from_profile = $profile->id;
        $msg->delete();

        $msg = new Message();
        $msg->to_profile = $profile->id;
        $msg->delete();
        return true;
    }

    public function onPluginVersion(array &$versions)
    {
        $versions[] = array('name' => 'Direct Message',
                            'version' => self::PLUGIN_VERSION,
                            'author' => 'Mikael Nordfeldth',
                            'homepage' => 'http://gnu.io/',
                            'rawdescription' =>
                            // TRANS: Plugin description.
                            _m('Direct Message to other local users (broken out of core).'));

        return true;
    }
}