1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* GpsLab component. |
4
|
|
|
* |
5
|
|
|
* @author Peter Gribanov <[email protected]> |
6
|
|
|
* @copyright Copyright (c) 2011, Peter Gribanov |
7
|
|
|
* @license http://opensource.org/licenses/MIT |
8
|
|
|
*/ |
9
|
|
|
|
10
|
|
|
namespace GpsLab\Component\Sitemap\Stream; |
11
|
|
|
|
12
|
|
|
use GpsLab\Component\Sitemap\Render\SitemapRender; |
13
|
|
|
use GpsLab\Component\Sitemap\Stream\Exception\FileAccessException; |
14
|
|
|
use GpsLab\Component\Sitemap\Stream\Exception\LinksOverflowException; |
15
|
|
|
use GpsLab\Component\Sitemap\Stream\Exception\SizeOverflowException; |
16
|
|
|
use GpsLab\Component\Sitemap\Stream\Exception\StreamStateException; |
17
|
|
|
use GpsLab\Component\Sitemap\Stream\State\StreamState; |
18
|
|
|
use GpsLab\Component\Sitemap\Url\Url; |
19
|
|
|
|
20
|
|
|
class RenderFileStream implements FileStream |
21
|
|
|
{ |
22
|
|
|
/** |
23
|
|
|
* @var SitemapRender |
24
|
|
|
*/ |
25
|
|
|
private $render; |
26
|
|
|
|
27
|
|
|
/** |
28
|
|
|
* @var StreamState |
29
|
|
|
*/ |
30
|
|
|
private $state; |
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* @var resource|null |
34
|
|
|
*/ |
35
|
|
|
private $handle; |
36
|
|
|
|
37
|
|
|
/** |
38
|
|
|
* @var string |
39
|
|
|
*/ |
40
|
|
|
private $filename = ''; |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* @var string |
44
|
|
|
*/ |
45
|
|
|
private $tmp_filename = ''; |
46
|
|
|
|
47
|
|
|
/** |
48
|
|
|
* @var int |
49
|
|
|
*/ |
50
|
|
|
private $counter = 0; |
51
|
|
|
|
52
|
|
|
/** |
53
|
|
|
* @var string |
54
|
|
|
*/ |
55
|
|
|
private $end_string = ''; |
56
|
|
|
|
57
|
|
|
/** |
58
|
|
|
* @var int |
59
|
|
|
*/ |
60
|
|
|
private $used_bytes = 0; |
61
|
|
|
|
62
|
|
|
/** |
63
|
|
|
* @param SitemapRender $render |
64
|
|
|
* @param string $filename |
65
|
|
|
*/ |
66
|
22 |
|
public function __construct(SitemapRender $render, $filename) |
67
|
|
|
{ |
68
|
22 |
|
$this->render = $render; |
69
|
22 |
|
$this->state = new StreamState(); |
70
|
22 |
|
$this->filename = $filename; |
71
|
22 |
|
} |
72
|
|
|
|
73
|
|
|
/** |
74
|
|
|
* @return string |
75
|
|
|
*/ |
76
|
9 |
|
public function getFilename() |
77
|
|
|
{ |
78
|
9 |
|
return $this->filename; |
79
|
|
|
} |
80
|
|
|
|
81
|
15 |
View Code Duplication |
public function open() |
82
|
|
|
{ |
83
|
15 |
|
$this->state->open(); |
84
|
|
|
|
85
|
15 |
|
$tmp_filename = tempnam(sys_get_temp_dir(), 'sitemap'); |
86
|
|
|
|
87
|
15 |
|
if ($tmp_filename === false) { |
88
|
|
|
throw FileAccessException::failedCreateUnique(sys_get_temp_dir(), 'sitemap'); |
89
|
|
|
} |
90
|
|
|
|
91
|
15 |
|
$handle = @fopen($tmp_filename, 'wb'); |
92
|
|
|
|
93
|
15 |
|
if ($handle === false) { |
94
|
|
|
throw FileAccessException::notWritable($tmp_filename); |
95
|
|
|
} |
96
|
|
|
|
97
|
15 |
|
$this->tmp_filename = $tmp_filename; |
98
|
15 |
|
$this->handle = $handle; |
99
|
|
|
|
100
|
15 |
|
$this->write($this->render->start()); |
101
|
|
|
// render end string only once |
102
|
15 |
|
$this->end_string = $this->render->end(); |
103
|
15 |
|
} |
104
|
|
|
|
105
|
19 |
View Code Duplication |
public function close() |
106
|
|
|
{ |
107
|
19 |
|
$this->state->close(); |
108
|
15 |
|
$this->write($this->end_string); |
109
|
15 |
|
fclose($this->handle); |
110
|
|
|
|
111
|
15 |
|
if (!rename($this->tmp_filename, $this->filename)) { |
112
|
|
|
unlink($this->tmp_filename); |
113
|
|
|
|
114
|
|
|
throw FileAccessException::failedOverwrite($this->tmp_filename, $this->filename); |
115
|
|
|
} |
116
|
|
|
|
117
|
15 |
|
$this->handle = null; |
118
|
15 |
|
$this->tmp_filename = ''; |
119
|
15 |
|
$this->counter = 0; |
120
|
15 |
|
$this->used_bytes = 0; |
121
|
15 |
|
} |
122
|
|
|
|
123
|
|
|
/** |
124
|
|
|
* @param Url $url |
125
|
|
|
*/ |
126
|
9 |
View Code Duplication |
public function push(Url $url) |
127
|
|
|
{ |
128
|
9 |
|
if (!$this->state->isReady()) { |
129
|
2 |
|
throw StreamStateException::notReady(); |
130
|
|
|
} |
131
|
|
|
|
132
|
7 |
|
if ($this->counter >= self::LINKS_LIMIT) { |
133
|
2 |
|
throw LinksOverflowException::withLimit(self::LINKS_LIMIT); |
134
|
|
|
} |
135
|
|
|
|
136
|
7 |
|
$render_url = $this->render->url($url); |
137
|
|
|
|
138
|
7 |
|
$expected_bytes = $this->used_bytes + strlen($render_url) + strlen($this->end_string); |
139
|
7 |
|
if ($expected_bytes > self::BYTE_LIMIT) { |
140
|
|
|
throw SizeOverflowException::withLimit(self::BYTE_LIMIT); |
141
|
|
|
} |
142
|
|
|
|
143
|
7 |
|
$this->write($render_url); |
144
|
7 |
|
++$this->counter; |
145
|
7 |
|
} |
146
|
|
|
|
147
|
|
|
/** |
148
|
|
|
* @return int |
149
|
|
|
*/ |
150
|
2 |
|
public function count() |
151
|
|
|
{ |
152
|
2 |
|
return $this->counter; |
153
|
|
|
} |
154
|
|
|
|
155
|
|
|
/** |
156
|
|
|
* @param string $string |
157
|
|
|
*/ |
158
|
15 |
|
private function write($string) |
159
|
|
|
{ |
160
|
15 |
|
fwrite($this->handle, $string); |
161
|
15 |
|
$this->used_bytes += strlen($string); |
162
|
15 |
|
} |
163
|
|
|
} |
164
|
|
|
|