We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

Commit daa8b473 authored by Zach Copley's avatar Zach Copley

New actions for direct messaging through the API

parent eaef9b68
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Show a the direct messages from or to a user
*
* PHP version 5
*
* LICENCE: 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/>.
*
* @category API
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @copyright 2009 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR.'/lib/apiauth.php';
/**
* Show a list of direct messages from or to the authenticating user
*
* @category API
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
class ApiDirectMessageAction extends ApiAuthAction
{
var $format = null;
var $messages = null;
var $page = null;
var $count = null;
var $max_id = null;
var $since_id = null;
var $since = null;
var $title = null;
var $subtitle = null;
var $link = null;
var $selfuri_base = null;
var $id = null;
/**
* Take arguments for running
*
* @param array $args $_REQUEST args
*
* @return boolean success flag
*
*/
function prepare($args)
{
parent::prepare($args);
if ($this->requiresAuth()) {
if ($this->checkBasicAuthUser() == false) {
return;
}
}
$this->user = $this->auth_user;
if (empty($this->user)) {
$this->clientError(_('No such user!'), 404, $this->format);
return;
}
$this->page = (int)$this->arg('page', 1);
$this->count = (int)$this->arg('count', 20);
$this->max_id = (int)$this->arg('max_id', 0);
$this->since_id = (int)$this->arg('since_id', 0);
$this->since = $this->arg('since');
$server = common_root_url();
$taguribase = common_config('integration', 'taguri');
if ($this->arg('sent')) {
// Action was called by /api/direct_messages/sent.format
$this->title = sprintf(
_("Direct messages from %s"),
$this->user->nickname
);
$this->subtitle = sprintf(
_("All the direct messages sent from %s"),
$this->user->nickname
);
$this->link = $server . $this->user->nickname . '/outbox';
$this->selfuri_base = common_root_url() . 'api/direct_messages/sent';
$this->id = "tag:$taguribase:SentDirectMessages:" . $this->user->id;
} else {
$this->title = sprintf(
_("Direct messages to %s"),
$this->user->nickname
);
$this->subtitle = sprintf(
_("All the direct messages sent to %s"),
$this->user->nickname
);
$this->link = $server . $this->user->nickname . '/inbox';
$this->selfuri_base = common_root_url() . 'api/direct_messages';
$this->id = "tag:$taguribase:DirectMessages:" . $this->user->id;
}
$this->format = $this->arg('format');
$this->messages = $this->getMessages();
return true;
}
/**
* Handle the request
*
* Show the messages
*
* @param array $args $_REQUEST data (unused)
*
* @return void
*/
function handle($args)
{
parent::handle($args);
$this->showMessages();
}
/**
* Show the messages
*
* @return void
*/
function showMessages()
{
switch($this->format) {
case 'xml':
$this->showXmlDirectMessages();
break;
case 'rss':
$this->showRssDirectMessages();
break;
case 'atom':
$this->showAtomDirectMessages();
break;
case 'json':
$this->showJsonDirectMessages();
break;
default:
$this->clientError(_('API method not found!'), $code = 404);
break;
}
}
/**
* Get notices
*
* @return array notices
*/
function getMessages()
{
$message = new Message();
if ($this->arg('sent')) {
$message->from_profile = $this->user->id;
} else {
$message->to_profile = $this->user->id;
}
if (!empty($this->max_id)) {
$message->whereAdd('id <= ' . $this->max_id);
}
if (!empty($this->since_id)) {
$message->whereAdd('id > ' . $this->since_id);
}
if (!empty($since)) {
$d = date('Y-m-d H:i:s', $this->since);
$message->whereAdd("created > '$d'");
}
$message->orderBy('created DESC, id DESC');
$message->limit((($this->page - 1) * $this->count), $this->count);
$message->find();
$messages = array();
while ($message->fetch()) {
$messages[] = clone($message);
}
return $messages;
}
/**
* Is this action read only?
*
* @param array $args other arguments
*
* @return boolean true
*/
function isReadOnly($args)
{
return true;
}
/**
* When was this notice last modified?
*
* @return string datestamp of the latest notice in the stream
*/
function lastModified()
{
if (!empty($this->messages)) {
return strtotime($this->messages[0]->created);
}
return null;
}
/**
* Shows a list of direct messages as Twitter-style XML array
*
* @return void
*/
function showXmlDirectMessages()
{
$this->init_document('xml');
$this->elementStart('direct-messages', array('type' => 'array'));
foreach ($this->messages as $m) {
$dm_array = $this->directMessageArray($m);
$this->showXmlDirectMessage($dm_array);
}
$this->elementEnd('direct-messages');
$this->end_document('xml');
}
/**
* Shows a list of direct messages as a JSON encoded array
*
* @return void
*/
function showJsonDirectMessages()
{
$this->init_document('json');
$dmsgs = array();
foreach ($this->messages as $m) {
$dm_array = $this->directMessageArray($m);
array_push($dmsgs, $dm_array);
}
$this->show_json_objects($dmsgs);
$this->end_document('json');
}
/**
* Shows a list of direct messages as RSS items
*
* @return void
*/
function showRssDirectMessages()
{
$this->init_document('rss');
$this->element('title', null, $this->title);
$this->element('link', null, $this->link);
$this->element('description', null, $this->subtitle);
$this->element('language', null, 'en-us');
$this->element(
'atom:link',
array(
'type' => 'application/rss+xml',
'href' => $this->selfuri_base . '.rss',
'rel' => self
),
null
);
$this->element('ttl', null, '40');
foreach ($this->messages as $m) {
$entry = $this->rssDirectMessageArray($m);
$this->show_twitter_rss_item($entry);
}
$this->end_twitter_rss();
}
/**
* Shows a list of direct messages as Atom entries
*
* @return void
*/
function showAtomDirectMessages()
{
$this->init_document('atom');
$this->element('title', null, $this->title);
$this->element('id', null, $this->id);
$selfuri = common_root_url() . 'api/direct_messages.atom';
$this->element(
'link', array(
'href' => $this->link,
'rel' => 'alternate',
'type' => 'text/html'),
null
);
$this->element(
'link', array(
'href' => $this->selfuri_base . '.atom', 'rel' => 'self',
'type' => 'application/atom+xml'),
null
);
$this->element('updated', null, common_date_iso8601('now'));
$this->element('subtitle', null, $this->subtitle);
foreach ($this->messages as $m) {
$entry = $this->rssDirectMessageArray($m);
$this->showTwitterAtomEntry($entry);
}
$this->end_document('atom');
}
/**
* An entity tag for this notice
*
* Returns an Etag based on the action name, language, and
* timestamps of the notice
*
* @return string etag
*/
function etag()
{
if (!empty($this->messages)) {
$last = count($this->messages) - 1;
return '"' . implode(
':',
array($this->arg('action'),
common_language(),
strtotime($this->messages[0]->created),
strtotime($this->messages[$last]->created)
)
)
. '"';
}
return null;
}
}
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Send a direct message via the API
*
* PHP version 5
*
* LICENCE: 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/>.
*
* @category API
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @copyright 2009 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
if (!defined('STATUSNET')) {
exit(1);
}
require_once INSTALLDIR.'/lib/apiauth.php';
/**
* Creates a new direct message from the authenticating user to
* the user specified by id.
*
* @category API
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
* @link http://status.net/
*/
class ApiDirectMessageNewAction extends ApiAuthAction
{
var $format = null;
var $source = null;
var $user = null;
var $other = null;
var $content = null;
/**
* Take arguments for running
*
* @param array $args $_REQUEST args
*
* @return boolean success flag
*
*/
function prepare($args)
{
parent::prepare($args);
if ($this->requiresAuth()) {
if ($this->checkBasicAuthUser() == false) {
return;
}
}
$this->user = $this->auth_user;
if (empty($this->user)) {
$this->clientError(_('No such user!'), 404, $this->format);
return;
}
$this->source = $this->trimmed('source'); // Not supported by Twitter.
$reserved_sources = array('web', 'omb', 'mail', 'xmpp', 'api');
if (empty($thtis->source) || in_array($this->source, $reserved_sources)) {
$source = 'api';
}
$this->content = $this->trimmed('text');
$this->user = $this->auth_user;
$user_param = $this->trimmed('user');
$user_id = $this->arg('user_id');
$screen_name = $this->trimmed('screen_name');
if (isset($user_param) || isset($user_id) || isset($screen_name)) {
$this->other = $this->getTargetUser($user_param);
}
$this->format = $this->arg('format');
return true;
}
/**
* Handle the request
*
* Save the new message
*
* @param array $args $_REQUEST data (unused)
*
* @return void
*/
function handle($args)
{
parent::handle($args);
if ($_SERVER['REQUEST_METHOD'] != 'POST') {
$this->clientError(
_('This method requires a POST.'),
400,
$this->format
);
return;
}
if (empty($this->content)) {
$this->clientError(
_('No message text!'),
406,
$this->format
);
} else {
$content_shortened = common_shorten_links($this->content);
if (Message::contentTooLong($content_shortened)) {
$this->clientError(
sprintf(
_('That\'s too long. Max message size is %d chars.'),
Message::maxContent()
),
406,
$this->format
);
return;
}
}
if (empty($this->other)) {
$this->clientError(_('Recipient user not found.'), 403, $this->format);
return;
} else if (!$this->user->mutuallySubscribed($this->other)) {
$this->clientError(
_('Can\'t send direct messages to users who aren\'t your friend.'),
403,
$this->format
);
return;
} else if ($this->user->id == $this->other->id) {
// Note: sending msgs to yourself is allowed by Twitter
$errmsg = 'Don\'t send a message to yourself; ' .
'just say it to yourself quietly instead.'
$this->clientError(_($errmsg), 403, $this->format);
return;
}
$message = Message::saveNew(
$this->user->id,
$this->other->id,
html_entity_decode($this->content, ENT_NOQUOTES, 'UTF-8'),
$this->source
);
if (is_string($message)) {
$this->serverError($message);
return;
}
mail_notify_message($message, $this->user, $this->other);
if ($this->format == 'xml') {
$this->showSingleXmlDirectMessage($message);
} elseif ($this->format == 'json') {
$this->showSingleJsondirectMessage($message);
}
}
}
<?php
/*
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2008, 2009, StatusNet, 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('STATUSNET') && !defined('LACONICA')) {
exit(1);
}
require_once(INSTALLDIR.'/lib/twitterapi.php');
class Twitapidirect_messagesAction extends TwitterapiAction
{
function direct_messages($args, $apidata)
{
parent::handle($args);
return $this->show_messages($args, $apidata, 'received');
}
function sent($args, $apidata)
{
parent::handle($args);
return $this->show_messages($args, $apidata, 'sent');
}
function show_messages($args, $apidata, $type)
{
$user = $apidata['user']; // Always the auth user
$message = new Message();
$title = null;
$subtitle = null;
$link = null;
$server = common_root_url();
if ($type == 'received') {
$message->to_profile = $user->id;