https://github.com/byjg/xmlnuke-cmdline
Enables run an existing XMLNuke module from the command line without to make changes in your module.
https://github.com/byjg/xmlnuke-cmdline
Last synced: 8 months ago
JSON representation
Enables run an existing XMLNuke module from the command line without to make changes in your module.
- Host: GitHub
- URL: https://github.com/byjg/xmlnuke-cmdline
- Owner: byjg
- Created: 2015-05-14T19:04:00.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-05-26T17:32:07.000Z (over 10 years ago)
- Last Synced: 2024-10-19T09:17:30.677Z (12 months ago)
- Language: PHP
- Size: 156 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# XMLNuke Command Line Project
Enables run an existing XMLNuke module from the command line without
to make changes in your module.
## Install
Project Level
```bash
composer require "byjg/xmlnuke-cmdline=dev-master"
```
Entire System
```bash
composer global require "byjg/xmlnuke-cmdline=dev-master"
```
## Usage
The syntax is:
```bash
runxmlnuke.php SCRIPT PARAMETERS
```
for example:
```
runxmlnuke.php xmlnuke module=Lesson1.Sample1 raw=json xpath=//mediaitem
```
The parameter SCRIPT can be:
* **xmlnuke** - Run a typical XMLNuke module with all parameters
* **ws** - Run a class that implements a SOAP interface. See more [here](/byjg/xmlnuke/wiki/Create-a-SOAP-Service).
* **daemon** - Create a Linux Daemon Service. More details below.
## Running a SOAP Service
The SOAP service in command line only work invoking the web method through a GET request. The command line will be something like:
```
runxmlnuke.php ws ws=/Lesson1.SOAP.SampleWebService svc=getEcho "text=Some Text"
```
## Create Daemon/Services with XMLNuke
A Service is a program that runs infinitely.
You can create a service in XMLNuke by implementing a class with a method `execute()`.
This method, does not need to create a Loop. XMLNuke will do a loop for you.
Example:
```php
namespace Lesson1\Classes;
class Service
{
protected $loop = 0;
public function execute()
{
$this->loop++;
echo $this->loop ."\n";
return true;
}
}
```
This method must return `true` to continue the service or `false` to stop it. To run this daemon:
```
sudo runxmlnuke.php daemon service=Lesson1.Classes.Service &
```
The service will run silently, but will create TWO log files:
* **/var/log/xmlnuke.daemon/Lesson1.Classes.Service.log** - All output from the service
* **/var/log/xmlnuke.daemon/Lesson1.Classes.Service.error.log** - All errors generated by the service.
### Create a init service
You can create a service in the Linux system just copying this file inside the folder `/etc/init`
Example: **sample.conf**
```
description "Sample Daemon"
author "JG"
# used to be: start on startup
# until we found some mounts weren't ready yet while booting:
start on started mountall
stop on shutdown
# Automatically Respawn:
respawn
respawn limit 99 5
exec /opt/xmlnuke/utils/cmdline/runxmlnuke.sh daemon service=Lesson1.Classes.Service
```
Now you can start or stop the service using:
```
service sample start
```
or
```
service sample stop
```
# Putting all together
* **Service**: https://github.com/byjg/xmlnuke-lesson1/blob/master/lib/Lesson1/Classes/Service.class.php
* **Init Conf**: https://github.com/byjg/xmlnuke-lesson1/blob/master/conf/sample.conf