-
Notifications
You must be signed in to change notification settings - Fork 66
/
m_quota.php
674 lines (553 loc) · 22.4 KB
/
m_quota.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
<?php
/*
----------------------------------------------------------------------
LICENSE
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License (GPL)
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
To read the license please visit http://www.gnu.org/copyleft/gpl.html
----------------------------------------------------------------------
*/
/**
* Class for hosting quotas management
*
* This class manages services' quotas for each user of AlternC.
* The available quotas for each service is stored in the system.quotas
* mysql table. The used value is computed by the class using a
* callback function <code>alternc_quota_check($uid)</code> that
* may by exported by each service class.<br>
* each class may also export a function <code>alternc_quota_names()</code>
* that returns an array with the quotas names managed by this class.
*
* @copyright AlternC-Team 2000-2017 https://alternc.com/
*/
class m_quota {
var $disk = Array(); /* disk resource for which we will manage quotas */
var $disk_quota_enable;
var $disk_quota_not_blocking;
var $quotas;
var $clquota; // Which class manage which quota.
/**
* Constructor
*/
function m_quota() {
$this->disk_quota_enable = variable_get('disk_quota_enable', 1, 'Are disk quota enabled for this server', array('desc' => 'Enabled', 'type' => 'boolean'));
if ($this->disk_quota_enable) {
$this->disk = Array("web" => "web");
$this->disk_quota_not_blocking = variable_get('disk_quota_not_blocking', 1, "0 - Block data when quota are exceeded (you need a working quota system) | 1 - Just show quota but don't block anything", array('desc' => 'Enabled', 'type' => 'boolean'));
}
}
private function dummy_for_translation() {
_("quota_web");
}
function hook_menu() {
global $cuid, $mem, $quota;
$obj = array(
'title' => _("Show my quotas"),
'ico' => 'images/quota.png',
'link' => 'toggle',
'pos' => 5,
'divclass' => 'menu-quota',
'links' => array(),
);
$q = $this->getquota();
foreach ($q as $key=>$value)
if (($key=="web")||(isset($value['in_menu'])&&$value['in_menu'])) {
if (!isset($q[$key]["u"]) || empty($q[$key]["t"])) {
continue;
}
$totalsize_used = $quota->get_size_web_sum_user($cuid) + $quota->get_size_mailman_sum_user($cuid) + ($quota->get_size_db_sum_user($mem->user["login"]) + $quota->get_size_mail_sum_user($cuid))/1024;
$usage_percent = (int) ($totalsize_used / $q[$key]["t"] * 100);
$obj['links'][] = array('txt' => _("quota_" . $key) . " " . sprintf(_("%s%% of %s"), $usage_percent, format_size($q[$key]["t"] * 1024)), 'url' => 'quota_show.php');
$obj['links'][] = array('txt' => 'progressbar', 'total' => $q[$key]["t"], 'used' => $totalsize_used);
}
// do not return menu item if there is no quota
if (!count($obj['links'])) return false;
return $obj;
}
function hook_homepageblock() {
return (object)Array(
'pos' => 20,
'call'=> function() {
define("QUOTASONE","1");
},
'include' => "quotas_oneuser.php"
);
}
/** Check if a user can use a ressource.
* @param string $ressource the ressource name (a named quota)
* @Return TRUE if the user can create a ressource (= is there any quota left ?)
* @return boolean
*/
function cancreate($ressource = "") {
$t = $this->getquota($ressource);
return $t["u"] < $t["t"];
}
/** List the quota-managed services in the server
* @Return array the quota names and description (translated)
*/
function qlist() {
$qlist = array();
reset($this->disk);
while (list($key, $val) = each($this->disk)) {
$qlist[$key] = _("quota_" . $key); // those are specific disks quotas.
}
foreach ($this->getquota() as $qq) {
if (isset($qq['name'])) {
$qlist[$qq['name']] = $qq['description'];
}
}
return $qlist;
}
/**
* Synchronise the quotas of the users with the quota of the
* user's profile.
* If the user have a greater quota than the profile, no change.
* If the quota entry doesn't exist for the user, create it with
* the defaults value.
*/
function synchronise_user_profile() {
global $db, $msg;
$msg->log("quota", "synchronise_user_profile");
$q = "INSERT INTO quotas SELECT m.uid AS uid, d.quota AS name, d.value AS total FROM membres m, defquotas d LEFT JOIN quotas q ON q.name=d.quota WHERE m.type=d.type ON DUPLICATE KEY UPDATE total = greatest(d.value, quotas.total);";
if (!$db->query($q)) {
return false;
}
return true;
}
/*
* Create default quota in the profile
* when a new quota appear
*/
function create_missing_quota_profile() {
global $db, $quota, $msg;
$msg->log("quota", "create_missing_quota_profile");
$qt = $quota->getquota('', true);
$type = $quota->listtype();
foreach ($type as $t) {
foreach ($qt as $q => $vv) {
$db->query("INSERT IGNORE defquotas (value,quota,type) VALUES (0, ?, ?);", array($q, $t));
}
}
return true;
}
/** Return a ressource usage (u) and total quota (t)
* @param string $ressource ressource to get quota of
* @Return array the quota used and total for this ressource (or for all ressource if unspecified)
*/
function getquota($ressource = "", $recheck = false) {
global $db, $msg, $cuid, $get_quota_cache, $hooks, $mem;
$msg->debug("quota", "getquota", $ressource);
if ($recheck) { // rebuilding quota
$get_quota_cache = null;
$this->quotas = array();
}
if (!empty($get_quota_cache[$cuid])) {
// This function is called many time each webpage, so I cache the result
$this->quotas = $get_quota_cache[$cuid];
} else {
$res = $hooks->invoke("hook_quota_get");
foreach ($res as $r) {
$this->quotas[$r['name']] = $r;
$this->quotas[$r['name']]['u'] = $r['used']; // retrocompatibility
if (isset($r['sizeondisk']))
$this->quotas[$r['name']]['s'] = $r['sizeondisk'];
$this->quotas[$r['name']]['t'] = 0; // Default quota = 0
}
reset($this->disk);
if (!empty($this->disk)) { // Check if there are some disk quota to check
// Look if there are some cached value
$disk_cached = $mem->session_tempo_params_get('quota_cache_disk');
while (list($key, $val) = each($this->disk)) {
$a = array();
if (
isset($disk_cached[$val]) && !empty($disk_cached[$val]) && $disk_cached[$val]['uid'] == $cuid && $disk_cached[$val]['timestamp'] > ( time() - (90) ) // Cache, en seconde
) {
// If there is a cached value
$a = $disk_cached[$val];
} else {
if ($this->disk_quota_not_blocking) {
$a['u'] = $this->get_size_web_sum_user($cuid);
$a['t'] = $this->get_quota_user_cat($cuid, 'web');
} else {
exec("/usr/lib/alternc/quota_get " . intval($cuid), $ak);
$a['u'] = intval($ak[0]);
$a['t'] = @intval($ak[1]);
}
$a['sizeondisk'] = $a['u'];
$a['timestamp'] = time();
$a['uid'] = $cuid;
$disk_cached = $mem->session_tempo_params_set('quota_cache_disk', array($val => $a));
}
$this->quotas[$val] = array("name" => "$val", 'description' => _("Web disk space"), "s" => $a['sizeondisk'], "t" => $a['t'], "u" => $a['u']);
}
}
// Get the allowed quota from database.
$db->query("select name, total from quotas where uid= ? ;", array($cuid));
while ($db->next_record()) {
$this->quotas[$db->f('name')]['t'] = $db->f('total');
}
$get_quota_cache[$cuid] = $this->quotas;
}
if ($ressource) {
if (isset($this->quotas[$ressource])) {
return $this->quotas[$ressource];
} else {
return 0;
}
} else {
return $this->quotas;
}
}
/** Set the quota for a user (and for a ressource)
* @param string $ressource ressource to set quota of
* @param integer size of the quota (available or used)
*/
function setquota($ressource, $size) {
global $msg, $db, $cuid;
$msg->log("quota", "setquota", $ressource . "/" . $size);
if (floatval($size) == 0) {
$size = "0";
}
if (!$this->disk_quota_not_blocking && isset($this->disk[$ressource])) {
// It's a disk resource, update it with shell command
exec("sudo /usr/lib/alternc/quota_edit " . intval($cuid) . " " . intval($size) . " &> /dev/null &");
// Now we check that the value has been written properly :
$a = array();
exec("sudo /usr/lib/alternc/quota_get " . intval($cuid) . " &> /dev/null &", $a);
if (!isset($a[1]) || $size != $a[1]) {
$msg->raise("ERROR", "quota", _("Error writing the quota entry!"));
return false;
}
}
// We check that this ressource exists for this client :
$db->query("SELECT * FROM quotas WHERE uid= ? AND name= ? ", array($cuid, $ressource));
if ($db->num_rows()) {
$db->query("UPDATE quotas SET total= ? WHERE uid= ? AND name= ?;", array($size, $cuid, $ressource));
} else {
$db->query("INSERT INTO quotas (uid,name,total) VALUES (?, ?, ?);", array($cuid, $ressource, $size));
}
return true;
}
/**
* Erase all quota information about the user.
*/
function delquotas() {
global $db, $msg, $cuid;
$msg->log("quota", "delquota");
$db->query("DELETE FROM quotas WHERE uid= ?;", array($cuid));
return true;
}
/**
* Get the default quotas as an associative array
* @return array the array of the default quotas
*/
function getdefaults() {
global $db;
$c = array();
$db->query("SELECT type,quota FROM defquotas WHERE type='default'");
if (!$db->next_record()) {
$this->addtype('default');
}
$db->query("SELECT value,quota,type FROM defquotas ORDER BY type,quota");
while ($db->next_record()) {
$type = $db->f("type");
$c[$type][$db->f("quota")] = $db->f("value");
}
return $c;
}
/**
* Set the default quotas
* @param array associative array of quota (key=>val)
*/
function setdefaults($newq) {
global $db;
$qlist = $this->qlist();
foreach ($newq as $type => $quotas) {
foreach ($quotas as $qname => $value) {
if (array_key_exists($qname, $qlist)) {
if (!$db->query("REPLACE INTO defquotas (value,quota,type) VALUES ( ?, ?, ?); ", array($value, $qname, $type))) {
return false;
}
}
}
}
return true;
}
/**
* Add an account type for quotas
* @param string $type account type to be added
* @return boolean true if all went ok
*/
function addtype($type) {
global $db, $msg;
$qlist = $this->qlist();
if (empty($type)) {
return false;
}
$type = strtolower($type);
if (!preg_match("#^[a-z0-9]*$#", $type)) {
$msg->raise("ERROR", "quota", _("Type can only contains characters a-z and 0-9"));
return false;
}
while (list($key, $val) = each($qlist)) {
if (!$db->query("INSERT IGNORE INTO defquotas (quota,type) VALUES(?, ?);", array($key, $type)) || $db->affected_rows() == 0) {
return false;
}
}
return true;
}
/**
* List types of quotas
* @return array
*/
function listtype() {
global $db;
$db->query("SELECT distinct(type) FROM defquotas ORDER by type");
$t = array();
while ($db->next_record()) {
$t[] = $db->f("type");
}
return $t;
}
/** Delete an account type for quotas
* @param string $type account type to be deleted
* @return boolean true if all went ok
*/
function deltype($type) {
global $db;
if ($db->query("UPDATE membres SET type='default' WHERE type= ? ;", array($type)) &&
$db->query("DELETE FROM defquotas WHERE type= ?;", array($type))) {
return true;
} else {
return false;
}
}
/** Create default quotas entries for a new user.
* The user we are talking about is in the global $cuid.
*/
function addquotas() {
global $db, $msg, $cuid;
$msg->log("quota", "addquota");
$ql = $this->qlist();
reset($ql);
$db->query("SELECT type,quota FROM defquotas WHERE type='default'");
if (!$db->next_record()) {
$this->addtype('default');
}
$db->query("SELECT type FROM membres WHERE uid= ?;", array($cuid));
$db->next_record();
$t = $db->f("type");
foreach ($ql as $res => $val) {
$db->query("SELECT value FROM defquotas WHERE quota= ? AND type= ? ;", array($res, $t));
$q = $db->next_record() ? $db->f("value") : 0;
$this->setquota($res, $q);
}
return true;
}
/** Return a quota value with its unit (when it is a space quota)
* in MB, GB, TB ...
* @param string $type The quota type
* @param integer $value The quota value
* @return string a quota value with its unit.
*/
function display_val($type, $value) {
switch ($type) {
case 'bw_web':
return format_size($value);
case 'web':
return format_size($value * 1024);
default:
return $value;
}
}
/* get size_xx function (filled by spoolsize.php) */
function _get_sum_sql($sql) {
global $db;
$db->query($sql);
if ($db->num_rows() == 0) {
return -1;
} else {
$db->next_record();
$r = $db->Record;
return $r['sum'];
}
}
function _get_count_sql($sql) {
global $db;
$db->query($sql);
if ($db->num_rows() == 0) {
return 0;
} else {
$db->next_record();
$r = $db->Record;
return $r['count'];
}
}
function _get_size_and_record_sql($sql) {
global $db;
$db->query($sql);
if ($db->num_rows() == 0) {
return array();
} else {
$ret = array();
while ($db->next_record()) {
$ret[] = $db->Record;
}
return $ret;
}
}
/* get the quota from one user for a cat */
function get_quota_user_cat($uid, $name) {
return $this->_get_sum_sql("SELECT SUM(total) AS sum FROM quotas WHERE uid='$uid' AND name='$name';");
}
/* sum of websites sizes from all users */
function get_size_web_sum_all() {
return $this->_get_sum_sql("SELECT SUM(size) AS sum FROM size_web;");
}
/* sum of websites sizes from one user */
function get_size_web_sum_user($u) {
return $this->_get_sum_sql("SELECT SUM(size) AS sum FROM size_web WHERE uid='$u';");
}
/* sum of mailbox sizes from all domains */
function get_size_mail_sum_all() {
return $this->_get_sum_sql("SELECT SUM(quota_dovecot) AS sum FROM dovecot_quota ;");
}
/* sum of mailbox sizes for one domain */
function get_size_mail_sum_domain($dom) {
global $mail;
return $mail->get_total_size_for_domain($dom);
}
/* sum of mailbox size for ine user */
function get_size_mail_sum_user($u) {
return $this->_get_sum_sql("SELECT SUM(quota_dovecot) as sum FROM dovecot_quota WHERE user IN (SELECT CONCAT(a.address, '@', d.domaine) as mail FROM `address` as a INNER JOIN domaines as d ON a.domain_id = d.id WHERE d.compte = '$u' AND a.type ='')");
}
/* count of mailbox sizes from all domains */
function get_size_mail_count_all() {
return $this->_get_count_sql("SELECT COUNT(*) AS count FROM dovecot_quota;");
}
/* count of mailbox for one domain */
function get_size_mail_count_domain($dom) {
return $this->_get_count_sql("SELECT COUNT(*) AS count FROM dovecot_quota WHERE user LIKE '%@{$dom}'");
}
/* get list of mailbox alias and size for one domain */
function get_size_mail_details_domain($dom) {
return $this->_get_size_and_record_sql("SELECT user as alias,quota_dovecot as size FROM dovecot_quota WHERE user LIKE '%@{$dom}' ORDER BY alias;");
}
/* sum of mailman lists sizes from all domains */
function get_size_mailman_sum_all() {
return $this->_get_sum_sql("SELECT SUM(size) AS sum FROM size_mailman;");
}
/* sum of mailman lists sizes for one domain */
function get_size_mailman_sum_domain($dom) {
return $this->_get_sum_sql("SELECT SUM(size) AS sum FROM size_mailman s INNER JOIN mailman m ON s.list = m.list AND s.uid = m.uid WHERE m.domain = '$dom'");
}
/* sum of mailman lists for one user */
function get_size_mailman_sum_user($u) {
return $this->_get_sum_sql("SELECT SUM(size) AS sum FROM size_mailman WHERE uid = '{$u}'");
}
/* count of mailman lists sizes from all domains */
function get_size_mailman_count_all() {
return $this->_get_count_sql("SELECT COUNT(*) AS count FROM size_mailman;");
}
/* count of mailman lists for one user */
function get_size_mailman_count_user($u) {
return $this->_get_count_sql("SELECT COUNT(*) AS count FROM size_mailman WHERE uid = '{$u}'");
}
/* get list of mailman list and size for one user */
function get_size_mailman_details_user($u) {
return $this->_get_size_and_record_sql("SELECT s.size,CONCAT(m.list,'@',m.domain) as list FROM size_mailman s LEFT JOIN mailman m ON s.list=m.name WHERE s.uid='{$u}' ORDER BY s.list ASC");
}
/* sum of databases sizes from all users */
function get_size_db_sum_all() {
return $this->_get_sum_sql("SELECT SUM(size) AS sum FROM size_db;");
}
/* sum of databases sizes for one user */
function get_size_db_sum_user($u) {
return $this->_get_sum_sql("SELECT SUM(size) AS sum FROM size_db WHERE db = '{$u}' OR db LIKE '{$u}\_%'");
}
/* count of databases from all users */
function get_size_db_count_all() {
return $this->_get_count_sql("SELECT COUNT(*) AS count FROM size_db;");
}
/* count of databases for one user */
function get_size_db_count_user($u) {
return $this->_get_count_sql("SELECT COUNT(*) AS count FROM size_db WHERE db = '{$u}' OR db LIKE '{$u}\_%'");
}
/* get list of databases name and size for one user */
function get_size_db_details_user($u) {
return $this->_get_size_and_record_sql("SELECT db,size FROM size_db WHERE db='{$u}' OR db LIKE '{$u}\_%';");
}
/* Return appropriate value and unit of a size given in Bytes (e.g. 1024 Bytes -> return 1 KB) */
function get_size_unit($size) {
$units = array(1073741824 => _("GB"), 1048576 => _("MB"), 1024 => _("KB"), 0 => _("B"));
foreach ($units as $value => $unit) {
if ($size >= $value) {
$size=$size/($value?$value:1);
return array('size' => $size, 'unit' => $unit);
}
}
}
/**
* show a progress-bar
* color_type :
* 0 = No colo change
* 1 = Progress from green to red depending on percentage
* 2 = Progress from red to green depending on percentage
*/
function quota_displaybar($usage, $color_type = 1) {
if ($color_type == 1) {
$csscolor = " background-color:" . PercentToColor($usage);
} elseif ($color_type == 2) {
$csscolor = " background-color:" . PercentToColor(100 - $usage);
} else {
$csscolor = "";
}
echo '<div class="progress-bar">';
echo '<div class="barre" style="width:' . $usage . '%;' . $csscolor . '" ></div>';
echo '<div class="txt">' . $usage . '%</div>';
echo '</div>';
}
/* ==== Hook functions ==== */
/** Hook function call when a user is deleted
* AlternC's standard function called when a user is deleted
* globals $cuid is the appropriate user
*/
function hook_admin_del_member() {
$this->delquotas();
}
/** Hook function called when a user is created
* This function initialize the user's quotas.
* globals $cuid is the appropriate user
*/
function hook_admin_add_member() {
global $msg;
$msg->log("quota", "hook_admin_add_member");
$this->addquotas();
$this->getquota('', true); // actualise quota
}
/** Exports all the quota related information for an account.
* @access private
* EXPERIMENTAL function ;)
*/
function alternc_export_conf() {
global $msg;
$msg->log("quota", "export");
$str = " <quota>";
$q = $this->getquota();
foreach ($q as $k => $v) {
$str.=" <$k>\n";
$str.=" <used>" . ($v["u"]) . "</used>\n";
$str.=" <total>" . ($v["t"]) . "</total>\n";
$str.=" </$k>\n";
}
$str.="</quota>\n";
return $str;
}
}
/* Class m_quota */