service/core/REST/SugarRestRSS.php

   1 <?php
   2 if(!defined('sugarEntry'))define('sugarEntry', true);
   3 /*********************************************************************************
   4  * SugarCRM is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 require_once('service/core/REST/SugarRest.php');
  40
  41 /**
  42  * This class is a serialize implementation of REST protocol
  43  *
  44  */
  45 class SugarRestRSS extends SugarRest{
  46
  47         /**
  48          * It will serialize the input object and echo's it
  49          *
  50          * @param array $input - assoc array of input values: key = param name, value = param type
  51          * @return String - echos serialize string of $input
  52          */
  53         function generateResponse($input){
  54                 $method = !empty($_REQUEST['method'])? $_REQUEST['method']: '';
  55                 if($method != 'get_entry_list')$this->fault('RSS currently only supports the get_entry_list method');
  56                 ob_clean();
  57                 $this->generateResponseHeader($input['result_count']);
  58                 $this->generateItems($input);
  59                 $this->generateResponseFooter();
  60         } // fn
  61
  62         function generateResponseHeader($count){
  63                 $date = gmdate("D, d M Y H:i:s") . " GMT";
  64 echo'<?xml version="1.0" encoding="UTF-8" ?>
  65 <rss version="2.0">
  66 <channel>
  67 <title>SugarCRM  RSS Feed</title>
  68 <link>http://cnn.com</link>
  69 <description>' . $count. ' records found</description>
  70 <pubDate>' . $date . '</pubDate>
  71 <generator>SugarCRM</generator>
  72 <ttl>' . $count . '</ttl>
  73 ';
  74         }
  75
  76 function generateItems($input){
  77         if(!empty($input['entry_list'])){
  78                 foreach($input['entry_list'] as $item){
  79                         $this->generateItem($item);
  80                 }
  81
  82         }
  83 }
  84
  85 function generateItem($item){
  86 echo "<item>\n";
  87 $name  = !empty($item['name_value_list']['name'])?htmlentities( $item['name_value_list']['name']): '';
  88 echo "<title>$name</title>\n";
  89 echo "<link>". $GLOBALS['sugar_config']['site_url']  . htmlentities('/index.php?module=' . $item['module_name']. '&record=' . $item['id']) .  "</link>\n";
  90 echo "<description><![CDATA[";
  91 $displayFieldNames = true;
  92 if(count($item['name_value_list']) == 2 &&isset($item['name_value_list']['name']))$displayFieldNames = false;
  93 foreach($item['name_value_list'] as $k=>$v){
  94         if($k =='name')continue;
  95         if($k == 'date_modified')continue;
  96         if($displayFieldNames) echo '<b>' .htmlentities( $k) . ':<b>&nbsp;';
  97         echo htmlentities( $v) . "\n<br>";
  98 }
  99 echo "]]></description>\n";
 100 if(!empty($item['name_value_list']['date_modified'])){
 101         $date = date("D, d M Y H:i:s", strtotime($item['name_value_list']['date_modified'])) . " GMT";
 102         echo "<pubDate>$date</pubDate>";
 103 }
 104
 105 echo "<guid>" . $item['id']. "</guid>\n";
 106 echo "</item>\n";
 107 }
 108 function generateResponseFooter(){
 109                 echo'</channel></rss>';
 110         }
 111
 112         /**
 113          * This method calls functions on the implementation class and returns the output or Fault object in case of error to client
 114          *
 115          * @return unknown
 116          */
 117         function serve(){
 118                 $this->fault('RSS is not a valid input_type');
 119         } // fn
 120
 121         function fault($faultObject){
 122                 ob_clean();
 123                 $this->generateResponseHeader();
 124                 echo '<item><name>';
 125                 if(is_object($errorObject)){
 126                         $error = $errorObject->number . ': ' . $errorObject->name . '<br>' . $errorObject->description;
 127                         $GLOBALS['log']->error($error);
 128                 }else{
 129                         $GLOBALS['log']->error(var_export($errorObject, true));
 130                         $error = var_export($errorObject, true);
 131                 } // else
 132                 echo $error;
 133                 echo '</name></item>';
 134                 $this->generateResponseFooter();
 135
 136         }
 137
 138
 139 } // clazz