|
1
|
|
|
<?php |
|
2
|
|
|
/* |
|
3
|
|
|
* Copyright (c) Arnaud Ligny <[email protected]> |
|
4
|
|
|
* |
|
5
|
|
|
* For the full copyright and license information, please view the LICENSE |
|
6
|
|
|
* file that was distributed with this source code. |
|
7
|
|
|
*/ |
|
8
|
|
|
|
|
9
|
|
|
namespace Cecil\Step; |
|
10
|
|
|
|
|
11
|
|
|
use Cecil\Collection\Page\Page; |
|
12
|
|
|
use Cecil\Exception\Exception; |
|
13
|
|
|
use Cecil\Util; |
|
14
|
|
|
|
|
15
|
|
|
/** |
|
16
|
|
|
* Pages saving. |
|
17
|
|
|
*/ |
|
18
|
|
|
class PagesSave extends AbstractStep |
|
19
|
|
|
{ |
|
20
|
|
|
/** |
|
21
|
|
|
* {@inheritdoc} |
|
22
|
|
|
* |
|
23
|
|
|
* @throws Exception |
|
24
|
|
|
*/ |
|
25
|
|
|
public function init($options) |
|
26
|
|
|
{ |
|
27
|
|
|
if ($options['dry-run']) { |
|
28
|
|
|
$this->process = false; |
|
29
|
|
|
call_user_func_array($this->builder->getMessageCb(), ['SAVE', 'Dry run']); |
|
30
|
|
|
|
|
31
|
|
|
return; |
|
32
|
|
|
} |
|
33
|
|
|
|
|
34
|
|
|
Util::getFS()->mkdir($this->config->getOutputPath()); |
|
35
|
|
|
|
|
36
|
|
|
$this->process = true; |
|
37
|
|
|
} |
|
38
|
|
|
|
|
39
|
|
|
/** |
|
40
|
|
|
* {@inheritdoc} |
|
41
|
|
|
* |
|
42
|
|
|
* @throws Exception |
|
43
|
|
|
*/ |
|
44
|
|
|
public function process() |
|
45
|
|
|
{ |
|
46
|
|
|
call_user_func_array($this->builder->getMessageCb(), ['SAVE', 'Saving pages']); |
|
47
|
|
|
|
|
48
|
|
|
/* @var $page Page */ |
|
49
|
|
|
$filteredPages = $this->builder->getPages()->filter(function (Page $page) { |
|
50
|
|
|
return !empty($page->getVariable('rendered')); |
|
51
|
|
|
}); |
|
52
|
|
|
$max = count($filteredPages); |
|
53
|
|
|
|
|
54
|
|
|
$count = 0; |
|
55
|
|
|
foreach ($filteredPages as $page) { |
|
56
|
|
|
$count++; |
|
57
|
|
|
$message = []; |
|
58
|
|
|
|
|
59
|
|
|
foreach ($page->getVariable('rendered') as $format => $rendered) { |
|
60
|
|
|
if (false === $pathname = $this->getPathname($page, $format)) { |
|
61
|
|
|
throw new Exception(sprintf( |
|
62
|
|
|
"Can't get pathname of page '%s' (format: '%s')", |
|
63
|
|
|
$page->getId(), |
|
64
|
|
|
$format |
|
65
|
|
|
)); |
|
66
|
|
|
continue; |
|
|
|
|
|
|
67
|
|
|
} |
|
68
|
|
|
$pathname = $this->cleanPath($this->config->getOutputPath().'/'.$pathname); |
|
69
|
|
|
try { |
|
70
|
|
|
Util::getFS()->dumpFile($pathname, $rendered['output']); |
|
71
|
|
|
} catch (\Exception $e) { |
|
72
|
|
|
throw new Exception($e->getMessage()); |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
$message[] = substr($pathname, strlen($this->config->getDestinationDir()) + 1); |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
call_user_func_array( |
|
79
|
|
|
$this->builder->getMessageCb(), |
|
80
|
|
|
['SAVE_PROGRESS', implode(', ', $message), $count, $max] |
|
81
|
|
|
); |
|
82
|
|
|
} |
|
83
|
|
|
} |
|
84
|
|
|
|
|
85
|
|
|
/** |
|
86
|
|
|
* Return output pathname. |
|
87
|
|
|
* |
|
88
|
|
|
* @param Page $page |
|
89
|
|
|
* @param string $format |
|
90
|
|
|
* |
|
91
|
|
|
* @return string|false |
|
92
|
|
|
*/ |
|
93
|
|
|
protected function getPathname(Page $page, string $format = 'html') |
|
94
|
|
|
{ |
|
95
|
|
|
// special case: list/index pages (ie: homepage, sections, etc.) |
|
96
|
|
|
if ($page->getName() == 'index') { |
|
97
|
|
|
return $page->getPath().'/'.$this->config->getOutputFile($format); |
|
98
|
|
|
} |
|
99
|
|
|
// uglyurl case. ie: robots.txt, 404.html, etc. |
|
100
|
|
|
if ($page->getVariable('uglyurl') || $this->config->get("site.output.formats.$format.uglyurl")) { |
|
101
|
|
|
return $page->getPathname().'.'.$this->config->get("site.output.formats.$format.extension"); |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
return $page->getPathname().'/'.$this->config->getOutputFile($format); |
|
105
|
|
|
} |
|
106
|
|
|
|
|
107
|
|
|
/** |
|
108
|
|
|
* Remove unnecessary slashes. |
|
109
|
|
|
* |
|
110
|
|
|
* @param string $pathname |
|
111
|
|
|
* |
|
112
|
|
|
* @return string |
|
113
|
|
|
*/ |
|
114
|
|
|
protected function cleanPath($pathname) |
|
115
|
|
|
{ |
|
116
|
|
|
return preg_replace('#/+#', '/', $pathname); |
|
117
|
|
|
} |
|
118
|
|
|
} |
|
119
|
|
|
|
Cecilapp /
Cecil
This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.
Unreachable code is most often the result of
return,dieorexitstatements that have been added for debug purposes.In the above example, the last
return falsewill never be executed, because a return statement has already been met in every possible execution path.