Commit | Line | Data |
---|---|---|
fb0ee2e8 SJ |
1 | <?php |
2 | /*************************************************************************** | |
3 | * Copyright (C) 2003-2009 Polytechnique.org * | |
4 | * http://opensource.polytechnique.org/ * | |
5 | * * | |
6 | * This program is free software; you can redistribute it and/or modify * | |
7 | * it under the terms of the GNU General Public License as published by * | |
8 | * the Free Software Foundation; either version 2 of the License, or * | |
9 | * (at your option) any later version. * | |
10 | * * | |
11 | * This program is distributed in the hope that it will be useful, * | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of * | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * | |
14 | * GNU General Public License for more details. * | |
15 | * * | |
16 | * You should have received a copy of the GNU General Public License * | |
17 | * along with this program; if not, write to the Free Software * | |
18 | * Foundation, Inc., * | |
19 | * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * | |
20 | ***************************************************************************/ | |
21 | ||
22 | // Base class for a reminder; it offers the factory for creating valid reminders | |
23 | // tailored for a given user, as well as base methods for reminder impls. | |
24 | // Sub-classes should define at least the abstract methods, and the static | |
25 | // IsCandidate method (prototype: (User &$user)). | |
26 | // | |
27 | // Usage: | |
28 | // // Instantiates and returns a valid Reminder object for the user. | |
29 | // $reminder = Reminder::GetCandidateReminder($user); | |
30 | // | |
31 | // // Returns the named Reminder object. | |
32 | // $reminder = Reminder::GetByName($user, 'ax_letter'); | |
33 | abstract class Reminder | |
34 | { | |
35 | // Details about the reminder. | |
36 | public $name; | |
37 | protected $type_id; | |
38 | protected $weight; | |
39 | protected $remind_delay_yes; | |
40 | protected $remind_delay_no; | |
41 | protected $remind_delay_dismiss; | |
42 | ||
43 | // Details about the user. | |
44 | protected $user; | |
45 | protected $current_status; | |
46 | protected $last_ask; | |
47 | ||
48 | // Constructs the Reminder object from a mandatory User instance, a list of | |
49 | // key-value pairs from the `reminder_type` and `reminder` tables. | |
50 | function __construct(User &$user, array $type) | |
51 | { | |
52 | $this->user = &$user; | |
53 | ||
54 | $this->type_id = $type['type_id']; | |
55 | $this->name = $type['name']; | |
56 | $this->weight = $type['weight']; | |
57 | $this->remind_delay_yes = $type['remind_delay_yes']; | |
58 | $this->remind_delay_no = $type['remind_delay_no']; | |
59 | $this->remind_delay_dismiss = $type['remind_delay_dismiss']; | |
60 | ||
61 | if (isset($type['status'])) { | |
62 | $this->current_status = $type['status']; | |
63 | } | |
64 | if (isset($type['remind_last'])) { | |
65 | $this->last_ask = $type['remind_last']; | |
66 | } | |
67 | } | |
68 | ||
69 | // Updates (or creates) the reminder line for the pair (|user|, |reminder_id|) | |
70 | // using the |status| as status, and the |next_ask| as the delay between now | |
71 | // and the next ask (if any). | |
efc272e2 | 72 | private static function UpdateStatus($user_id, $type_id, $status, $next_ask) |
fb0ee2e8 SJ |
73 | { |
74 | XDB::execute('REPLACE INTO reminder | |
75 | SET uid = {?}, type_id = {?}, status = {?}, | |
76 | remind_last = NOW(), remind_next = FROM_UNIXTIME({?})', | |
efc272e2 | 77 | $user_id, $type_id, $status, |
fb0ee2e8 SJ |
78 | ($next_ask > 0 ? time() + $next_ask * 24 * 60 * 60 : null)); |
79 | } | |
80 | ||
81 | // Updates the status of the reminder for the current user. | |
82 | protected function UpdateOnYes() | |
83 | { | |
efc272e2 VZ |
84 | $this->UpdateStatus($this->user->id(), $this->type_id, |
85 | 'yes', $this->remind_delay_yes); | |
fb0ee2e8 SJ |
86 | } |
87 | protected function UpdateOnNo() | |
88 | { | |
efc272e2 VZ |
89 | $this->UpdateStatus($this->user->id(), $this->type_id, |
90 | 'no', $this->remind_delay_no); | |
fb0ee2e8 SJ |
91 | } |
92 | protected function UpdateOnDismiss() | |
93 | { | |
efc272e2 VZ |
94 | $this->UpdateStatus($this->user->id(), $this->type_id, |
95 | 'dismiss', $this->remind_delay_dismiss); | |
fb0ee2e8 SJ |
96 | } |
97 | ||
98 | // Display and http handling helpers -------------------------------------- | |
99 | ||
100 | // Handles a hit on the reminder onebox (for links made using the GetBaseUrl | |
101 | // method below). | |
102 | abstract public function HandleAction($action); | |
103 | ||
4b0cb388 VZ |
104 | // Displays the reminder as a standalone html snippet. It should be used |
105 | // when the reminder is the only output of a page. | |
106 | public function DisplayStandalone(&$page) | |
fb0ee2e8 SJ |
107 | { |
108 | header('Content-Type: text/html; charset=utf-8'); | |
4b0cb388 VZ |
109 | $page->changeTpl('reminder/base.tpl', NO_SKIN); |
110 | $this->Prepare($page); | |
fb0ee2e8 SJ |
111 | } |
112 | ||
4b0cb388 VZ |
113 | // Prepares the display by assigning template variables. |
114 | public function Prepare(&$page) | |
fb0ee2e8 | 115 | { |
4b0cb388 | 116 | $page->assign_by_ref('reminder', $this); |
fb0ee2e8 SJ |
117 | } |
118 | ||
4b0cb388 VZ |
119 | // Returns the name of the inner template, or null if a simple text obtained |
120 | // from GetText should be printed. | |
121 | public function template() { return null; } | |
122 | ||
123 | // Returns the text to display in the onebox, or null if a | |
124 | public function text() { return ''; } | |
125 | ||
126 | // Returns the title of the onebox. | |
127 | public function title() { return ''; } | |
128 | ||
129 | // Should return true if this onebox needs to be considered as a warning and | |
130 | // not just as a subscription offer. | |
131 | public function warning() { return false; } | |
fb0ee2e8 SJ |
132 | |
133 | // Returns the base url for the reminder module. | |
4b0cb388 | 134 | public function baseurl() |
fb0ee2e8 SJ |
135 | { |
136 | return 'ajax/reminder/' . $this->name; | |
137 | } | |
138 | ||
efc272e2 VZ |
139 | // Static status update methods ------------------------------------------- |
140 | ||
141 | // Marks the candidate reminder as having been accepted for user |user_id|. | |
142 | // It is intended to be used when a reminder box has been bypassed, and when | |
143 | // it should behave as if the user had clicked on 'yes'. | |
144 | protected static function MarkCandidateAsAccepted($user_id, $candidate) | |
145 | { | |
146 | Reminder::UpdateStatus($user_id, $candidate['type_id'], | |
147 | 'yes', $candidate['remind_delay_yes']); | |
148 | } | |
149 | ||
fb0ee2e8 SJ |
150 | // Static factories ------------------------------------------------------- |
151 | ||
152 | // Returns a chosen class using the user data from |user|, and from the database. | |
153 | public static function GetCandidateReminder(User &$user) | |
154 | { | |
155 | $res = XDB::query('SELECT rt.*, r.status, r.remind_last | |
156 | FROM reminder_type AS rt | |
157 | LEFT JOIN reminder AS r ON (rt.type_id = r.type_id AND r.uid = {?}) | |
e9ff46f1 | 158 | WHERE r.uid IS NULL OR r.remind_next < NOW()', |
fb0ee2e8 | 159 | $user->id()); |
fb0ee2e8 | 160 | $candidates = $res->fetchAllAssoc(); |
e9ff46f1 VZ |
161 | |
162 | $weight_map = create_function('$a', 'return $a["weight"];'); | |
163 | while (count($candidates) > 0) { | |
164 | $position = rand(1, array_sum(array_map($weight_map, $candidates))); | |
fb0ee2e8 | 165 | foreach ($candidates as $key => $candidate) { |
e9ff46f1 VZ |
166 | $position -= $candidate['weight']; |
167 | if ($position <= 0) { | |
fb0ee2e8 | 168 | $class = self::GetClassName($candidate['name']); |
efc272e2 | 169 | if ($class && call_user_func(array($class, 'IsCandidate'), $user, $candidate)) { |
fb0ee2e8 SJ |
170 | return new $class($user, $candidate); |
171 | } | |
172 | unset($candidates[$key]); | |
173 | } | |
174 | } | |
fb0ee2e8 SJ |
175 | } |
176 | ||
177 | return null; | |
178 | } | |
179 | ||
180 | // Returns an instantiation of the reminder class which name is |name|, using | |
181 | // user data from |user|, and from the database. | |
182 | public static function GetByName(User &$user, $name) | |
183 | { | |
184 | if (!($class = self::GetClassName($name))) { | |
185 | return null; | |
186 | } | |
187 | ||
188 | $res = XDB::query('SELECT rt.*, r.status, r.remind_last | |
189 | FROM reminder_type AS rt | |
190 | LEFT JOIN reminder AS r ON (rt.type_id = r.type_id AND r.uid = {?}) | |
191 | WHERE rt.name = {?}', | |
192 | $user->id(), $name); | |
193 | if ($res->numRows() > 0) { | |
194 | return new $class($user, $res->fetchOneAssoc()); | |
195 | } | |
196 | ||
197 | return null; | |
198 | } | |
199 | ||
200 | // Computes the name of the class for reminder named |name|, and preloads | |
201 | // the class. | |
202 | private static function GetClassName($name) | |
203 | { | |
4b0cb388 | 204 | include_once "reminder/$name.inc.php"; |
fb0ee2e8 SJ |
205 | $class = 'Reminder' . str_replace(' ', '', ucwords(str_replace('_', ' ', $name))); |
206 | return (class_exists($class) ? $class : null); | |
207 | } | |
208 | } | |
209 | ||
210 | ||
211 | // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: | |
212 | ?> |