2 rcs_id('$Id: SystemInfo.php,v 1.6 2003-02-21 23:01:11 dairiki Exp $');
4 Copyright 1999, 2000, 2001, 2002 $ThePhpWikiProgrammingTeam
6 This file is part of PhpWiki.
8 PhpWiki is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 PhpWiki 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.
18 You should have received a copy of the GNU General Public License
19 along with PhpWiki; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 * Usage: <?plugin SystemInfo all ?>
25 * or <?plugin SystemInfo pagestats cachestats discspace hitstats ?>
26 * or <?plugin SystemInfo version ?>
27 * or <?plugin SystemInfo current_theme ?>
28 * or <?plugin SystemInfo PHPWIKI_DIR ?>
30 * Provide access to phpwiki's lower level system information.
32 * version, CHARSET, pagestats, SERVER_NAME, database, discspace,
33 * cachestats, userstats, linkstats, accessstats, hitstats,
34 * revisionstats, interwikilinks, imageextensions, wikiwordregexp,
35 * availableplugins, downloadurl, ...
37 * In spirit to http://www.ecyrd.com/JSPWiki/SystemInfo.jsp
39 * Todo: Some calculations are heavy (~5-8 secs), so we should cache
40 * the result. In the page or with WikiPluginCached?
42 //require_once "lib/WikiPluginCached.php";
44 class WikiPlugin_SystemInfo
45 //extends WikiPluginCached
48 function getPluginType() {
49 return PLUGIN_CACHED_HTML;
52 return _("SystemInfo");
55 function getDescription() {
56 return _("Provides access to PhpWiki's lower level system information.");
59 function getVersion() {
60 return preg_replace("/[Revision: $]/", '',
64 function getExpire($dbi, $argarray, $request) {
65 return '+1800'; // 30 minutes
67 function getHtml($dbi, $argarray, $request, $basepage) {
68 $loader = new WikiPluginLoader;
69 return $loader->expandPI('<?plugin SystemInfo '
70 . WikiPluginCached::glueArgs($argarray) // all
71 . ' ?>', $request, $basepage);
74 function getDefaultArguments() {
76 'seperator' => ' ', // on multiple args
82 global $DBParams, $request;
83 $s = _("db type:") . " {$DBParams['dbtype']}, ";
84 switch ($DBParams['dbtype']) {
87 $dsn = $DBParams['dsn'];
88 $s .= _("db backend:") . " ";
89 $s .= ($DBParams['dbtype'] == 'SQL') ? 'PearDB' : 'ADODB';
90 if (preg_match('/^(\w+):/', $dsn, $m)) {
96 $s .= _("dba handler:") . " {$DBParams['dba_handler']}, ";
99 // $s .= "cvs stuff: , ";
102 // $s .= "flatfile stuff: , ";
105 // hack: suppress error when using sql, so no timeout
106 @$s .= _("timeout:") . " {$DBParams['timeout']}";
109 function cachestats() {
110 global $DBParams, $request;
111 if (! defined('USECACHE') or !USECACHE)
112 return _("no cache used");
113 $dbi = $request->getDbh();
114 $cache = $dbi->_cache;
115 $s = _("cached pagedata:") . " " . count($cache->_pagedata_cache);
116 $s .= ", " . _("cached versiondata:");
117 $s .= " " . count($cache->_versiondata_cache);
118 //$s .= ", glv size: " . count($cache->_glv_cache);
119 //$s .= ", cache hits: ?";
120 //$s .= ", cache misses: ?";
123 function ExpireParams() {
124 global $ExpireParams;
125 $s = sprintf(_("Keep up to %d major edits, but keep them no longer than %d days."),
126 $ExpireParams['major']['keep'],
127 $ExpireParams['major']['max_age']);
128 $s .= sprintf(_(" Keep up to %d minor edits, but keep them no longer than %d days."),
129 $ExpireParams['minor']['keep'],
130 $ExpireParams['minor']['max_age']);
131 $s .= sprintf(_(" Keep the latest contributions of the last %d authors up to %d days."),
132 $ExpireParams['author']['keep'], $ExpireParams['author']['max_age']);
133 $s .= sprintf(_(" Additionally, try to keep the latest contributions of all authors in the last %d days (even if there are more than %d of them,) but in no case keep more than %d unique author revisions."),
134 $ExpireParams['author']['min_age'],
135 $ExpireParams['author']['keep'],
136 $ExpireParams['author']['max_keep']);
139 function pagestats() {
143 $dbi = $request->getDbh();
144 $include_empty = true;
145 $iter = $dbi->getAllPages($include_empty);
146 while ($page = $iter->next())
148 $s = sprintf(_("%d pages"), $e);
149 $include_empty = false;
150 $iter = $dbi->getAllPages($include_empty);
151 while ($page = $iter->next())
153 $s .= ", " . sprintf(_("%d not-empty pages"), $a);
155 // $s .= ", " . sprintf(_("earliest page from %s"), $earliestdate);
156 // $s .= ", " . sprintf(_("latest page from %s"), $latestdate);
157 // $s .= ", " . sprintf(_("latest pagerevision from %s"), $latestrevdate);
160 //What kind of link statistics?
161 // total links in, total links out, mean links per page, ...
162 // Any useful numbers similar to a VisualWiki interestmap?
163 function linkstats() {
167 // number of homepages: easy
168 // number of anonymous users?
169 // calc this from accesslog info?
170 // number of anonymous edits?
171 // easy. related to the view/edit rate in accessstats.
172 function userstats() {
174 $dbi = $request->getDbh();
176 $page_iter = $dbi->getAllPages(true);
177 while ($page = $page_iter->next()) {
178 if ($page->isUserPage(true)) // check if the admin is there. if not add him to the authusers.
181 $s = sprintf(_("%d homepages"), $h);
182 // $s .= ", " . sprintf(_("%d anonymous users"), $au); // ??
183 // $s .= ", " . sprintf(_("%d anonymous edits"), $ae); // see recentchanges
184 // $s .= ", " . sprintf(_("%d authenticated users"), $auth); // users with password set
185 // $s .= ", " . sprintf(_("%d externally authenticated users"), $extauth); // query AuthDB?
188 //only from logging info possible. = hitstats per time.
189 // total hits per day/month/year
191 function accessstats() {
195 // only absolute numbers, not for any time interval. see accessstats
196 // some useful number derived from the curve of the hit stats.
197 // total, max, mean, median, stddev;
198 // %d pages less than 3 hits (<10%) <10% percent of the leastpopular
199 // %d pages more than 100 hits (>90%) >90% percent of the mostpopular
200 function hitstats() {
202 $dbi = $request->getDbh();
206 $page_iter = $dbi->getAllPages(true);
207 while ($page = $page_iter->next()) {
208 if ($current = $page->getCurrentRevision()
209 && (! $current->hasDefaultContents())) {
210 $h = $page->get('hits');
213 $max = max($h, $max);
219 $median_i = (int) $n / 2;
221 $median = $hits[$median_i];
223 $median = $hits[$median_i];
224 $stddev = stddev(&$hits, $total);
226 $s = sprintf(_("total hits: %d"), $total);
227 $s .= ", " . sprintf(_("max: %d"), $max);
228 $s .= ", " . sprintf(_("mean: %2.3f"), $total / $n);
229 $s .= ", " . sprintf(_("median: %d"), $median);
230 $s .= ", " . sprintf(_("stddev: %2.3f"), $stddev);
232 $mintreshold = $max * $percentage / 100.0; // lower than 10% of the hits
234 $nmin = $hits[0] < $mintreshold ? 1 : 0;
235 while (next($hits) < $mintreshold)
237 $maxtreshold = $max - $mintreshold; // more than 90% of the hits
240 while (prev($hits) > $maxtreshold)
242 $s .= "; " . sprintf(_("%d pages with less than %d hits (<%d%%)."),
243 $nmin, $mintreshold, $percentage);
244 $s .= " " . sprintf(_("%d page(s) with more than %d hits (>%d%%)."),
245 $nmax, $maxtreshold, 100 - $percentage);
248 function revisionstats() {
250 $dbi = $request->getDbh();
254 $page_iter = $dbi->getAllPages(true);
255 while ($page = $page_iter->next()) {
256 if ($current = $page->getCurrentRevision()
257 && (! $current->hasDefaultContents())) {
258 //$ma = $page->get('major');
259 //$mi = $page->get('minor');
265 // size of databases/files/cvs are possible plus the known size of the app.
266 // Todo: cache this costly operation!
267 function discspace() {
270 $appsize = `du -s $dir | cut -f1`;
272 if (in_array($DBParams['dbtype'], array('SQL', 'ADODB'))) {
274 } elseif ($DBParams['dbtype'] == 'dba') {
276 $dbdir = $DBParams['directory'];
277 if ($DBParams['dba_handler'] == 'db3')
278 $pagesize = filesize($DBParams['directory']
279 . "/wiki_pagedb.db3") / 1024;
280 // if issubdirof($dbdir, $dir) $appsize -= $pagesize;
281 } else { // flatfile, cvs
282 $dbdir = $DBParams['directory'];
283 $pagesize = `du -s $dbdir`;
284 // if issubdirof($dbdir, $dir) $appsize -= $pagesize;
286 $s = sprintf(_("Application size: %d Kb"), $appsize);
288 $s .= ", " . sprintf(_("Pagedata size: %d Kb", $pagesize));
292 function inlineimages () {
293 return implode(' ', explode('|', $GLOBALS['InlineImages']));
295 function wikinameregexp () {
296 return $GLOBALS['WikiNameRegexp'];
298 function allowedprotocols () {
299 return implode(' ', explode('|', $GLOBALS['AllowedProtocols']));
301 function available_plugins () {
302 $fileset = new FileSet(FindFile('lib/plugin'), '*.php');
303 $list = $fileset->getFiles();
306 return sprintf(_("Total %d plugins: "), count($list))
307 . implode(', ', array_map(create_function('$f',
308 'return substr($f,0,-4);'),
311 function supported_languages () {
312 $available_languages = array('en');
313 $dir_root = PHPWIKI_DIR . '/locale/';
314 $dir = dir($dir_root);
316 while($entry = $dir->read()) {
317 if (is_dir($dir_root . $entry)
318 && (substr($entry, 0, 1) != '.')
320 && $entry != 'CVS') {
321 array_push($available_languages, $entry);
326 natcasesort($available_languages);
328 return sprintf(_("Total of %d languages: "),
329 count($available_languages))
330 . implode(', ', $available_languages) . ". "
331 . sprintf(_("Current language: '%s'"), $GLOBALS['LANG'])
332 . ((DEFAULT_LANGUAGE != $GLOBALS['LANG'])
333 ? ". " . sprintf(_("Default language: '%s'"), DEFAULT_LANGUAGE)
337 function supported_themes () {
339 $available_themes = array();
340 $dir_root = PHPWIKI_DIR . '/themes/';
341 $dir = dir($dir_root);
343 while($entry = $dir->read()) {
344 if (is_dir($dir_root.$entry)
345 && (substr($entry,0,1) != '.')
347 array_push($available_themes, $entry);
352 natcasesort($available_themes);
353 return sprintf(_("Total of %d themes: "), count($available_themes))
354 . implode(', ',$available_themes) . ". "
355 . sprintf(_("Current theme: '%s'"), $Theme->_name)
356 . ((THEME != $Theme->_name)
357 ? ". " . sprintf(_("Default theme: '%s'"), THEME)
361 function call ($arg, &$availableargs) {
362 if (!empty($availableargs[$arg]))
363 return $availableargs[$arg]();
364 elseif (method_exists($this, $arg)) // any defined SystemInfo->method()system
365 return call_user_func_array(array(&$this, $arg), '');
366 elseif (defined($arg) && $arg != 'ADMIN_PASSWD') // any defined constant
367 return constant($arg);
369 return $this->error(sprintf(_("unknown argument '%s' to SystemInfo"), $arg));
372 function run($dbi, $argstr, $request, $basepage) {
373 // don't parse argstr for name=value pairs. instead we use just 'name'
374 //$args = $this->getArgs($argstr, $request);
375 $args['seperator'] = ' ';
376 $availableargs = // name => callback + 0 args
377 array ('appname' => create_function('',"return 'PhpWiki';"),
378 'version' => create_function('',"return sprintf('%s', PHPWIKI_VERSION);"),
379 'LANG' => create_function('','return $GLOBALS["LANG"];'),
380 'LC_ALL' => create_function('','return setlocale(LC_ALL, 0);'),
381 'current_language' => create_function('','return $GLOBALS["LANG"];'),
382 'system_language' => create_function('','return DEFAULT_LANGUAGE;'),
383 'current_theme' => create_function('','return $GLOBALS["Theme"]->_name;'),
384 'system_theme' => create_function('','return THEME;'),
385 // more here or as method.
386 '' => create_function('',"return 'dummy';")
388 // split the argument string by any number of commas or space
389 // characters, which include " ", \r, \t, \n and \f
390 $allargs = preg_split("/[\s,]+/", $argstr, -1, PREG_SPLIT_NO_EMPTY);
391 if (in_array('all', $allargs) || in_array('table', $allargs)) {
392 $allargs = array('appname' => _("Application name"),
393 'version' => _("PhpWiki engine version"),
394 'database' => _("Database"),
395 'cachestats' => _("Cache statistics"),
396 'pagestats' => _("Page statistics"),
397 //'revisionstats' => _("Page revision statistics"),
398 //'linkstats' => _("Link statistics"),
399 'userstats' => _("User statistics"),
400 //'accessstats' => _("Access statistics"),
401 'hitstats' => _("Hit statistics"),
402 //'discspace' => _("Harddisc usage"),
403 'expireparams' => _("Expiry parameters"),
404 'wikinameregexp' => _("Wikiname regexp"),
405 'allowedprotocols' => _("Allowed protocols"),
406 'inlineimages' => _("Inline images"),
407 'available_plugins' => _("Available plugins"),
408 'supported_languages' => _("Supported languages"),
409 'supported_themes' => _("Supported themes"),
413 $table = HTML::table(array('border' => 1,'cellspacing' => 3,
414 'cellpadding' => 3));
415 foreach ($allargs as $arg => $desc) {
420 $table->pushContent(HTML::tr(HTML::td(HTML::strong($desc . ':')),
421 HTML::td(HTML($this->call($arg, &$availableargs)))));
426 foreach ($allargs as $arg) {
427 $o = $this->call($arg, &$availableargs);
431 $output .= ($o . $args['seperator']);
433 // if more than one arg, remove the trailing seperator
434 if ($output) $output = substr($output, 0,
435 - strlen($args['seperator']));
436 return HTML($output);
441 /* // autolisp stdlib
442 ;;; Median of the sorted list of numbers. 50% is above and 50% below
443 ;;; "center of a distribution"
444 ;;; Ex: (std-median (std-make-list 100 std-%random)) => 0.5 +- epsilon
445 ;;; (std-median (std-make-list 100 (lambda () (std-random 10))))
446 ;;; => 4.0-5.0 [0..9]
447 ;;; (std-median (std-make-list 99 (lambda () (std-random 10))))
449 ;;; (std-median '(0 0 2 4 12)) => 2
450 ;;; (std-median '(0 0 4 12)) => 2.0
451 (defun STD-MEDIAN (numlst / l)
452 (setq numlst (std-sort numlst '<)) ; don't remove duplicates
453 (if (= 0 (rem (setq l (length numlst)) 2)) ; if even length
454 (* 0.5 (+ (nth (/ l 2) numlst) ; force float!
455 (nth (1- (/ l 2)) numlst))) ; fixed by Serge Pashkov
456 (nth (/ l 2) numlst)))
459 function median($hits) {
463 $median = (int) $n / 2;
464 if (! ($n % 2)) // proper rounding on even length
465 return ($hits[$median] + $hits[$median-1]) * 0.5;
467 return $hits[$median];
470 function rsum($a, $b) {
474 function mean(&$hits, $total = false) {
477 $total = array_reduce($hits, 'rsum');
478 return (float) $total / ($n * 1.0);
480 function gensym($prefix = "_gensym") {
482 while (isset($GLOBALS[$prefix . $i]))
487 /* // autolisp stdlib
488 (defun STD-STANDARD-DEVIATION (numlst / n _dev_m r)
489 (setq n (length numlst)
490 _dev_m (std-mean numlst)
491 r (mapcar (function (lambda (x) (std-sqr (- x _dev_m)))) numlst))
492 (sqrt (* (std-mean r) (/ n (float (- n 1))))))
495 function stddev(&$hits, $total=false) {
497 if (!$total) $total = array_reduce($hits, 'rsum');
498 $mean = gensym("_mean");
499 $GLOBALS[$mean] = $total / $n;
500 $cb = "global ${$mean}; return (\$i-${$mean})*(\$i-${$mean});";
501 $r = array_map(create_function('$i',"global ${$mean}; return (\$i-${$mean})*(\$i-${$mean});"),$hits);
502 unset($GLOBALS[$mean]);
503 return (float) sqrt(mean($r,$total) * ($n / (float)($n -1)));
506 function stddev(&$hits, $total = false) {
509 $total = array_reduce($hits, 'rsum');
510 $GLOBALS['mean'] = $total / $n;
511 $r = array_map(create_function('$i', 'global $mean; return ($i-$mean)*($i-$mean);'),
513 unset($GLOBALS['mean']);
514 return (float)sqrt(mean($r, $total) * ($n / (float)($n -1)));
517 // $Log: not supported by cvs2svn $
518 // Revision 1.5 2003/01/18 22:08:01 carstenklapp
520 // Reformatting & tabs to spaces;
521 // Added copyleft, getVersion, getDescription, rcs_id.
528 // c-hanging-comment-ender-p: nil
529 // indent-tabs-mode: nil