├── laravel5
├── GearmanFacade.php
├── config
│ └── gearman.php
├── Console
│ └── SupervisorCommand.php
└── GearmanServiceProvider.php
├── yii1
├── SupervisorCommand.php
└── GearmanComponent.php
├── yii2
├── SupervisorController.php
└── Component.php
├── composer.json
├── README.md
├── SupervisorConfig.php
├── GearmanQueue.php
└── LICENSE
/laravel5/GearmanFacade.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\gearman\laravel5;
10 |
11 | use Illuminate\Support\Facades\Facade;
12 |
13 | /**
14 | * Gearman facade
15 | */
16 | class GearmanFacade extends Facade
17 | {
18 | /**
19 | * Get the registered name of the component.
20 | *
21 | * @return string
22 | */
23 | protected static function getFacadeAccessor()
24 | {
25 | return 'gearman';
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/yii1/SupervisorCommand.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\gearman\yii1;
10 |
11 | /**
12 | * Supervisor config action
13 | */
14 | class SupervisorCommand extends \CConsoleCommand
15 | {
16 | public $gearmanComponentName = 'gearman';
17 |
18 | /**
19 | * Request user supervisor config set
20 | */
21 | public function actionIndex()
22 | {
23 | /** @var \demi\gearman\yii1\GearmanComponent $component */
24 | $component = \Yii::app()->getComponent($this->gearmanComponentName);
25 |
26 | $component->configureSupervisor();
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/yii2/SupervisorController.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\gearman\yii2;
10 |
11 | use yii\console\Controller;
12 |
13 | /**
14 | * Supervisor config action
15 | */
16 | class SupervisorController extends Controller
17 | {
18 | public $gearmanComponentName = 'gearman';
19 |
20 | /**
21 | * Request user supervisor config set
22 | *
23 | * @throws \yii\base\InvalidConfigException
24 | */
25 | public function actionIndex()
26 | {
27 | /** @var \demi\gearman\yii2\Component $component */
28 | $component = \Yii::$app->get($this->gearmanComponentName);
29 |
30 | $component->configureSupervisor();
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/laravel5/config/gearman.php:
--------------------------------------------------------------------------------
1 | '127.0.0.1',
5 | 'port' => 4730,
6 | 'supervisorConfig' => [
7 | 'configFile' => '/etc/supervisor/conf.d/workers.conf',
8 | 'workersDirectory' => realpath(__DIR__ . '/../'),
9 | 'restartSleepingTime' => 5,
10 | 'all' => [
11 | 'crop_image' => ['numprocs' => 0, 'command' => '/usr/bin/php artisan worker:crop-image'],
12 | 'bad_worker' => ['numprocs' => 0, 'command' => '/usr/bin/php artisan worker:bad-worker'],
13 | ],
14 | 'sets' => [
15 | 'general' => [
16 | 'crop_image' => 5,
17 | ],
18 | 'minimal' => [
19 | 'crop_image' => 50,
20 | 'bad_worker' => 50,
21 | ],
22 | 'maximal' => [
23 | 'crop_image' => 100,
24 | 'bad_worker' => 100,
25 | ],
26 | ],
27 | ],
28 | ];
29 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "demi/php-gearman",
3 | "description": "Gearman job server workers helper",
4 | "keywords": ["php", "gearman", "job", "server", "workers", "supervisor", "Yii1", "Yii2", "Laravel"],
5 | "homepage": "https://github.com/demisang/php-gearman#readme",
6 | "type": "library",
7 | "license": "GPL-3.0-or-later",
8 | "authors": [
9 | {
10 | "name": "Ivan Orlov",
11 | "email": "gnasimed@gmail.com",
12 | "homepage": "https://orlov.io/",
13 | "role": "Creator"
14 | }
15 | ],
16 | "support": {
17 | "issues": "https://github.com/demisang/php-gearman/issues",
18 | "source": "https://github.com/demisang/php-gearman"
19 | },
20 | "require": {
21 | "php": ">=5.3.0"
22 | },
23 | "autoload": {
24 | "psr-4": {
25 | "demi\\gearman\\": ""
26 | }
27 | },
28 | "suggest": {
29 | "ext-gearman": "PHP Gearman extension for running workers"
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/laravel5/Console/SupervisorCommand.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\gearman\laravel5\Console;
10 |
11 | use demi\gearman\SupervisorConfig;
12 |
13 | /**
14 | * Supervisor config command
15 | */
16 | class SupervisorCommand extends \Illuminate\Console\Command
17 | {
18 | /**
19 | * The console command name.
20 | *
21 | * @var string
22 | */
23 | protected $name = 'gearman';
24 |
25 | /**
26 | * The console command description.
27 | *
28 | * @var string
29 | */
30 | protected $description = 'Run supervisor configurator';
31 |
32 | /**
33 | * Execute the console command.
34 | * Request user supervisor config set.
35 | */
36 | public function fire()
37 | {
38 | $config = config('gearman.supervisorConfig');
39 | $supervisor = new SupervisorConfig($config['configFile'], $config['workersDirectory']);
40 | $supervisor->restartSleepingTime = $config['restartSleepingTime'];
41 | $supervisor->workersConfig = $config['all'];
42 | $supervisor->workersSets = $config['sets'];
43 |
44 | $supervisor->requestUpdate();
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/laravel5/GearmanServiceProvider.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\gearman\laravel5;
10 |
11 | /**
12 | * Gearman aueue service provider
13 | */
14 | class GearmanServiceProvider extends \Illuminate\Support\ServiceProvider
15 | {
16 | /**
17 | * Indicates if loading of the provider is deferred.
18 | *
19 | * @var bool
20 | */
21 | protected $defer = false;
22 |
23 | /**
24 | * @inheritdoc
25 | */
26 | public function register()
27 | {
28 | $this->app->singleton('gearman', function ($app) {
29 | $component = new \demi\gearman\GearmanQueue(
30 | config('gearman.host', '127.0.0.1'),
31 | config('gearman.port', 4730),
32 | config('gearman.servers', [])
33 | );
34 | $component->beforeJobCallback = config('gearman.beforeJobCallback');
35 | $component->afterJobCallback = config('gearman.afterJobCallback');
36 |
37 | return $component;
38 | });
39 |
40 | $this->app['command.gearman'] = $this->app->share(
41 | function ($app) {
42 | return new \demi\gearman\laravel5\Console\SupervisorCommand();
43 | }
44 | );
45 | $this->commands('command.gearman');
46 | }
47 |
48 | public function boot()
49 | {
50 | $this->publishes(array(
51 | __DIR__ . '/config/gearman.php' => config_path('gearman.php'),
52 | ), 'config');
53 | }
54 |
55 | /**
56 | * Get the services provided by the provider.
57 | *
58 | * @return array
59 | */
60 | public function provides()
61 | {
62 | return array('gearman', 'command.gearman');
63 | }
64 | }
65 |
--------------------------------------------------------------------------------
/yii2/Component.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\gearman\yii2;
10 |
11 | use demi\gearman\GearmanQueue;
12 | use demi\gearman\SupervisorConfig;
13 |
14 | /**
15 | * Queue base class
16 | *
17 | * @property GearmanQueue $queue
18 | *
19 | * Magic methods
20 | * @mixin \demi\gearman\GearmanQueue
21 | */
22 | class Component extends \yii\base\Component
23 | {
24 | /**
25 | * Gearman server host
26 | *
27 | * @var string
28 | */
29 | public $host = '127.0.0.1';
30 | /**
31 | * Gearman server port
32 | *
33 | * @var int
34 | */
35 | public $port = 4730;
36 | /**
37 | * Addtitional gearman servers
38 | *
39 | * @var array array('123.134.156.245:4730', '178.214.52.184:4730'), ...
40 | */
41 | public $servers = [];
42 | /**
43 | * Callacble function, running on before worker job handler call
44 | * function ($jobName, \GearmanJob $job) {
45 | * $workload = $job->workload();
46 | * var_dump($jobName); // worker name, eg.: "crop_image"
47 | * var_dump($workload); // job workload string, eg.: '{"post_id":7388,"foo":"bar"}' @see deserializeWorkload()
48 | * }
49 | *
50 | * @var callable
51 | */
52 | public $beforeJobCallback;
53 | /**
54 | * Callacble function, running on after worker job handler called
55 | * function ($jobName, \GearmanJob $job, $result) {
56 | * $workload = $job->workload();
57 | * var_dump($jobName); // worker name, eg.: "crop_image"
58 | * var_dump($workload); // job workload string, eg.: '{"post_id":7388,"foo":"bar"}' @see deserializeWorkload()
59 | * var_dump($result); // job handler return value
60 | * }
61 | *
62 | * @var callable
63 | */
64 | public $afterJobCallback;
65 | /**
66 | * Supervisor config:
67 | *
68 | * [
69 | * 'configFile' => '/etc/supervisor/conf.d/workers.conf',
70 | * 'workersDirectory' => '/var/www/site',
71 | * 'restartSleepingTime' => 5,
72 | * 'all' => [
73 | * 'crop_image' => ['numprocs' => 0, 'command' => '/usr/bin/php yii workers/crop-image'],
74 | * 'bad_worker' => ['numprocs' => 0, 'command' => '/usr/bin/php yii workers/bad-worker'],
75 | * ],
76 | * 'sets' => [
77 | * 'general' => [
78 | * 'crop_image' => 5,
79 | * ],
80 | * 'minimal' => [
81 | * 'crop_image' => 50,
82 | * 'bad_worker' => 50,
83 | * ],
84 | * 'maximal' => [
85 | * 'crop_image' => 100,
86 | * 'bad_worker' => 100,
87 | * ],
88 | * ],
89 | * ]
90 | *
91 | * @var array
92 | */
93 | public $supervisorConfig = [];
94 |
95 | /**
96 | * Gearman queue component instance
97 | *
98 | * @var GearmanQueue
99 | */
100 | protected $_queue;
101 |
102 | /**
103 | * @inheritdoc
104 | */
105 | public function init()
106 | {
107 | // Initialize queue component
108 | $queue = new GearmanQueue($this->host, $this->port, $this->servers);
109 | $queue->beforeJobCallback = $this->beforeJobCallback;
110 | $queue->afterJobCallback = $this->afterJobCallback;
111 |
112 | $this->_queue = $queue;
113 |
114 | parent::init();
115 | }
116 |
117 | /**
118 | * @inheritdoc
119 | */
120 | public function __call($name, $params)
121 | {
122 | if (method_exists($this->queue, $name)) {
123 | return call_user_func_array([$this->queue, $name], $params);
124 | }
125 |
126 | return parent::__call($name, $params);
127 | }
128 |
129 | /**
130 | * Get queue component instance
131 | *
132 | * @return GearmanQueue
133 | */
134 | public function getQueue()
135 | {
136 | return $this->_queue;
137 | }
138 |
139 | /**
140 | * Set queue component instance
141 | *
142 | * @param GearmanQueue $queue
143 | */
144 | public function setQueue(GearmanQueue $queue)
145 | {
146 | $this->_queue = $queue;
147 | }
148 |
149 | /**
150 | * Run supervisor configurator
151 | */
152 | public function configureSupervisor()
153 | {
154 | $config = $this->supervisorConfig;
155 | $supervisor = new SupervisorConfig($config['configFile'], $config['workersDirectory']);
156 | $supervisor->restartSleepingTime = $config['restartSleepingTime'];
157 | $supervisor->workersConfig = $config['all'];
158 | $supervisor->workersSets = $config['sets'];
159 |
160 | $supervisor->requestUpdate();
161 | }
162 | }
163 |
--------------------------------------------------------------------------------
/yii1/GearmanComponent.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\gearman\yii1;
10 |
11 | use demi\gearman\GearmanQueue;
12 | use demi\gearman\SupervisorConfig;
13 |
14 | /**
15 | * Queue base class
16 | *
17 | * @property GearmanQueue $queue
18 | *
19 | * Magic methods
20 | * @mixin \demi\gearman\GearmanQueue
21 | */
22 | class GearmanComponent extends \CApplicationComponent
23 | {
24 | /**
25 | * Gearman server host
26 | *
27 | * @var string
28 | */
29 | public $host = '127.0.0.1';
30 | /**
31 | * Gearman server port
32 | *
33 | * @var int
34 | */
35 | public $port = 4730;
36 | /**
37 | * Addtitional gearman servers
38 | *
39 | * @var array array('123.134.156.245:4730', '178.214.52.184:4730'), ...
40 | */
41 | public $servers = array();
42 | /**
43 | * Callacble function, running on before worker job handler call
44 | * function ($jobName, \GearmanJob $job) {
45 | * $workload = $job->workload();
46 | * var_dump($jobName); // worker name, eg.: "crop_image"
47 | * var_dump($workload); // job workload string, eg.: '{"post_id":7388,"foo":"bar"}' @see deserializeWorkload()
48 | * }
49 | *
50 | * @var callable
51 | */
52 | public $beforeJobCallback;
53 | /**
54 | * Callacble function, running on after worker job handler called
55 | * function ($jobName, \GearmanJob $job, $result) {
56 | * $workload = $job->workload();
57 | * var_dump($jobName); // worker name, eg.: "crop_image"
58 | * var_dump($workload); // job workload string, eg.: '{"post_id":7388,"foo":"bar"}' @see deserializeWorkload()
59 | * var_dump($result); // job handler return value
60 | * }
61 | *
62 | * @var callable
63 | */
64 | public $afterJobCallback;
65 | /**
66 | * Supervisor config:
67 | *
68 | * [
69 | * 'configFile' => '/etc/supervisor/conf.d/workers.conf',
70 | * 'workersDirectory' => '/var/www/site',
71 | * 'restartSleepingTime' => 5,
72 | * 'all' => [
73 | * 'crop_image' => ['numprocs' => 0, 'command' => '/usr/bin/php yii workers/crop-image'],
74 | * 'bad_worker' => ['numprocs' => 0, 'command' => '/usr/bin/php yii workers/bad-worker'],
75 | * ],
76 | * 'sets' => [
77 | * 'general' => [
78 | * 'crop_image' => 5,
79 | * ],
80 | * 'minimal' => [
81 | * 'crop_image' => 50,
82 | * 'bad_worker' => 50,
83 | * ],
84 | * 'maximal' => [
85 | * 'crop_image' => 100,
86 | * 'bad_worker' => 100,
87 | * ],
88 | * ],
89 | * ]
90 | *
91 | * @var array
92 | */
93 | public $supervisorConfig = array();
94 |
95 | /**
96 | * Gearman queue component instance
97 | *
98 | * @var GearmanQueue
99 | */
100 | protected $_queue;
101 |
102 | /**
103 | * @inheritdoc
104 | */
105 | public function init()
106 | {
107 | parent::init();
108 |
109 | // Initialize queue component
110 | $queue = new GearmanQueue($this->host, $this->port, $this->servers);
111 | $queue->beforeJobCallback = $this->beforeJobCallback;
112 | $queue->afterJobCallback = $this->afterJobCallback;
113 |
114 | $this->_queue = $queue;
115 | }
116 |
117 | /**
118 | * @inheritdoc
119 | */
120 | public function __call($name, $params)
121 | {
122 | if (method_exists($this->queue, $name)) {
123 | return call_user_func_array(array($this->queue, $name), $params);
124 | }
125 |
126 | return parent::__call($name, $params);
127 | }
128 |
129 | /**
130 | * Get queue component instance
131 | *
132 | * @return GearmanQueue
133 | */
134 | public function getQueue()
135 | {
136 | return $this->_queue;
137 | }
138 |
139 | /**
140 | * Set queue component instance
141 | *
142 | * @param GearmanQueue $queue
143 | */
144 | public function setQueue(GearmanQueue $queue)
145 | {
146 | $this->_queue = $queue;
147 | }
148 |
149 | /**
150 | * Run supervisor configurator
151 | */
152 | public function configureSupervisor()
153 | {
154 | $config = $this->supervisorConfig;
155 | $supervisor = new SupervisorConfig($config['configFile'], $config['workersDirectory']);
156 | $supervisor->restartSleepingTime = $config['restartSleepingTime'];
157 | $supervisor->workersConfig = $config['all'];
158 | $supervisor->workersSets = $config['sets'];
159 |
160 | $supervisor->requestUpdate();
161 | }
162 | }
163 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | php-gearman-job-server
2 | ===================
3 |
4 | Gearman job server workers helper
5 |
6 | Installation
7 | ------------
8 | * Run:
9 | ```code
10 | composer require "demi/php-gearman" "~1.0"
11 | ```
12 | * Install gearman job server as PHP-extension: http://gearman.org/getting-started/#gearman_php_extension
13 | * Install supervisor:
14 | ```bash
15 | apt-get install supervisor
16 | ```
17 | * (optional) Install Gearman GUI: http://gaspaio.github.io/gearmanui
18 |
19 |
20 | Configuration
21 | -------------
22 | ### Yii1/Yii2:
23 | supervisor.php at you common config dir:
24 | ```php
25 | return [
26 | 'configFile' => '/etc/supervisor/conf.d/workers.conf',
27 | 'workersDirectory' => realpath(__DIR__ . '/../../'),
28 | 'restartSleepingTime' => 5,
29 | 'all' => [
30 | 'crop_image' => ['numprocs' => 0, 'command' => '/usr/bin/php yii workers/crop-image'],
31 | 'bad_worker' => ['numprocs' => 0, 'command' => '/usr/bin/php yii workers/bad-worker'],
32 | ],
33 | 'sets' => [
34 | 'general' => [
35 | 'crop_image' => 5,
36 | ],
37 | 'minimal' => [
38 | 'crop_image' => 50,
39 | 'bad_worker' => 50,
40 | ],
41 | 'maximal' => [
42 | 'crop_image' => 100,
43 | 'bad_worker' => 100,
44 | ],
45 | ],
46 | ];
47 | ```
48 |
49 | ## Gearman component configuration
50 |
51 | ### Yii2
52 | /common/config/main.php:
53 | ```php
54 | 'components' => [
55 | 'gearman' => [
56 | 'class' => '\demi\gearman\yii2\Component',
57 | 'host' => '127.0.0.1',
58 | 'port' => 4730,
59 | 'supervisorConfig' => require(__DIR__ . '/supervisor.php'),
60 | ],
61 | ],
62 | ```
63 | /console/config/main.php:
64 | ```php
65 | return [
66 | 'controllerMap' => [
67 | 'gearman' => [
68 | 'class' => '\demi\gearman\yii2\SupervisorController',
69 | 'gearmanComponentName' => 'gearman', // name of component: Yii::$app->gearman (from previous config listing)
70 | ],
71 | ],
72 | ],
73 | ```
74 |
75 |
76 | ### Yii1
77 | /protected/config/main.php:
78 | ```php
79 | 'components' => [
80 | 'gearman' => [
81 | 'class' => '\demi\gearman\yii1\GearmanComponent',
82 | 'host' => '127.0.0.1',
83 | 'port' => 4730,
84 | 'supervisorConfig' => require(__DIR__ . '/supervisor.php'),
85 | ],
86 | ],
87 | ```
88 | /protected/config/console.php:
89 | ```php
90 | $mainConfig = require(dirname(__FILE__) . '/main.php');
91 | return [
92 | 'commandMap' => [
93 | 'gearman' => [
94 | 'class' => '\demi\gearman\yii1\SupervisorCommand',
95 | 'gearmanComponentName' => 'gearman', // name of component: Yii::app()->gearman (from previous config listing)
96 | ],
97 | ],
98 | 'components' => [
99 | 'gearman' => $mainConfig['components']['gearman'],
100 | ],
101 | ],
102 | ```
103 |
104 | ### Laravel:
105 | Add service provider to /config/app.php:
106 | ```php
107 | 'providers' => [
108 | // Gearman helper
109 | demi\gearman\laravel5\GearmanServiceProvider::class
110 | ],
111 | 'aliases' => [
112 | // Gearman helper
113 | 'Gearman' => demi\gearman\laravel5\GearmanFacade::class,
114 | ],
115 | ```
116 |
117 | Publish /config/gearman.php
118 | ```bash
119 | php artisan vendor:publish --provider="demi\gearman\laravel5\GearmanServiceProvider" --tag=config
120 | ```
121 |
122 |
123 | Usage
124 | -----
125 | ### Running workers:
126 | Gearman workers - it is simple looped console commands
127 |
128 | ##### Yii2:
129 | Create new console controller
130 | /console/controllers/WorkersController.php:
131 | ```php
132 | gearman->runWorker('crop_image', function (GearmanJob $job) {
150 | $workload = Yii::$app->gearman->deserializeWorkload($job->workload());
151 | $imagePath = $workload['image_path'];
152 | if (empty($imagePath)) {
153 | return Yii::$app->gearman->serializeWorkload(['status' => 'error', 'message' => 'No image']);
154 | }
155 |
156 | // Do some job...
157 |
158 | return Yii::$app->gearman->serializeWorkload(['status' => 'success', 'foo' => 'bar']);
159 | });
160 | }
161 | }
162 | ````
163 |
164 | ##### Yii1:
165 | Create new console command
166 | /protected/commands/WorkersCommand.php:
167 | ```php
168 | gearman->runWorker('crop_image', function (GearmanJob $job) {
181 | $workload = Yii::app()->gearman->deserializeWorkload($job->workload());
182 | $imagePath = $workload['image_path'];
183 | if (empty($imagePath)) {
184 | return Yii::app()->gearman->serializeWorkload(['status' => 'error', 'message' => 'No image']);
185 | }
186 |
187 | // Do some job...
188 |
189 | return Yii::app()->gearman->serializeWorkload(['status' => 'success', 'foo' => 'bar']);
190 | });
191 | }
192 | }
193 | ````
194 |
195 | ##### Laravel:
196 | Create new console command
197 | /app/Console/Commands/CropImage.php:
198 | ```php
199 | workload());
231 | $imagePath = $workload['image_path'];
232 | if (empty($imagePath)) {
233 | return Gearman::serializeWorkload(['status' => 'error', 'message' => 'No image']);
234 | }
235 |
236 | // Do some job...
237 |
238 | return Gearman::serializeWorkload(['status' => 'success', 'foo' => 'bar']);
239 | });
240 | }
241 | }
242 | ````
243 | Update /app/Console/Kernel.php:
244 | Add to `protected $commands`:
245 | ```php
246 | protected $commands = [
247 | // ...
248 | \App\Console\Commands\CropImage::class,
249 | ]
250 | ```
251 |
252 |
253 | ### Change supervisor config set and restart supervisor:
254 | Yii2:
255 | ```bash
256 | php yii gearman
257 | ````
258 |
259 | Yii1:
260 | ```bash
261 | php yiic gearman
262 | ````
263 |
264 | Laravel:
265 | ```bash
266 | php artisan gearman
267 | ````
268 |
269 |
270 | Examples
271 | --------
272 | ##### Yii2:
273 | At any place:
274 | ```php
275 | // synchronous
276 | $result = Yii::$app->gearman->doNormal('crop_image', ['image_path' => '/var/www/image.jpg']);
277 | var_dump(Yii::$app->gearman->deserializeWorkload($result)); // ['status' => 'success', 'foo' => 'bar']
278 | $result = Yii::$app->gearman->doNormal('crop_image');
279 | var_dump(Yii::$app->gearman->deserializeWorkload($result)); // ['status' => 'error', 'message' => 'No image']
280 |
281 | // asynchronous
282 | $result = Yii::$app->gearman->doBackground('crop_image', ['image_path' => '/var/www/image.jpg']);
283 | var_dump($result); // job handle file descriptior
284 | $result = Yii::$app->gearman->doBackground('crop_image');
285 | var_dump($result); // job handle file descriptior
286 |
287 | // Variants:
288 | // doLow(), doNormal(), doHigh(),
289 | // doLowBackground(), doBackground(), doHighBackground(),
290 | ```
291 |
292 | ##### Yii1:
293 | At any place:
294 | ```php
295 | // synchronous
296 | $result = Yii::app()->gearman->doNormal('crop_image', ['image_path' => '/var/www/image.jpg']);
297 | var_dump(Yii::app()->gearman->deserializeWorkload($result)); // ['status' => 'success', 'foo' => 'bar']
298 | $result = Yii::app()->gearman->doNormal('crop_image');
299 | var_dump(Yii::app()->gearman->deserializeWorkload($result)); // ['status' => 'error', 'message' => 'No image']
300 |
301 | // asynchronous
302 | $result = Yii::app()->gearman->doBackground('crop_image', ['image_path' => '/var/www/image.jpg']);
303 | var_dump($result); // job handle file descriptior
304 | $result = Yii::app()->gearman->doBackground('crop_image');
305 | var_dump($result); // job handle file descriptior
306 |
307 | // Variants:
308 | // doLow(), doNormal(), doHigh(),
309 | // doLowBackground(), doBackground(), doHighBackground(),
310 | ```
311 |
312 | ##### Laravel:
313 | At any place:
314 | ```php
315 | use Gearman;
316 |
317 | // synchronous
318 | $result = Gearman::doNormal('crop_image', ['image_path' => '/var/www/image.jpg']);
319 | var_dump(Gearman::deserializeWorkload($result)); // ['status' => 'success', 'foo' => 'bar']
320 | $result = Gearman::doNormal('crop_image');
321 | var_dump(Gearman::deserializeWorkload($result)); // ['status' => 'error', 'message' => 'No image']
322 |
323 | // asynchronous
324 | $result = Gearman::doBackground('crop_image', ['image_path' => '/var/www/image.jpg']);
325 | var_dump($result); // job handle file descriptior
326 | $result = Gearman::doBackground('crop_image');
327 | var_dump($result); // job handle file descriptior
328 |
329 | // Variants:
330 | // doLow(), doNormal(), doHigh(),
331 | // doLowBackground(), doBackground(), doHighBackground(),
--------------------------------------------------------------------------------
/SupervisorConfig.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\gearman;
10 |
11 | /**
12 | * Supervisor config tool
13 | */
14 | class SupervisorConfig
15 | {
16 | /**
17 | * Path to the supervisor config file.
18 | * "/etc/supervisor/conf.d/workers.conf"
19 | *
20 | * @var string
21 | */
22 | public $configFile;
23 | /**
24 | * Default supervisor worker config
25 | *
26 | * @var array
27 | */
28 | public $defaultWorkerConfig;
29 | /**
30 | * All workers config:
31 | *
32 | * [
33 | * 'crop_image' => ['numprocs' => 0, 'command' => '/usr/bin/php yii workers/crop-image'],
34 | * 'bad_worker' => ['numprocs' => 0, 'command' => '/usr/bin/php yii workers/bad-worker'],
35 | * ...
36 | * ]
37 | *
38 | * @var array
39 | */
40 | public $workersConfig = array();
41 | /**
42 | * Workers sets list:
43 | *
44 | * [
45 | * 'general' => [
46 | * 'crop_image' => 5,
47 | * ],
48 | * 'minimal' => [
49 | * 'crop_image' => 50,
50 | * 'bad_worker' => 50,
51 | * ],
52 | * 'maximal' => [
53 | * 'crop_image' => 100,
54 | * 'bad_worker' => 100,
55 | * ],
56 | * ]
57 | *
58 | * @var array
59 | */
60 | public $workersSets = array();
61 | /**
62 | * Number of seconds before supervisor will started again after config updating.
63 | * (Some times very big workers number require more time for restart)
64 | *
65 | * @var int
66 | */
67 | public $restartSleepingTime = 5;
68 |
69 | // Console output colors
70 | const FG_RED = 31;
71 | const FG_GREEN = 32;
72 |
73 | /**
74 | * SupervisorConfig constructor.
75 | *
76 | * @param string $configFile Path to the supervisor config file. ("/etc/supervisor/conf.d/workers.conf")
77 | * @param string $workersDirectory Directory where placed workers
78 | */
79 | public function __construct($configFile, $workersDirectory)
80 | {
81 | $this->configFile = $configFile;
82 |
83 | $this->defaultWorkerConfig = array(
84 | 'command' => '',
85 | 'process_name' => '%(program_name)s_%(process_num)02d',
86 | 'numprocs' => 0,
87 | 'directory' => $workersDirectory, // "/var/www/site"
88 | 'stdout_logfile' => '/var/www/logs/workers/%(program_name)s.log',
89 | 'stderr_logfile' => '/var/www/logs/workers/%(program_name)s.error.log',
90 | 'autostart' => 'true',
91 | 'autorestart' => 'true',
92 | 'user' => 'www-data',
93 | 'stopsignal' => 'KILL',
94 | );
95 | }
96 |
97 | /**
98 | * Give user opportunity to choise workers set
99 | */
100 | public function requestUpdate()
101 | {
102 | // Workers list with basic config set
103 | $workers = $this->workersConfig;
104 |
105 | // Workers sets
106 | $sets = $this->workersSets;
107 |
108 | // Show info about available sets
109 | static::stdout("\nWorkers sets:\n");
110 |
111 | $i = 0;
112 | $setNumKeys = array();
113 | foreach ($sets as $name => $config) {
114 | $i++;
115 | $setNumKeys[$i] = $name;
116 | static::stdout($i . '. ' . $name . "\n");
117 | }
118 |
119 | // Get number of selected set
120 | $setNum = $this->prompt("\nChoise worker set:", array('required' => true));
121 | if (!isset($setNumKeys[$setNum])) {
122 | static::stdout("Set '$setNum' not exists\n", static::FG_RED);
123 |
124 | return;
125 | }
126 |
127 | // Merge default config with selected config set
128 | foreach ($sets[$setNumKeys[$setNum]] as $workerId => $numprocs) {
129 | $workers[$workerId]['numprocs'] = $numprocs;
130 | }
131 |
132 | static::stdout("\nActive workers:\n");
133 | // Generate config file lines
134 | $lines = array();
135 | foreach ($workers as $workerId => $config) {
136 | // Merge default config with custom worker config
137 | $resultConfig = array_merge($this->defaultWorkerConfig, $config);
138 |
139 | // Not need add workers without processes
140 | if ($resultConfig['numprocs'] <= 0) {
141 | continue;
142 | }
143 |
144 | $lines[] = "[program:$workerId]";
145 |
146 | foreach ($resultConfig as $k => $v) {
147 | $lines[] = "$k=$v";
148 | }
149 | $lines[] = ''; // empty line separator
150 |
151 | // Show info about active workers
152 | if ($resultConfig['numprocs'] > 0) {
153 | static::stdout("$workerId: " . $resultConfig['numprocs'] . "\n", static::FG_GREEN);
154 | }
155 | }
156 |
157 | // Rewrite config file
158 | $f = @fopen($this->configFile, 'w');
159 | if (!$f) {
160 | static::stdout("Cannot open config file '$this->configFile' for write\n", static::FG_RED);
161 |
162 | return;
163 | }
164 |
165 | // Write new config lines
166 | foreach ($lines as $line) {
167 | fwrite($f, $line . PHP_EOL);
168 | }
169 | fclose($f);
170 | static::stdout("\nConfig file saved\n", static::FG_GREEN);
171 |
172 | // Stop supervisor service
173 | $shellResult = trim(shell_exec('service supervisor stop'));
174 | static::stdout("Supervisor stopped, waiting $this->restartSleepingTime seconds..." .
175 | (!empty($shellResult) ? " ($shellResult)" : '') . "\n", static::FG_GREEN);
176 | // Snooze, because supervisor must rest before work...
177 | sleep($this->restartSleepingTime);
178 | // Start supervisor service
179 | $shellResult = trim(shell_exec('service supervisor start'));
180 | static::stdout('Supervisor started' . (!empty($shellResult) ? " ($shellResult)" : '') . "\n", static::FG_GREEN);
181 | }
182 |
183 | /**
184 | * Prints a string to STDOUT
185 | *
186 | * You may optionally format the string with ANSI codes by
187 | * passing additional parameters using the constants defined in [[\yii\helpers\Console]].
188 | *
189 | * Example:
190 | *
191 | * ~~~
192 | * static::stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
193 | * ~~~
194 | *
195 | * @param string $string the string to print
196 | *
197 | * @return int|boolean Number of bytes printed or false on error
198 | */
199 | protected static function stdout($string)
200 | {
201 | $args = func_get_args();
202 | array_shift($args);
203 | $string = static::ansiFormat($string, $args);
204 |
205 | return fwrite(\STDOUT, $string);
206 | }
207 |
208 | /**
209 | * Will return a string formatted with the given ANSI style
210 | *
211 | * @param string $string the string to be formatted
212 | * @param array $format An array containing formatting values.
213 | * You can pass any of the FG_*, BG_* and TEXT_* constants
214 | * and also [[xtermFgColor]] and [[xtermBgColor]] to specify a format.
215 | *
216 | * @return string
217 | */
218 | protected static function ansiFormat($string, $format = array())
219 | {
220 | $code = implode(';', $format);
221 |
222 | return "\033[0m" . ($code !== '' ? "\033[" . $code . "m" : '') . $string . "\033[0m";
223 | }
224 |
225 | /**
226 | * Prompts the user for input and validates it
227 | *
228 | * @param string $text prompt string
229 | * @param array $options the options to validate the input:
230 | *
231 | * - `required`: whether it is required or not
232 | * - `default`: default value if no input is inserted by the user
233 | * - `pattern`: regular expression pattern to validate user input
234 | * - `validator`: a callable function to validate input. The function must accept two parameters:
235 | * - `input`: the user input to validate
236 | * - `error`: the error value passed by reference if validation failed.
237 | *
238 | * @return string the user input
239 | */
240 | public static function prompt($text, $options = array())
241 | {
242 | $options = array_merge(array(
243 | 'required' => false,
244 | 'default' => null,
245 | 'pattern' => null,
246 | 'validator' => null,
247 | 'error' => 'Invalid input.',
248 | ), $options);
249 | $error = null;
250 |
251 | top:
252 | $input = $options['default']
253 | ? static::input("$text [" . $options['default'] . '] ')
254 | : static::input("$text ");
255 |
256 | if ($input === '') {
257 | if (isset($options['default'])) {
258 | $input = $options['default'];
259 | } elseif ($options['required']) {
260 | static::stdout($options['error']);
261 | goto top;
262 | }
263 | } elseif ($options['pattern'] && !preg_match($options['pattern'], $input)) {
264 | static::stdout($options['error']);
265 | goto top;
266 | } elseif ($options['validator'] &&
267 | !call_user_func_array($options['validator'], array($input, &$error))
268 | ) {
269 | static::stdout(isset($error) ? $error : $options['error']);
270 | goto top;
271 | }
272 |
273 | return $input;
274 | }
275 |
276 | /**
277 | * Asks the user for input. Ends when the user types a carriage return (PHP_EOL). Optionally, It also provides a
278 | * prompt.
279 | *
280 | * @param string $prompt the prompt to display before waiting for input (optional)
281 | *
282 | * @return string the user's input
283 | */
284 | public static function input($prompt = null)
285 | {
286 | if (isset($prompt)) {
287 | static::stdout($prompt);
288 | }
289 |
290 | return static::stdin();
291 | }
292 |
293 | /**
294 | * Gets input from STDIN and returns a string right-trimmed for EOLs.
295 | *
296 | * @param boolean $raw If set to true, returns the raw string without trimming
297 | *
298 | * @return string the string read from stdin
299 | */
300 | public static function stdin($raw = false)
301 | {
302 | return $raw ? fgets(\STDIN) : rtrim(fgets(\STDIN), PHP_EOL);
303 | }
304 | }
305 |
--------------------------------------------------------------------------------
/GearmanQueue.php:
--------------------------------------------------------------------------------
1 |
7 | */
8 |
9 | namespace demi\gearman;
10 |
11 | use GearmanWorker;
12 | use GearmanClient;
13 |
14 | /**
15 | * Gearman queue class
16 | */
17 | class GearmanQueue
18 | {
19 | const PRIORITY_LOW = 'low';
20 | const PRIORITY_NORMAL = 'normal';
21 | const PRIORITY_HIGH = 'high';
22 |
23 | /**
24 | * Gearman server host
25 | *
26 | * @var string
27 | */
28 | public $host = '127.0.0.1';
29 | /**
30 | * Gearman server port
31 | *
32 | * @var int
33 | */
34 | public $port = 4730;
35 | /**
36 | * Addtitional gearman servers
37 | *
38 | * @var array array('123.134.156.245:4730', '178.214.52.184:4730'), ...
39 | */
40 | public $servers = array();
41 | /**
42 | * Callacble function, running on before worker job handler call
43 | * function ($jobName, \GearmanJob $job) {
44 | * $workload = $job->workload();
45 | * var_dump($jobName); // worker name, eg.: "crop_image"
46 | * var_dump($workload); // job workload string, eg.: '{"post_id":7388,"foo":"bar"}' @see deserializeWorkload()
47 | * }
48 | *
49 | * @var callable
50 | */
51 | public $beforeJobCallback;
52 | /**
53 | * Callacble function, running on after worker job handler called
54 | * function ($jobName, \GearmanJob $job, $result) {
55 | * $workload = $job->workload();
56 | * var_dump($jobName); // worker name, eg.: "crop_image"
57 | * var_dump($workload); // job workload string, eg.: '{"post_id":7388,"foo":"bar"}' @see deserializeWorkload()
58 | * var_dump($result); // job handler return value
59 | * }
60 | *
61 | * @var callable
62 | */
63 | public $afterJobCallback;
64 | /**
65 | * Gearman client instance
66 | *
67 | * @var GearmanClient
68 | */
69 | private $_client;
70 | /**
71 | * Gearman worker instance
72 | *
73 | * @var GearmanWorker
74 | */
75 | private $_worker;
76 |
77 | /**
78 | * GearmanQueue constructor.
79 | *
80 | * @param string $host Gearman job server host
81 | * @param int $port Gearman job server post
82 | * @param array $servers Additional Gearman job servers: array('123.134.156.245:4730', '178.214.52.184:4730'), ...
83 | */
84 | public function __construct($host = '127.0.0.1', $port = 4730, $servers = array())
85 | {
86 | $this->host = $host;
87 | $this->port = $port;
88 | $this->servers = $servers;
89 | }
90 |
91 | /**
92 | * Get gearman client instance
93 | *
94 | * @return GearmanClient
95 | */
96 | public function getClient()
97 | {
98 | if (!$this->_client instanceof GearmanClient) {
99 | $this->_client = new GearmanClient();
100 | $this->_client->addServer($this->host, $this->port);
101 | // additional servers
102 | if (!empty($this->servers)) {
103 | $this->_client->addServers(implode(',', $this->servers));
104 | }
105 | }
106 |
107 | return $this->_client;
108 | }
109 |
110 | /**
111 | * Get gearman worker instance
112 | *
113 | * @return GearmanWorker
114 | */
115 | public function getWorker()
116 | {
117 | if (!$this->_worker instanceof GearmanWorker) {
118 | $this->_worker = new GearmanWorker();
119 | $this->_worker->addServer($this->host, $this->port);
120 | // additional servers
121 | if (!empty($this->servers)) {
122 | $this->_worker->addServers(implode(',', $this->servers));
123 | }
124 | }
125 |
126 | return $this->_worker;
127 | }
128 |
129 | /**
130 | * Register new task handler
131 | *
132 | * @param string $jobName
133 | * @param callable $handler
134 | */
135 | public function runWorker($jobName, $handler)
136 | {
137 | $that = $this;
138 | $workerHandler = function (\GearmanJob $job) use ($jobName, $handler, $that) {
139 | // Request before callback
140 | if (is_callable($that->beforeJobCallback)) {
141 | call_user_func($that->beforeJobCallback, $jobName, $job);
142 | }
143 |
144 | // Request worker handler
145 | $handlerResult = call_user_func($handler, $job);
146 |
147 | // Work finished
148 | // Request after callback
149 | if (is_callable($that->afterJobCallback)) {
150 | call_user_func($that->afterJobCallback, $jobName, $job, $handlerResult);
151 | }
152 |
153 | return $handlerResult;
154 | };
155 |
156 | // Get gearman worker instance
157 | $worker = $this->getWorker();
158 |
159 | // Register gearman worker
160 | $worker->addFunction($jobName, $workerHandler);
161 |
162 | // Run worker loop
163 | while ($worker->work()) {
164 | }
165 | }
166 |
167 | /**
168 | * Run a single task
169 | *
170 | * @param string $jobName
171 | * @param array $params
172 | * @param string $priority low, normal or high
173 | * @param bool $isBackground
174 | *
175 | * @return mixed
176 | */
177 | protected function doTask(
178 | $jobName, Array $params = array(), $priority = self::PRIORITY_NORMAL, $isBackground = false
179 | ) {
180 | // Synchronous Gearman functions
181 | $syncFuncions = array(
182 | static::PRIORITY_LOW => 'doLow',
183 | static::PRIORITY_NORMAL => 'doNormal',
184 | static::PRIORITY_HIGH => 'doHigh',
185 | );
186 | // Asynchronous Gearman functions
187 | $asyncFuncions = array(
188 | static::PRIORITY_LOW => 'doLowBackground',
189 | static::PRIORITY_NORMAL => 'doBackground',
190 | static::PRIORITY_HIGH => 'doHighBackground',
191 | );
192 |
193 | // Choise functions list
194 | $functions = $isBackground ? $asyncFuncions : $syncFuncions;
195 |
196 | // Choise function name
197 | $funcName = $functions[$priority];
198 |
199 | return $this->getClient()->$funcName($jobName, $this->serializeWorkload($params));
200 | }
201 |
202 | /**
203 | * Runs a single low priority task
204 | *
205 | * @param string $jobName
206 | * @param array $params
207 | *
208 | * @return mixed
209 | */
210 | public function doLow($jobName, Array $params = array())
211 | {
212 | return $this->doTask($jobName, $params, static::PRIORITY_LOW);
213 | }
214 |
215 | /**
216 | * Runs a single task
217 | *
218 | * @param string $jobName
219 | * @param array $params
220 | *
221 | * @return mixed
222 | */
223 | public function doNormal($jobName, Array $params = array())
224 | {
225 | return $this->doTask($jobName, $params, static::PRIORITY_NORMAL);
226 | }
227 |
228 | /**
229 | * Runs a single high priority task
230 | *
231 | * @param string $jobName
232 | * @param array $params
233 | *
234 | * @return mixed
235 | */
236 | public function doHigh($jobName, Array $params = array())
237 | {
238 | return $this->doTask($jobName, $params, static::PRIORITY_HIGH);
239 | }
240 |
241 | /**
242 | * Runs a low priority task in the background
243 | *
244 | * @param string $jobName
245 | * @param array $params
246 | *
247 | * @return mixed
248 | */
249 | public function doLowBackground($jobName, Array $params = array())
250 | {
251 | return $this->doTask($jobName, $params, static::PRIORITY_LOW, true);
252 | }
253 |
254 | /**
255 | * Runs a task in the background
256 | *
257 | * @param string $jobName
258 | * @param array $params
259 | *
260 | * @return mixed
261 | */
262 | public function doBackground($jobName, Array $params = array())
263 | {
264 | return $this->doTask($jobName, $params, static::PRIORITY_NORMAL, true);
265 | }
266 |
267 | /**
268 | * Runs a high priority task in the background
269 | *
270 | * @param string $jobName
271 | * @param array $params
272 | *
273 | * @return mixed
274 | */
275 | public function doHighBackground($jobName, Array $params = array())
276 | {
277 | return $this->doTask($jobName, $params, static::PRIORITY_HIGH, true);
278 | }
279 |
280 | /**
281 | * Serialize task params
282 | *
283 | * @param array|string $params
284 | *
285 | * @return string Serialized string
286 | */
287 | public function serializeWorkload($params)
288 | {
289 | if (!is_array($params)) {
290 | return (string)$params;
291 | } else {
292 | return json_encode($params);
293 | }
294 | }
295 |
296 | /**
297 | * Deserialize task params
298 | *
299 | * @param string $workload
300 | *
301 | * @return array Deserialized string
302 | */
303 | public function deserializeWorkload($workload)
304 | {
305 | return json_decode($workload, true);
306 | }
307 |
308 | /**
309 | * Return workers array with info
310 | *
311 | * example:
312 | * [
313 | * 'crop_image' => [
314 | * 'queued' => 8,
315 | * 'running' => 8,
316 | * 'available' => 50,
317 | * ],
318 | * 'save_file' => [
319 | * 'queued' => 150,
320 | * 'running' => 10,
321 | * 'available' => 10,
322 | * ],
323 | * ];
324 | *
325 | * @return array
326 | */
327 | public function getStatus()
328 | {
329 | $command = "(echo status ; sleep 0.1) | netcat $this->host $this->port -w 1";
330 | $output = shell_exec($command);
331 | if (empty($output)) {
332 | return array();
333 | }
334 |
335 | $workers = array();
336 | $lines = explode(PHP_EOL, $output);
337 | foreach ($lines as $line) {
338 | $matches = array();
339 | preg_match('/([\w]+)[^\d]+(\d+)\s+(\d+)\s+(\d+)/is', $line, $matches);
340 | if (!isset($matches[1], $matches[2], $matches[3], $matches[4])) {
341 | continue;
342 | }
343 | list(, $workerName, $queuedJobs, $runningJobs, $availableWorkers) = $matches;
344 |
345 | $workers[$workerName] = array(
346 | 'queued' => (int)$queuedJobs,
347 | 'running' => (int)$runningJobs,
348 | 'available' => (int)$availableWorkers,
349 | );
350 | }
351 |
352 | return $workers;
353 | }
354 |
355 | /**
356 | * Get free workers count by worker name
357 | *
358 | * @param string $workerName 'crop_image'
359 | *
360 | * @return int|false Free workers count or FALSE if worker does not running
361 | */
362 | public function getFreeWorkersCount($workerName)
363 | {
364 | $status = $this->getStatus();
365 |
366 | if (!isset($status[$workerName])) {
367 | return false;
368 | }
369 |
370 | $free = $status[$workerName]['available'] - $status[$workerName]['running'];
371 |
372 | return $free > 0 ? $free : 0;
373 | }
374 | }
375 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------