| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 5 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
| 7 | +--------------------------------------------------------------------+ |
| 8 | | This file is a part of CiviCRM. | |
| 9 | | | |
| 10 | | CiviCRM is free software; you can copy, modify, and distribute it | |
| 11 | | under the terms of the GNU Affero General Public License | |
| 12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | |
| 13 | | | |
| 14 | | CiviCRM is distributed in the hope that it will be useful, but | |
| 15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| 17 | | See the GNU Affero General Public License for more details. | |
| 18 | | | |
| 19 | | You should have received a copy of the GNU Affero General Public | |
| 20 | | License and the CiviCRM Licensing Exception along | |
| 21 | | with this program; if not, contact CiviCRM LLC | |
| 22 | | at info[AT]civicrm[DOT]org. If you have questions about the | |
| 23 | | GNU Affero General Public License or the licensing of CiviCRM, | |
| 24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | |
| 25 | +--------------------------------------------------------------------+ |
| 26 | */ |
| 27 | |
| 28 | /** |
| 29 | * |
| 30 | * @package CRM |
| 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
| 32 | */ |
| 33 | |
| 34 | /** |
| 35 | * @file |
| 36 | * API for event export in iCalendar format |
| 37 | * as outlined in Internet Calendaring and |
| 38 | * Scheduling Core Object Specification |
| 39 | */ |
| 40 | class CRM_Utils_ICalendar { |
| 41 | |
| 42 | /** |
| 43 | * Escape text elements for safe ICalendar use. |
| 44 | * |
| 45 | * @param string $text |
| 46 | * Text to escape. |
| 47 | * |
| 48 | * @return string |
| 49 | */ |
| 50 | public static function formatText($text) { |
| 51 | $text = strip_tags($text); |
| 52 | $text = str_replace("\\", "\\\\", $text); |
| 53 | $text = str_replace(',', '\,', $text); |
| 54 | $text = str_replace(';', '\;', $text); |
| 55 | $text = str_replace(["\r\n", "\n", "\r"], "\\n ", $text); |
| 56 | $text = implode("\n ", str_split($text, 50)); |
| 57 | return $text; |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Restore iCal formatted text to normal. |
| 62 | * |
| 63 | * @param string $text |
| 64 | * Text to unescape. |
| 65 | * |
| 66 | * @return string |
| 67 | */ |
| 68 | public static function unformatText($text) { |
| 69 | $text = str_replace('\n ', "\n", $text); |
| 70 | $text = str_replace('\;', ';', $text); |
| 71 | $text = str_replace('\,', ',', $text); |
| 72 | $text = str_replace("\\\\", "\\", $text); |
| 73 | $text = str_replace("DQUOTE", "\"", $text); |
| 74 | return $text; |
| 75 | } |
| 76 | |
| 77 | /** |
| 78 | * Escape date elements for safe ICalendar use. |
| 79 | * |
| 80 | * @param $date |
| 81 | * Date to escape. |
| 82 | * |
| 83 | * @param bool $gdata |
| 84 | * |
| 85 | * @return string |
| 86 | * Escaped date |
| 87 | */ |
| 88 | public static function formatDate($date, $gdata = FALSE) { |
| 89 | |
| 90 | if ($gdata) { |
| 91 | return date("Y-m-d\TH:i:s.000", |
| 92 | strtotime($date) |
| 93 | ); |
| 94 | } |
| 95 | else { |
| 96 | return date("Ymd\THis", |
| 97 | strtotime($date) |
| 98 | ); |
| 99 | } |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * Send the ICalendar to the browser with the specified content type |
| 104 | * - 'text/calendar' : used for downloaded ics file |
| 105 | * - 'text/plain' : used for iCal formatted feed |
| 106 | * - 'text/xml' : used for gData or rss formatted feeds |
| 107 | * |
| 108 | * |
| 109 | * @param string $calendar |
| 110 | * The calendar data to be published. |
| 111 | * @param string $content_type |
| 112 | * @param string $charset |
| 113 | * The character set to use, defaults to 'us-ascii'. |
| 114 | * @param string $fileName |
| 115 | * The file name (for downloads). |
| 116 | * @param string $disposition |
| 117 | * How the file should be sent ('attachment' for downloads). |
| 118 | */ |
| 119 | public static function send($calendar, $content_type = 'text/calendar', $charset = 'us-ascii', $fileName = NULL, $disposition = NULL) { |
| 120 | $config = CRM_Core_Config::singleton(); |
| 121 | $lang = $config->lcMessages; |
| 122 | CRM_Utils_System::setHttpHeader("Content-Language", $lang); |
| 123 | CRM_Utils_System::setHttpHeader("Content-Type", "$content_type; charset=$charset"); |
| 124 | |
| 125 | if ($content_type == 'text/calendar') { |
| 126 | CRM_Utils_System::setHttpHeader('Content-Length', strlen($calendar)); |
| 127 | CRM_Utils_System::setHttpHeader("Content-Disposition", "$disposition; filename=\"$fileName\""); |
| 128 | CRM_Utils_System::setHttpHeader("Pragma", "no-cache"); |
| 129 | CRM_Utils_System::setHttpHeader("Expires", "0"); |
| 130 | CRM_Utils_System::setHttpHeader("Cache-Control", "no-cache, must-revalidate"); |
| 131 | } |
| 132 | |
| 133 | echo $calendar; |
| 134 | } |
| 135 | |
| 136 | } |