FirefoxProfile.php
5.16 KB
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
<?php
// Copyright 2004-present Facebook. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
namespace Facebook\WebDriver\Firefox;
use Facebook\WebDriver\Exception\WebDriverException;
use FilesystemIterator;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use ZipArchive;
class FirefoxProfile {
/**
* @var array
*/
private $preferences = array();
/**
* @var array
*/
private $extensions = array();
/**
* @param string $extension The path to the xpi extension.
* @return FirefoxProfile
*/
public function addExtension($extension) {
$this->extensions[] = $extension;
return $this;
}
/**
* @param string $key
* @param string|bool|int $value
* @return FirefoxProfile
* @throws WebDriverException
*/
public function setPreference($key, $value) {
if (is_string($value)) {
$value = sprintf('"%s"', $value);
} else if (is_int($value)) {
$value = sprintf('%d', $value);
} else if (is_bool($value)) {
$value = $value ? 'true' : 'false';
} else {
throw new WebDriverException(
'The value of the preference should be either a string, int or bool.');
}
$this->preferences[$key] = $value;
return $this;
}
/**
* @return string
*/
public function encode() {
$temp_dir = $this->createTempDirectory('WebDriverFirefoxProfile');
foreach ($this->extensions as $extension) {
$this->installExtension($extension, $temp_dir);
}
$content = "";
foreach ($this->preferences as $key => $value) {
$content .= sprintf("user_pref(\"%s\", %s);\n", $key, $value);
}
file_put_contents($temp_dir.'/user.js', $content);
$zip = new ZipArchive();
$temp_zip = tempnam('', 'WebDriverFirefoxProfileZip');
$zip->open($temp_zip, ZipArchive::CREATE);
$dir = new RecursiveDirectoryIterator($temp_dir);
$files = new RecursiveIteratorIterator($dir);
foreach ($files as $name => $object) {
if (is_dir($name)) {
continue;
}
$dir_prefix = preg_replace(
'#\\\\#',
'\\\\\\\\',
$temp_dir.DIRECTORY_SEPARATOR
);
$path = preg_replace("#^{$dir_prefix}#", "", $name);
$zip->addFile($name, $path);
}
$zip->close();
$profile = base64_encode(file_get_contents($temp_zip));
// clean up
$this->deleteDirectory($temp_dir);
unlink($temp_zip);
return $profile;
}
/**
* @param string $extension The path to the extension.
* @param string $profile_dir The path to the profile directory.
* @return string The path to the directory of this extension.
*/
private function installExtension($extension, $profile_dir) {
$temp_dir = $this->createTempDirectory();
$this->extractTo($extension, $temp_dir);
$install_rdf_path = $temp_dir.'/install.rdf';
// This is a hacky way to parse the id since there is no offical
// RDF parser library.
$matches = array();
$xml = file_get_contents($install_rdf_path);
preg_match('#<em:id>([^<]+)</em:id>#', $xml, $matches);
$ext_dir = $profile_dir.'/extensions/'.$matches[1];
mkdir($ext_dir, 0777, true);
$this->extractTo($extension, $ext_dir);
// clean up
$this->deleteDirectory($temp_dir);
return $ext_dir;
}
/**
* @param string $prefix Prefix of the temp directory.
*
* @return string The path to the temp directory created.
* @throws WebDriverException
*/
private function createTempDirectory($prefix = '') {
$temp_dir = tempnam('', $prefix);
if (file_exists($temp_dir)) {
unlink($temp_dir);
mkdir($temp_dir);
if (!is_dir($temp_dir)) {
throw new WebDriverException('Cannot create firefox profile.');
}
}
return $temp_dir;
}
/**
* @param string $directory The path to the directory.
*/
private function deleteDirectory($directory) {
$dir = new RecursiveDirectoryIterator($directory, FilesystemIterator::SKIP_DOTS);
$paths = new RecursiveIteratorIterator($dir, RecursiveIteratorIterator::CHILD_FIRST);
foreach ($paths as $path) {
if ($path->isDir() && !$path->isLink()) {
rmdir($path->getPathname());
} else {
unlink($path->getPathname());
}
}
rmdir($directory);
}
/**
* @param string $xpi The path to the .xpi extension.
* @param string $target_dir The path to the unzip directory.
*
* @return FirefoxProfile
* @throws \Exception
*/
private function extractTo($xpi, $target_dir) {
$zip = new ZipArchive();
if ($zip->open($xpi)) {
$zip->extractTo($target_dir);
$zip->close();
} else {
throw new \Exception("Failed to open the firefox extension. '$xpi'");
}
return $this;
}
}