gnu-social/plugins/EmailReminder/classes/Email_reminder.php
Zach Copley a35392da2f EmailReminder plugin to send reminders about various things
* Needs some cleanup and testing
* Email templates need work
* More documentation

Squashed commit of the following:

commit 1c7b418dad5ec1b7713d61b6a42d6d7a394d500f
Author: Zach Copley <zach@status.net>
Date:   Fri Jun 17 02:17:31 2011 -0700

    * Set the reminder interval correctly

commit ae0ded8cf95210f54b4cd58dac0eeeedf2d99c67
Author: Zach Copley <zach@status.net>
Date:   Fri Jun 17 02:15:01 2011 -0700

    Send email reminders for invitations

commit 1b596d08f5dbe765a16fbdfbd21e2ad68e8b0058
Author: Zach Copley <zach@status.net>
Date:   Thu Jun 16 23:53:48 2011 -0700

    Handle multiple confirmation types

commit 25d83351d878f39498cd6a14fddde27f1afef2ca
Author: Zach Copley <zach@status.net>
Date:   Thu Jun 16 18:04:57 2011 -0700

    Actually send reminders and record a record of doing so

commit 9ffc2dbee15cacc7e7f9feab492185ee9964a17e
Author: Zach Copley <zach@status.net>
Date:   Thu Jun 16 14:20:16 2011 -0700

    Make the queue handling actually work

commit 2a6ce3c17c045bdb0a3ddf36f2c290c9c48eb003
Author: Zach Copley <zach@status.net>
Date:   Thu Jun 16 13:27:56 2011 -0700

    Fix syntax errors

commit 054b54847dfadc490aa7d7dff12d473af31c99bb
Author: Zach Copley <zach@status.net>
Date:   Thu Jun 16 00:36:37 2011 -0700

    Registration reminders should work now, but code is untested

commit b44117017b64635aae340c260167cf1efab9b2ae
Merge: 9d1441d f74de88
Author: Zach Copley <zach@status.net>
Date:   Tue Jun 14 09:43:19 2011 -0700

    Merge branch 'email-reminder' of gitorious.org:~zcopley/statusnet/zcopleys-clone into email-reminder

    * 'email-reminder' of gitorious.org:~zcopley/statusnet/zcopleys-clone:
      Stubby EmailReminderPlugin and data class
      Remove bogus data class

    Conflicts:
    	plugins/EmailReminder/EmailReminderPlugin.php
    	plugins/EmailReminder/classes/Email_reminder.php

commit 9d1441d7366df57e38cdfaf96e006f7d2f29d889
Author: Zach Copley <zach@status.net>
Date:   Tue Jun 14 09:23:23 2011 -0700

    Most of the other classes needed to send email reminders

commit 4e9bb11dbb23556bf5c1847e7a127084b5cc217c
Author: Zach Copley <zach@status.net>
Date:   Mon Jun 13 12:10:55 2011 -0700

    size -> length

commit a9ea80ef8abae1e64d5713091baedd931b7184e2
Author: Zach Copley <zach@status.net>
Date:   Fri Jun 10 16:38:06 2011 -0400

    Stubby EmailReminderPlugin and data class

commit 5d893f982209b245cb9113a59e49721dd6e191b6
Author: Zach Copley <zach@status.net>
Date:   Fri Jun 10 14:01:48 2011 -0400

    Remove bogus data class

commit f74de8841a98add73536fd8a4d3cee76035b491c
Author: Zach Copley <zach@status.net>
Date:   Fri Jun 10 16:38:06 2011 -0400

    Stubby EmailReminderPlugin and data class

commit 5b14370918233e5112a95da94567c4ed83429bc9
Author: Zach Copley <zach@status.net>
Date:   Fri Jun 10 14:01:48 2011 -0400

    Remove bogus data class
2011-06-17 02:24:34 -07:00

155 lines
4.8 KiB
PHP

<?php
/**
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2011, StatusNet, Inc.
*
* Data class for email reminders
*
* 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 Data
* @package EmailReminder
* @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 Email_reminder extends Managed_DataObject
{
const INVITE_REMINDER = 'invite'; // @todo Move this to the invite reminder handler
public $__table = 'email_reminder';
public $type; // type of reminder
public $code; // confirmation code
public $days; // number of days after code was created
public $sent; // timestamp
public $created; // timestamp
public $modified; // timestamp
/**
* Get an instance by key
*
* This is a utility method to get a single instance with a given key value.
*
* @param string $k Key to use to lookup
* @param mixed $v Value to lookup
*
* @return QnA_Answer object found, or null for no hits
*
*/
function staticGet($k, $v=null)
{
return Memcached_DataObject::staticGet('email_reminder', $k, $v);
}
/**
*
* @param type $type
* @param type $confirm
* @param type $day
* @return type
*/
static function needsReminder($type, $confirm, $days) {
$reminder = new Email_reminder();
$reminder->type = $type;
$reminder->code = $confirm->code;
$reminder->days = $days;
$result = $reminder->find(true);
if (empty($result)) {
return true;
}
return false;
}
/**
*
* @param type $type
* @param type $confirm
* @param type $day
* @return type
*/
static function recordReminder($type, $confirm, $days) {
$reminder = new Email_reminder();
$reminder->type = $type;
$reminder->code = $confirm->code;
$reminder->days = $days;
$reminder->sent = $reminder->created = common_sql_now();
$result = $reminder->insert();
if (empty($result)) {
common_log_db_error($reminder, 'INSERT', __FILE__);
throw new ServerException(
_m('Database error inserting reminder record.')
);
}
return $result;
}
/**
* Data definition for email reminders
*/
public static function schemaDef()
{
return array(
'description' => 'Record of email reminders that have been sent',
'fields' => array(
'type' => array(
'type' => 'varchar',
'length' => 255,
'not null' => true,
'description' => 'type of reminder'
),
'code' => array(
'type' => 'varchar',
'not null' => 'true',
'length' => 255,
'description' => 'confirmation code'
),
'days' => array(
'type' => 'int',
'not null' => 'true',
'description' => 'number of days since code creation'
),
'sent' => array(
'type' => 'datetime',
'not null' => true,
'description' => 'Date and time the reminder was sent'
),
'created' => array(
'type' => 'datetime',
'not null' => true,
'description' => 'Date and time the record was created'
),
'modified' => array(
'type' => 'timestamp',
'not null' => true,
'description' => 'Date and time the record was last modified'
),
),
'primary key' => array('type', 'code', 'days'),
'indexes' => array(
'sent_idx' => array('sent'),
),
);
}
}