ILIAS  Release_4_4_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
class.ilUserXMLWriter.php
Go to the documentation of this file.
1 <?php
2 
3 /* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */
4 
5 include_once "./Services/Xml/classes/class.ilXmlWriter.php";
6 include_once './Services/User/classes/class.ilObjUserFolder.php';
7 
20 class ilUserXMLWriter extends ilXmlWriter
21 {
22  var $ilias;
23  var $xml;
24  var $users;
25  var $user_id = 0;
26  var $attachRoles = false;
27  var $attachPreferences = false;
28  private static $exportablePrefs;
29 
35  private $settings;
36 
44  function ilUserXMLWriter()
45  {
46  global $ilias,$ilUser;
47 
48  parent::ilXmlWriter();
49 
50  $this->ilias =& $ilias;
51  $this->user_id = $ilUser->getId();
52  $this->attachRoles = false;
53 
54 /* $this->exportablePrefs = array(
55  "priv_feed_pass", "language", "style", "skin", 'ilPageEditor_HTMLMode',
56  'ilPageEditor_JavaScript', 'ilPageEditor_MediaMode', 'tst_javascript',
57  'tst_lastquestiontype', 'tst_multiline_answers', 'tst_use_previous_answers',
58  'graphicalAnswerSetting', "weekstart"
59  );*/
60  }
61 
62  function setAttachRoles ($value)
63  {
64  $this->attachRoles = $value == 1? true : false;
65  }
66 
67  function setObjects(& $users)
68  {
69  $this->users = & $users;
70  }
71 
72 
73  function start()
74  {
75  if (!is_array($this->users))
76  return false;
77 
78  $this->__buildHeader();
79 
80 
81  include_once ("./Services/User/classes/class.ilUserDefinedFields.php");
82  $udf_data = & ilUserDefinedFields::_getInstance();
83  $udf_data->addToXML($this);
84 
85  foreach ($this->users as $user)
86  {
87 
88  $this->__handleUser ($user);
89 
90  }
91 
92  $this->__buildFooter();
93 
94  return true;
95  }
96 
97  function getXML()
98  {
99  return $this->xmlDumpMem(FALSE);
100  }
101 
102 
103  function __buildHeader()
104  {
105  $this->xmlSetDtdDef("<!DOCTYPE Users PUBLIC \"-//ILIAS//DTD UserImport//EN\" \"".ILIAS_HTTP_PATH."/xml/ilias_user_4_0.dtd\">");
106  $this->xmlSetGenCmt("User of ilias system");
107  $this->xmlHeader();
108 
109  $this->xmlStartTag('Users');
110 
111  return true;
112  }
113 
114  function __buildFooter()
115  {
116  $this->xmlEndTag('Users');
117  }
118 
119  function __handleUser ($row)
120  {
121  global $ilDB,$lng;
122  if (!is_array ($this->settings)) {
123  include_once ('./Services/User/classes/class.ilObjUserFolder.php');
124  $this->setSettings(ilObjUserFolder::getExportSettings());
125  }
126 
127  $prefs = ilObjUser::_getPreferences($row["usr_id"]);
128 
129  if (strlen($row["language"]) == 0)
130  {
131  $row["language"] = $lng->getDefaultLanguage();
132 
133  }
134 
135  $attrs = array (
136  'Id' => "il_".IL_INST_ID."_usr_".$row["usr_id"],
137  'Language' => $row["language"],
138  'Action' => "Update"
139  );
140 
141  $this->xmlStartTag("User", $attrs);
142 
143  $this->xmlElement("Login", null, $row["login"]);
144 
145  if ($this->attachRoles == TRUE)
146  {
147  include_once './Services/AccessControl/classes/class.ilObjRole.php';
148 
149  $query = sprintf("SELECT object_data.title, object_data.description, rbac_fa.* ".
150  "FROM object_data, rbac_ua, rbac_fa WHERE rbac_ua.usr_id = %s ".
151  "AND rbac_ua.rol_id = rbac_fa.rol_id AND object_data.obj_id = rbac_fa.rol_id",
152  $ilDB->quote($row["usr_id"],'integer')
153  );
154  $rbacresult = $ilDB->query($query);
155 
156  while ($rbacrow = $rbacresult->fetchRow(DB_FETCHMODE_ASSOC))
157  {
158  if ($rbacrow["assign"] != "y")
159  continue;
160 
161  $type = "";
162 
163  if ($rbacrow["parent"] == ROLE_FOLDER_ID)
164  {
165  $type = "Global";
166  }
167  else
168  {
169  $type = "Local";
170  }
171  if (strlen($type))
172  {
173  $this->xmlElement("Role",
174  array ("Id" =>
175  "il_".IL_INST_ID."_role_".$rbacrow["rol_id"], "Type" => $type),
176  $rbacrow["title"]);
177  }
178 
179  }
180  }
181 
185  $i2passwd = FALSE;
186  if ($this->canExport("i2passwd","i2passwd") && strlen($row["i2passwd"]) > 0)
187  {
188  $i2passwd = TRUE;
189  $this->__addElement("Password",$row["i2passwd"], array("Type" => "ILIAS2"),"i2passwd");
190  }
191  if (!$i2passwd && strlen($row["passwd"]) > 0)
192  {
193  $this->__addElement("Password",$row["passwd"], array("Type" => "ILIAS3"),"passwd");
194  }
195 
196 
197  $this->__addElement ("Firstname", $row["firstname"]);
198  $this->__addElement ("Lastname", $row["lastname"]);
199  $this->__addElement ("Title", $row["title"]);
200 
201  if ($this->canExport("PersonalPicture", "upload"))
202  {
203  $imageData = $this->getPictureValue($row["usr_id"]);
204  if ($imageData)
205  {
206  $value = array_shift($imageData); //$imageData["value"];
207  $this->__addElement ("PersonalPicture", $value, $imageData, "upload");
208  }
209  }
210 
211 
212  $this->__addElement ("Gender", $row["gender"]);
213  $this->__addElement ("Email", $row["email"]);
214  $this->__addElement ("Birthday", $row["birthday"]);
215  $this->__addElement ("Institution", $row["institution"]);
216  $this->__addElement ("Street", $row["street"]);
217  $this->__addElement ("City", $row["city"]);
218  $this->__addElement ("PostalCode", $row["zipcode"], null, "zipcode");
219  $this->__addElement ("Country", $row["country"]);
220  $this->__addElement ("PhoneOffice", $row["phone_office"], null, "phone_office");
221  $this->__addElement ("PhoneHome", $row["phone_home"], null, "phone_home");
222  $this->__addElement ("PhoneMobile", $row["phone_mobile"], null, "phone_mobile");
223  $this->__addElement ("Fax", $row["fax"]);
224  $this->__addElement ("Hobby", $row["hobby"]);
225  $this->__addElement ("Department", $row["department"]);
226  $this->__addElement ("Comment", $row["referral_comment"], null, "referral_comment");
227  $this->__addElement ("Matriculation", $row["matriculation"]);
228  $this->__addElement ("Active", $row["active"] ? "true":"false" );
229  $this->__addElement ("ClientIP", $row["client_ip"], null, "client_ip");
230  $this->__addElement ("TimeLimitOwner", $row["time_limit_owner"], null, "time_limit_owner");
231  $this->__addElement ("TimeLimitUnlimited", $row["time_limit_unlimited"], null, "time_limit_unlimited");
232  $this->__addElement ("TimeLimitFrom", $row["time_limit_from"], null, "time_limit_from");
233  $this->__addElement ("TimeLimitUntil", $row["time_limit_until"], null, "time_limit_until");
234  $this->__addElement ("TimeLimitMessage", $row["time_limit_message"], null, "time_limit_message");
235  $this->__addElement ("ApproveDate", $row["approve_date"], null, "approve_date");
236  $this->__addElement ("AgreeDate", $row["agree_date"], null, "agree_date");
237 
238  if ((int) $row["ilinc_id"] !=0) {
239  $this->__addElement ("iLincID", $row["ilinc_id"], "ilinc_id");
240  $this->__addElement ("iLincUser", $row["ilinc_user"], "ilinc_user");
241  $this->__addElement ("iLincPasswd", $row["ilinc_passwd"], "ilinc_passwd");
242  }
243 
244  if (strlen($row["auth_mode"])>0)
245  {
246  $this->__addElement ("AuthMode", null, array ("type" => $row["auth_mode"]),"auth_mode", true);
247  }
248 
249  if (strlen($row["ext_account"])>0)
250  {
251  $this->__addElement ("ExternalAccount", $row["ext_account"], null, "ext_account", true);
252  }
253 
254  if ($this->canExport("Look","skin_style"))
255  {
256  $this->__addElement("Look", null, array(
257  "Skin" => $prefs["skin"], "Style" => $prefs["style"]
258  ), "skin_style", true);
259 
260  }
261 
262 
263  $this->__addElement ("LastUpdate", $row["last_update"], null, "last_update");
264  $this->__addElement ("LastLogin", $row["last_login"], null, "last_login");
265 
266  include_once ("./Services/User/classes/class.ilUserDefinedData.php");
267  $udf_data = new ilUserDefinedData($row['usr_id']);
268  $udf_data->addToXML($this, $this->settings);
269 
270  $msgrs = array ("skype" => "im_skype", "yahoo" => "im_yahoo", "msn"=>"im_msn", "aim"=>"im_aim", "icq"=>"im_icq", "delicious" => "delicious", "external" => "ext_account", "jabber" => "im_jabber", "voip" => "im_voip");
271  foreach ($msgrs as $type => $fieldname) {
272  $this->__addElement("AccountInfo", $row[$fieldname], array("Type" => $type), "instant_messengers");
273  }
274 
275  $this->__addElement("GMapsInfo", null, array (
276  "longitude" => $row["longitude"],
277  "latitude" => $row["latitude"],
278  "zoom" => $row["loc_zoom"]));
279 
280  $this->__addElement("Feedhash", $row["feed_hash"]);
281 
282  if ($this->attachPreferences || $this->canExport("prefs", "preferences"))
283  $this->__handlePreferences ($prefs, $row);
284 
285  $this->xmlEndTag('User');
286  }
287 
288 
289  private function __handlePreferences ($prefs, $row)
290  {
291 
292  include_once ("Services/Mail/classes/class.ilMailOptions.php");
293  $mailOptions = new ilMailOptions($row["usr_id"]);
294  $prefs["mail_incoming_type"] = $mailOptions->getIncomingType();
295  $prefs["mail_signature"] = $mailOptions->getSignature();
296  $prefs["mail_linebreak"] = $mailOptions->getLinebreak();
297  if (count($prefs))
298  {
299  $this->xmlStartTag("Prefs");
300  foreach ($prefs as $key => $value)
301  {
302  if (ilUserXMLWriter::isPrefExportable($key))
303  $this->xmlElement("Pref", array("key" => $key), $value);
304  }
305  $this->xmlEndTag("Prefs");
306  }
307  }
308 
309 
310  function __addElement ($tagname, $value, $attrs = null, $settingsname = null, $requiredTag = false)
311  {
312  if ($this->canExport($tagname, $settingsname))
313  if (strlen($value) > 0 || $requiredTag || (is_array($attrs) && count($attrs) > 0))
314  $this->xmlElement ($tagname, $attrs, $value);
315 
316  }
317 
318  private function canExport ($tagname, $settingsname = null)
319  {
320  return !is_array($this->settings) ||
321  in_array(strtolower($tagname), $this->settings) !== FALSE ||
322  in_array($settingsname, $this->settings) !== FALSE;
323  }
324 
330  function setSettings ($settings) {
331  $this->settings = $settings;
332  }
333 
339  private function getPictureValue ($usr_id) {
340  global $ilDB;
341  // personal picture
342  $q = sprintf("SELECT value FROM usr_pref WHERE usr_id = %s AND keyword = %s",
343  $ilDB->quote($usr_id, "integer"), $ilDB->quote('profile_image', "text"));
344  $r = $ilDB->query($q);
345  if ($ilDB->numRows($r) == 1)
346  {
347  $personal_picture_data = $r->fetchRow(DB_FETCHMODE_ASSOC);
348  $personal_picture = $personal_picture_data["value"];
349  $webspace_dir = ilUtil::getWebspaceDir();
350  $image_file = $webspace_dir."/usr_images/".$personal_picture;
351  if (@is_file($image_file))
352  {
353  $fh = fopen($image_file, "rb");
354  if ($fh)
355  {
356  $image_data = fread($fh, filesize($image_file));
357  fclose($fh);
358  $base64 = base64_encode($image_data);
359  $imagetype = "image/jpeg";
360  if (preg_match("/.*\.(png|gif)$/", $personal_picture, $matches))
361  {
362  $imagetype = "image/".$matches[1];
363  }
364  return array (
365  "value" => $base64,
366  "encoding" => "Base64",
367  "imagetype" => $imagetype
368  );
369  }
370  }
371  }
372  return false;
373  }
374 
375 
382  public function setAttachPreferences ($attachPrefs)
383  {
384  $this->attachPreferences = $attachPrefs;
385  }
386 
392  public static function getExportablePreferences() {
393  return array (
394  'hits_per_page',
395  'public_city',
396  'public_country',
397  'public_department',
398  'public_email',
399  'public_fax',
400  'public_hobby',
401  'public_institution',
402  'public_matriculation',
403  'public_phone',
404  'public_phone_home',
405  'public_phone_mobile',
406  'public_phone_office',
407  'public_profile',
408  'public_street',
409  'public_upload',
410  'public_zip',
411  'send_info_mails',
412  'show_users_online',
413  'hide_own_online_status',
414  'user_tz',
415  'weekstart',
416  'mail_incoming_type',
417  'mail_signature',
418  'mail_linebreak'
419  );
420  }
421 
428  public static function isPrefExportable($key) {
429  return in_array($key, ilUserXMLWriter::getExportablePreferences());
430  }
431 
432 }
433 
434 
435 ?>