/usr/share/phoronix-test-suite/pts-core/objects/client/pts_module.php is in phoronix-test-suite 4.8.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?php
/*
Phoronix Test Suite
URLs: http://www.phoronix.com, http://www.phoronix-test-suite.com/
Copyright (C) 2008 - 2011, Phoronix Media
Copyright (C) 2008 - 2011, Michael Larabel
pts_module_interface.php: The generic Phoronix Test Suite module object that is extended by the specific modules/plug-ins
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 3 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, see <http://www.gnu.org/licenses/>.
*/
class pts_module
{
const MODULE_UNLOAD = "MODULE_UNLOAD";
const QUIT_PTS_CLIENT = "QUIT_PTS_CLIENT";
public static function save_dir()
{
$prefix_dir = PTS_MODULE_DATA_PATH;
pts_file_io::mkdir($prefix_dir);
return $prefix_dir . str_replace('_', '-', self::module_name()) . '/';
}
public static function is_module($name)
{
return is_file(PTS_MODULE_LOCAL_PATH . $name . ".php") || is_file(PTS_MODULE_PATH . $name . ".php");
}
public static function module_config_save($module_name, $set_options = null)
{
// Validate the config files, update them (or write them) if needed, and other configuration file tasks
pts_file_io::mkdir(PTS_MODULE_DATA_PATH . $module_name);
$settings_to_write = array();
if(is_file(PTS_MODULE_DATA_PATH . $module_name . "/module-settings.xml"))
{
$module_config_parser = new nye_XmlReader(PTS_MODULE_DATA_PATH . $module_name . "/module-settings.xml");
$option_identifier = $module_config_parser->getXMLArrayValues('PhoronixTestSuite/ModuleSettings/Option/Identifier');
$option_value = $module_config_parser->getXMLArrayValues('PhoronixTestSuite/ModuleSettings/Option/Value');
for($i = 0; $i < count($option_identifier); $i++)
{
$settings_to_write[$option_identifier[$i]] = $option_value[$i];
}
}
foreach($set_options as $identifier => $value)
{
$settings_to_write[$identifier] = $value;
}
$config = new nye_XmlWriter();
foreach($settings_to_write as $identifier => $value)
{
$config->addXmlNode('PhoronixTestSuite/ModuleSettings/Option/Identifier', $identifier);
$config->addXmlNode('PhoronixTestSuite/ModuleSettings/Option/Value', $value);
}
$config->saveXMLFile(PTS_MODULE_DATA_PATH . $module_name . "/module-settings.xml");
}
public static function is_module_setup()
{
$module_name = self::module_name();
$is_setup = true;
$module_setup_options = pts_module_manager::module_call($module_name, "module_setup");
foreach($module_setup_options as $option)
{
if($option instanceOf pts_module_option)
{
if(pts_module::read_option($option->get_identifier()) == false && $option->setup_check_needed())
{
$is_setup = false;
break;
}
}
}
return $is_setup;
}
public static function read_variable($var)
{
// For now this is just readung from the real env
return trim(getenv($var));
}
public static function valid_run_command($module, $command = null)
{
if($command == null)
{
if(strpos($module, '.') != false)
{
list($module, $command) = explode('.', $module);
}
else
{
$command = 'run';
}
}
if(!pts_module_manager::is_module_attached($module))
{
pts_module_manager::attach_module($module);
}
$all_options = pts_module_manager::module_call($module, 'user_commands');
$valid = count($all_options) > 0 && ((isset($all_options[$command]) && method_exists($module, $all_options[$command])) || in_array($command, array('help')));
return $valid ? array($module, $command) : false;
}
public static function read_option($identifier, $default_fallback = false)
{
$module_name = self::module_name();
$value = false;
$module_config_parser = new nye_XmlReader(PTS_MODULE_DATA_PATH . $module_name . "/module-settings.xml");
$option_identifier = $module_config_parser->getXMLArrayValues('PhoronixTestSuite/ModuleSettings/Option/Identifier');
$option_value = $module_config_parser->getXMLArrayValues('PhoronixTestSuite/ModuleSettings/Option/Value');
for($i = 0; $i < count($option_identifier) && $value == false; $i++)
{
if($option_identifier[$i] == $identifier)
{
$value = $option_value[$i];
}
}
if($default_fallback && empty($value))
{
// Find the default value
$module_options = call_user_func(array($module_name, "module_setup"));
for($i = 0; $i < count($module_options) && $value == false; $i++)
{
if($module_options[$i]->get_identifier() == $identifier)
{
$value = $module_options[$i]->get_default_value();
}
}
}
return $value;
}
public static function read_all_options()
{
$module_name = self::module_name();
$options = array();
$module_config_parser = new nye_XmlReader(PTS_MODULE_DATA_PATH . $module_name . "/module-settings.xml");
$option_identifier = $module_config_parser->getXMLArrayValues('PhoronixTestSuite/ModuleSettings/Option/Identifier');
$option_value = $module_config_parser->getXMLArrayValues('PhoronixTestSuite/ModuleSettings/Option/Value');
for($i = 0; $i < count($option_identifier); $i++)
{
$options[$option_identifier[$i]] = $option_value[$i];
}
return $options;
}
public static function set_option($identifier, $value)
{
pts_module::module_config_save(self::module_name(), array($identifier => $value));
}
public static function save_file($file, $contents = null, $append = false)
{
// Saves a file for a module
$save_base_dir = self::save_dir();
pts_file_io::mkdir($save_base_dir);
if(($extra_dir = dirname($file)) != "." && !is_dir($save_base_dir . $extra_dir))
{
mkdir($save_base_dir . $extra_dir);
}
if($append)
{
if(is_file($save_base_dir . $file))
{
if(file_put_contents($save_base_dir . $file, $contents . "\n", FILE_APPEND) != false)
{
return $save_base_dir . $file;
}
}
}
else
{
if(file_put_contents($save_base_dir . $file, $contents) != false)
{
return $save_base_dir . $file;
}
}
return false;
}
public static function read_file($file)
{
$file = self::save_dir() . $file;
return is_file($file) ? file_get_contents($file) : false;
}
public static function is_file($file)
{
$file = self::save_dir() . $file;
return is_file($file);
}
public static function remove_file($file)
{
$file = self::save_dir() . $file;
return is_file($file) && unlink($file);
}
public static function copy_file($from_file, $to_file)
{
// Copy a file for a module
$save_base_dir = self::save_dir();
pts_file_io::mkdir($save_base_dir);
if(($extra_dir = dirname($to_file)) != "." && !is_dir($save_base_dir . $extra_dir))
{
mkdir($save_base_dir . $extra_dir);
}
if(is_file($from_file) && (!is_file($save_base_dir . $to_file) || md5_file($from_file) != md5_file($save_base_dir . $to_file)))
{
if(copy($from_file, $save_base_dir . $to_file))
{
return $save_base_dir . $to_file;
}
}
return false;
}
public static function pts_fork_function($function)
{
self::pts_timed_function($function, -1);
}
public static function pts_timed_function($function, $time)
{
if(($time < 0.5 && $time != -1) || $time > 300)
{
return;
}
if(function_exists('pcntl_fork'))
{
$pid = pcntl_fork();
if($pid != -1)
{
if($pid)
{
return $pid;
}
else
{
$loop_continue = true;
/*
ML: I think this below check can be safely removed
$start_id = pts_unique_runtime_identifier();
&& ($start_id == pts_unique_runtime_identifier() || $start_id == PTS_INIT_TIME)
*/
while(pts_test_run_manager::test_run_process_active() !== -1 && is_file(PTS_USER_LOCK) && $loop_continue)
{
call_user_func(array(self::module_name(), $function));
if($time > 0)
{
sleep($time);
}
else if($time == -1)
{
$loop_continue = false;
}
}
exit(0);
}
}
}
else
{
pts_client::$display->generic_error("php-pcntl must be installed for the " . self::module_name() . " module.");
}
}
private static function module_name()
{
$module_name = "unknown";
if(($current = pts_module_manager::get_current_module()) != null)
{
$module_name = $current;
}
else
{
$bt = debug_backtrace();
for($i = 0; $i < count($bt) && $module_name == "unknown"; $i++)
{
if($bt[$i]["class"] != "pts_module")
{
$module_name = $bt[$i]["class"];
}
}
}
return $module_name;
}
}
?>
|