Compare commits

...
3 Commits
Author SHA1 Message Date
itismadness bd168e98b1 Bump to 0.8.1 2018-11-29 22:33:32 -05:00
itismadness ec4d49f690 Use command -v for checking for programs 2018-11-29 22:32:33 -05:00
itismadness 5a6a22cfbe Update readme 2018-11-29 21:30:21 -05:00
4 changed files with 64 additions and 28 deletions

No files matched your search

+57 -24
View File
@@ -15,39 +15,32 @@ setting up the necessary programs to validate the checksum, see below for the gi
## Requirements
* PHP 7.0+
* Python3.4+
## Optional Requirements
* Python 3.5+
* [chardet](https://github.com/chardet/chardet)
* [eac_logchecker.py](https://github.com/OPSnet/eac_logchecker.py)
* [xld_logchecker.py](https://github.com/OPSnet/xld_logchecker.py)
## Installation
```
$ composer require orpheusnet/logchecker
$ pip3 install chardet eac-logchecker xld-logchecker
```
## Usage
### CLI
## Standalone
### Installation
Go to our [releases](https://github.com/OPSnet/Logchecker/releases) and grab the logchecker.phar
file. Download this file, and then it can executed via CLI by running `php logchecker.phar`.
Alternatively, if you `chmod +x logchecker.phar`, it can be executed directly by doing `./logchecker.phar`.
To install it globally, run:
```
mv logchecker.phar /usr/local/bin/logchecker
chmod +x /usr/local/bin/logchecker
```
$ logchecker list
Logchecker by Orpheus 0.5.0
Usage:
command [options] [arguments]
Options:
-h, --help Display this help message
-V, --version Display this application version
Available commands:
analyze analyze log file
help Displays help for a command
list Lists commands
$ logchecker analyze --help
Description:
analyze log file
### Usage
```
$ logchecker --help
Usage:
analyze [options] [--] <file>
@@ -57,11 +50,18 @@ Arguments:
Options:
--output Print the HTML log text
-h, --help Display this help message
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
-file, --out=OUT File to write HTML log text to
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
Help:
This command analyzes a log file
$ logchecker analyze tests/logs/wgdbcm.log
$ logchecker tests/logs/wgdbcm.log
Score : 57
Checksum: false
Details :
@@ -82,3 +82,36 @@ $logchecker = new OrpheusNET\Logchecker\Logchecker();
$logchecker->add_file('path/to/file.log');
list($score, $details, $checksum, $log_text) = $logchecker->parse();
```
## Library Usage
### Installation
```
$ composer require orpheusnet/logchecker
```
### Usage
```
use OrpheusNET\Logchecker\Logchecker();
$logchecker = new Logchecker();
$logchecker->new_file('/path/to/log/file');
list($score, $details, $checksum, $log_text) = $logchecker->parse();
print('Score: ' . $score . "\n");
print('Checksum: ' . ($checksum ? 'true' : 'false') . "\n");
print("\nDetails:\n");
foreach ($details as $detail) {
print(" {$detail}\n");
}
print("\nLog Text:\n{$log_text}");
```
## Building
To build your own phar, you can checkout this repository, and then
run the `bin/compile` script. To do this, run the following commands:
```
git clone https://github.com/OPSnet/Logchecker
cd Logchecker
composer install
php -d phar.readonly=0 /bin/compile
```
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "orpheusnet/logchecker",
"description": "Logchecker for validating logs generated from supported ripping programs (like EAC and XLD)",
"version": "0.8.0",
"version": "0.8.1",
"license": "Unlicense",
"type": "library",
"authors": [
+2 -1
View File
@@ -15,11 +15,12 @@ class Chardet {
foreach ($this->executables as $executable) {
if (Util::commandExists($executable)) {
$this->executable = $executable;
break;
}
}
if ($this->executable === null) {
throw new \RuntimeException('Chardet not installed');
throw new \RuntimeException('chardet not installed');
}
}
+4 -2
View File
@@ -4,8 +4,10 @@ namespace OrpheusNET\Logchecker;
class Util {
public static function commandExists($cmd) {
$return = shell_exec(sprintf("which %s", escapeshellarg($cmd)));
return !empty($return);
$where = substr(strtolower(PHP_OS), 0, 3) === 'win' ? 'where' : 'command -v';
exec("{$where} {$cmd} 2>/dev/null", $output, $return_var);
return $return_var === 0;
}
public static function strposArray(string $haystack, array $needles) {