ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
Public Member Functions
ilDiskQuotaSummaryNotification Class Reference
+ Inheritance diagram for ilDiskQuotaSummaryNotification:
+ Collaboration diagram for ilDiskQuotaSummaryNotification:

Public Member Functions

 __construct ()
 Constructor. More...
 
 send ()
 Send notifications. More...
 
- Public Member Functions inherited from ilMailNotification
 __construct ($a_is_personal_workspace=false)
 
 setType ($a_type)
 Set notification type. More...
 
 getType ()
 Get notification type. More...
 
 setSender ($a_usr_id)
 Set sender of mail. More...
 
 getSender ()
 get sender of mail More...
 
 setRecipients (array $a_rcp)
 
 getRecipients ()
 get array of recipients More...
 
 setAttachments ($a_att)
 Set attachments. More...
 
 getAttachments ()
 Get attachments. More...
 
 setLangModules (array $a_modules)
 Set lang modules. More...
 
 getUserLanguage ($a_usr_id)
 Get user language. More...
 
 setRefId ($a_id)
 
 getRefId ()
 
 getObjId ()
 
 setObjId ($a_obj_id)
 
 getObjType ()
 Get object type. More...
 
 setAdditionalInformation (array $a_info)
 Additional information for creating notification mails. More...
 
 getAdditionalInformation ()
 
 sendMail (array $a_rcp, $a_type, $a_parse_recipients=true)
 
 getBlockBorder ()
 Get (ascii) block border. More...
 

Additional Inherited Members

- Data Fields inherited from ilMailNotification
const SUBJECT_TITLE_LENGTH = 60
 
- Protected Member Functions inherited from ilMailNotification
 setSubject ($a_subject)
 
 getSubject ()
 
 setBody ($a_body)
 
 appendBody ($a_body)
 Append body text. More...
 
 getBody ()
 
 initLanguage ($a_usr_id)
 Init language. More...
 
 initLanguageByIso2Code ($a_code='')
 Init language by ISO2 code. More...
 
 setLanguage ($a_language)
 
 getLanguage ()
 
 getLanguageText ($a_keyword)
 
 getObjectTitle ($a_shorten=false)
 
 initMail ()
 
 getMail ()
 
 createPermanentLink ($a_params=array(), $a_append='')
 
 userToString ($a_usr_id)
 
 isRefIdAccessible ($a_user_id, $a_ref_id, $a_permission="read")
 Check if ref id is accessible for user. More...
 
- Protected Attributes inherited from ilMailNotification
 $type = null
 
 $sender = null
 
 $mail = null
 
 $subject = ''
 
 $body = ''
 
 $attachments = array()
 
 $language = null
 
 $lang_modules = array()
 
 $recipients = array()
 
 $ref_id = null
 
 $obj_id = null
 
 $obj_type = null
 
 $additional_info = array()
 
 $is_in_wsp
 
 $wsp_tree
 
 $wsp_access_handler
 

Detailed Description

Author
Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de
Version
$Id$

Definition at line 13 of file class.ilDiskQuotaSummaryNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ilDiskQuotaSummaryNotification::__construct ( )

Constructor.

public

Definition at line 22 of file class.ilDiskQuotaSummaryNotification.php.

References ilObjUser\_lookupId(), and ilMailNotification\setRecipients().

23  {
24  $dqs = new ilSetting('disk_quota');
25  $rcpt = $dqs->get('summary_rcpt');
26  $rcpt = explode(',', $rcpt);
27  $loginnames = array();
28  foreach($rcpt as $loginname)
29  {
30  $loginname = trim($loginname);
31  if(ilObjUser::_lookupId($loginname))
32  {
33  $loginnames[] = $loginname;
34  }
35  }
36  $this->setRecipients($loginnames);
37 
38  parent::__construct();
39  }
ilSetting
ILIAS Setting Class.
Definition: class.ilSetting.php:32
ilObjUser\_lookupId
static _lookupId($a_user_str)
Lookup id by login.
Definition: class.ilObjUser.php:824
+ Here is the call graph for this function:

Member Function Documentation

◆ send()

ilDiskQuotaSummaryNotification::send ( )

Send notifications.

public

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

References $ilDB, $res, $row, ilUtil\_getHttpPath(), ilDiskQuotaChecker\_lookupDiskUsage(), ilObjUser\_lookupId(), ilMailNotification\appendBody(), ilFormat\formatSize(), ilMailNotification\getLanguage(), ilMailNotification\getMail(), ilMailNotification\getRecipients(), ilMail\getSalutation(), ilMailNotification\initLanguage(), ilMailNotification\initMail(), ilMailNotification\sendMail(), ilMailNotification\setBody(), and ilMailNotification\setSubject().

49  {
50  global $ilDB;
51 
52  // parent::send();
53 
54  if( count($this->getRecipients()) )
55  {
56  $res = $ilDB->queryf(
57  "SELECT u.usr_id,u.gender,u.firstname,u.lastname,u.login,u.email,u.last_login,u.active,".
58  "u.time_limit_unlimited, ".$ilDB->fromUnixtime("u.time_limit_from").", ".$ilDB->fromUnixtime("u.time_limit_until").",".
59 
60  // Inactive users get the date 0001-01-01 so that they appear
61  // first when the list is sorted by this field. Users with
62  // unlimited access get the date 9999-12-31 so that they appear
63  // last.
64  "CASE WHEN u.active = 0 THEN '0001-01-01' ELSE CASE WHEN u.time_limit_unlimited=1 THEN '9999-12-31' ELSE ".$ilDB->fromUnixtime("u.time_limit_until")." END END access_until,".
65 
66  " CASE WHEN ".$ilDB->unixTimestamp()." BETWEEN u.time_limit_from AND u.time_limit_until THEN 0 ELSE 1 END expired,".
67  "rq.role_disk_quota, system_role.rol_id role_id, ".
68  "p1.value+0 user_disk_quota,".
69  "p2.value+0 disk_usage, ".
70  "p3.value last_update, ".
71  "p5.value language, ".
72 
73  // We add 0 to some of the values to convert them into a number.
74  // This is needed for correct sorting.
75  "CASE WHEN rq.role_disk_quota>p1.value+0 OR p1.value IS NULL THEN rq.role_disk_quota ELSE p1.value+0 END disk_quota ".
76  "FROM usr_data u ".
77 
78  // Fetch the role with the highest disk quota value.
79  "JOIN (SELECT u.usr_id usr_id,MAX(rd.disk_quota) role_disk_quota ".
80  "FROM usr_data u ".
81  "JOIN rbac_ua ua ON ua.usr_id=u.usr_id ".
82  "JOIN rbac_fa fa ON fa.rol_id=ua.rol_id AND fa.parent=%s ".
83  "JOIN role_data rd ON rd.role_id=ua.rol_id WHERE u.usr_id=ua.usr_id GROUP BY u.usr_id) rq ON rq.usr_id=u.usr_id ".
84 
85  // Fetch the system role in order to determine whether the user has unlimited disk quota
86  "LEFT JOIN rbac_ua system_role ON system_role.usr_id=u.usr_id AND system_role.rol_id = %s ".
87 
88  // Fetch the user disk quota from table usr_pref
89  "LEFT JOIN usr_pref p1 ON p1.usr_id=u.usr_id AND p1.keyword = 'disk_quota' ".
90 
91  // Fetch the disk usage from table usr_pref
92  "LEFT JOIN usr_pref p2 ON p2.usr_id=u.usr_id AND p2.keyword = 'disk_usage' ".
93 
94  // Fetch the last update from table usr_pref
95  "LEFT JOIN usr_pref p3 ON p3.usr_id=u.usr_id AND p3.keyword = 'disk_usage.last_update' ".
96 
97  // Fetch the language of the user
98  "LEFT JOIN usr_pref p5 ON p5.usr_id=u.usr_id AND p5.keyword = 'language' ".
99 
100  // Fetch only users who have exceeded their quota, and who have
101  // access, and who have not received a reminder in the past seven days
102  // #8554 / #10301
103  'WHERE (((p1.value+0 > rq.role_disk_quota OR rq.role_disk_quota IS NULL) AND p2.value+0 > p1.value+0) OR
104  ((rq.role_disk_quota > p1.value+0 OR p1.value IS NULL) AND p2.value+0 > rq.role_disk_quota)) '.
105  'AND (u.active=1 AND (u.time_limit_unlimited = 1 OR '.$ilDB->unixTimestamp().' BETWEEN u.time_limit_from AND u.time_limit_until)) '
106  ,
107  array('integer','integer'),
108  array(ROLE_FOLDER_ID, SYSTEM_ROLE_ID)
109  );
110 
111  $users = array();
112 
113  $counter = 0;
114  while( $row = $ilDB->fetchAssoc($res) )
115  {
116  $details = ilDiskQuotaChecker::_lookupDiskUsage($row['usr_id']);
117 
118  $users[$counter]['disk_quota'] = $row['disk_quota'];
119  $users[$counter]['disk_usage'] = $details['disk_usage'];
120  $users[$counter]['email'] = $row['email'];
121  $users[$counter]['firstname'] = $row['firstname'];
122  $users[$counter]['lastname'] = $row['lastname'];
123 
124  ++$counter;
125  }
126 
127  if( count($users) ) foreach($this->getRecipients() as $rcp)
128  {
129  $usrId = ilObjUser::_lookupId($rcp);
130 
131  $this->initLanguage($usrId);
132  $this->initMail();
133 
134  $this->setSubject($this->getLanguage()->txt('disk_quota_summary_subject'));
135 
136  $this->setBody(ilMail::getSalutation($usrId, $this->getLanguage()));
137 
138  $this->appendBody("\n\n");
139  $this->appendBody($this->getLanguage()->txt('disk_quota_exceeded_headline'));
140  $this->appendBody("\n\n");
141 
142  $first = true;
143  $counter = 0;
144  $numUsers = count($users);
145  foreach($users as $user)
146  {
147  if(!$first)
148  {
149  $this->appendBody("\n---------------------------------------------------\n\n");
150  }
151 
152  $this->appendBody(
153  $this->getLanguage()->txt('fullname').': '.
154  $user['lastname'].', '.$user['firstname']
155  ."\n");
156  $this->appendBody(
157  $this->getLanguage()->txt('email').': '.
158  $user['email']
159  ."\n");
160  $this->appendBody(
161  $this->getLanguage()->txt('disk_quota').': '.
162  ilFormat::formatSize($user['disk_quota'],'short', $this->getLanguage())
163  ."\n");
164  $this->appendBody(
165  $this->getLanguage()->txt('currently_used_disk_space').': '.
166  ilFormat::formatSize($user['disk_usage'],'short', $this->getLanguage())
167  ."\n");
168 
169  $this->appendBody(
170  $this->getLanguage()->txt('usrf_profile_link').': '.
171  ilUtil::_getHttpPath().'/goto.php?target=usrf&client_id='.CLIENT_ID
172  );
173 
174  if($counter < $numUsers - 1)
175  {
176  $this->appendBody("\n");
177  }
178 
179  ++$counter;
180  $first = false;
181  }
182 
183  $this->getMail()->appendInstallationSignature(true);
184 
185  $this->sendMail(array($rcp), array('system'), false);
186  }
187  }
188  }
ilMailNotification\initLanguage
initLanguage($a_usr_id)
Init language.
Definition: class.ilMailNotification.php:192
ilObjUser\_lookupId
static _lookupId($a_user_str)
Lookup id by login.
Definition: class.ilObjUser.php:824
ilMail\getSalutation
static getSalutation($a_usr_id, $a_language=null)
Get salutation.
Definition: class.ilMail.php:2929
ilMailNotification\sendMail
sendMail(array $a_rcp, $a_type, $a_parse_recipients=true)
Definition: class.ilMailNotification.php:355
ilMailNotification\getRecipients
getRecipients()
get array of recipients
Definition: class.ilMailNotification.php:156
ilDiskQuotaChecker\_lookupDiskUsage
static _lookupDiskUsage($a_user_id)
Gets the disk usage info for the specified user account.
Definition: class.ilDiskQuotaChecker.php:140
ilUtil\_getHttpPath
static _getHttpPath()
Definition: class.ilUtil.php:5124
ilFormat\formatSize
static formatSize($size, $a_mode='short', $a_lng=null)
Returns the specified file size value in a human friendly form.
Definition: class.ilFormat.php:716
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
ilMailNotification\appendBody
appendBody($a_body)
Append body text.
Definition: class.ilMailNotification.php:131
+ Here is the call graph for this function:
The documentation for this class was generated from the following file: