1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
|
<?php
/**
* reStructuredText rendering task for Phing, the PHP build tool.
*
* PHP version 5
*
* @category Tasks
* @package phing.tasks.ext
* @author Christian Weiske <cweiske@cweiske.de>
* @license LGPL v3 or later http://www.gnu.org/licenses/lgpl.html
* @link http://www.phing.info/
* @version SVN: $Id: ad2ac21008b4635c4f557e3a65c9306a350ca1f2 $
*/
require_once 'phing/Task.php';
require_once 'phing/util/FileUtils.php';
/**
* reStructuredText rendering task for Phing, the PHP build tool.
*
* PHP version 5
*
* @category Tasks
* @package phing.tasks.ext
* @author Christian Weiske <cweiske@cweiske.de>
* @license LGPL v3 or later http://www.gnu.org/licenses/lgpl.html
* @link http://www.phing.info/
*/
class rSTTask extends Task
{
/**
* @var string Taskname for logger
*/
protected $taskName = 'rST';
/**
* Result format, defaults to "html".
* @see $supportedFormats for all possible options
*
* @var string
*/
protected $format = 'html';
/**
* Array of supported output formats
*
* @var array
* @see $format
* @see $targetExt
*/
protected static $supportedFormats = array(
'html', 'latex', 'man', 'odt', 's5', 'xml'
);
/**
* Maps formats to file extensions
*
* @var array
*/
protected static $targetExt = array(
'html' => 'html',
'latex' => 'tex',
'man' => '3',
'odt' => 'odt',
's5' => 'html',
'xml' => 'xml',
);
/**
* Input file in rST format.
* Required
*
* @var string
*/
protected $file = null;
/**
* Additional rst2* tool parameters.
*
* @var string
*/
protected $toolParam = null;
/**
* Full path to the tool, i.e. /usr/local/bin/rst2html
*
* @var string
*/
protected $toolPath = null;
/**
* Output file or directory. May be omitted.
* When it ends with a slash, it is considered to be a directory
*
* @var string
*/
protected $destination = null;
protected $filesets = array(); // all fileset objects assigned to this task
protected $mapperElement = null;
/**
* all filterchains objects assigned to this task
*
* @var array
*/
protected $filterChains = array();
/**
* mode to create directories with
*
* @var integer
*/
protected $mode = 0755;
/**
* Only render files whole source files are newer than the
* target files
*
* @var boolean
*/
protected $uptodate = false;
/**
* Init method: requires the PEAR System class
*/
public function init()
{
require_once 'System.php';
}
/**
* The main entry point method.
*
* @return void
*/
public function main()
{
$tool = $this->getToolPath($this->format);
if (count($this->filterChains)) {
$this->fileUtils = new FileUtils();
}
if ($this->file != '') {
$file = $this->file;
$targetFile = $this->getTargetFile($file, $this->destination);
$this->render($tool, $file, $targetFile);
return;
}
if (!count($this->filesets)) {
throw new BuildException(
'"file" attribute or "fileset" subtag required'
);
}
// process filesets
$mapper = null;
if ($this->mapperElement !== null) {
$mapper = $this->mapperElement->getImplementation();
}
$project = $this->getProject();
foreach ($this->filesets as $fs) {
$ds = $fs->getDirectoryScanner($project);
$fromDir = $fs->getDir($project);
$srcFiles = $ds->getIncludedFiles();
foreach ($srcFiles as $src) {
$file = new PhingFile($fromDir, $src);
if ($mapper !== null) {
$results = $mapper->main($file);
if ($results === null) {
throw new BuildException(
sprintf(
'No filename mapper found for "%s"',
$file
)
);
}
$targetFile = reset($results);
} else {
$targetFile = $this->getTargetFile($file, $this->destination);
}
$this->render($tool, $file, $targetFile);
}
}
}
/**
* Renders a single file and applies filters on it
*
* @param string $tool conversion tool to use
* @param string $source rST source file
* @param string $targetFile target file name
*
* @return void
*/
protected function render($tool, $source, $targetFile)
{
if (count($this->filterChains) == 0) {
return $this->renderFile($tool, $source, $targetFile);
}
$tmpTarget = tempnam(sys_get_temp_dir(), 'rST-');
$this->renderFile($tool, $source, $tmpTarget);
$this->fileUtils->copyFile(
new PhingFile($tmpTarget),
new PhingFile($targetFile),
true, false, $this->filterChains,
$this->getProject(), $this->mode
);
unlink($tmpTarget);
}
/**
* Renders a single file with the rST tool.
*
* @param string $tool conversion tool to use
* @param string $source rST source file
* @param string $targetFile target file name
*
* @return void
*
* @throws BuildException When the conversion fails
*/
protected function renderFile($tool, $source, $targetFile)
{
if ($this->uptodate && file_exists($targetFile)
&& filemtime($source) <= filemtime($targetFile)
) {
//target is up to date
return;
}
//work around a bug in php by replacing /./ with /
$targetDir = str_replace('/./', '/', dirname($targetFile));
if (!is_dir($targetDir)) {
$this->log("Creating directory '$targetDir'", Project::MSG_VERBOSE);
mkdir($targetDir, $this->mode, true);
}
$cmd = $tool
. ' --exit-status=2'
. ' ' . $this->toolParam
. ' ' . escapeshellarg($source)
. ' ' . escapeshellarg($targetFile)
. ' 2>&1';
$this->log('command: ' . $cmd, Project::MSG_VERBOSE);
exec($cmd, $arOutput, $retval);
if ($retval != 0) {
$this->log(implode("\n", $arOutput), Project::MSG_INFO);
throw new BuildException('Rendering rST failed');
}
$this->log(implode("\n", $arOutput), Project::MSG_DEBUG);
}
/**
* Finds the rst2* binary path
*
* @param string $format Output format
*
* @return string Full path to rst2$format
*
* @throws BuildException When the tool cannot be found
*/
protected function getToolPath($format)
{
if ($this->toolPath !== null) {
return $this->toolPath;
}
$tool = 'rst2' . $format;
$path = System::which($tool);
if (!$path) {
throw new BuildException(
sprintf('"%s" not found. Install python-docutils.', $tool)
);
}
return $path;
}
/**
* Determines and returns the target file name from the
* input file and the configured destination name.
*
* @param string $file Input file
* @param string $destination Destination file or directory name,
* may be null
*
* @return string Target file name
*
* @uses $format
* @uses $targetExt
*/
public function getTargetFile($file, $destination = null)
{
if ($destination != ''
&& substr($destination, -1) !== '/'
&& substr($destination, -1) !== '\\'
) {
return $destination;
}
if (strtolower(substr($file, -4)) == '.rst') {
$file = substr($file, 0, -4);
}
return $destination . $file . '.' . self::$targetExt[$this->format];
}
/**
* The setter for the attribute "file"
*
* @param string $file Path of file to render
*
* @return void
*/
public function setFile($file)
{
$this->file = $file;
}
/**
* The setter for the attribute "format"
*
* @param string $format Output format
*
* @return void
*
* @throws BuildException When the format is not supported
*/
public function setFormat($format)
{
if (!in_array($format, self::$supportedFormats)) {
throw new BuildException(
sprintf(
'Invalid output format "%s", allowed are: %s',
$format,
implode(', ', self::$supportedFormats)
)
);
}
$this->format = $format;
}
/**
* The setter for the attribute "destination"
*
* @param string $destination Output file or directory. When it ends
* with a slash, it is taken as directory.
*
* @return void
*/
public function setDestination($destination)
{
$this->destination = $destination;
}
/**
* The setter for the attribute "toolparam"
*
* @param string $param Additional rst2* tool parameters
*
* @return void
*/
public function setToolparam($param)
{
$this->toolParam = $param;
}
/**
* The setter for the attribute "toolpath"
*
* @param string $param Full path to tool path, i.e. /usr/local/bin/rst2html
*
* @return void
*
* @throws BuildException When the tool does not exist or is not executable
*/
public function setToolpath($path)
{
if (!file_exists($path)) {
$fullpath = System::which($path);
if ($fullpath === false) {
throw new BuildException(
'Tool does not exist. Path: ' . $path
);
}
$path = $fullpath;
}
if (!is_executable($path)) {
throw new BuildException(
'Tool not executable. Path: ' . $path
);
}
$this->toolPath = $path;
}
/**
* The setter for the attribute "uptodate"
*
* @param string $uptodate True/false
*
* @return void
*/
public function setUptodate($uptodate)
{
$this->uptodate = (boolean)$uptodate;
}
/**
* Add a set of files to be rendered.
*
* @param FileSet $fileset Set of rst files to render
*
* @return void
*/
public function addFileset(FileSet $fileset)
{
$this->filesets[] = $fileset;
}
/**
* Nested creator, creates one Mapper for this task
*
* @return Mapper The created Mapper type object
*
* @throws BuildException
*/
public function createMapper()
{
if ($this->mapperElement !== null) {
throw new BuildException(
'Cannot define more than one mapper', $this->location
);
}
$this->mapperElement = new Mapper($this->project);
return $this->mapperElement;
}
/**
* Creates a filterchain, stores and returns it
*
* @return FilterChain The created filterchain object
*/
public function createFilterChain()
{
$num = array_push($this->filterChains, new FilterChain($this->project));
return $this->filterChains[$num-1];
}
}
|