├── .buildpath
├── .gitignore
├── .settings
├── org.eclipse.php.core.prefs
└── org.eclipse.wst.common.project.facet.core.xml
├── BROWSER_README.md
├── INSTALL.md
├── LICENSE
├── MTS
├── Common
│ ├── Data
│ │ └── Computer
│ │ │ ├── FileSystems
│ │ │ ├── Directory.php
│ │ │ ├── File.php
│ │ │ └── ProcessPipe.php
│ │ │ └── OperatingSystems
│ │ │ ├── Base.php
│ │ │ ├── Linux
│ │ │ ├── ArchBase.php
│ │ │ ├── CentOSBase.php
│ │ │ ├── DebianBase.php
│ │ │ ├── LinuxBase.php
│ │ │ ├── RHELBase.php
│ │ │ └── UbuntuBase.php
│ │ │ ├── Microsoft
│ │ │ ├── Windows.php
│ │ │ └── WindowsBase.php
│ │ │ └── Mikrotik
│ │ │ ├── MikrotikBase.php
│ │ │ └── RouterOSBase.php
│ ├── Devices
│ │ ├── Actions
│ │ │ ├── Local
│ │ │ │ ├── Base.php
│ │ │ │ └── Host
│ │ │ │ │ ├── ApplicationPaths.php
│ │ │ │ │ ├── Browser.php
│ │ │ │ │ ├── MtsSetup
│ │ │ │ │ └── SetupMTS.php
│ │ │ │ │ ├── OperatingSystem.php
│ │ │ │ │ ├── PhpEnvironment.php
│ │ │ │ │ ├── Processes.php
│ │ │ │ │ ├── Shell.php
│ │ │ │ │ └── Users.php
│ │ │ └── Remote
│ │ │ │ ├── Base.php
│ │ │ │ ├── Connections
│ │ │ │ └── Ssh.php
│ │ │ │ └── Host
│ │ │ │ ├── OperatingSystem.php
│ │ │ │ └── Users.php
│ │ ├── Browsers
│ │ │ ├── Base.php
│ │ │ ├── BrowserInterface.php
│ │ │ ├── PhantomJS.php
│ │ │ └── Window.php
│ │ ├── Device.php
│ │ ├── Shells
│ │ │ ├── Base.php
│ │ │ ├── Bash.php
│ │ │ ├── Cmd.php
│ │ │ ├── PowerShell.php
│ │ │ └── RouterOS.php
│ │ ├── Types
│ │ │ ├── Localhost.php
│ │ │ └── Remotehost.php
│ │ └── VendorData
│ │ │ ├── PowerShell
│ │ │ └── mtsPsInit.ps1
│ │ │ └── phantomJS
│ │ │ ├── PJSCtrl.js
│ │ │ ├── PJSLinux32
│ │ │ ├── PJSLinux64
│ │ │ └── PJSWindows.exe
│ └── Tools
│ │ ├── FileSystems
│ │ ├── Directories.php
│ │ └── Files.php
│ │ └── Time
│ │ └── Epoch.php
├── EnableMTS.php
├── Factories.php
├── Factories
│ ├── Actions.php
│ ├── Devices.php
│ ├── Files.php
│ └── Time.php
└── WorkDirectory
│ └── placeHolder.php
├── MtsSetup.php
├── README.md
├── SHELL_README.md
├── Tests
├── Common
│ └── Devices
│ │ ├── Actions
│ │ └── Host
│ │ │ ├── ApplicationPathsTest.php
│ │ │ ├── BrowserTest.php
│ │ │ ├── OperatingSystemTest.php
│ │ │ ├── ProcessesTest.php
│ │ │ ├── ShellTest.php
│ │ │ └── UsersTest.php
│ │ ├── Browsers
│ │ └── PhantomJSTest.php
│ │ └── Types
│ │ └── LocalhostTest.php
├── Factories
│ ├── ActionsTest.php
│ └── DevicesTest.php
├── MtsBootstrap.php
├── MtsPhpUnit.xml
└── MtsUnitTestDevices.php
└── composer.json
/.buildpath:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /.project
2 |
--------------------------------------------------------------------------------
/.settings/org.eclipse.php.core.prefs:
--------------------------------------------------------------------------------
1 | eclipse.preferences.version=1
2 | include_path=0;/MTS
3 |
--------------------------------------------------------------------------------
/.settings/org.eclipse.wst.common.project.facet.core.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/BROWSER_README.md:
--------------------------------------------------------------------------------
1 | ## The Browser:
2 | Ever needed to login to a webpage, navigate to a specific menu and retrive content and the page relies on AJAX?
3 | I have, tons of times, let me give you one example.
4 |
5 | A major retailer in the US has an API for their vendors to retrive reports.
6 | The authentication is done by a token that can be renewed for upto one year, but every new years eve the token must be updated manually,
7 | and that process could only be done via a web page. Its a process that always causes a hickup in an otherwise automated reporting system.
8 | Its always the one off, once a year processes that do.
9 |
10 | With this browser that process has been automated. Three weeks before new years eve, the system does a dry run to make sure the portal webpage has not changed.
11 | If it changed (has not in the last 5 years) the staff gets an alert so they can update the process, otherwise the system automatically updates the token at 3am on new years while we are popping champagne.
12 |
13 | Not a huge problem, but 15 minutes of coding and the system is truely automated.
14 |
15 | This component would not be possible without the awesome work done by the people who built PhantomJS.
16 | This project simply wraps their work so it is easy for you to access using PHP.
17 |
18 | ### Basic use:
19 |
20 | This package creates a instance of PhantomJS, you can then open a website and execute standard functions against it through PHP.
21 | You start by following the installation instructions: Click Here, then instantiate a browser.
22 |
23 | ```php
24 | //Some websites are either far away or just slow, so it is a good idea to up the allowed execution time.
25 | ini_set('max_execution_time', 120);
26 |
27 | //Get a new browser window:
28 | $myUrl = "https://www.wikipedia.org/";
29 | $windowObj = \MTS\Factories::getDevices()->getLocalHost()->getBrowser('phantomjs')->getNewWindow($myUrl);
30 | ```
31 |
32 | $windowObj now contains a browser window with wikipedias website loaded.
33 |
34 | Lets do a search on wikipedia. Whenever we wish to manipulate an element we do so by using a css selector to identify it. Its really easy i.e.:
35 | if we want an element with id='mySearchBox' the selector would be: [id=mySearchBox]. Basically [attribute=value].
36 | Another example of a selector: a.myClass:nth-of-type(2) this selector takes all hyperlinks in class "myClass", then picks the second one.
37 | For more information see this article.
38 |
39 | ```php
40 | //left click on the search input box (it has id=searchInput):
41 | $windowObj->mouseEventOnElement("[id=searchInput]", 'leftclick');
42 |
43 | //Type the search string we want to perform:
44 | $windowObj->sendKeyPresses("Nikola Tesla");
45 |
46 | //Press enter. Note special keys must be inputted as an array, while characters / numbers are inputted as a string
47 | $windowObj->sendKeyPresses(array("Enter"));
48 | ```
49 |
50 | The page is now displaying the search result. Lets do a screen shot to make sure:
51 |
52 | ```php
53 | //perform a screenshot:
54 | $screenshotData = $windowObj->screenshot();
55 |
56 | //render it:
57 | echo ' . ')
';
58 | ```
59 |
60 | See "Window Methods" below for a complete list of examples
61 |
62 | ### How It Works:
63 | PhantomJS is executed and the stdIn / stdOut are used to send and receive JSON encoded commands.
64 | The JS file that is executed by PhantomJS is constantly checking its stdIn to see if any new commands have arrived.
65 | Once a command is received the action is completed and the result returned.
66 |
67 | You only have to worry about opening a page and manipulating it.
68 |
69 | ### Window Methods:
70 |
71 | Set the size of the window (in pixels):
72 | ```php
73 | $width = 640;
74 | $height = 480;
75 | $windowObj->setSize($width, $height);
76 | ```
77 |
78 | Set the area of the window you want to screenshot (in pixels):
79 | ```php
80 | $top = 0;
81 | $left = 0;
82 | $width = 640;
83 | $height = 480;
84 | $windowObj->setRasterSize($top, $left, $width, $height);
85 | ```
86 |
87 | Take a screenshot of the window:
88 |
89 | Accepts one argument which determines the image format. By default "png". All valid options: "png", "jpeg".
90 | ```php
91 | $imageData = $windowObj->screenshot();
92 | ```
93 |
94 | Close window:
95 | ```php
96 | $windowObj->close();
97 | ```
98 | Note: This will also close any child windows
99 |
100 | Get the DOM:
101 | ```php
102 | //get the HTML of the current page:
103 | $domData = $windowObj->getDom();
104 | ```
105 |
106 | Place cursor in a particular input element:
107 | ```php
108 | $selector = "[id=someElementId]";
109 | $windowObj->focusElement($selector);
110 | ```
111 |
112 | Does a particular selector exist:
113 | ```php
114 | $selector = "[id=someElementId]";
115 | $exists = $windowObj->getSelectorExists($selector);
116 | //true if exists, else false
117 | ```
118 |
119 | Type with the keyboard. Accepts two arguments: Keys to press and modifiers.
120 |
121 | Characters and numbers are accepted as a string. Special keys must be set as array, special keys:
122 | ```php
123 | $keys = array('Enter', 'Tab', 'Space', 'Backspace', 'Delete', 'Up', 'Down', 'Left', 'Right', 'Pageup', 'Pagedown', 'Numlock', 'F1', 'F2', 'F3', 'F4', 'F5', 'F6', 'F7', 'F8', 'F9', 'F10', 'F11', 'F12', 'BraceLeft', 'BraceRight', 'BracketLeft', 'BracketRight');
124 | ```
125 | Modifiers must be set as array, modifier keys:
126 | ```php
127 | $modifiers = array('Alt', 'Shift', 'Ctrl', 'Meta', 'Keypad');
128 | ```
129 | Examples:
130 | ```php
131 | //Example 1, send a string of characters
132 | $keys = "My Search Key Words";
133 | $windowObj->sendKeyPresses($keys);
134 |
135 | //Example 2, send a string of characters while holding down "shift".
136 | $keys = "My Search Key Words";
137 | $modifiers = array("shift");
138 | $windowObj->sendKeyPresses($keys, $modifiers);
139 |
140 | //Example 3, press enter
141 | $keys = array('Enter');
142 | $windowObj->sendKeyPresses($keys);
143 |
144 | ```
145 |
146 | Perform a mouse event on an element:
147 |
148 | Valid events:
149 | "up", "down", "move", "leftclick", "leftdoubleclick", "rightclick", "rightdoubleclick"
150 | ```php
151 | //left click an element
152 | $selector = "[id=someElementId]";
153 | $event = "leftclick";
154 | $windowObj->mouseEventOnElement($selector, $event);
155 | ```
156 | Note: Do not use this method to click hyperlinks, use clickElement() instead.
157 | mouseEventOnElement() can only click on elements that have 2D size, a hyperlink is just a line and has no area to click.
158 |
159 | Click on an element:
160 | ```php
161 | $selector = "[id=someElementId]";
162 | $windowObj->clickElement($selector);
163 | ```
164 |
165 | Load some custom JavaScript in the window:
166 | ```php
167 | $scriptData = "function myHelloWorld() {
168 | return 'Hello World';
169 | }";
170 |
171 | $windowObj->loadJS($scriptData);
172 | ```
173 |
174 | Call a JavaScript function:
175 | ```php
176 | //$funcReturn will contain a string with the return from the function.
177 | $funcReturn = $windowObj->callJSFunction("myHelloWorld");
178 | ```
179 | Note: Only content that can be serialize by Json can be returned (JSON.stringify(data), will help you), no objects.
180 |
181 | Get all cookies from a page:
182 | ```php
183 | //returns array of cookies
184 | $cookies = $windowObj->getCookies();
185 | ```
186 |
187 | Set a cookie for the current page
188 | ```php
189 | $name = "MyCookieName"; //String: mandetory cookie name.
190 | $value = "My Cookie Value"; //String: mandetory cookie value.
191 | $domain = null; //String: defaults to current domain in window URL
192 | $path = null; //String: defaults to "/";
193 | $expireTime = null; //Int (epoch): default is 2147483647
194 | $serverOnly = false; //Bool: default false; if true cookie cannot be read by client scripts.
195 | $secureOnly = false; //Bool: default false; if true cookie can only be transmitted using secure (defined by the user agent, i.e. TLS) channel.
196 |
197 | $windowObj->setCookie($name, $value, $domain, $path, $expireTime, $serverOnly, $secureOnly);
198 | ```
199 | Note: PhantomJS 2.1.1 have several issues regarding setting cookies:
200 | https://github.com/ariya/phantomjs/issues/13409
201 | https://github.com/ariya/phantomjs/issues/14047
202 |
203 | Get details of an element i.e. value:
204 | ```php
205 | //limited currently, will get more detail over time
206 | //returns array
207 | $selector = "[id=someElementId]";
208 | $eleDetails = $windowObj->getElement($selector);
209 | ```
210 |
211 | Get details of the document i.e. height and width:
212 | ```php
213 | //limited currently, will get more detail over time
214 | //returns array
215 | $docDetails = $windowObj->getDocument();
216 | ```
217 |
218 | Set the url in the window:
219 | ```php
220 | //Will load the URL in the window
221 | $myUrl = "http://www.google.com";
222 | $windowObj->setURL($myUrl);
223 | ```
224 |
225 | Get the current url in the window:
226 | ```php
227 | //returns the current URL as a string.
228 | $strUrl = $windowObj->getURL();
229 | ```
230 | Note: It is the CURRENT url that is returned, so if you submitted a form the URL may not be the same as you originally set.
231 |
232 | Set the User Agent:
233 | ```php
234 | $agentName = "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:47.0) Gecko/20100101 Firefox/47.0";
235 | $windowObj->setUserAgent($agentName);
236 | ```
237 |
238 | Set the scroll position in the window (in pixels):
239 | ```php
240 | //scroll down the page 500px
241 | $top = 500;
242 | $left = 0;
243 | $windowObj->setScrollPosition($top, $left);
244 | ```
245 |
246 | Set if images should be loaded:
247 | ```php
248 | //default is true, but setting to false will speed up loading by omitting images
249 | $bool = false;
250 | $windowObj->setLoadImages($bool);
251 | ```
252 |
253 | If the window spawned a popup or another window:
254 | ```php
255 | $childWindowObjs = $windowObj->getChildren();
256 | if (count(childWindowObjs) > 0) {
257 | //the child window can be used just like a regular window
258 | $childWindowObj = current($childWindowObjs);
259 | //i.e. you can take a screen shot
260 | $childImageData = $childWindowObj->screenshot();
261 | }
262 | ```
263 | Note: If you execute setURL() on the parent window, all child windows will be closed automatically
264 |
265 | ##### Debugging:
266 |
267 | Figuring out what happens when a call fails can be a challenge, but if you enable debug you can catch the exception and see all reads and writes to help debug the issue.
268 |
269 | ```php
270 | $errMsg = null;
271 | try {
272 |
273 | $localHost = \MTS\Factories::getDevices()->getLocalHost();
274 | $localHost->setDebug(true);
275 |
276 | $browserObj = $localHost->getBrowser('phantomjs');
277 |
278 | $myUrl = "https://www.wikipedia.org/";
279 | $windowObj = $browserObj->getNewWindow($myUrl);
280 |
281 | //execute the trouble command here i.e:
282 | $funcReturn = $windowObj->callJSFunction("myHelloWorld");
283 |
284 | $browserObj->terminate();
285 |
286 | } catch (\Exception $e) {
287 | switch($e->getCode()){
288 | default;
289 | $errMsg = $e->getMessage();
290 | }
291 | }
292 |
293 | echo "Start Debug<<<\n \n ";
294 | echo "Exception Message: " . $errMsg;
295 | print_r($browserObj->getDebugData());
296 | print_r($browserObj->getDebugFileContent());
297 | echo "\n