From 3159264522d1863a83aad9fdbb36a228f3822ac4 Mon Sep 17 00:00:00 2001
From: pdontthink <pdontthink@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Date: Wed, 10 Sep 2008 06:47:36 +0000
Subject: [PATCH 1/1] RPC requests should use their own template sets with
 different content-type.

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@13273 7612ce4b-ef26-0410-bec9-ea0150e637f0
---
 templates/default_rpc/config.php              | 53 +++++++++++++++++++
 templates/default_rpc/rpc_response_error.tpl  | 35 ++++++++++++
 .../default_rpc/rpc_response_success.tpl      | 35 ++++++++++++
 3 files changed, 123 insertions(+)
 create mode 100644 templates/default_rpc/config.php
 create mode 100644 templates/default_rpc/rpc_response_error.tpl
 create mode 100644 templates/default_rpc/rpc_response_success.tpl

diff --git a/templates/default_rpc/config.php b/templates/default_rpc/config.php
new file mode 100644
index 00000000..6e09872b
--- /dev/null
+++ b/templates/default_rpc/config.php
@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * Provides some basic configuration options to the template engine
+ *
+ * @copyright &copy; 1999-2008 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage templates
+ */
+
+
+/**
+ * Indicates what template engine this template set uses.
+ */
+$template_engine = SQ_PHP_TEMPLATE;
+
+
+/**
+ * Indicates what the content type is for this template set.
+ */
+//FIXME - what is the proper content-type? (TODO: possibly make default RPC templates SOAP-compliant)
+//$content_type = 'application/soap+xml';
+$content_type = 'text/xml';
+
+
+/**
+  * If non-empty, indicates which template set this set is derived from.
+  *
+  * If a template file does not exist in this template set, then the
+  * parent set is searched for the file.  If not found there and that
+  * set has a parent itself (the grandparent of this set), the file is
+  * searched for there....  This continues until there are no more parent
+  * template sets, and if the file is still not found, the fall-back
+  * template set (see $templateset_fallback in config/config.php) is the 
+  * last placed searched for the file.
+  *
+  */
+$parent_template_set = '';
+
+
+/**
+  * These settings allow this template set to change SquirrelMail's
+  * list of active plugins by adding or removing any of those listed
+  * herein.  If the $remove_plugins list contains "*", then ALL plugins
+  * will be disabled, and only those in $add_plugins will be enabled.
+  *
+  */
+$add_plugins = array();
+$remove_plugins = array();
+
+
diff --git a/templates/default_rpc/rpc_response_error.tpl b/templates/default_rpc/rpc_response_error.tpl
new file mode 100644
index 00000000..a7b5b551
--- /dev/null
+++ b/templates/default_rpc/rpc_response_error.tpl
@@ -0,0 +1,35 @@
+<?php
+
+/**
+  * rpc_response_error.tpl
+  *
+  * Template for constructing an error response to a remote 
+  * procedure call.
+  *
+  * The following variables are available in this template:
+  *      + $error_code - The numeric error code associated with the 
+  *                      current error condition
+  *      + $error_text - Any error message associated with the current
+  *                      error condition (optional; may not be present)
+  *
+  * @copyright &copy; 1999-2007 The SquirrelMail Project Team
+  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+  * @version $Id: rpc_response_error.tpl 12111 2007-01-11 08:05:51Z pdontthink $
+  * @package squirrelmail
+  * @subpackage templates
+  */
+
+
+// retrieve the template vars
+//
+extract($t);
+
+
+/*echo '<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>';*/
+echo '<?xml version="1.0" ?>';
+?>
+<response>
+    <status>ERROR</status>
+    <result_code><?php echo $error_code; ?></result_code>
+    <result_text><?php echo $error_text; ?></result_text>
+</response>
diff --git a/templates/default_rpc/rpc_response_success.tpl b/templates/default_rpc/rpc_response_success.tpl
new file mode 100644
index 00000000..fa53d025
--- /dev/null
+++ b/templates/default_rpc/rpc_response_success.tpl
@@ -0,0 +1,35 @@
+<?php
+
+/**
+  * rpc_response_success.tpl
+  *
+  * Template for constructing a standard response to a remote 
+  * procedure call.
+  *
+  * The following variables are available in this template:
+  *      + $result_code - The result code (optional; if not given 
+  *                       must default to 0 (zero))
+  *      + $result_text - Any result message (optional; may not be 
+  *                       present)
+  *
+  * @copyright &copy; 1999-2007 The SquirrelMail Project Team
+  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+  * @version $Id: rpc_response_success.tpl 12111 2007-01-11 08:05:51Z pdontthink $
+  * @package squirrelmail
+  * @subpackage templates
+  */
+
+
+// retrieve the template vars
+//
+extract($t);
+
+
+/*echo '<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>';*/
+echo '<?xml version="1.0" ?>';
+?>
+<response>
+    <status>OK</status>
+    <result_code><?php echo $result_code; ?></result_code>
+    <result_text><?php echo $result_text; ?></result_text>
+</response>
-- 
2.25.1