Merge "By default, keep users in HTTPS with wgSecureLogin"
[lhc/web/wiklou.git] / includes / profiler / ProfilerSimple.php
index 8aab1ec..1322e47 100644 (file)
@@ -1,13 +1,26 @@
 <?php
 /**
+ * Base class for simple profiling.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License 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.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
  * @file
  * @ingroup Profiler
  */
 
-if ( !class_exists( 'Profiler' ) ) {
-       require_once(dirname(__FILE__).'/Profiler.php');
-}
-
 /**
  * Simple profiler base class.
  * @todo document methods (?)
@@ -15,83 +28,71 @@ if ( !class_exists( 'Profiler' ) ) {
  */
 class ProfilerSimple extends Profiler {
        var $mMinimumTime = 0;
-       var $mProfileID = false;
-
-       function __construct() {
-               global $wgRequestTime, $wgRUstart;
-               if (!empty($wgRequestTime) && !empty($wgRUstart)) {
-                       $this->mWorkStack[] = array( '-total', 0, $wgRequestTime,$this->getCpuTime($wgRUstart));
 
-                       $elapsedcpu = $this->getCpuTime() - $this->getCpuTime($wgRUstart);
-                       $elapsedreal = microtime(true) - $wgRequestTime;
+       var $zeroEntry = array( 'cpu'=> 0.0, 'cpu_sq' => 0.0, 'real' => 0.0, 'real_sq' => 0.0, 'count' => 0 );
+       var $errorEntry;
 
-                       $entry =& $this->mCollated["-setup"];
-                       if (!is_array($entry)) {
-                               $entry = array('cpu'=> 0.0, 'cpu_sq' => 0.0, 'real' => 0.0, 'real_sq' => 0.0, 'count' => 0);
-                               $this->mCollated["-setup"] =& $entry;
-                       }
-                       $entry['cpu'] += $elapsedcpu;
-                       $entry['cpu_sq'] += $elapsedcpu*$elapsedcpu;
-                       $entry['real'] += $elapsedreal;
-                       $entry['real_sq'] += $elapsedreal*$elapsedreal;
-                       $entry['count']++;
-               }
+       public function isPersistent() {
+               /* Implement in output subclasses */
+               return false;
        }
 
-       function setMinimum( $min ) {
-               $this->mMinimumTime = $min;
-       }
+       protected function addInitialStack() {
+               $this->errorEntry = $this->zeroEntry;
+               $this->errorEntry['count'] = 1;
 
-       function setProfileID( $id ) {
-               $this->mProfileID = $id;
-       }
+               $initialTime = $this->getInitialTime();
+               $initialCpu = $this->getInitialTime( 'cpu' );
+               if ( $initialTime !== null && $initialCpu !== null ) {
+                       $this->mWorkStack[] = array( '-total', 0, $initialTime, $initialCpu );
+                       $this->mWorkStack[] = array( '-setup', 1, $initialTime, $initialCpu );
 
-       function getProfileID() {
-               if ( $this->mProfileID === false ) {
-                       return wfWikiID();
+                       $this->profileOut( '-setup' );
                } else {
-                       return $this->mProfileID;
+                       $this->profileIn( '-total' );
                }
        }
 
-       function profileIn($functionname) {
+       function setMinimum( $min ) {
+               $this->mMinimumTime = $min;
+       }
+
+       function profileIn( $functionname ) {
                global $wgDebugFunctionEntry;
-               if ($wgDebugFunctionEntry) {
-                       $this->debug(str_repeat(' ', count($this->mWorkStack)).'Entering '.$functionname."\n");
+               if ( $wgDebugFunctionEntry ) {
+                       $this->debug( str_repeat( ' ', count( $this->mWorkStack ) ) . 'Entering ' . $functionname . "\n" );
                }
-               $this->mWorkStack[] = array($functionname, count( $this->mWorkStack ), microtime(true), $this->getCpuTime());
+               $this->mWorkStack[] = array( $functionname, count( $this->mWorkStack ), $this->getTime(), $this->getTime( 'cpu' ) );
        }
 
-       function profileOut($functionname) {
+       function profileOut( $functionname ) {
                global $wgDebugFunctionEntry;
 
-               if ($wgDebugFunctionEntry) {
-                       $this->debug(str_repeat(' ', count($this->mWorkStack) - 1).'Exiting '.$functionname."\n");
+               if ( $wgDebugFunctionEntry ) {
+                       $this->debug( str_repeat( ' ', count( $this->mWorkStack ) - 1 ) . 'Exiting ' . $functionname . "\n" );
                }
 
-               list($ofname, /* $ocount */ ,$ortime,$octime) = array_pop($this->mWorkStack);
+               list( $ofname, /* $ocount */, $ortime, $octime ) = array_pop( $this->mWorkStack );
 
-               if (!$ofname) {
-                       $this->debug("Profiling error: $functionname\n");
+               if ( !$ofname ) {
+                       $this->debug( "Profiling error: $functionname\n" );
                } else {
-                       if ($functionname == 'close') {
+                       if ( $functionname == 'close' ) {
                                $message = "Profile section ended by close(): {$ofname}";
                                $functionname = $ofname;
                                $this->debug( "$message\n" );
-                               $this->mCollated[$message] = array(
-                                       'real' => 0.0, 'count' => 1);
+                               $this->mCollated[$message] = $this->errorEntry;
                        }
-                       elseif ($ofname != $functionname) {
+                       elseif ( $ofname != $functionname ) {
                                $message = "Profiling error: in({$ofname}), out($functionname)";
                                $this->debug( "$message\n" );
-                               $this->mCollated[$message] = array(
-                                       'real' => 0.0, 'count' => 1);
+                               $this->mCollated[$message] = $this->errorEntry;
                        }
                        $entry =& $this->mCollated[$functionname];
-                       $elapsedcpu = $this->getCpuTime() - $octime;
-                       $elapsedreal = microtime(true) - $ortime;
-                       if (!is_array($entry)) {
-                               $entry = array('cpu'=> 0.0, 'cpu_sq' => 0.0, 'real' => 0.0, 'real_sq' => 0.0, 'count' => 0);
+                       $elapsedcpu = $this->getTime( 'cpu' ) - $octime;
+                       $elapsedreal = $this->getTime() - $ortime;
+                       if ( !is_array( $entry ) ) {
+                               $entry = $this->zeroEntry;
                                $this->mCollated[$functionname] =& $entry;
                        }
                        $entry['cpu'] += $elapsedcpu;
@@ -103,28 +104,29 @@ class ProfilerSimple extends Profiler {
                }
        }
 
-       function getFunctionReport() {
+       public function getFunctionReport() {
                /* Implement in output subclasses */
+               return '';
        }
 
-       function getCpuTime($ru=null) {
-               if ( function_exists( 'getrusage' ) ) {
-                       if ( $ru == null ) {
-                               $ru = getrusage();
-                       }
-                       return ($ru['ru_utime.tv_sec'] + $ru['ru_stime.tv_sec'] + ($ru['ru_utime.tv_usec'] +
-                               $ru['ru_stime.tv_usec']) * 1e-6);
-               } else {
-                       return 0;
-               }
+       public function logData() {
+               /* Implement in subclasses */
        }
 
-       /* If argument is passed, it assumes that it is dual-format time string, returns proper float time value */
-       function getTime($time=null) {
-               if ($time==null) {
-                       return microtime(true);
+       /**
+        * Get the actual CPU time or the initial one if $ru is set.
+        *
+        * @deprecated in 1.20
+        * @return float|null
+        */
+       function getCpuTime( $ru = null ) {
+               wfDeprecated( __METHOD__, '1.20' );
+
+               if ( $ru === null ) {
+                       return $this->getTime( 'cpu' );
+               } else {
+                       # It theory we should use $ru here, but it always $wgRUstart that is passed here
+                       return $this->getInitialTime( 'cpu' );
                }
-               list($a,$b)=explode(" ",$time);
-               return (float)($a+$b);
        }
 }