[Summary view] [Print] [Text view]

   1  <?php // $Id: iCalendar_parameters.php,v 1.1 2006/01/13 15:06:25 defacer Exp $
   2  
   3  /**
   4   *  BENNU - PHP iCalendar library
   5   *  (c) 2005-2006 Ioannis Papaioannou (pj@moodle.org). All rights reserved.
   6   *
   7   *  Released under the LGPL.
   8   *
   9   *  See http://bennu.sourceforge.net/ for more information and downloads.
  10   *
  11   * @author Ioannis Papaioannou 
  12   * @version $Id: iCalendar_parameters.php,v 1.1 2006/01/13 15:06:25 defacer Exp $
  13   * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
  14   */
  15  
  16  class iCalendar_parameter {
  17      function multiple_values_allowed($parameter) {
  18          switch($parameter) {
  19              case 'DELEGATED-FROM':
  20              case 'DELEGATED-TO':
  21              case 'MEMBER':
  22                  return true;
  23              default:
  24                  return false;
  25          }
  26      }
  27  
  28      function default_value($parameter) {
  29          switch($parameter) {
  30              case 'CUTYPE':   return 'INDIVIDUAL';
  31              case 'FBTYPE':   return 'BUSY';
  32              case 'PARTSTAT': return 'NEEDS-ACTION';
  33              case 'RELATED':  return 'START';
  34              case 'RELTYPE':  return 'PARENT';
  35              case 'ROLE':     return 'REQ-PARTICIPANT';
  36              case 'RSVP':     return 'FALSE';
  37              default:         return NULL;
  38          }
  39      }
  40  
  41      function is_valid_value(&$parent_property, $parameter, $value) {
  42          switch($parameter) {
  43              // These must all be a URI
  44              case 'ALTREP':
  45              case 'DIR':
  46                  return rfc2445_is_valid_value($value, RFC2445_TYPE_URI);
  47              break;
  48  
  49              // These must be CAL-ADDRESS, which is equivalent to URI
  50              case 'DELEGATED-FROM':
  51              case 'DELEGATED-TO':
  52              case 'MEMBER':
  53              case 'SENT-BY':
  54                  return rfc2445_is_valid_value($value, RFC2445_TYPE_CAL_ADDRESS);
  55              break;
  56  
  57              // These are textual parameters, so the MUST NOT contain double quotes
  58              case 'CN':
  59                  return (strpos($value, '"') === false);
  60              break;
  61  
  62              // These have enumerated legal values
  63              case 'CUTYPE':
  64                  $value = strtoupper($value);
  65                  return ($value == 'INDIVIDUAL' || $value == 'GROUP' || $value == 'RESOURCE' || $value == 'ROOM' || $value == 'UNKNOWN' || rfc2445_is_xname($value));
  66              break;
  67  
  68              case 'ENCODING':
  69                  $value = strtoupper($value);
  70                  return ($value == '8BIT' || $value == 'BASE64' || rfc2445_is_xname($value));
  71              break;
  72  
  73              case 'FBTYPE':
  74                  $value = strtoupper($value);
  75                  return ($value == 'FREE' || $value == 'BUSY' || $value == 'BUSY-UNAVAILABLE' || $value == 'BUSY-TENTATIVE' || rfc2445_is_xname($value));
  76              break;
  77  
  78              case 'FMTTYPE':
  79                  $fmttypes = array(
  80                          'TEXT'        => array('PLAIN', 'RICHTEXT', 'ENRICHED', 'TAB-SEPARATED-VALUES', 'HTML', 'SGML',
  81                                                 'VND.LATEX-Z', 'VND.FMI.FLEXSTOR'),
  82                          'MULTIPART'   => array('MIXED', 'ALTERNATIVE', 'DIGEST', 'PARALLEL', 'APPLEDOUBLE', 'HEADER-SET',
  83                                                 'FORM-DATA', 'RELATED', 'REPORT', 'VOICE-MESSAGE', 'SIGNED', 'ENCRYPTED',
  84                                                 'BYTERANGES'),
  85                          'MESSAGE'     => array('RFC822', 'PARTIAL', 'EXTERNAL-BODY', 'NEWS', 'HTTP'),
  86                          'APPLICATION' => array('OCTET-STREAM', 'POSTSCRIPT', 'ODA', 'ATOMICMAIL', 'ANDREW-INSET', 'SLATE',
  87                                                 'WITA', 'DEC-DX', 'DCA-RFT', 'ACTIVEMESSAGE', 'RTF', 'APPLEFILE',
  88                                                 'MAC-BINHEX40', 'NEWS-MESSAGE-ID', 'NEWS-TRANSMISSION', 'WORDPERFECT5.1',
  89                                                 'PDF', 'ZIP', 'MACWRITEII', 'MSWORD', 'REMOTE-PRINTING', 'MATHEMATICA',
  90                                                 'CYBERCASH', 'COMMONGROUND', 'IGES', 'RISCOS', 'ESHOP', 'X400-BP', 'SGML',
  91                                                 'CALS-1840', 'PGP-ENCRYPTED', 'PGP-SIGNATURE', 'PGP-KEYS', 'VND.FRAMEMAKER',
  92                                                 'VND.MIF', 'VND.MS-EXCEL', 'VND.MS-POWERPOINT', 'VND.MS-PROJECT',
  93                                                 'VND.MS-WORKS', 'VND.MS-TNEF', 'VND.SVD', 'VND.MUSIC-NIFF', 'VND.MS-ARTGALRY',
  94                                                 'VND.TRUEDOC', 'VND.KOAN', 'VND.STREET-STREAM', 'VND.FDF',
  95                                                 'SET-PAYMENT-INITIATION', 'SET-PAYMENT', 'SET-REGISTRATION-INITIATION',
  96                                                 'SET-REGISTRATION', 'VND.SEEMAIL', 'VND.BUSINESSOBJECTS',
  97                                                 'VND.MERIDIAN-SLINGSHOT', 'VND.XARA', 'SGML-OPEN-CATALOG', 'VND.RAPID',
  98                                                 'VND.ENLIVEN', 'VND.JAPANNET-REGISTRATION-WAKEUP', 
  99                                                 'VND.JAPANNET-VERIFICATION-WAKEUP', 'VND.JAPANNET-PAYMENT-WAKEUP',
 100                                                 'VND.JAPANNET-DIRECTORY-SERVICE', 'VND.INTERTRUST.DIGIBOX', 'VND.INTERTRUST.NNCP'),
 101                          'IMAGE'       => array('JPEG', 'GIF', 'IEF', 'G3FAX', 'TIFF', 'CGM', 'NAPLPS', 'VND.DWG', 'VND.SVF',
 102                                                 'VND.DXF', 'PNG', 'VND.FPX', 'VND.NET-FPX'),
 103                          'AUDIO'       => array('BASIC', '32KADPCM', 'VND.QCELP'),
 104                          'VIDEO'       => array('MPEG', 'QUICKTIME', 'VND.VIVO', 'VND.MOTOROLA.VIDEO', 'VND.MOTOROLA.VIDEOP')
 105                  );
 106                  $value = strtoupper($value);
 107                  if(rfc2445_is_xname($value)) {
 108                      return true;
 109                  }
 110                  @list($type, $subtype) = explode('/', $value);
 111                  if(empty($type) || empty($subtype)) {
 112                      return false;
 113                  }
 114                  if(!isset($fmttypes[$type]) || !in_array($subtype, $fmttypes[$type])) {
 115                      return false;
 116                  }
 117                  return true;
 118              break;
 119  
 120              case 'LANGUAGE':
 121                  $value = strtoupper($value);
 122                  $parts = explode('-', $value);
 123                  foreach($parts as $part) {
 124                      if(empty($part)) {
 125                          return false;
 126                      }
 127                      if(strspn($part, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789') != strlen($part)) {
 128                          return false;
 129                      }
 130                  }
 131                  return true;
 132              break;
 133  
 134              case 'PARTSTAT':
 135                  $value = strtoupper($value);
 136                  switch($parent_property->parent_component) {
 137                      case 'VEVENT':
 138                          return ($value == 'NEEDS-ACTION' || $value == 'ACCEPTED' || $value == 'DECLINED' || $value == 'TENTATIVE'
 139                                  || $value == 'DELEGATED' || rfc2445_is_xname($value));
 140                      break;
 141                      case 'VTODO':
 142                          return ($value == 'NEEDS-ACTION' || $value == 'ACCEPTED' || $value == 'DECLINED' || $value == 'TENTATIVE'
 143                                  || $value == 'DELEGATED' || $value == 'COMPLETED' || $value == 'IN-PROCESS' || rfc2445_is_xname($value));
 144                      break;
 145                      case 'VJOURNAL':
 146                          return ($value == 'NEEDS-ACTION' || $value == 'ACCEPTED' || $value == 'DECLINED' || rfc2445_is_xname($value));
 147                      break;
 148                  }
 149                  return false;
 150              break;
 151  
 152              case 'RANGE':
 153                  $value = strtoupper($value);
 154                  return ($value == 'THISANDPRIOR' || $value == 'THISANDFUTURE');
 155              break;
 156  
 157              case 'RELATED':
 158                  $value = strtoupper($value);
 159                  return ($value == 'START' || $value == 'END');
 160              break;
 161  
 162              case 'RELTYPE':
 163                  $value = strtoupper($value);
 164                  return ($value == 'PARENT' || $value == 'CHILD' || $value == 'SIBLING' || rfc2445_is_xname($value));
 165              break;
 166  
 167              case 'ROLE':
 168                  $value = strtoupper($value);
 169                  return ($value == 'CHAIR' || $value == 'REQ-PARTICIPANT' || $value == 'OPT-PARTICIPANT' || $value == 'NON-PARTICIPANT' || rfc2445_is_xname($value));
 170              break;
 171  
 172              case 'RSVP':
 173                  $value = strtoupper($value);
 174                  return ($value == 'TRUE' || $value == 'FALSE');
 175              break;
 176  
 177              case 'TZID':
 178                  if(empty($value)) {
 179                      return false;
 180                  }
 181                  return (strcspn($value, '";:,') == strlen($value));
 182              break;
 183  
 184              case 'VALUE':
 185                  $value = strtoupper($value);
 186                  return ($value == 'BINARY'    || $value == 'BOOLEAN'    || $value == 'CAL-ADDRESS' || $value == 'DATE'    ||
 187                          $value == 'DATE-TIME' || $value == 'DURATION'   || $value == 'FLOAT'       || $value == 'INTEGER' ||
 188                          $value == 'PERIOD'    || $value == 'RECUR'      || $value == 'TEXT'        || $value == 'TIME'    ||
 189                          $value == 'URI'       || $value == 'UTC-OFFSET' || rfc2445_is_xname($value));
 190              break;
 191          }
 192      }
 193  
 194      function do_value_formatting($parameter, $value) {
 195          switch($parameter) {
 196              // Parameters of type CAL-ADDRESS or URI MUST be double-quoted
 197              case 'ALTREP':
 198              case 'DIR':
 199              case 'DELEGATED-FROM':
 200              case 'DELEGATED-TO':
 201              case 'MEMBER':
 202              case 'SENT-BY':
 203                  return '"'.$value.'"';
 204              break;
 205  
 206              // Textual parameter types must be double quoted if they contain COLON, SEMICOLON
 207              // or COMMA. Quoting always sounds easier and standards-conformant though.
 208              case 'CN':
 209                  return '"'.$value.'"';
 210              break;
 211  
 212              // Parameters with enumerated legal values, just make them all caps
 213              case 'CUTYPE':
 214              case 'ENCODING':
 215              case 'FBTYPE':
 216              case 'FMTTYPE':
 217              case 'LANGUAGE':
 218              case 'PARTSTAT':
 219              case 'RANGE':
 220              case 'RELATED':
 221              case 'RELTYPE':
 222              case 'ROLE':
 223              case 'RSVP':
 224              case 'VALUE':
 225                  return strtoupper($value);
 226              break;
 227  
 228              // Parameters we shouldn't be messing with
 229              case 'TZID':
 230                  return $value;
 231              break;
 232          }
 233      }
 234  
 235      function undo_value_formatting($parameter, $value) {
 236      }
 237  
 238  }
 239  
 240  ?>