482956f2 |
1 | <?php |
2 | |
3 | /** |
85ae8774 |
4 | * squirrelmail_rpc.php |
482956f2 |
5 | * |
6 | * This file contains the entry point to the "SquirrelMail API" -- the |
7 | * remote procedure call request receiver. |
8 | * |
a49f857e |
9 | * @copyright © 1999-2008 The SquirrelMail Project Team |
482956f2 |
10 | * @license http://opensource.org/licenses/gpl-license.php GNU Public License |
11 | * @version $Id$ |
12 | * @package squirrelmail |
13 | * @since 1.5.2 |
14 | * |
15 | */ |
ebd2391c |
16 | |
17 | /** This is the squirrelmail_rpc page */ |
85ae8774 |
18 | define('PAGE_NAME', 'squirrelmail_rpc'); |
ebd2391c |
19 | |
482956f2 |
20 | //FIXME: If we decide to route ALL requests, even normal page |
21 | // requests through this file, need to change page requests |
22 | // to something like this |
85ae8774 |
23 | //http://example.org/squirrelmail/src/squirrelmail_rpc.php?page=read_body&passed_id=47633... |
482956f2 |
24 | // This file would then add ".php" to the "page" variable |
25 | // and pass the request on to that page by simply require()ing |
26 | // that page and exiting. |
27 | // Does this present problems, security or otherwise? What |
28 | // problems are created by the fact that the page request |
29 | // is always the same thing (some parts of the code and some |
30 | // plugins switch functionality based on $PHP_SELF and other |
31 | // $_SERVER variables that look for specific page names -- those |
32 | // can be fixed by looking at the "page" GET argument, but what |
33 | // other issues are created)? What about plugins? How would |
34 | // they work in this scheme? Would they be a lot more difficult |
35 | // to develop? |
36 | //NOTE: It is not entirely clear if doing the above is even desirable. |
37 | // Initial conversations on the squirrelmail-devel list were |
38 | // inconclusive. On one hand, doing so would give us one master |
39 | // file that handles any and all incoming requests, no matter |
40 | // where they came from or what format/type they are. On the |
41 | // other, keeping page requests out of this file keeps this file |
42 | // lean and specific to one technology: our RPC interface. |
43 | |
44 | |
45 | /** |
46 | * Include the SquirrelMail initialization file. |
47 | */ |
48 | //FIXME: init.php assumes it is being called by a browser, so some error |
49 | // conditions are handled by immediately calling error_box() or |
50 | // otherwise trying to push something to the browser, which should |
51 | // be avoided at all costs. This is also pervasive in the whole |
52 | // core and must be cleaned up entirely before this can be a very |
53 | // functional RPC interface |
54 | require('../include/init.php'); |
55 | |
56 | |
57 | |
a49f857e |
58 | //FIXME: do we need to put this list somewhere else? |
59 | //FIXME: do we want to use constants instead? probably not a bad idea, although plugins probably won't, so we still want to try to keep track of the plugin error codes too if possible (new plugin website should help) |
60 | /** |
61 | * Known core error codes: |
62 | * |
63 | * 1 - No RPC action was given in request (please use "rpc_action") |
64 | * 2 - RPC action was not understood (perhaps a needed plugin is |
65 | * not installed and activated?) |
66 | * |
67 | * Known plugin error codes: |
68 | * |
cd60d608 |
69 | * 500 - Empty Folders plugin empty_folders_purge_trash action failed |
70 | * 501 - Empty Folders plugin empty_folders_purge_all action failed |
71 | * 502 - Empty Folders plugin empty_folders_delete_all action failed |
a49f857e |
72 | * |
73 | */ |
74 | |
75 | |
76 | |
482956f2 |
77 | /** |
78 | * Get RPC Action (can be in either GET or POST) |
79 | * |
80 | */ |
81 | if (!sqGetGlobalVar('rpc_action', $rpc_action, SQ_FORM)) { |
a49f857e |
82 | sm_rpc_return_error(1, _("No RPC action given")); |
482956f2 |
83 | } |
84 | |
85 | |
86 | |
87 | /** |
88 | * No matter what our response is, the headers |
89 | * will not change. |
90 | * |
91 | */ |
92 | $oTemplate->header('Content-Type: text/xml'); |
93 | $oTemplate->header('Content-Type: application/xml'); // required by IE |
94 | //FIXME: which anti-cache headers do we want to use? |
95 | $oTemplate->header('Cache-Control: no-cache'); |
96 | // $oTemplate->header("Expires: Sat, 1 Jan 2000 00:00:00 GMT"); |
97 | // $oTemplate->header("Last-Modified: " . gmdate("D, d M Y H:i:s") . "GMT"); |
98 | // $oTemplate->header("Cache-Control: no-cache, must-revalidate"); |
99 | // $oTemplate->header("Pragma: no-cache"); |
100 | |
101 | |
102 | |
103 | /** |
104 | * Allow plugins to add their own RPC action |
105 | * or modify behavior of SM core RPC actions... |
106 | * |
107 | * A plugin that handles a custom RPC action must |
108 | * return TRUE to the hook so that it knows that |
109 | * the action was handled and was not an unknown |
110 | * action. If the action was not handled, the plugin |
111 | * should return FALSE to the hook. |
112 | * |
113 | * Developer note: the $rpc_action parameter is passed |
114 | * in an array in case we can think of more parameters |
115 | * to add in the future. |
116 | * |
a49f857e |
117 | * Known users of this hook: |
118 | * empty_folders |
119 | * |
482956f2 |
120 | */ |
beb1a2f1 |
121 | $temp = array(&$rpc_action); |
122 | $handled_by_plugin = boolean_hook_function('squirrelmail_rpc', $temp, 1); |
482956f2 |
123 | |
124 | |
125 | |
126 | /** |
127 | * Go take care of each RPC action (unless plugin already did) |
128 | * |
129 | */ |
130 | if (!$handled_by_plugin) switch (strtolower($rpc_action)) { |
131 | |
132 | /** |
133 | * Delete Messages |
134 | * |
135 | */ |
136 | case 'delete_messages': |
137 | |
138 | require_once(SM_PATH . 'functions/mailbox_display.php'); |
139 | require_once(SM_PATH . 'functions/imap.php'); |
140 | |
141 | if (!sqGetGlobalVar('delete_ids', $delete_ids, SQ_FORM)) { |
142 | sm_rpc_return_error(99, _("No deletion ID given")); |
143 | } |
144 | $delete_ids = explode(',', $delete_ids); |
145 | if (!sqGetGlobalVar('mailbox', $mailbox, SQ_FORM)) { |
146 | sm_rpc_return_error(99, _("No mailbox given")); |
147 | } |
148 | if (sqGetGlobalVar('startMessage', $startMessage, SQ_INORDER, 1)) { |
149 | $startMessage = (int) $startMessage; |
150 | } |
151 | sqGetGlobalVar('what', $what, SQ_FORM, 0); |
152 | if (sqGetGlobalVar('account', $iAccount, SQ_GET, 0)) { |
153 | $iAccount = (int) $iAccount; |
154 | } |
155 | //FIXME: need to grab the bypass trash variable here too! probably other vars... |
156 | |
157 | /* FIXME: --- The following code was just experimental/proof-of-concept; the rest |
158 | of the implementation of this functionality still needs to be done "for real" |
159 | $oImapMessage = new IMAP_Message(0, $mailbox, $startMessage, $what, $iAccount); |
160 | foreach ($delete_ids as $id) { |
161 | $oImapMessage->setUid($id); |
162 | //FIXME: establish constants for $hide values (the 3 below indicates not to show errors, but to return any error string) |
163 | $result = $oImapMessage->deleteMessage(3); |
164 | if ($result !== TRUE) { |
165 | sm_rpc_return_error(99, $result); |
166 | } |
167 | } |
168 | --- */ |
169 | |
170 | sm_rpc_return_success(); |
171 | //FIXME: Just for testing the line above can be changed to something like this: |
172 | //sm_rpc_return_success(0, 'Hooray! Message(s) deleted. Refresh your message list and make sure.'); |
173 | break; |
174 | |
175 | |
176 | /** |
177 | * Default: error out |
178 | * |
179 | */ |
180 | default: |
a49f857e |
181 | sm_rpc_return_error(2, _("RPC action not understood")); |
482956f2 |
182 | break; |
183 | |
184 | } |
185 | |
186 | |
187 | |
188 | /** |
189 | * Returns an error message to the RPC caller and exits |
190 | * |
191 | * NOTE that this function exits and will never return |
192 | * |
193 | * @param int $error_code The error code for the current error condition |
194 | * @param string $error_text Any error message associated with the error |
195 | * condition (OPTIONAL; default empty string) |
196 | * |
197 | */ |
198 | function sm_rpc_return_error($error_code, $error_text='') { |
199 | |
200 | global $oTemplate; |
201 | $oTemplate->assign('error_code', $error_code); |
202 | $oTemplate->assign('error_text', $error_text); |
203 | |
204 | $oTemplate->display('rpc_response_error.tpl'); |
205 | |
206 | exit; |
207 | |
208 | } |
209 | |
210 | |
211 | |
212 | /** |
213 | * Returns a standard success result to the RPC caller and exits |
214 | * |
215 | * NOTE that this function exits and will never return |
216 | * |
217 | * @param int $result_code The result code (OPTIONAL; default 0) |
218 | * @param string $result_text Any result message (OPTIONAL; default |
219 | * empty string) |
220 | * |
221 | */ |
222 | function sm_rpc_return_success($result_code=0, $result_text='') { |
223 | |
224 | global $oTemplate; |
225 | $oTemplate->assign('result_code', $result_code); |
226 | $oTemplate->assign('result_text', $result_text); |
227 | |
228 | $oTemplate->display('rpc_response_success.tpl'); |
229 | |
230 | exit; |
231 | |
232 | } |
233 | |
234 | |
235 | |