autosubmitFile = $conf['cachedir'] . '/autosubmit.txt'; $this->autosubmitErrorFile = $conf['cachedir'] . '/autosubmitError.txt'; $this->popularityLastSubmitFile = $conf['cachedir'] . '/lastSubmitTime.txt'; } /** * Check if autosubmit is enabled * * @return boolean TRUE if we should send data once a month, FALSE otherwise */ public function isAutoSubmitEnabled() { return file_exists($this->autosubmitFile); } /** * Send the data, to the submit url * * @param string $data The popularity data * @return string An empty string if everything worked fine, a string describing the error otherwise */ public function sendData($data) { $error = ''; $httpClient = new DokuHTTPClient(); $status = $httpClient->sendRequest($this->submitUrl, ['data' => $data], 'POST'); if (! $status) { $error = $httpClient->error; } return $error; } /** * Compute the last time the data was sent. If it has never been sent, we return 0. * * @return int */ public function lastSentTime() { $manualSubmission = @filemtime($this->popularityLastSubmitFile); $autoSubmission = @filemtime($this->autosubmitFile); return max((int) $manualSubmission, (int) $autoSubmission); } /** * Gather all information * * @return string The popularity data as a string */ public function gatherAsString() { $data = $this->gather(); $string = ''; foreach ($data as $key => $val) { if (is_array($val)) foreach ($val as $v) { $string .= hsc($key) . "\t" . hsc($v) . "\n"; } else { $string .= hsc($key) . "\t" . hsc($val) . "\n"; } } return $string; } /** * Initialize an empty list to be used in file traversing * * @return array * @see searchCountCallback */ protected function initEmptySearchList() { return $list = array_fill_keys([ 'file_count', 'file_size', 'file_max', 'file_min', 'dir_count', 'dir_nest', 'file_oldest' ], 0); } /** * Gather all information * * @return array The popularity data as an array */ protected function gather() { global $conf; /** @var $auth DokuWiki_Auth_Plugin */ global $auth; $data = []; $phptime = ini_get('max_execution_time'); @set_time_limit(0); $pluginInfo = $this->getInfo(); // version $data['anon_id'] = md5(auth_cookiesalt()); $data['version'] = getVersion(); $data['popversion'] = $pluginInfo['date']; $data['language'] = $conf['lang']; $data['now'] = time(); $data['popauto'] = (int) $this->isAutoSubmitEnabled(); // some config values $data['conf_useacl'] = $conf['useacl']; $data['conf_authtype'] = $conf['authtype']; $data['conf_template'] = $conf['template']; // number and size of pages $list = $this->initEmptySearchList(); search($list, $conf['datadir'], [$this, 'searchCountCallback'], ['all' => false], ''); $data['page_count'] = $list['file_count']; $data['page_size'] = $list['file_size']; $data['page_biggest'] = $list['file_max']; $data['page_smallest'] = $list['file_min']; $data['page_nscount'] = $list['dir_count']; $data['page_nsnest'] = $list['dir_nest']; if ($list['file_count']) $data['page_avg'] = $list['file_size'] / $list['file_count']; $data['page_oldest'] = $list['file_oldest']; unset($list); // number and size of media $list = $this->initEmptySearchList(); search($list, $conf['mediadir'], [$this, 'searchCountCallback'], ['all' => true]); $data['media_count'] = $list['file_count']; $data['media_size'] = $list['file_size']; $data['media_biggest'] = $list['file_max']; $data['media_smallest'] = $list['file_min']; $data['media_nscount'] = $list['dir_count']; $data['media_nsnest'] = $list['dir_nest']; if ($list['file_count']) $data['media_avg'] = $list['file_size'] / $list['file_count']; unset($list); // number and size of cache $list = $this->initEmptySearchList(); search($list, $conf['cachedir'], [$this, 'searchCountCallback'], ['all' => true]); $data['cache_count'] = $list['file_count']; $data['cache_size'] = $list['file_size']; $data['cache_biggest'] = $list['file_max']; $data['cache_smallest'] = $list['file_min']; if ($list['file_count']) $data['cache_avg'] = $list['file_size'] / $list['file_count']; unset($list); // number and size of index $list = $this->initEmptySearchList(); search($list, $conf['indexdir'], [$this, 'searchCountCallback'], ['all' => true]); $data['index_count'] = $list['file_count']; $data['index_size'] = $list['file_size']; $data['index_biggest'] = $list['file_max']; $data['index_smallest'] = $list['file_min']; if ($list['file_count']) $data['index_avg'] = $list['file_size'] / $list['file_count']; unset($list); // number and size of meta $list = $this->initEmptySearchList(); search($list, $conf['metadir'], [$this, 'searchCountCallback'], ['all' => true]); $data['meta_count'] = $list['file_count']; $data['meta_size'] = $list['file_size']; $data['meta_biggest'] = $list['file_max']; $data['meta_smallest'] = $list['file_min']; if ($list['file_count']) $data['meta_avg'] = $list['file_size'] / $list['file_count']; unset($list); // number and size of attic $list = $this->initEmptySearchList(); search($list, $conf['olddir'], [$this, 'searchCountCallback'], ['all' => true]); $data['attic_count'] = $list['file_count']; $data['attic_size'] = $list['file_size']; $data['attic_biggest'] = $list['file_max']; $data['attic_smallest'] = $list['file_min']; if ($list['file_count']) $data['attic_avg'] = $list['file_size'] / $list['file_count']; $data['attic_oldest'] = $list['file_oldest']; unset($list); // user count if ($auth instanceof AuthPlugin && $auth->canDo('getUserCount')) { $data['user_count'] = $auth->getUserCount(); } // calculate edits per day $list = (array) @file($conf['metadir'] . '/_dokuwiki.changes'); $count = count($list); if ($count > 2) { $first = (int) substr(array_shift($list), 0, 10); $last = (int) substr(array_pop($list), 0, 10); $dur = ($last - $first) / (60 * 60 * 24); // number of days in the changelog $data['edits_per_day'] = $count / $dur; } unset($list); // plugins $data['plugin'] = plugin_list(); // pcre info if (defined('PCRE_VERSION')) $data['pcre_version'] = PCRE_VERSION; $data['pcre_backtrack'] = ini_get('pcre.backtrack_limit'); $data['pcre_recursion'] = ini_get('pcre.recursion_limit'); // php info $data['os'] = PHP_OS; $data['webserver'] = $_SERVER['SERVER_SOFTWARE']; $data['php_version'] = phpversion(); $data['php_sapi'] = PHP_SAPI; $data['php_memory'] = php_to_byte(ini_get('memory_limit')); $data['php_exectime'] = $phptime; $data['php_extension'] = get_loaded_extensions(); // plugin usage data $this->addPluginUsageData($data); return $data; } /** * Triggers event to let plugins add their own data * * @param $data */ protected function addPluginUsageData(&$data) { $pluginsData = []; Event::createAndTrigger('PLUGIN_POPULARITY_DATA_SETUP', $pluginsData); foreach ($pluginsData as $plugin => $d) { if (is_array($d)) { foreach ($d as $key => $value) { $data['plugin_' . $plugin . '_' . $key] = $value; } } else { $data['plugin_' . $plugin] = $d; } } } /** * Callback to search and count the content of directories in DokuWiki * * @param array &$data Reference to the result data structure * @param string $base Base usually $conf['datadir'] * @param string $file current file or directory relative to $base * @param string $type Type either 'd' for directory or 'f' for file * @param int $lvl Current recursion depht * @param array $opts option array as given to search() * @return bool */ public function searchCountCallback(&$data, $base, $file, $type, $lvl, $opts) { // traverse if ($type == 'd') { if ($data['dir_nest'] < $lvl) $data['dir_nest'] = $lvl; $data['dir_count']++; return true; } //only search txt files if 'all' option not set if ($opts['all'] || str_ends_with($file, '.txt')) { $size = filesize($base . '/' . $file); $date = filemtime($base . '/' . $file); $data['file_count']++; $data['file_size'] += $size; if (!isset($data['file_min']) || $data['file_min'] > $size) $data['file_min'] = $size; if ($data['file_max'] < $size) $data['file_max'] = $size; if (!isset($data['file_oldest']) || $data['file_oldest'] > $date) $data['file_oldest'] = $date; } return false; } }