src/rpc.php

   1 <?php
   2
   3 /**
   4   * rpc.php
   5   *
   6   * This file contains the entry point to the "SquirrelMail API" -- the
   7   * remote procedure call request receiver.
   8   *
   9   * @copyright &copy; 1999-2007 The SquirrelMail Project Team
  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   */
  16
  17 /** This is the squirrelmail_rpc page */
  18 define('PAGE_NAME', 'rpc');
  19
  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
  23 //http://example.org/squirrelmail/src/rpc.php?page=read_body&passed_id=47633...
  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
  58 /**
  59   * Get RPC Action (can be in either GET or POST)
  60   *
  61   */
  62 if (!sqGetGlobalVar('rpc_action', $rpc_action, SQ_FORM)) {
  63 //FIXME: establish error codes (using 99 in the interim)
  64     sm_rpc_return_error(99, _("No RPC action given"));
  65 }
  66
  67
  68
  69 /**
  70   * No matter what our response is, the headers
  71   * will not change.
  72   *
  73   */
  74 $oTemplate->header('Content-Type: text/xml');
  75 $oTemplate->header('Content-Type: application/xml'); // required by IE
  76 //FIXME: which anti-cache headers do we want to use?
  77 $oTemplate->header('Cache-Control: no-cache');
  78 // $oTemplate->header("Expires: Sat, 1 Jan 2000 00:00:00 GMT");
  79 // $oTemplate->header("Last-Modified: " . gmdate("D, d M Y H:i:s") . "GMT");
  80 // $oTemplate->header("Cache-Control: no-cache, must-revalidate");
  81 // $oTemplate->header("Pragma: no-cache");
  82
  83
  84
  85 /**
  86   * Allow plugins to add their own RPC action
  87   * or modify behavior of SM core RPC actions...
  88   *
  89   * A plugin that handles a custom RPC action must
  90   * return TRUE to the hook so that it knows that
  91   * the action was handled and was not an unknown
  92   * action.  If the action was not handled, the plugin
  93   * should return FALSE to the hook.
  94   *
  95   * Developer note: the $rpc_action parameter is passed
  96   * in an array in case we can think of more parameters
  97   * to add in the future.
  98   *
  99   */
 100 $handled_by_plugin = boolean_hook_function('squirrelmail_rpc',
 101                                            $temp=array(&$rpc_action),
 102                                            1);
 103
 104
 105
 106 /**
 107   * Go take care of each RPC action (unless plugin already did)
 108   *
 109   */
 110 if (!$handled_by_plugin) switch (strtolower($rpc_action)) {
 111
 112     /**
 113       * Delete Messages
 114       *
 115       */
 116     case 'delete_messages':
 117
 118         require_once(SM_PATH . 'functions/mailbox_display.php');
 119         require_once(SM_PATH . 'functions/imap.php');
 120
 121         if (!sqGetGlobalVar('delete_ids', $delete_ids, SQ_FORM)) {
 122             sm_rpc_return_error(99, _("No deletion ID given"));
 123         }
 124         $delete_ids = explode(',', $delete_ids);
 125         if (!sqGetGlobalVar('mailbox', $mailbox, SQ_FORM)) {
 126             sm_rpc_return_error(99, _("No mailbox given"));
 127         }
 128         if (sqGetGlobalVar('startMessage', $startMessage, SQ_INORDER, 1)) {
 129             $startMessage = (int) $startMessage;
 130         }
 131         sqGetGlobalVar('what', $what, SQ_FORM, 0);
 132         if (sqGetGlobalVar('account', $iAccount,  SQ_GET, 0)) {
 133             $iAccount = (int) $iAccount;
 134         }
 135 //FIXME: need to grab the bypass trash variable here too!  probably other vars...
 136
 137 /* FIXME: --- The following code was just experimental/proof-of-concept; the rest
 138               of the implementation of this functionality still needs to be done "for real"
 139         $oImapMessage = new IMAP_Message(0, $mailbox, $startMessage, $what, $iAccount);
 140         foreach ($delete_ids as $id) {
 141             $oImapMessage->setUid($id);
 142             //FIXME: establish constants for $hide values (the 3 below indicates not to show errors, but to return any error string)
 143             $result = $oImapMessage->deleteMessage(3);
 144             if ($result !== TRUE) {
 145                 sm_rpc_return_error(99, $result);
 146             }
 147         }
 148 --- */
 149
 150         sm_rpc_return_success();
 151         //FIXME: Just for testing the line above can be changed to something like this:
 152         //sm_rpc_return_success(0, 'Hooray!  Message(s) deleted.  Refresh your message list and make sure.');
 153         break;
 154
 155
 156     /**
 157       * Default: error out
 158       *
 159       */
 160     default:
 161         sm_rpc_return_error(99, _("RPC action not understood"));
 162         break;
 163
 164 }
 165
 166
 167
 168 /**
 169   * Returns an error message to the RPC caller and exits
 170   *
 171   * NOTE that this function exits and will never return
 172   *
 173   * @param int    $error_code The error code for the current error condition
 174   * @param string $error_text Any error message associated with the error
 175   *                           condition (OPTIONAL; default empty string)
 176   *
 177   */
 178 function sm_rpc_return_error($error_code, $error_text='') {
 179
 180     global $oTemplate;
 181     $oTemplate->assign('error_code', $error_code);
 182     $oTemplate->assign('error_text', $error_text);
 183
 184     $oTemplate->display('rpc_response_error.tpl');
 185
 186     exit;
 187
 188 }
 189
 190
 191
 192 /**
 193   * Returns a standard success result to the RPC caller and exits
 194   *
 195   * NOTE that this function exits and will never return
 196   *
 197   * @param int    $result_code The result code (OPTIONAL; default 0)
 198   * @param string $result_text Any result message (OPTIONAL; default
 199   *                            empty string)
 200   *
 201   */
 202 function sm_rpc_return_success($result_code=0, $result_text='') {
 203
 204     global $oTemplate;
 205     $oTemplate->assign('result_code', $result_code);
 206     $oTemplate->assign('result_text', $result_text);
 207
 208     $oTemplate->display('rpc_response_success.tpl');
 209
 210     exit;
 211
 212 }
 213
 214
 215