ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
class.ilCourseXMLParser.php
Go to the documentation of this file.
1<?php
2/*
3 +-----------------------------------------------------------------------------+
4 | ILIAS open source |
5 +-----------------------------------------------------------------------------+
6 | Copyright (c) 1998-2001 ILIAS open source, University of Cologne |
7 | |
8 | This program is free software; you can redistribute it and/or |
9 | modify it under the terms of the GNU General Public License |
10 | as published by the Free Software Foundation; either version 2 |
11 | of the License, or (at your option) any later version. |
12 | |
13 | This program is distributed in the hope that it will be useful, |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 | GNU General Public License for more details. |
17 | |
18 | You should have received a copy of the GNU General Public License |
19 | along with this program; if not, write to the Free Software |
20 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
21 +-----------------------------------------------------------------------------+
22*/
23
24
25include_once("Services/MetaData/classes/class.ilMDSaxParser.php");
26include_once("Services/MetaData/classes/class.ilMD.php");
27include_once('Services/Utilities/interfaces/interface.ilSaxSubsetParser.php');
28include_once('Services/Utilities/classes/class.ilSaxController.php');
29include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
30include_once 'Modules/Course/classes/class.ilCourseWaitingList.php';
31include_once 'Modules/Course/classes/class.ilCourseConstants.php';
32
33
34
44{
45 var $lng;
46 var $md_obj = null; // current meta data object
47
49
59 function ilCourseXMLParser($a_course_obj, $a_xml_file = '')
60 {
61 global $lng,$ilLog;
62
63 parent::ilMDSaxParser($a_xml_file);
64
65 $this->sax_controller = new ilSaxController();
66
67 $this->log =& $ilLog;
68
69 $this->course_obj = $a_course_obj;
70 $this->course_members = ilCourseParticipants::_getInstanceByObjId($this->course_obj->getId());
71 $this->course_waiting_list = new ilCourseWaitingList($this->course_obj->getId());
72 // flip the array so we can use array_key_exists
73 $this->course_members_array = array_flip($this->course_members->getParticipants());
74
75 $this->md_obj = new ilMD($this->course_obj->getId(),0,'crs');
76 $this->setMDObject($this->md_obj);
77
78 $this->lng =& $lng;
79 }
80
87 function setHandlers($a_xml_parser)
88 {
89 $this->sax_controller->setHandlers($a_xml_parser);
90 $this->sax_controller->setDefaultElementHandler($this);
91
92 include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValueParser.php');
93 $this->sax_controller->setElementHandler(
94 $this->adv_md_handler = new ilAdvancedMDValueParser($this->course_obj->getId()),
95 'AdvancedMetaData');
96 }
97
98
99
100
108 function handlerBeginTag($a_xml_parser,$a_name,$a_attribs)
109 {
110 if($this->in_meta_data)
111 {
112 parent::handlerBeginTag($a_xml_parser,$a_name,$a_attribs);
113 return;
114 }
115
116 switch($a_name)
117 {
118 case 'Course':
119
120 if(strlen($a_attribs['importId']))
121 {
122 $this->log->write("CourseXMLParser: importId = ".$a_attribs['importId']);
123 $this->course_obj->setImportId($a_attribs['importId']);
124 ilObject::_writeImportId($this->course_obj->getId(),$a_attribs['importId']);
125 }
126 if(strlen($a_attribs['showMembers']))
127 {
128 $this->course_obj->setShowMembers(
129 $a_attribs['showMembers'] == 'Yes' ? true : false
130 );
131 }
132 break;
133
134 case 'Admin':
135 if($id_data = $this->__parseId($a_attribs['id']))
136 {
137 if($id_data['local'] or $id_data['imported'])
138 {
139 $this->handleAdmin($a_attribs, $id_data);
140 }
141 }
142 break;
143
144 case 'Tutor':
145 if($id_data = $this->__parseId($a_attribs['id']))
146 {
147 if($id_data['local'] or $id_data['imported'])
148 {
149 $this->handleTutor($a_attribs, $id_data);
150
151 }
152 }
153 break;
154
155 case 'Member':
156 if($id_data = $this->__parseId($a_attribs['id']))
157 {
158 if($id_data['local'] or $id_data['imported'])
159 {
160 $this->handleMember($a_attribs, $id_data);
161 }
162 }
163 break;
164
165 case 'Subscriber':
166 if($id_data = $this->__parseId($a_attribs['id']))
167 {
168 if($id_data['local'] or $id_data['imported'])
169 {
170 $this->handleSubscriber($a_attribs, $id_data);
171 }
172 }
173 break;
174
175 case 'WaitingList':
176 if($id_data = $this->__parseId($a_attribs['id']))
177 {
178 if($id_data['local'] or $id_data['imported'])
179 {
180 $this->handleWaitingList($a_attribs, $id_data);
181 }
182 }
183 break;
184
185 case 'Owner':
186 if($id_data = $this->__parseId($a_attribs['id']))
187 {
188 if($id_data['local'] or $id_data['imported'])
189 {
190 $this->course_obj->setOwner($id_data['usr_id']);
191 $this->course_obj->updateOwner();
192 }
193 }
194 break;
195
196
197 case 'Settings':
198 $this->in_settings = true;
199 break;
200 case 'Availability':
201 $this->in_availability = true;
202 break;
203
204 case 'NotAvailable':
205 if($this->in_availability)
206 {
207 $this->course_obj->setActivationType(IL_CRS_ACTIVATION_OFFLINE);
208 }
209 elseif($this->in_registration)
210 {
211 $this->course_obj->setSubscriptionLimitationType(IL_CRS_SUBSCRIPTION_DEACTIVATED);
212 }
213
214 break;
215
216 case 'Unlimited':
217 if($this->in_availability)
218 {
219 $this->course_obj->setOfflineStatus(false);
220 $this->course_obj->setActivationType(IL_CRS_ACTIVATION_UNLIMITED);
221 }
222 elseif($this->in_registration)
223 {
224 $this->course_obj->setSubscriptionLimitationType(IL_CRS_SUBSCRIPTION_UNLIMITED);
225 }
226
227 break;
228 case 'TemporarilyAvailable':
229 if($this->in_availability)
230 {
231 $this->course_obj->setOfflineStatus(false);
232 $this->course_obj->setActivationType(IL_CRS_ACTIVATION_LIMITED);
233 }
234 elseif($this->in_registration)
235 {
236 $this->course_obj->setSubscriptionLimitationType(IL_CRS_SUBSCRIPTION_LIMITED);
237 }
238 break;
239
240 case 'Start':
241 break;
242
243 case 'End':
244 break;
245
246 case 'Syllabus':
247 break;
248
249 case 'Contact':
250 break;
251
252 case 'Name':
253 case 'Responsibility':
254 case 'Phone':
255 case 'Email':
256 case 'Consultation':
257 break;
258
259 case 'Registration':
260 $this->in_registration = true;
261
262 switch($a_attribs['registrationType'])
263 {
264 case 'Confirmation':
265 $this->course_obj->setSubscriptionType(IL_CRS_SUBSCRIPTION_CONFIRMATION);
266 break;
267
268 case 'Direct':
269 $this->course_obj->setSubscriptionType(IL_CRS_SUBSCRIPTION_DIRECT);
270 break;
271
272 case 'Password':
273 $this->course_obj->setSubscriptionType(IL_CRS_SUBSCRIPTION_PASSWORD);
274 break;
275 }
276
277 $this->course_obj->setSubscriptionMaxMembers((int) $a_attribs['maxMembers']);
278 $this->course_obj->enableSubscriptionMembershipLimitation($this->course_obj->getSubscriptionMaxMembers() > 0);
279 $this->course_obj->setSubscriptionNotify($a_attribs['notification'] == 'Yes' ? true : false);
280 $this->course_obj->enableWaitingList($a_attribs['waitingList'] == 'Yes' ? true : false);
281 break;
282
283 case 'Sort':
284 include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
285 ilContainerSortingSettings::_importContainerSortingSettings($a_attribs, $this->course_obj->getId());
286
287 //#17837
288 $this->course_obj->setOrderType(
289 ilContainerSortingSettings::getInstanceByObjId($this->course_obj->getId())->getSortMode()
290 );
291 break;
292
293
294 case 'Archive':
295 $this->in_archive = true;
296 switch($a_attribs['Access'])
297 {
298 case 'Disabled':
299 $this->course_obj->setArchiveType(IL_CRS_ARCHIVE_NONE);
300 break;
301
302 case 'Read':
303 $this->course_obj->setArchiveType(IL_CRS_ARCHIVE_NONE);
304 #$this->course_obj->setViewMode(IL_CRS_VIEW_ARCHIVE);
305 break;
306
307 case 'Download':
308 #$this->course_obj->setViewMode(IL_CRS_VIEW_ARCHIVE);
309 $this->course_obj->setArchiveType(IL_CRS_ARCHIVE_DOWNLOAD);
310 break;
311 }
312 break;
313
314 case 'Disabled':
315 $this->course_obj->getSubscriptionLimitationType(IL_CRS_SUBSCRIPTION_DEACTIVATED);
316 break;
317
318 case "MetaData":
319 $this->in_meta_data = true;
320 parent::handlerBeginTag($a_xml_parser,$a_name,$a_attribs);
321 break;
322
323 case 'ContainerSetting':
324 $this->current_container_setting = $a_attribs['id'];
325 break;
326 }
327 }
328
337 private function handleMember ($a_attribs, $id_data)
338 {
339 if (!isset($a_attribs['action']) || $a_attribs['action'] == 'Attach')
340 // if action not set, or set and attach
341 {
342 if (!array_key_exists($id_data['usr_id'], $this->course_members_array))
343 // add only if member is not yet assigned as tutor or admin
344 {
345 $this->course_members->add($id_data['usr_id'],IL_CRS_MEMBER);
346 if($a_attribs['blocked'] == 'Yes')
347 {
348 $this->course_members->updateBlocked($id_data['usr_id'],true);
349 }
350 if($a_attribs['passed'] == 'Yes')
351 {
352 $this->course_members->updatePassed($id_data['usr_id'],true);
353 }
354 $this->course_members_array[$id_data['usr_id']] = "added";
355 }
356 else
357 // the member does exist. Now update status etc. only
358 {
359 if($a_attribs['blocked'] == 'Yes')
360 {
361 $this->course_members->updateBlocked($id_data['usr_id'],true);
362 }
363 if($a_attribs['passed'] == 'Yes')
364 {
365 $this->course_members->updatePassed($id_data['usr_id'],true);
366 }
367 }
368 }
369 elseif (isset($a_attribs['action']) && $a_attribs['action'] == 'Detach' && $this->course_members->isMember($id_data['usr_id']))
370 // if action set and detach and is member of course
371 {
372 $this->course_members->delete($id_data['usr_id']);
373 }
374
375 }
376
377
385 private function handleAdmin ($a_attribs, $id_data)
386 {
387 global $rbacadmin;
388
389 if (!isset($a_attribs['action']) || $a_attribs['action'] == 'Attach')
390 // if action not set, or attach
391 {
392 if (!array_key_exists($id_data['usr_id'], $this->course_members_array))
393 // add only if member is not assigned yet
394 {
395 $this->course_members->add($id_data['usr_id'],IL_CRS_ADMIN);
396 if($a_attribs['notification'] == 'Yes')
397 {
398 $this->course_members->updateNotification($id_data['usr_id'],true);
399 }
400 if($a_attribs['passed'] == 'Yes')
401 {
402 $this->course_members->updatePassed($id_data['usr_id'],true);
403 }
404 $this->course_members_array[$id_data['usr_id']] = "added";
405 }
406 else
407 // update
408 {
409 if($a_attribs['notification'] == 'Yes')
410 {
411 $this->course_members->updateNotification($id_data['usr_id'],true);
412 }
413 if($a_attribs['passed'] == 'Yes')
414 {
415 $this->course_members->updatePassed($id_data['usr_id'],true);
416 }
417 $this->course_members->updateBlocked($id_data['usr_id'],false);
418 }
419 }
420 elseif (isset($a_attribs['action']) && $a_attribs['action'] == 'Detach' && $this->course_members->isAdmin($id_data['usr_id']))
421 // if action set and detach and is admin of course
422 {
423 $this->course_members->delete($id_data['usr_id']);
424 }
425
426 }
427
428
436 private function handleTutor ($a_attribs, $id_data) {
437 if (!isset($a_attribs['action']) || $a_attribs['action'] == 'Attach')
438 // if action not set, or attach
439 {
440 if (!array_key_exists($id_data['usr_id'], $this->course_members_array))
441 // add only if member is not assigned yet
442 {
443 $this->course_members->add($id_data['usr_id'],IL_CRS_TUTOR);
444 if($a_attribs['notification'] == 'Yes')
445 {
446 $this->course_members->updateNotification($id_data['usr_id'],true);
447 }
448 if($a_attribs['passed'] == 'Yes')
449 {
450 $this->course_members->updatePassed($id_data['usr_id'],true);
451 }
452 $this->course_members_array[$id_data['usr_id']] = "added";
453 }
454 else
455 {
456 if($a_attribs['notification'] == 'Yes')
457 {
458 $this->course_members->updateNotification($id_data['usr_id'],true);
459 }
460 if($a_attribs['passed'] == 'Yes')
461 {
462 $this->course_members->updatePassed($id_data['usr_id'],true);
463 }
464 $this->course_members->updateBlocked($id_data['usr_id'],false);
465 }
466 }
467 elseif (isset($a_attribs['action']) && $a_attribs['action'] == 'Detach' && $this->course_members->isTutor($id_data['usr_id']))
468 // if action set and detach and is tutor of course
469 {
470 $this->course_members->delete($id_data['usr_id']);
471 }
472
473 }
474
475
476
483 private function handleSubscriber ($a_attribs, $id_data)
484 {
485 if (!isset($a_attribs['action']) || $a_attribs['action'] == 'Attach')
486 // if action not set, or attach
487 {
488 if (!$this->course_members->isSubscriber($id_data['usr_id']))
489 // add only if not exist
490 {
491 $this->course_members->addSubscriber($id_data['usr_id']);
492 }
493 $this->course_members->updateSubscriptionTime($id_data['usr_id'],$a_attribs['subscriptionTime']);
494
495 }
496 elseif (isset($a_attribs['action']) && $a_attribs['action'] == 'Detach' && $this->course_members->isSubscriber($id_data['usr_id']))
497 // if action set and detach and is subscriber
498 {
499 $this->course_members->deleteSubscriber($id_data["usr_id"]);
500 }
501
502 }
503
510 private function handleWaitingList ($a_attribs, $id_data)
511 {
512 if (!isset($a_attribs['action']) || $a_attribs['action'] == 'Attach')
513 // if action not set, or attach
514 {
515 if (!$this->course_waiting_list->isOnList($id_data['usr_id']))
516 // add only if not exists
517 {
518 $this->course_waiting_list->addToList($id_data['usr_id']);
519 }
520 $this->course_waiting_list->updateSubscriptionTime($id_data['usr_id'],$a_attribs['subscriptionTime']);
521
522 }
523 elseif (isset($a_attribs['action']) && $a_attribs['action'] == 'Detach' && $this->course_waiting_list->isOnList($id_data['usr_id']))
524 // if action set and detach and is on list
525 {
526 $this->course_waiting_list->removeFromList($id_data['usr_id']);
527 }
528
529 }
530
531
538 function handlerEndTag($a_xml_parser,$a_name)
539 {
540 if($this->in_meta_data)
541 {
542 parent::handlerEndTag($a_xml_parser,$a_name);
543 }
544
545 switch($a_name)
546 {
547 case 'Course':
548
549 $this->log->write('CourseXMLParser: import_id = '.$this->course_obj->getImportId());
550 $this->course_obj->MDUpdateListener('General');
551 $this->course_obj->update();
552 $this->adv_md_handler->save();
553 break;
554
555 case 'Settings':
556 $this->in_settings = false;
557 break;
558
559 case 'Availability':
560 $this->in_availability = false;
561 break;
562
563 case 'Registration':
564 $this->in_registration = false;
565 break;
566
567 case 'Archive':
568 $this->in_archive = false;
569 break;
570
571 case 'Start':
572 if($this->in_availability)
573 {
574 $this->course_obj->setActivationStart(trim($this->cdata));
575 }
576 if($this->in_registration)
577 {
578 $this->course_obj->setSubscriptionStart(trim($this->cdata));
579 }
580 if($this->in_archive)
581 {
582 $this->course_obj->setArchiveStart(trim($this->cdata));
583 }
584 break;
585
586 case 'End':
587 if($this->in_availability)
588 {
589 $this->course_obj->setActivationEnd(trim($this->cdata));
590 }
591 if($this->in_registration)
592 {
593 $this->course_obj->setSubscriptionEnd(trim($this->cdata));
594 }
595 if($this->in_archive)
596 {
597 $this->course_obj->setArchiveEnd(trim($this->cdata));
598 }
599 break;
600
601 case 'Syllabus':
602 $this->course_obj->setSyllabus(trim($this->cdata));
603 break;
604
605
606 case 'ImportantInformation':
607 $this->course_obj->setImportantInformation(trim($this->cdata));
608 break;
609
610 case 'Name':
611 $this->course_obj->setContactName(trim($this->cdata));
612 break;
613
614 case 'Responsibility':
615 $this->course_obj->setContactResponsibility(trim($this->cdata));
616 break;
617
618 case 'Phone':
619 $this->course_obj->setContactPhone(trim($this->cdata));
620 break;
621
622 case 'Email':
623 $this->course_obj->setContactEmail(trim($this->cdata));
624 break;
625
626 case 'Consultation':
627 $this->course_obj->setContactConsultation(trim($this->cdata));
628 break;
629
630 case 'Password':
631 $this->course_obj->setSubscriptionPassword(trim($this->cdata));
632 break;
633
634 case 'MetaData':
635 $this->in_meta_data = false;
636 parent::handlerEndTag($a_xml_parser,$a_name);
637 break;
638
639 case 'ContainerSetting':
640 if($this->current_container_setting)
641 {
643 $this->course_obj->getId(),
644 $this->current_container_setting,
645 $this->cdata);
646 }
647 break;
648 }
649 $this->cdata = '';
650
651 return;
652 }
653
660 function handlerCharacterData($a_xml_parser,$a_data)
661 {
662 // call meta data handler
663 if($this->in_meta_data)
664 {
665 parent::handlerCharacterData($a_xml_parser,$a_data);
666 }
667 if($a_data != "\n")
668 {
669 // Replace multiple tabs with one space
670 $a_data = preg_replace("/\t+/"," ",$a_data);
671
672 $this->cdata .= $a_data;
673 }
674 }
675
676 // PRIVATE
677 function __parseId($a_id)
678 {
679 global $ilias;
680
681 $fields = explode('_',$a_id);
682
683 if(!is_array($fields) or
684 $fields[0] != 'il' or
685 !is_numeric($fields[1]) or
686 $fields[2] != 'usr' or
687 !is_numeric($fields[3]))
688 {
689 return false;
690 }
691 if($id = ilObjUser::_getImportedUserId($a_id))
692 {
693 return array('imported' => true,
694 'local' => false,
695 'usr_id' => $id);
696 }
697 if(($fields[1] == $ilias->getSetting('inst_id',0)) and strlen(ilObjUser::_lookupLogin($fields[3])))
698 {
699 return array('imported' => false,
700 'local' => true,
701 'usr_id' => $fields[3]);
702 }
703 return false;
704 }
705
706}
707?>
const IL_CRS_SUBSCRIPTION_LIMITED
const IL_CRS_ACTIVATION_OFFLINE
const IL_CRS_ACTIVATION_UNLIMITED
const IL_CRS_SUBSCRIPTION_PASSWORD
const IL_CRS_ARCHIVE_NONE
const IL_CRS_SUBSCRIPTION_CONFIRMATION
const IL_CRS_ARCHIVE_DOWNLOAD
const IL_CRS_SUBSCRIPTION_UNLIMITED
const IL_CRS_ACTIVATION_LIMITED
const IL_CRS_SUBSCRIPTION_DEACTIVATED
const IL_CRS_SUBSCRIPTION_DIRECT
const IL_CRS_ADMIN
Base class for course and group participants.
const IL_CRS_MEMBER
const IL_CRS_TUTOR
static getInstanceByObjId($a_obj_id)
Get singleton instance.
static _importContainerSortingSettings($attibs, $obj_id)
sorting import for all container objects
_writeContainerSetting($a_id, $a_keyword, $a_value)
static _getInstanceByObjId($a_obj_id)
Get singleton instance.
handleWaitingList($a_attribs, $id_data)
attach or detach members from waitinglist
handlerCharacterData($a_xml_parser, $a_data)
handler for character data
handlerBeginTag($a_xml_parser, $a_name, $a_attribs)
handler for begin of element
ilCourseXMLParser($a_course_obj, $a_xml_file='')
Constructor.
handleSubscriber($a_attribs, $id_data)
attach or detach members from subscribers
handleTutor($a_attribs, $id_data)
attach or detach admin from course member
setHandlers($a_xml_parser)
set event handlers
handleAdmin($a_attribs, $id_data)
attach or detach admin from course member
handlerEndTag($a_xml_parser, $a_name)
handler for end of element
handleMember($a_attribs, $id_data)
attach or detach user/member/admin from course member
_lookupLogin($a_user_id)
lookup login
_getImportedUserId($i2_id)
_writeImportId($a_obj_id, $a_import_id)
write import id to db (static)
Controller class for sax element handlers.
Interface definition for sax subset parsers.