ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
ilICalParser Class Reference
+ Collaboration diagram for ilICalParser:

Public Member Functions

 __construct ($a_ical, $a_type)
 Constructor. More...
 
 setCategoryId ($a_id)
 set category id More...
 
 parse ()
 Parse input. More...
 

Data Fields

const INPUT_STRING = 1
 
const INPUT_FILE = 2
 

Protected Member Functions

 getContainer ()
 get container More...
 
 setContainer ($a_container)
 set container More...
 
 dropContainer ()
 pop la More...
 
 pushContainer ($a_container)
 push container More...
 
 parseLine ($line)
 parse a line More...
 
 storeItems ($a_param_part, $a_value_part)
 store items More...
 
 splitLine ($a_line)
 parse parameters More...
 
 tokenize ($a_string, $a_tokenizer)
 tokenize string More...
 
 getTZ ($a_timezone)
 get timezone More...
 
 switchTZ (ilTimeZone $timezone)
 Switch timezone. More...
 
 restoreTZ ()
 restore time More...
 
 writeEvent ()
 write a new event More...
 
 purgeString ($a_string)
 purge string More...
 

Protected Attributes

 $log = null
 
 $category = null
 
 $ical = ''
 
 $file = ''
 
 $default_timezone = null
 
 $container = array()
 

Detailed Description

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

/

Definition at line 45 of file class.ilICalParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilICalParser::__construct (   $a_ical,
  $a_type 
)

Constructor.

public

Parameters
stringical string
Exceptions
ilICalParserException

Definition at line 69 of file class.ilICalParser.php.

References $GLOBALS, and $ilLog.

70  {
71  global $ilLog;
72 
73  if($a_type == self::INPUT_STRING)
74  {
75  $this->ical = $a_ical;
76  }
77  elseif($a_type == self::INPUT_FILE)
78  {
79  $this->file = $a_ical;
80  $this->ical = file_get_contents($a_ical);
81 
82  if(!strlen($this->ical))
83  {
84  throw new ilICalParserException($GLOBALS['cal_err_no_input']);
85  }
86  #$GLOBALS['ilLog']->write(__METHOD__.': Ical content: '. $this->ical);
87  }
88  $this->log = $ilLog;
89  }
$ilLog
$ilLog
Definition: inc.setup_header.php:136
$GLOBALS
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276

Member Function Documentation

◆ dropContainer()

ilICalParser::dropContainer ( )
protected

pop la

protected

Definition at line 168 of file class.ilICalParser.php.

Referenced by parseLine(), and storeItems().

169  {
170  return array_pop($this->container);
171  }
+ Here is the caller graph for this function:

◆ getContainer()

ilICalParser::getContainer ( )
protected

get container

protected

Definition at line 147 of file class.ilICalParser.php.

Referenced by parseLine(), storeItems(), and writeEvent().

148  {
149  return $this->container[count($this->container) - 1];
150  }
+ Here is the caller graph for this function:

◆ getTZ()

ilICalParser::getTZ (   $a_timezone)
protected

get timezone

protected

Definition at line 386 of file class.ilICalParser.php.

References $default_timezone, $tz, and ilTimeZone\_getInstance().

Referenced by parseLine(), and writeEvent().

387  {
388  $parts = explode('/',$a_timezone);
389  $tz = array_pop($parts);
390  $continent = array_pop($parts);
391 
392  if(isset($continent) and $continent)
393  {
394  $timezone = $continent.'/'.$tz;
395  }
396  else
397  {
398  $timezone = $a_timezone;
399  }
400 
401  try
402  {
403  if($this->default_timezone->getIdentifier() == $timezone)
404  {
405  return $this->default_timezone;
406  }
407  else
408  {
409  $this->log->write(__METHOD__.': Found new timezone: '.$timezone);
410  return ilTimeZone::_getInstance(trim($timezone));
411  }
412  }
413  catch(ilTimeZoneException $e)
414  {
415  $this->log->write(__METHOD__.': Found invalid timezone: '.$timezone);
416  return $this->default_timezone;
417  }
418 
419  }
$tz
$tz
Definition: inc.setup_header.php:108
ilTimeZoneException
Class for TimeZone exceptions.
Definition: class.ilTimeZoneException.php:34
ilTimeZone\_getInstance
static _getInstance($a_tz='')
get instance by timezone
Definition: class.ilTimeZone.php:123
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse()

ilICalParser::parse ( )

Parse input.

public

Definition at line 110 of file class.ilICalParser.php.

References ilTimeZone\_getInstance(), ilICalUtils\ICAL_EOL, ilICalUtils\ICAL_EOL_FB, ilICalUtils\ICAL_SPACE, ilICalUtils\ICAL_TAB, parseLine(), and tokenize().

111  {
112  $this->default_timezone = ilTimeZone::_getInstance();
113 
114  $lines = $this->tokenize($this->ical,ilICalUtils::ICAL_EOL);
115 
116  if(count(lines) == 1)
117  {
118  $lines = $this->tokenize($this->ical, ilICalUtils::ICAL_EOL_FB);
119  }
120 
121  for($i = 0; $i < count($lines); $i++)
122  {
123  $line = $lines[$i];
124 
125  // Check for next multilines (they start with a space)
126  $offset = 1;
127  while(isset($lines[$i + $offset]) and
128  (strpos($lines[$i + $offset],ilICalUtils::ICAL_SPACE) === 0) or
129  (strpos($lines[$i + $offset],ilICalUtils::ICAL_TAB) === 0))
130  {
131  $lines[$i + $offset] = str_replace(ilICalUtils::ICAL_EOL,'',$lines[$i + $offset]);
132  $line = $line.substr($lines[$i + $offset],1);
133  $offset++;
134  }
135  $i += ($offset - 1);
136 
137  // Parse this line
138  $this->parseLine($line);
139  }
140  }
ilICalParser\tokenize
tokenize($a_string, $a_tokenizer)
tokenize string
Definition: class.ilICalParser.php:376
ilTimeZone\_getInstance
static _getInstance($a_tz='')
get instance by timezone
Definition: class.ilTimeZone.php:123
ilICalParser\parseLine
parseLine($line)
parse a line
Definition: class.ilICalParser.php:190
+ Here is the call graph for this function:

◆ parseLine()

ilICalParser::parseLine (   $line)
protected

parse a line

protected

Definition at line 190 of file class.ilICalParser.php.

References $container, $params, dropContainer(), getContainer(), getTZ(), pushContainer(), setContainer(), splitLine(), storeItems(), and writeEvent().

Referenced by parse().

191  {
192  switch(trim($line))
193  {
194  case 'BEGIN:VCALENDAR':
195  $this->log->write(__METHOD__.': BEGIN VCALENDAR');
196  $this->setContainer(new ilICalComponent('VCALENDAR'));
197  break;
198 
199  case 'END:VCALENDAR':
200  $this->log->write(__METHOD__.': END VCALENDAR');
201  break;
202 
203  case 'BEGIN:VEVENT':
204  $this->log->write(__METHOD__.': BEGIN VEVENT');
205  $this->pushContainer(new ilICalComponent('VEVENT'));
206  break;
207 
208  case 'END:VEVENT':
209  $this->log->write(__METHOD__.': END VEVENT');
210 
211  $this->writeEvent();
212 
213  $this->dropContainer();
214  break;
215 
216  case 'BEGIN:VTIMEZONE':
217  $this->log->write(__METHOD__.': BEGIN VTIMEZONE');
218  $container = new ilICalComponent('VTIMEZONE');
219  $this->pushContainer($container);
220  break;
221 
222  case 'END:VTIMEZONE':
223  $this->log->write(__METHOD__.': END VTIMEZONE');
224 
225  if($tzid = $this->getContainer()->getItemsByName('TZID'))
226  {
227  $this->default_timezone = $this->getTZ($tzid[0]->getValue());
228  }
229  $this->dropContainer();
230  break;
231 
232  default:
233  if(strpos(trim($line),'BEGIN') === 0)
234  {
235  $this->log->write(__METHOD__.': Do not handling line:'.$line);
236  continue;
237  }
238  if(strpos(trim($line),'X-WR-TIMEZONE') === 0)
239  {
240  list($param,$value) = $this->splitLine($line);
241  $this->default_timezone = $this->getTZ($value);
242  }
243  else
244  {
245  list($params,$values) = $this->splitLine($line);
246  $this->storeItems($params,$values);
247  }
248  break;
249  }
250 
251  }
ilICalParser\splitLine
splitLine($a_line)
parse parameters
Definition: class.ilICalParser.php:355
ilICalParser\storeItems
storeItems($a_param_part, $a_value_part)
store items
Definition: class.ilICalParser.php:258
ilICalParser\writeEvent
writeEvent()
write a new event
Definition: class.ilICalParser.php:454
ilICalComponent
Represents a ical component.
Definition: class.ilICalComponent.php:38
ilICalParser\getContainer
getContainer()
get container
Definition: class.ilICalParser.php:147
ilICalParser\setContainer
setContainer($a_container)
set container
Definition: class.ilICalParser.php:158
ilICalParser\pushContainer
pushContainer($a_container)
push container
Definition: class.ilICalParser.php:179
$params
$params
Definition: example_049.php:96
ilICalParser\getTZ
getTZ($a_timezone)
get timezone
Definition: class.ilICalParser.php:386
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ purgeString()

ilICalParser::purgeString (   $a_string)
protected

purge string

protected

Definition at line 645 of file class.ilICalParser.php.

References ilUtil\stripSlashes().

Referenced by writeEvent().

646  {
647  $a_string = str_replace("\;",";",$a_string);
648  $a_string = str_replace("\,",",",$a_string);
649  $a_string = str_replace("\:",":",$a_string);
650  return ilUtil::stripSlashes($a_string);
651 
652  }
ilUtil\stripSlashes
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
Definition: class.ilUtil.php:2691
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ pushContainer()

ilICalParser::pushContainer (   $a_container)
protected

push container

protected

Parameters
ilICalItem

Definition at line 179 of file class.ilICalParser.php.

Referenced by parseLine(), and storeItems().

180  {
181  $this->container[] = $a_container;
182  }
+ Here is the caller graph for this function:

◆ restoreTZ()

ilICalParser::restoreTZ ( )
protected

restore time

protected

Definition at line 444 of file class.ilICalParser.php.

445  {
446  $this->default_timezone->restoreTZ();
447  }

◆ setCategoryId()

ilICalParser::setCategoryId (   $a_id)

set category id

public

Parameters
intcategory id
Returns

Definition at line 98 of file class.ilICalParser.php.

99  {
100  include_once('./Services/Calendar/classes/class.ilCalendarCategory.php');
101  $this->category = new ilCalendarCategory($a_id);
102  }
ilCalendarCategory
Stores calendar categories.
Definition: class.ilCalendarCategory.php:33

◆ setContainer()

ilICalParser::setContainer (   $a_container)
protected

set container

protected

Parameters
ilICalItem

Definition at line 158 of file class.ilICalParser.php.

Referenced by parseLine().

159  {
160  $this->container = array($a_container);
161  }
+ Here is the caller graph for this function:

◆ splitLine()

ilICalParser::splitLine (   $a_line)
protected

parse parameters

protected

Parameters
stringa line

Definition at line 355 of file class.ilICalParser.php.

Referenced by parseLine().

356  {
357  $matches = array();
358 
359  if(preg_match('/([^:]+):(.*)/',$a_line,$matches))
360  {
361  return array($matches[1],$matches[2]);
362  }
363  else
364  {
365  $this->log->write(__METHOD__.': Found invalid parameter: '.$a_line);
366  }
367 
368  return array('','');
369  }
+ Here is the caller graph for this function:

◆ storeItems()

ilICalParser::storeItems (   $a_param_part,
  $a_value_part 
)
protected

store items

protected

Definition at line 258 of file class.ilICalParser.php.

References dropContainer(), getContainer(), and pushContainer().

Referenced by parseLine().

259  {
260  // Check for a semicolon in param part and split it.
261 
262  $items = array();
263  if($splitted_param = explode(';',$a_param_part))
264  {
265  $counter = 0;
266  foreach($splitted_param as $param)
267  {
268  if(!$counter)
269  {
270  $items[$counter]['param'] = $param;
271  $items[$counter]['value'] = $a_value_part;
272  }
273  else
274  {
275  // Split by '='
276  if($splitted_param_values = explode('=',$param))
277  {
278  $items[$counter]['param'] = $splitted_param_values[0];
279  $items[$counter]['value'] = $splitted_param_values[1];
280  }
281  }
282  ++$counter;
283  }
284  }
285 
286  // Split value part
287  $substituted_values = str_replace('\;','',$a_value_part);
288 
289  $values = array();
290  if($splitted_values = explode(';',$substituted_values))
291  {
292  $counter = 0;
293  foreach($splitted_values as $value)
294  {
295  // Split by '='
296  if($splitted_value_values = explode('=',$value))
297  {
298  $values[$counter]['param'] = $splitted_value_values[0];
299  $values[$counter]['value'] = $splitted_value_values[1];
300  }
301  ++$counter;
302  }
303  }
304 
305  // Return if there are no values
306  if(!count($items))
307  {
308  $this->log->write(__METHOD__.': Cannot parse parameter: '.$a_param_part.', value: '.$a_value_part);
309  return false;
310  }
311 
312 
313  $counter = 0;
314  foreach($items as $item)
315  {
316  if(!$counter)
317  {
318  // First is ical-Parameter
319  $parameter = new ilICalProperty($item['param'],$item['value']);
320 
321  if(!$this->getContainer() instanceof ilICalItem)
322  {
323  continue;
324  }
325 
326  $this->getContainer()->addItem($parameter);
327  $this->pushContainer($parameter);
328 
329  if(count($values) > 1)
330  {
331  foreach($values as $value)
332  {
333  $value = new ilICalValue($value['param'],$value['value']);
334  $this->getContainer()->addItem($value);
335  }
336  }
337  }
338  else
339  {
340  $value = new ilICalParameter($item['param'],$item['value']);
341  $this->getContainer()->addItem($value);
342  }
343  ++$counter;
344  }
345  $this->dropContainer();
346  }
ilICalProperty
Represents a ical property.
Definition: class.ilICalProperty.php:36
ilICalValue
Used for storage og multiple values E.g RRULE:FREQ=WEEKLY;COUNT=20;INTERVAL=2;BYDAY=TU.
Definition: class.ilICalValue.php:36
ilICalParameter
This class represents a ical parameter E.g VALUE=DATETIME.
Definition: class.ilICalParameter.php:35
ilICalParser\getContainer
getContainer()
get container
Definition: class.ilICalParser.php:147
ilICalParser\pushContainer
pushContainer($a_container)
push container
Definition: class.ilICalParser.php:179
ilICalItem
Abstract base class for all ical items (Component, Parameter and Value)
Definition: class.ilICalItem.php:34
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ switchTZ()

ilICalParser::switchTZ ( ilTimeZone  $timezone)
protected

Switch timezone.

protected

Definition at line 426 of file class.ilICalParser.php.

References ilTimeZone\switchTZ().

427  {
428  try
429  {
430  $timezone->switchTZ();
431  }
432  catch(ilTimeZoneException $e)
433  {
434  $this->log->write(__METHOD__.': Found invalid timezone: '.$timezone);
435  return false;
436  }
437  }
ilTimeZone\switchTZ
switchTZ()
Switch timezone to given timezone.
Definition: class.ilTimeZone.php:160
ilTimeZoneException
Class for TimeZone exceptions.
Definition: class.ilTimeZoneException.php:34
+ Here is the call graph for this function:

◆ tokenize()

ilICalParser::tokenize (   $a_string,
  $a_tokenizer 
)
protected

tokenize string

protected

Definition at line 376 of file class.ilICalParser.php.

Referenced by parse().

377  {
378  return explode($a_tokenizer,$a_string);
379  }
+ Here is the caller graph for this function:

◆ writeEvent()

ilICalParser::writeEvent ( )
protected

write a new event

protected

Definition at line 454 of file class.ilICalParser.php.

References $default_timezone, ilCalendarCategoryAssignments\addAssignment(), getContainer(), getTZ(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_DAY, ilDateTime\increment(), ilCalendarCategory\LTYPE_REMOTE, and purgeString().

Referenced by parseLine().

455  {
456  $entry = new ilCalendarEntry();
457 
458  // Search for summary
459  foreach($this->getContainer()->getItemsByName('SUMMARY',false) as $item)
460  {
461  if(is_a($item,'ilICalProperty'))
462  {
463  $entry->setTitle($this->purgeString($item->getValue()));
464  break;
465  }
466  }
467  // Search description
468  foreach($this->getContainer()->getItemsByName('DESCRIPTION',false) as $item)
469  {
470  if(is_a($item,'ilICalProperty'))
471  {
472  $entry->setDescription($this->purgeString($item->getValue()));
473  break;
474  }
475  }
476 
477  // Search location
478  foreach($this->getContainer()->getItemsByName('LOCATION',false) as $item)
479  {
480  if(is_a($item,'ilICalProperty'))
481  {
482  $entry->setLocation($this->purgeString($item->getValue()));
483  break;
484  }
485  }
486 
487  foreach($this->getContainer()->getItemsByName('DTSTART') as $start)
488  {
489  $fullday = false;
490  foreach($start->getItemsByName('VALUE') as $type)
491  {
492  if($type->getValue() == 'DATE')
493  {
494  $fullday = true;
495  }
496  }
497  $start_tz = $this->default_timezone;
498  foreach($start->getItemsByName('TZID') as $param)
499  {
500  $start_tz = $this->getTZ($param->getValue());
501  }
502  if($fullday)
503  {
504  $start = new ilDate($start->getValue(),
505  IL_CAL_DATE);
506  }
507  else
508  {
509  $start = new ilDateTime($start->getValue(),
510  IL_CAL_DATETIME,
511  $start_tz->getIdentifier());
512  }
513  $entry->setStart($start);
514  $entry->setFullday($fullday);
515  }
516 
517  foreach($this->getContainer()->getItemsByName('DTEND') as $end)
518  {
519  $fullday = false;
520  foreach($end->getItemsByName('VALUE') as $type)
521  {
522  if($type->getValue() == 'DATE')
523  {
524  $fullday = true;
525  }
526  }
527  $end_tz = $this->default_timezone;
528  foreach($end->getItemsByName('TZID') as $param)
529  {
530  $end_tz = $this->getTZ($param->getValue());
531  }
532  if($fullday)
533  {
534  $end = new ilDate($end->getValue(),
535  IL_CAL_DATE);
536  $end->increment(IL_CAL_DAY,-1);
537  }
538  else
539  {
540  $end = new ilDateTime($end->getValue(),
541  IL_CAL_DATETIME,
542  $end_tz->getIdentifier());
543  }
544  $entry->setEnd($end);
545  $entry->setFullday($fullday);
546  }
547  // save calendar event
548  if($this->category->getLocationType() == ilCalendarCategory::LTYPE_REMOTE)
549  {
550  $entry->setAutoGenerated(true);
551  }
552  $entry->save();
553 
554  include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
555  $ass = new ilCalendarCategoryAssignments($entry->getEntryId());
556  $ass->addAssignment($this->category->getCategoryID());
557 
558 
559  // Recurrences
560  foreach($this->getContainer()->getItemsByName('RRULE') as $recurrence)
561  {
562  #var_dump("<pre>",$recurrence,"</pre>");
563 
564 
565  include_once('./Services/Calendar/classes/class.ilCalendarRecurrence.php');
566  $rec = new ilCalendarRecurrence();
567  $rec->setEntryId($entry->getEntryId());
568 
569  foreach($recurrence->getItemsByName('FREQ') as $freq)
570  {
571  switch($freq->getValue())
572  {
573  case 'DAILY':
574  case 'WEEKLY':
575  case 'MONTHLY':
576  case 'YEARLY':
577  $rec->setFrequenceType((string) $freq->getValue());
578  break;
579 
580  default:
581  $this->log->write(__METHOD__.': Cannot handle recurring event of type: '.$freq->getValue());
582  break 3;
583  }
584  }
585 
586  foreach($recurrence->getItemsByName('COUNT') as $value)
587  {
588  $rec->setFrequenceUntilCount((string) $value->getValue());
589  break;
590  }
591  foreach($recurrence->getItemsByName('UNTIL') as $until)
592  {
593  $rec->setFrequenceUntilDate(new ilDate($until->getValue(),IL_CAL_DATE));
594  break;
595  }
596  foreach($recurrence->getItemsByName('INTERVAL') as $value)
597  {
598  $rec->setInterval((string) $value->getValue());
599  break;
600  }
601  foreach($recurrence->getItemsByName('BYDAY') as $value)
602  {
603  $rec->setBYDAY((string) $value->getValue());
604  break;
605  }
606  foreach($recurrence->getItemsByName('BYWEEKNO') as $value)
607  {
608  $rec->setBYWEEKNO((string) $value->getValue());
609  break;
610  }
611  foreach($recurrence->getItemsByName('BYMONTH') as $value)
612  {
613  $rec->setBYMONTH((string) $value->getValue());
614  break;
615  }
616  foreach($recurrence->getItemsByName('BYMONTHDAY') as $value)
617  {
618  $rec->setBYMONTHDAY((string) $value->getValue());
619  break;
620  }
621  foreach($recurrence->getItemsByName('BYYEARDAY') as $value)
622  {
623  $rec->setBYYEARDAY((string) $value->getValue());
624  break;
625  }
626  foreach($recurrence->getItemsByName('BYSETPOS') as $value)
627  {
628  $rec->setBYSETPOS((string) $value->getValue());
629  break;
630  }
631  foreach($recurrence->getItemsByName('WKST') as $value)
632  {
633  $rec->setWeekstart((string) $value->getValue());
634  break;
635  }
636  $rec->save();
637  }
638  }
ilCalendarEntry
Model for a calendar entry.
Definition: class.ilCalendarEntry.php:20
IL_CAL_DATETIME
const IL_CAL_DATETIME
Definition: class.ilDateTime.php:9
IL_CAL_DAY
const IL_CAL_DAY
Definition: class.ilDateTime.php:20
ilDate
Class for single dates.
Definition: class.ilDate.php:36
ilDateTime
Date and time handling
Definition: class.ilDateTime.php:32
ilDateTime\increment
increment($a_type, $a_count=1)
increment
Definition: class.ilDateTime.php:262
IL_CAL_DATE
const IL_CAL_DATE
Definition: class.ilDateTime.php:10
ilICalParser\getContainer
getContainer()
get container
Definition: class.ilICalParser.php:147
ilICalParser\getTZ
getTZ($a_timezone)
get timezone
Definition: class.ilICalParser.php:386
ilICalParser\purgeString
purgeString($a_string)
purge string
Definition: class.ilICalParser.php:645
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $category

ilICalParser::$category = null
protected

Definition at line 52 of file class.ilICalParser.php.

◆ $container

ilICalParser::$container = array()
protected

Definition at line 58 of file class.ilICalParser.php.

Referenced by parseLine().

◆ $default_timezone

ilICalParser::$default_timezone = null
protected

Definition at line 56 of file class.ilICalParser.php.

Referenced by getTZ(), and writeEvent().

◆ $file

ilICalParser::$file = ''
protected

Definition at line 55 of file class.ilICalParser.php.

◆ $ical

ilICalParser::$ical = ''
protected

Definition at line 54 of file class.ilICalParser.php.

◆ $log

ilICalParser::$log = null
protected

Definition at line 50 of file class.ilICalParser.php.

◆ INPUT_FILE

const ilICalParser::INPUT_FILE = 2

Definition at line 48 of file class.ilICalParser.php.

Referenced by ilCalendarCategoryGUI\doImportFile().

◆ INPUT_STRING

const ilICalParser::INPUT_STRING = 1

Definition at line 47 of file class.ilICalParser.php.

Referenced by ilCalendarRemoteReader\importIcal().

The documentation for this class was generated from the following file: