46f98b3142
The core plugins whose version was attached to GS's were reseted to 2.0.0. 2.0.0 was chosen as reset version for plugins because it is higher than the one that was set by inheriting GS version. Furthermore, it's a major change from prior plugin versioning system thus it also makes semantic sense. Justification for version bump: == GS == 9a4ab31f26 1.19.0c13b935201
1.18.3c13b935201
1.18.218fc39d2cf
1.18.1c083a8bcc2
1.18.0e8783d46d0
1.17.1d9a42550ff
1.17.01536d3ef29
1.16.0c03ed457a6
1.15.0d2e6519bad
1.14.2fe411e8138
1.14.1b17e0b4169
1.14.0daa5f87fd4
1.13.0d75b5d2f4a
1.11.7f6dbf66983
1.11.66cf674f8f8
1.11.57845a09b34
1.11.4e4d432295d
1.11.3339204f1ee
1.11.2a4e679a118
1.11.17967db6ff5
1.11.0bc030da320
1.10.19cc7df51d6
1.10.0bf7f17474d
1.9.28a07edec5f
1.9.10042971d74
1.9.06b5450b7e6
1.8.05dcc98d1c6
1.7.0e6667db0cd
1.6.03290227b50
1.5.0a59c439b46
1.4.0496ab8c920
1.3.10986030060b
1.3.91d529c021a
1.3.8f89c052cf8
1.3.738f2ecefac
1.3.6e473937cb9
1.3.59a39ebe66f
1.3.4ddc3cecfc0
1.3.32b43d484eb
1.3.2e8e487187e
1.3.1 == Plugins == XMPP plugine0887220b0
bump patche186ad57d0
bump patch OStatuse186ad57d0
bump patch Nodeinfoceae66a30f
bump minor586fb5a517
bump major195296846e
bump minor
198 lines
6.1 KiB
PHP
198 lines
6.1 KiB
PHP
<?php
|
|
/**
|
|
* StatusNet - the distributed open-source microblogging tool
|
|
* Copyright (C) 2011, StatusNet, Inc.
|
|
*
|
|
* Plugin for sending email reminders about various things
|
|
*
|
|
* PHP version 5
|
|
*
|
|
* 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 OnDemand
|
|
* @package StatusNet
|
|
* @author Zach Copley <zach@status.net>
|
|
* @copyright 2011 StatusNet, Inc.
|
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
|
|
* @link http://status.net/
|
|
*/
|
|
|
|
if (!defined('STATUSNET')) {
|
|
// This check helps protect against security problems;
|
|
// your code file can't be executed directly from the web.
|
|
exit(1);
|
|
}
|
|
|
|
/**
|
|
* Email reminder plugin
|
|
*
|
|
* @category Plugin
|
|
* @package StatusNet
|
|
* @author Zach Copley <zach@status.net>
|
|
* @copyright 2011 StatusNet, Inc.
|
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
|
|
* @link http://status.net/
|
|
*/
|
|
class EmailReminderPlugin extends Plugin
|
|
{
|
|
const PLUGIN_VERSION = '2.0.0';
|
|
|
|
/**
|
|
* Set up email_reminder table
|
|
*
|
|
* @see Schema
|
|
* @see ColumnDef
|
|
*
|
|
* @return boolean hook value; true means continue processing, false means stop.
|
|
*/
|
|
function onCheckSchema()
|
|
{
|
|
$schema = Schema::get();
|
|
$schema->ensureTable('email_reminder', Email_reminder::schemaDef());
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Register our queue handlers
|
|
*
|
|
* @param QueueManager $qm Current queue manager
|
|
*
|
|
* @return boolean hook value
|
|
*/
|
|
function onEndInitializeQueueManager($qm)
|
|
{
|
|
$qm->connect('siterem', 'SiteConfirmReminderHandler');
|
|
$qm->connect('uregrem', 'UserConfirmRegReminderHandler');
|
|
$qm->connect('uinvrem', 'UserInviteReminderHandler');
|
|
|
|
return true;
|
|
}
|
|
|
|
function onEndDocFileForTitle($title, $paths, &$filename)
|
|
{
|
|
if (empty($filename)) {
|
|
$filename = dirname(__FILE__) . '/mail-src/' . $title;
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Send a reminder and record doing so
|
|
*
|
|
* @param string $type type of reminder
|
|
* @param mixed $object Confirm_address or Invitation object
|
|
* @param string $subject subjct of the email reminder
|
|
* @param int $day number of days
|
|
*/
|
|
static function sendReminder($type, $object, $subject, $day)
|
|
{
|
|
// XXX: -1 is a for the special one-time reminder (maybe 30) would be
|
|
// better? Like >= 30 days?
|
|
if ($day == -1) {
|
|
$title = "{$type}-onetime";
|
|
} else {
|
|
$title = "{$type}-{$day}";
|
|
}
|
|
|
|
// Record the fact that we sent a reminder
|
|
if (self::sendReminderEmail($type, $object, $subject, $title)) {
|
|
try {
|
|
Email_reminder::recordReminder($type, $object, $day);
|
|
common_log(
|
|
LOG_INFO,
|
|
"Sent {$type} reminder to {$object->address}.",
|
|
__FILE__
|
|
);
|
|
} catch (Exception $e) {
|
|
// oh noez
|
|
common_log(LOG_ERR, $e->getMessage(), __FILE__);
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Send a real live email reminder
|
|
*
|
|
* @todo This would probably be better as two or more sep functions
|
|
*
|
|
* @param string $type type of reminder
|
|
* @param mixed $object Confirm_address or Invitation object
|
|
* @param string $subject subjct of the email reminder
|
|
* @param string $title title of the email reminder
|
|
* @return boolean true if the email subsystem doesn't explode
|
|
*/
|
|
static function sendReminderEmail($type, $object, $subject, $title = null) {
|
|
|
|
$sitename = common_config('site', 'name');
|
|
$recipients = array($object->address);
|
|
$inviter = null;
|
|
$inviterurl = null;
|
|
|
|
if ($type == UserInviteReminderHandler::INVITE_REMINDER) {
|
|
$user = User::getKV($object->user_id);
|
|
if (!empty($user)) {
|
|
$profile = $user->getProfile();
|
|
$inviter = $profile->getBestName();
|
|
$inviterUrl = $profile->profileurl;
|
|
}
|
|
}
|
|
|
|
$headers['From'] = mail_notify_from();
|
|
$headers['To'] = trim($object->address);
|
|
// TRANS: Subject for confirmation e-mail.
|
|
// TRANS: %s is the StatusNet sitename.
|
|
$headers['Subject'] = $subject;
|
|
$headers['Content-Type'] = 'text/html; charset=UTF-8';
|
|
|
|
$confirmUrl = common_local_url('register', array('code' => $object->code));
|
|
|
|
$template = DocFile::forTitle($title, DocFile::mailPaths());
|
|
|
|
$blankfillers = array('confirmurl' => $confirmUrl);
|
|
|
|
if ($type == UserInviteReminderHandler::INVITE_REMINDER) {
|
|
$blankfillers['inviter'] = $inviter;
|
|
$blankfillers['inviterurl'] = $inviterUrl;
|
|
// @todo private invitation message?
|
|
}
|
|
|
|
$body = $template->toHTML($blankfillers);
|
|
|
|
return mail_send($recipients, $headers, $body);
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param type $versions
|
|
* @return type
|
|
*/
|
|
function onPluginVersion(array &$versions)
|
|
{
|
|
$versions[] = array(
|
|
'name' => 'EmailReminder',
|
|
'version' => self::PLUGIN_VERSION,
|
|
'author' => 'Zach Copley',
|
|
'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/EmailReminder',
|
|
// TRANS: Plugin description.
|
|
'rawdescription' => _m('Send email reminders for various things.')
|
|
);
|
|
return true;
|
|
}
|
|
|
|
}
|