4 * Small sorting callback function to sort files and directories by name.
5 * Function keeps '.' and '..' names always in the beginning of array.
6 * Used to sort files and directories from Bvfs.
8 function sortFilesListByName($a, $b) {
9 $firstLeft = substr($a['name'], 0, 1);
10 $firstRight = substr($b['name'], 0, 1);
11 if ($firstLeft == '.' && $firstRight != '.') {
13 } else if ($firstRight == '.' && $firstLeft != '.') {
16 return strcasecmp($a['name'], $b['name']);
19 class Miscellaneous extends TModule {
21 const LICENCE_FILE = 'LICENSE';
23 const RPATH_PATTERN = '/^b2\d+$/';
25 public $job_types = array(
38 private $jobLevels = array(
41 'D' => 'Differential',
46 'O' => 'VolumeToCatalog',
47 'd' => 'DiskToCatalog'
50 private $jobStates = array(
51 'C' => array('value' => 'Created', 'description' =>'Created but not yet running'),
52 'R' => array('value' => 'Running', 'description' => 'Running'),
53 'B' => array('value' => 'Blocked', 'description' => 'Blocked'),
54 'T' => array('value' => 'Terminated', 'description' =>'Terminated normally'),
55 'W' => array('value' => 'Terminated', 'description' =>'Terminated normally with warnings'),
56 'E' => array('value' => 'Error', 'description' =>'Terminated in Error'),
57 'e' => array('value' => 'Non-fatal error', 'description' =>'Non-fatal error'),
58 'f' => array('value' => 'Fatal error', 'description' =>'Fatal error'),
59 'D' => array('value' => 'Verify Diff.', 'description' =>'Verify Differences'),
60 'A' => array('value' => 'Canceled', 'description' =>'Canceled by the user'),
61 'I' => array('value' => 'Incomplete', 'description' =>'Incomplete Job'),
62 'F' => array('value' => 'Waiting on FD', 'description' =>'Waiting on the File daemon'),
63 'S' => array('value' => 'Waiting on SD', 'description' =>'Waiting on the Storage daemon'),
64 'm' => array('value' => 'Waiting for new vol.', 'description' =>'Waiting for a new Volume to be mounted'),
65 'M' => array('value' => 'Waiting for mount', 'description' =>'Waiting for a Mount'),
66 's' => array('value' => 'Waiting for storage', 'description' =>'Waiting for Storage resource'),
67 'j' => array('value' => 'Waiting for job', 'description' =>'Waiting for Job resource'),
68 'c' => array('value' => 'Waiting for client', 'description' =>'Waiting for Client resource'),
69 'd' => array('value' => 'Waiting for Max. jobs', 'description' =>'Wating for Maximum jobs'),
70 't' => array('value' => 'Waiting for start', 'description' =>'Waiting for Start Time'),
71 'p' => array('value' => 'Waiting for higher priority', 'description' =>'Waiting for higher priority job to finish'),
72 'i' => array('value' => 'Batch insert', 'description' =>'Doing batch insert file records'),
73 'a' => array('value' => 'Despooling attributes', 'description' =>'SD despooling attributes'),
74 'l' => array('value' => 'Data despooling', 'description' =>'Doing data despooling'),
75 'L' => array('value' => 'Commiting data', 'description' =>'Committing data (last despool)')
78 private $jobStatesOK = array('T', 'D');
79 private $jobStatesWarning = array('W');
80 private $jobStatesError = array('E', 'e', 'f', 'I');
81 private $jobStatesCancel = array('A');
82 private $jobStatesRunning = array('C', 'R', 'B', 'F', 'S', 'm', 'M', 's', 'j', 'c', 'd','t', 'p', 'i', 'a', 'l', 'L');
84 private $runningJobStates = array('C', 'R');
86 private $components = array(
87 'dir' => array('full_name' => 'Director', 'main_resource' => 'Director'),
88 'sd' => array('full_name' => 'Storage Daemon', 'main_resource' => 'Storage'),
89 'fd' => array('full_name' => 'File Daemon', 'main_resource' => 'FileDaemon'),
90 'bcons' => array('full_name' => 'Console', 'main_resource' => 'Director')
94 * Getting the licence from file.
97 * @return string licence text
99 public function getLicence() {
100 return nl2br(htmlspecialchars(file_get_contents(self::LICENCE_FILE)));
103 public function getJobLevels() {
104 return $this->jobLevels;
107 public function getJobState($jobStateLetter = null) {
109 if(is_null($jobStateLetter)) {
110 $state = $this->jobStates;
112 $state = array_key_exists($jobStateLetter, $this->jobStates) ? $this->jobStates[$jobStateLetter] : null;
117 public function getRunningJobStates() {
118 return $this->runningJobStates;
121 public function getComponents() {
122 $components = array_keys($this->components);
125 public function getMainComponentResource($type) {
127 if (array_key_exists($type, $this->components)) {
128 $resource = $this->components[$type]['main_resource'];
133 public function getComponentFullName($type) {
135 if (array_key_exists($type, $this->components)) {
136 $name = $this->components[$type]['full_name'];
141 public function getJobStatesByType($type) {
142 $statesByType = array();
146 $states = $this->jobStatesOK;
149 $states = $this->jobStatesWarning;
152 $states = $this->jobStatesError;
155 $states = $this->jobStatesCancel;
158 $states = $this->jobStatesRunning;
162 for ($i = 0; $i < count($states); $i++) {
163 $statesByType[$states[$i]] = $this->getJobState($states[$i]);
166 return $statesByType;
169 public function isValidJobLevel($jobLevel) {
170 return array_key_exists($jobLevel, $this->getJobLevels());
173 public function isValidName($name) {
174 return (preg_match('/^[\w:\.\-\s]{1,127}$/', $name) === 1);
178 * Writing INI-style configuration file.
180 * Functions has been got from StackOverflow.com service (http://stackoverflow.com/questions/4082626/save-ini-file-with-comments).
183 * @param string $file file localization
184 * @param array $options structure of config file params
185 * @return mixed if success then returns the number of bytes that were written to the file as the integer type, if failure then returns false
187 public function writeINIFile($file, array $options){
189 foreach($options as $section => $values){
190 $tmp .= "[$section]\n";
191 foreach($values as $key => $val){
193 foreach($val as $k => $v) {
194 $v = $this->escapeINIVal($v);
195 $tmp .= "{$key}[$k] = \"$v\"\n";
198 $val = $this->escapeINIVal($val);
199 $tmp .= "$key = \"$val\"\n";
204 $old_umask = umask(0);
206 $result = file_put_contents($file, $tmp);
212 * Escape text written to INI-style file.
215 * @param string $value text to escape
216 * @return string escaped text
218 private function escapeINIVal($value) {
219 $esc_value = str_replace('"', '\"', $value);
224 * Parse INI-style configuration file.
227 * @param string $file file localization
228 * @return array data of configuration file
230 public static function parseINIFile($file) {
232 if (file_exists($file)) {
233 $content = parse_ini_file($file, true);
234 if (!is_array($content)) {
243 * This method is copied from http://stackoverflow.com/questions/4345554/convert-php-object-to-associative-array
245 public function objectToArray($data) {
246 if (is_array($data) || is_object($data)) {
248 foreach ($data as $key => $value) {
249 $result[$key] = $this->objectToArray($value);
256 public function decode_bacula_lstat($lstat) {
257 $base64 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
258 $lstat = trim($lstat);
259 $lstat_fields = explode(' ', $lstat);
261 if(count($lstat_fields) !== 16) {
262 die('Błąd! Niepoprawna ilość pól wartości LStat. Proszę upewnić się, że podany ciąg znaków jest poprawną wartością LStat');
265 list($dev, $inode, $mode, $nlink, $uid, $gid, $rdev, $size, $blocksize, $blocks, $atime, $mtime, $ctime, $linkfi, $flags, $data) = $lstat_fields;
266 $encoded_values = array('dev' => $dev, 'inode' => $inode, 'mode' => $mode, 'nlink' => $nlink, 'uid' => $uid, 'gid' => $gid, 'rdev' => $rdev, 'size' => $size, 'blocksize' => $blocksize, 'blocks' => $blocks, 'atime' => $atime, 'mtime' => $mtime, 'ctime' => $ctime, 'linkfi' => $linkfi, 'flags' => $flags, 'data' => $data);
269 foreach($encoded_values as $key => $val) {
274 if(substr($val, 0, 1) === '-') {
279 for($i = $start; $i < strlen($val); $i++) {
280 $result = bcmul($result, bcpow(2,6));
281 $result += strpos($base64, substr($val, $i , 1));
283 $ret[$key] = ($is_minus === true) ? -$result : $result;
288 public function parseBvfsList($list) {
290 for($i = 0; $i < count($list); $i++) {
291 if(preg_match('/^(?P<pathid>\d+)\t(?P<filenameid>\d+)\t(?P<fileid>\d+)\t(?P<jobid>\d+)\t(?P<lstat>[a-zA-z0-9\+\/\ ]+)\t(?P<name>.*)\/$/', $list[$i], $match) == 1 || preg_match('/^(?P<pathid>\d+)\t(?P<filenameid>\d+)\t(?P<fileid>\d+)\t(?P<jobid>\d+)\t(?P<lstat>[a-zA-z0-9\+\/\ ]+)\t(?P<name>\.{2})$/', $list[$i], $match) == 1) {
292 if($match['name'] == '.') {
294 } elseif($match['name'] != '..') {
295 $match['name'] .= '/';
297 $elements[] = array('pathid' => $match['pathid'], 'filenameid' => $match['filenameid'], 'fileid' => $match['fileid'], 'jobid' => $match['jobid'], 'lstat' => $match['lstat'], 'name' => $match['name'], 'type' => 'dir');
298 } elseif(preg_match('/^(?P<pathid>\d+)\t(?P<filenameid>\d+)\t(?P<fileid>\d+)\t(?P<jobid>\d+)\t(?P<lstat>[a-zA-z0-9\+\/\ ]+)\t(?P<name>[^\/]+)$/', $list[$i], $match) == 1) {
299 if($match['name'] == '.') {
302 $elements[] = array('pathid' => $match['pathid'], 'filenameid' => $match['filenameid'], 'fileid' => $match['fileid'], 'jobid' => $match['jobid'], 'lstat' => $match['lstat'], 'name' => $match['name'], 'type' => 'file');
305 usort($elements, 'sortFilesListByName');
309 public function parseFileVersions($filename, $list) {
311 for($i = 0; $i < count($list); $i++) {
312 if(preg_match('/^(?P<pathid>\d+)\t(?P<filenameid>\d+)\t(?P<fileid>\d+)\t(?P<jobid>\d+)\t(?P<lstat>[a-zA-Z0-9\+\/\ ]+)\t(?P<md5>.+)\t(?P<volname>.+)\t(?P<inchanger>\d+)$/', $list[$i], $match) == 1) {
313 $elements[$match['fileid']] = array('name' => $filename, 'pathid' => $match['pathid'], 'filenameid' => $match['filenameid'], 'fileid' => $match['fileid'], 'jobid' => $match['jobid'], 'lstat' => $this->decode_bacula_lstat($match['lstat']), 'md5' => $match['md5'], 'volname' => $match['volname'], 'inchanger' => $match['inchanger'], 'type' => 'file');
319 public function findJobIdStartedJob($output) {
321 $output = array_reverse($output); // jobid is ussually at the end of output
322 for ($i = 0; $i < count($output); $i++) {
323 if (preg_match('/^Job queued\.\sJobId=(?P<jobid>\d+)$/', $output[$i], $match) === 1) {
324 $jobid = $match['jobid'];
332 * Get (pseudo)random string.
334 * Useful for log out user from HTTP Basic auth by providing random password.
337 * @return string random 62 characters string from range [a-zA-Z0-9]
339 public function getRandomString($length = null) {
340 $characters = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
341 $rand_string = str_shuffle($characters);
342 if (is_int($length) && $length <= 62) {
343 $rand_string = substr($rand_string, 0, $length);
349 * Get encrypted password to use in HTTP Basic auth.
352 * @param string $password plain text password
353 * @return string encrypted password
355 public function getCryptedPassword($password) {
356 $enc_pwd = crypt($password, base64_encode($password));