├── LICENSE
├── README.md
└── skyRemote.py
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | SkyRemote
2 | =========
3 |
4 | A python based remote control for Sky+HD boxes updated to Picasso.
5 |
6 | Based on Craig Heffner's Miranda, which is currently on Google Code http://code.google.com/p/miranda-upnp/ and licensed under GPLv3.
7 |
8 |
9 | How does it work?
10 | ------------------------------------------------
11 |
12 | Since Sky's Picasso update for Sky+HD boxes earlier this year, the Sky+HD box (DRX890 and DRX895, at present) boxes expose a DNLA server which, until the recent iPad application, was for an unknown reason.
13 |
14 | This DNLA server exposes 5 control endpoints that can be used to control the Sky+ box over IP.
15 |
16 | Miranda is a UPnP browser that lets you browse a UPnP client, and while the Sky+HD box requires a few specific changes to work with it, it pretty much does the job of browsing available methods, and lets you send things to it.
17 |
18 | SkyRemote makes this a bit easier, by completely automating the detection of a Sky+HD box and loading the relative xml files to provide the data, and giving a simple "control" command which allows you to perform any of the "SkyPlay" control endpoint methods.
19 |
20 | To run the script, you'll need python installed. You already have this if you're on a mac, and probably on linux too. Then you can run:
21 |
22 | python skyRemote.py
23 |
24 | These available "control" commands are currently:
25 |
26 | * `GetMediaInfo_Ext`
27 | * `X_NDS_SetUserPIN` Send the user's PIN (Used to unlock pre-watershed channels and recorded programming)
28 | * `Play` Equivalent of "Play" button (prompts for play speed, can be used to fast forward)
29 | * `Pause` Equivalent of "Pause" button
30 | * `GetPositionInfo`
31 | * `GetMediaInfo`
32 | * `GetTransportInfo`
33 | * `Stop` Equivalent of "Stop" button
34 | * `GetDeviceCapabilities`
35 | * `Next`
36 | * `X_NDS_GetCACondition`
37 | * `SetAVTransportURI`
38 | * `GetTransportSettings`
39 | * `Seek`
40 | * `GetCurrentTransportActions`
41 | * `Previous`
42 |
43 | Please excuse any undocumented functions, I'm still figuring all this out.
44 | You'll be prompted for any required arguments.
45 |
46 | So, for example, if you wanted to send a "Pause" command, you can just run:
47 |
48 | control pause
49 |
50 | Advanced
51 | ------------------------------------------------
52 |
53 | If you understnad these things, you can view the full, complete list of endpoints which are exposed by this using the command:
54 |
55 | host details 0
56 |
57 | You can then send a raw command with:
58 |
59 | host send 0 SkyControl [SkyPlay|SkyRC2|SkyCM2]
60 |
61 | More information on the Sky DNLA Remote service is on my blog, at [http://www.gladdy.co.uk/blog](http://www.gladdy.co.uk/blog)
62 |
63 | Help
64 | ------------------------------------------------
65 | Check the [FAQ on the Wiki](https://github.com/lgladdy/SkyRemote/wiki/FAQ)
--------------------------------------------------------------------------------
/skyRemote.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 |
3 | # Based on Craig Heffner's Miranda - http://code.google.com/p/miranda-upnp/
4 | # Licensed under GPL v3
5 |
6 | try:
7 | import sys,os
8 | from socket import *
9 | from urllib2 import URLError, HTTPError
10 | from platform import system as thisSystem
11 | import xml.dom.minidom as minidom
12 | import IN,urllib,urllib2
13 | import readline,time
14 | import pickle
15 | import struct
16 | import base64
17 | import re
18 | import getopt
19 | except Exception,e:
20 | print 'Unmet dependency:',e
21 | sys.exit(1)
22 |
23 | #Most of the cmdCompleter class was originally written by John Kenyan
24 | #It serves to tab-complete commands inside the program's shell
25 | class cmdCompleter:
26 | def __init__(self,commands):
27 | self.commands = commands
28 |
29 | #Traverses the list of available commands
30 | def traverse(self,tokens,tree):
31 | retVal = []
32 |
33 | #If there are no commands, or no user input, return null
34 | if tree is None or len(tokens) == 0:
35 | return []
36 | #If there is only one word, only auto-complete the primary commands
37 | elif len(tokens) == 1:
38 | retVal = [x+' ' for x in tree if x.startswith(tokens[0])]
39 | #Else auto-complete for the sub-commands
40 | elif tokens[0] in tree.keys():
41 | retVal = self.traverse(tokens[1:],tree[tokens[0]])
42 | return retVal
43 |
44 | #Returns a list of possible commands that match the partial command that the user has entered
45 | def complete(self,text,state):
46 | try:
47 | tokens = readline.get_line_buffer().split()
48 | if not tokens or readline.get_line_buffer()[-1] == ' ':
49 | tokens.append('')
50 | results = self.traverse(tokens,self.commands) + [None]
51 | return results[state]
52 | except:
53 | return
54 |
55 | #UPNP class for getting, sending and parsing SSDP/SOAP XML data (among other things...)
56 | class upnp:
57 | ip = False
58 | port = False
59 | completer = False
60 | msearchHeaders = {
61 | 'MAN' : '"ssdp:discover"',
62 | 'MX' : '2'
63 | }
64 | DEFAULT_IP = "239.255.255.250"
65 | DEFAULT_PORT = 1900
66 | UPNP_VERSION = '1.0'
67 | MAX_RECV = 8192
68 | HTTP_HEADERS = []
69 | ENUM_HOSTS = {}
70 | VERBOSE = False
71 | UNIQ = False
72 | DEBUG = False
73 | LOG_FILE = False
74 | IFACE = None
75 | STARS = '****************************************************************'
76 | csock = False
77 | ssock = False
78 |
79 | def __init__(self,ip,port,iface,appCommands):
80 | if appCommands:
81 | self.completer = cmdCompleter(appCommands)
82 | if self.initSockets(ip,port,iface) == False:
83 | print 'UPNP class initialization failed!'
84 | print 'Bye!'
85 | sys.exit(1)
86 | else:
87 | self.soapEnd = re.compile('<\/.*:envelope>')
88 |
89 | #Initialize default sockets
90 | def initSockets(self,ip,port,iface):
91 | if self.csock:
92 | self.csock.close()
93 | if self.ssock:
94 | self.ssock.close()
95 |
96 | if iface != None:
97 | self.IFACE = iface
98 | if not ip:
99 | ip = self.DEFAULT_IP
100 | if not port:
101 | port = self.DEFAULT_PORT
102 | self.port = port
103 | self.ip = ip
104 |
105 | try:
106 | #This is needed to join a multicast group
107 | self.mreq = struct.pack("4sl",inet_aton(ip),INADDR_ANY)
108 |
109 | #Set up client socket
110 | self.csock = socket(AF_INET,SOCK_DGRAM)
111 | self.csock.setsockopt(IPPROTO_IP,IP_MULTICAST_TTL,2)
112 |
113 | #Set up server socket
114 | self.ssock = socket(AF_INET,SOCK_DGRAM,IPPROTO_UDP)
115 | self.ssock.setsockopt(SOL_SOCKET,SO_REUSEADDR,1)
116 |
117 | #Only bind to this interface
118 | if self.IFACE != None:
119 | print '\nBinding to interface',self.IFACE,'...\n'
120 | self.ssock.setsockopt(SOL_SOCKET,IN.SO_BINDTODEVICE,struct.pack("%ds" % (len(self.IFACE)+1,), self.IFACE))
121 | self.csock.setsockopt(SOL_SOCKET,IN.SO_BINDTODEVICE,struct.pack("%ds" % (len(self.IFACE)+1,), self.IFACE))
122 |
123 | try:
124 | self.ssock.bind(('',self.port))
125 | except Exception, e:
126 | print "WARNING: Failed to bind %s:%d: %s" , (self.ip,self.port,e)
127 | try:
128 | self.ssock.setsockopt(IPPROTO_IP,IP_ADD_MEMBERSHIP,self.mreq)
129 | except Exception, e:
130 | print 'WARNING: Failed to join multicast group:',e
131 | except Exception, e:
132 | print "Failed to initialize UPNP sockets:",e
133 | return False
134 | return True
135 |
136 | #Clean up file/socket descriptors
137 | def cleanup(self):
138 | if self.LOG_FILE != False:
139 | self.LOG_FILE.close()
140 | self.csock.close()
141 | self.ssock.close()
142 |
143 | #Send network data
144 | def send(self,data,socket):
145 | #By default, use the client socket that's part of this class
146 | if socket == False:
147 | socket = self.csock
148 | try:
149 | socket.sendto(data,(self.ip,self.port))
150 | return True
151 | except Exception, e:
152 | print "SendTo method failed for %s:%d : %s" % (self.ip,self.port,e)
153 | return False
154 |
155 | #Listen for network data
156 | def listen(self,size,socket):
157 | if socket == False:
158 | socket = self.ssock
159 |
160 | try:
161 | return socket.recv(size)
162 | except:
163 | return False
164 |
165 | #Create new UDP socket on ip, bound to port
166 | def createNewListener(self,ip,port):
167 | try:
168 | newsock = socket(AF_INET,SOCK_DGRAM,IPPROTO_UDP)
169 | newsock.setsockopt(SOL_SOCKET,SO_REUSEADDR,1)
170 | newsock.bind((ip,port))
171 | return newsock
172 | except:
173 | return False
174 |
175 | #Return the class's primary server socket
176 | def listener(self):
177 | return self.ssock
178 |
179 | #Return the class's primary client socket
180 | def sender(self):
181 | return self.csock
182 |
183 | #Parse a URL, return the host and the page
184 | def parseURL(self,url):
185 | delim = '://'
186 | host = False
187 | page = False
188 |
189 | #Split the host and page
190 | try:
191 | (host,page) = url.split(delim)[1].split('/',1)
192 | page = '/' + page
193 | except:
194 | #If '://' is not in the url, then it's not a full URL, so assume that it's just a relative path
195 | page = url
196 |
197 | return (host,page)
198 |
199 | #Pull the name of the device type from a device type string
200 | #The device type string looks like: 'urn:schemas-upnp-org:device:WANDevice:1'
201 | def parseDeviceTypeName(self,string):
202 | delim1 = 'device:'
203 | delim2 = ':'
204 |
205 | if delim1 in string and not string.endswith(delim1):
206 | return string.split(delim1)[1].split(delim2,1)[0]
207 | return False
208 |
209 | #Pull the name of the service type from a service type string
210 | #The service type string looks like: 'urn:schemas-upnp-org:service:Layer3Forwarding:1'
211 | def parseServiceTypeName(self,string):
212 | delim1 = 'service:'
213 | delim2 = ':'
214 |
215 | if delim1 in string and not string.endswith(delim1):
216 | return string.split(delim1)[1].split(delim2,1)[0]
217 | return False
218 |
219 | #Pull the header info for the specified HTTP header - case insensitive
220 | def parseHeader(self,data,header):
221 | delimiter = "%s:" % header
222 | defaultRet = False
223 |
224 | lowerDelim = delimiter.lower()
225 | dataArray = data.split("\r\n")
226 |
227 | #Loop through each line of the headers
228 | for line in dataArray:
229 | lowerLine = line.lower()
230 | #Does this line start with the header we're looking for?
231 | if lowerLine.startswith(lowerDelim):
232 | try:
233 | return line.split(':',1)[1].strip()
234 | except:
235 | print "Failure parsing header data for %s" % header
236 | return defaultRet
237 |
238 | #Extract the contents of a single XML tag from the data
239 | def extractSingleTag(self,data,tag):
240 | startTag = "<%s" % tag
241 | endTag = "" % tag
242 |
243 | try:
244 | tmp = data.split(startTag)[1]
245 | index = tmp.find('>')
246 | if index != -1:
247 | index += 1
248 | return tmp[index:].split(endTag)[0].strip()
249 | except:
250 | pass
251 | return None
252 |
253 | #Parses SSDP notify and reply packets, and populates the ENUM_HOSTS dict
254 | def parseSSDPInfo(self,data,showUniq,verbose):
255 | hostFound = False
256 | foundLocation = False
257 | messageType = False
258 | xmlFile = False
259 | host = False
260 | page = False
261 | upnpType = None
262 | knownHeaders = {
263 | 'NOTIFY' : 'notification',
264 | 'HTTP/1.1 200 OK' : 'reply'
265 | }
266 |
267 | #Use the class defaults if these aren't specified
268 | if showUniq == False:
269 | showUniq = self.UNIQ
270 | if verbose == False:
271 | verbose = self.VERBOSE
272 |
273 | #Is the SSDP packet a notification, a reply, or neither?
274 | for text,messageType in knownHeaders.iteritems():
275 | if data.upper().startswith(text):
276 | break
277 | else:
278 | messageType = False
279 |
280 | #If this is a notification or a reply message...
281 | if messageType != False:
282 | #Get the host name and location of it's main UPNP XML file
283 | xmlFile = self.parseHeader(data,"LOCATION")
284 | upnpType = self.parseHeader(data,"SERVER")
285 |
286 | (host,page) = self.parseURL(xmlFile)
287 |
288 | if upnpType.find('SKY') == -1:
289 | return False
290 |
291 | #Update xmlFile to be description0.xml. Sky has two service points, and for now we only support the SkyPlay endpoint
292 | xmlFile = "http://"+host+"/description0.xml"
293 |
294 | #Sanity check to make sure we got all the info we need
295 | if xmlFile == False or host == False or page == False:
296 | print 'ERROR parsing recieved header:'
297 | print self.STARS
298 | print data
299 | print self.STARS
300 | print ''
301 | return False
302 |
303 | #Get the protocol in use (i.e., http, https, etc)
304 | protocol = xmlFile.split('://')[0]+'://'
305 |
306 | #Check if we've seen this host before; add to the list of hosts if:
307 | # 1. This is a new host
308 | # 2. We've already seen this host, but the uniq hosts setting is disabled
309 | for hostID,hostInfo in self.ENUM_HOSTS.iteritems():
310 | if hostInfo['name'] == host:
311 | hostFound = True
312 | if self.UNIQ:
313 | return False
314 |
315 | if (hostFound and not self.UNIQ) or not hostFound:
316 | #Get the new host's index number and create an entry in ENUM_HOSTS
317 | index = len(self.ENUM_HOSTS)
318 | self.ENUM_HOSTS[index] = {
319 | 'name' : host,
320 | 'dataComplete' : False,
321 | 'proto' : protocol,
322 | 'xmlFile' : xmlFile,
323 | 'serverType' : None,
324 | 'upnpServer' : upnpType,
325 | 'deviceList' : {}
326 | }
327 | #Be sure to update the command completer so we can tab complete through this host's data structure
328 | self.updateCmdCompleter(self.ENUM_HOSTS)
329 |
330 | #Print out some basic device info
331 | print "Found a Sky Box at "+host[:-6]
332 | return "complete"
333 |
334 | #Send GET request for a UPNP XML file
335 | def getXML(self,url):
336 |
337 | headers = {
338 | 'USER-AGENT':'SKY_skyplus',
339 | 'CONTENT-TYPE':'text/xml; charset="utf-8"'
340 | }
341 |
342 | try:
343 | #Use urllib2 for the request, it's awesome
344 | req = urllib2.Request(url, None, headers)
345 | response = urllib2.urlopen(req)
346 | output = response.read()
347 | headers = response.info()
348 | return (headers,output)
349 | except Exception, e:
350 | print "Request for '%s' failed: %s" % (url,e)
351 | return (False,False)
352 |
353 | #Send SOAP request
354 | def sendSOAP(self,hostName,serviceType,controlURL,actionName,actionArguments):
355 | argList = ''
356 | soapResponse = ''
357 |
358 | if '://' in controlURL:
359 | urlArray = controlURL.split('/',3)
360 | if len(urlArray) < 4:
361 | controlURL = '/'
362 | else:
363 | controlURL = '/' + urlArray[3]
364 |
365 |
366 | soapRequest = 'POST %s HTTP/1.1\r\n' % controlURL
367 |
368 | #Check if a port number was specified in the host name; default is port 80
369 | if ':' in hostName:
370 | hostNameArray = hostName.split(':')
371 | host = hostNameArray[0]
372 | try:
373 | port = int(hostNameArray[1])
374 | except:
375 | print 'Invalid port specified for host connection:',hostName[1]
376 | return False
377 | else:
378 | host = hostName
379 | port = 80
380 |
381 | #Create a string containing all of the SOAP action's arguments and values
382 | for arg,(val,dt) in actionArguments.iteritems():
383 | argList += '<%s>%s' % (arg,val,arg)
384 |
385 | #Create the SOAP request
386 | soapBody = ''\
387 | ''\
388 | ''\
389 | ''\
390 | '%s'\
391 | ''\
392 | ''\
393 | '' % (actionName,serviceType,argList,actionName)
394 |
395 |
396 | actualServiceType = serviceType[:-2] + "2:2"
397 |
398 | #Specify the headers to send with the request
399 | headers = {
400 | 'Host':hostName[:-6],
401 | 'Content-Length':len(soapBody),
402 | 'Content-Type':'text/xml; charset="utf-8"',
403 | 'User-Agent':'SKY_skyplus',
404 | 'SOAPACTION':'"%s#%s"' % (actualServiceType,actionName),
405 | 'connection':'close'
406 | }
407 |
408 |
409 | #Generate the final payload
410 | for head,value in headers.iteritems():
411 | soapRequest += '%s: %s\r\n' % (head,value)
412 | soapRequest += '\r\n%s' % soapBody
413 |
414 | #Send data and go into recieve loop
415 | try:
416 | sock = socket(AF_INET,SOCK_STREAM)
417 | sock.connect((host,port))
418 | sock.send(soapRequest)
419 | while True:
420 | data = sock.recv(self.MAX_RECV)
421 | if not data:
422 | break
423 | else:
424 | soapResponse += data
425 | if self.soapEnd.search(soapResponse.lower()) != None:
426 | break
427 | sock.close()
428 |
429 | (header,body) = soapResponse.split('\r\n\r\n',1)
430 |
431 | if not header.upper().startswith('HTTP/1.1 200'):
432 | print 'SOAP request failed with error code:',header.split('\r\n')[0].split(' ',1)[1]
433 | errorMsg = self.extractSingleTag(body,'errorDescription')
434 | if errorMsg:
435 | print 'SOAP error message:',errorMsg
436 | return False
437 | else:
438 | return body
439 | except Exception, e:
440 | print 'Caught socket exception:',e
441 | sock.close()
442 | return False
443 | except KeyboardInterrupt:
444 | sock.close()
445 | return False
446 |
447 |
448 | #Display all info for a given host
449 | def showCompleteHostInfo(self,index,fp):
450 | na = 'N/A'
451 | serviceKeys = ['controlURL','eventSubURL','serviceId','SCPDURL','fullName']
452 | if fp == False:
453 | fp = sys.stdout
454 |
455 | if index < 0 or index >= len(self.ENUM_HOSTS):
456 | fp.write('Specified host does not exist...\n')
457 | return
458 | try:
459 | hostInfo = self.ENUM_HOSTS[index]
460 | if hostInfo['dataComplete'] == False:
461 | print "Cannot show all host info because we don't have it all yet. Try running 'host info %d' first...\n" % index
462 | fp.write('Host name: %s\n' % hostInfo['name'])
463 | fp.write('UPNP XML File: %s\n\n' % hostInfo['xmlFile'])
464 |
465 | fp.write('\nDevice information:\n')
466 | for deviceName,deviceStruct in hostInfo['deviceList'].iteritems():
467 | fp.write('\tDevice Name: %s\n' % deviceName)
468 | for serviceName,serviceStruct in deviceStruct['services'].iteritems():
469 | fp.write('\t\tService Name: %s\n' % serviceName)
470 | for key in serviceKeys:
471 | fp.write('\t\t\t%s: %s\n' % (key,serviceStruct[key]))
472 | fp.write('\t\t\tServiceActions:\n')
473 | for actionName,actionStruct in serviceStruct['actions'].iteritems():
474 | fp.write('\t\t\t\t%s\n' % actionName)
475 | for argName,argStruct in actionStruct['arguments'].iteritems():
476 | fp.write('\t\t\t\t\t%s \n' % argName)
477 | for key,val in argStruct.iteritems():
478 | if key == 'relatedStateVariable':
479 | fp.write('\t\t\t\t\t\t%s:\n' % val)
480 | for k,v in serviceStruct['serviceStateVariables'][val].iteritems():
481 | fp.write('\t\t\t\t\t\t\t%s: %s\n' % (k,v))
482 | else:
483 | fp.write('\t\t\t\t\t\t%s: %s\n' % (key,val))
484 |
485 | except Exception, e:
486 | print 'Caught exception while showing host info:',e
487 |
488 | #Wrapper function...
489 | def getHostInfo(self,xmlData,xmlHeaders,index):
490 | if self.ENUM_HOSTS[index]['dataComplete'] == True:
491 | return
492 |
493 | if index >= 0 and index < len(self.ENUM_HOSTS):
494 | try:
495 | xmlRoot = minidom.parseString(xmlData)
496 | self.parseDeviceInfo(xmlRoot,index)
497 | self.ENUM_HOSTS[index]['serverType'] = xmlHeaders.getheader('Server')
498 | self.ENUM_HOSTS[index]['dataComplete'] = True
499 | return True
500 | except Exception, e:
501 | print 'Caught exception while getting host info:',e
502 | return False
503 |
504 | #Parse device info from the retrieved XML file
505 | def parseDeviceInfo(self,xmlRoot,index):
506 | deviceEntryPointer = False
507 | devTag = "device"
508 | deviceType = "deviceType"
509 | deviceListEntries = "deviceList"
510 | deviceTags = ["friendlyName","modelDescription","modelName","modelNumber","modelURL","presentationURL","UDN","UPC","manufacturer","manufacturerURL"]
511 |
512 | #Find all device entries listed in the XML file
513 | for device in xmlRoot.getElementsByTagName(devTag):
514 | try:
515 | #Get the deviceType string
516 | deviceTypeName = str(device.getElementsByTagName(deviceType)[0].childNodes[0].data)
517 | except:
518 | continue
519 |
520 | #Pull out the action device name from the deviceType string
521 | deviceDisplayName = self.parseDeviceTypeName(deviceTypeName)
522 | if not deviceDisplayName:
523 | continue
524 |
525 | #Create a new device entry for this host in the ENUM_HOSTS structure
526 | deviceEntryPointer = self.ENUM_HOSTS[index][deviceListEntries][deviceDisplayName] = {}
527 | deviceEntryPointer['fullName'] = deviceTypeName
528 |
529 | #Parse out all the device tags for that device
530 | for tag in deviceTags:
531 | try:
532 | deviceEntryPointer[tag] = str(device.getElementsByTagName(tag)[0].childNodes[0].data)
533 | except Exception, e:
534 | if self.VERBOSE:
535 | print 'Device',deviceEntryPointer['fullName'],'does not have a',tag
536 | continue
537 | #Get a list of all services for this device listing
538 | self.parseServiceList(device,deviceEntryPointer,index)
539 |
540 | return
541 |
542 | #Parse the list of services specified in the XML file
543 | def parseServiceList(self,xmlRoot,device,index):
544 | serviceEntryPointer = False
545 | dictName = "services"
546 | serviceListTag = "serviceList"
547 | serviceTag = "service"
548 | serviceNameTag = "serviceType"
549 | serviceTags = ["serviceId","controlURL","eventSubURL","SCPDURL"]
550 |
551 | try:
552 | device[dictName] = {}
553 | #Get a list of all services offered by this device
554 | for service in xmlRoot.getElementsByTagName(serviceListTag)[0].getElementsByTagName(serviceTag):
555 | #Get the full service descriptor
556 | serviceName = str(service.getElementsByTagName(serviceNameTag)[0].childNodes[0].data)
557 |
558 | #Get the service name from the service descriptor string
559 | serviceDisplayName = self.parseServiceTypeName(serviceName)
560 | if not serviceDisplayName:
561 | continue
562 |
563 | #Create new service entry for the device in ENUM_HOSTS
564 | serviceEntryPointer = device[dictName][serviceDisplayName] = {}
565 | serviceEntryPointer['fullName'] = serviceName
566 |
567 | #Get all of the required service info and add it to ENUM_HOSTS
568 | for tag in serviceTags:
569 | serviceEntryPointer[tag] = str(service.getElementsByTagName(tag)[0].childNodes[0].data)
570 |
571 | #Get specific service info about this service
572 | self.parseServiceInfo(serviceEntryPointer,index)
573 | except Exception, e:
574 | print 'Caught exception while parsing device service list:',e
575 |
576 | #Parse details about each service (arguements, variables, etc)
577 | def parseServiceInfo(self,service,index):
578 | argIndex = 0
579 | argTags = ['direction','relatedStateVariable']
580 | actionList = 'actionList'
581 | actionTag = 'action'
582 | nameTag = 'name'
583 | argumentList = 'argumentList'
584 | argumentTag = 'argument'
585 |
586 | #Get the full path to the service's XML file
587 | xmlFile = self.ENUM_HOSTS[index]['proto'] + self.ENUM_HOSTS[index]['name']
588 | if not xmlFile.endswith('/') and not service['SCPDURL'].startswith('/'):
589 | xmlFile += '/'
590 | if self.ENUM_HOSTS[index]['proto'] in service['SCPDURL']:
591 | xmlFile = service['SCPDURL']
592 | else:
593 | xmlFile += service['SCPDURL']
594 | service['actions'] = {}
595 |
596 | #Get the XML file that describes this service
597 | (xmlHeaders,xmlData) = self.getXML(xmlFile)
598 | if not xmlData:
599 | print 'Failed to retrieve service descriptor located at:',xmlFile
600 | return False
601 |
602 | try:
603 | xmlRoot = minidom.parseString(xmlData)
604 |
605 | #Get a list of actions for this service
606 | try:
607 | actionList = xmlRoot.getElementsByTagName(actionList)[0]
608 | except:
609 | print 'Failed to retrieve action list for service %s!' % service['fullName']
610 | return False
611 | actions = actionList.getElementsByTagName(actionTag)
612 | if actions == []:
613 | print 'Failed to retrieve actions from service actions list for service %s!' % service['fullName']
614 | return False
615 |
616 | #Parse all actions in the service's action list
617 | for action in actions:
618 | #Get the action's name
619 | try:
620 | actionName = str(action.getElementsByTagName(nameTag)[0].childNodes[0].data).strip()
621 | except:
622 | print 'Failed to obtain service action name (%s)!' % service['fullName']
623 | continue
624 |
625 | #Add the action to the ENUM_HOSTS dictonary
626 | service['actions'][actionName] = {}
627 | service['actions'][actionName]['arguments'] = {}
628 |
629 | #Parse all of the action's arguments
630 | try:
631 | argList = action.getElementsByTagName(argumentList)[0]
632 | except:
633 | #Some actions may take no arguments, so continue without raising an error here...
634 | continue
635 |
636 | #Get all the arguments in this action's argument list
637 | arguments = argList.getElementsByTagName(argumentTag)
638 | if arguments == []:
639 | if self.VERBOSE:
640 | print 'Action',actionName,'has no arguments!'
641 | continue
642 |
643 | #Loop through the action's arguments, appending them to the ENUM_HOSTS dictionary
644 | for argument in arguments:
645 | try:
646 | argName = str(argument.getElementsByTagName(nameTag)[0].childNodes[0].data)
647 | except:
648 | print 'Failed to get argument name for',actionName
649 | continue
650 | service['actions'][actionName]['arguments'][argName] = {}
651 |
652 | #Get each required argument tag value and add them to ENUM_HOSTS
653 | for tag in argTags:
654 | try:
655 | service['actions'][actionName]['arguments'][argName][tag] = str(argument.getElementsByTagName(tag)[0].childNodes[0].data)
656 | except:
657 | print 'Failed to find tag %s for argument %s!' % (tag,argName)
658 | continue
659 |
660 | #Parse all of the state variables for this service
661 | self.parseServiceStateVars(xmlRoot,service)
662 |
663 | except Exception, e:
664 | print 'Caught exception while parsing Service info for service %s: %s' % (service['fullName'],str(e))
665 | return False
666 |
667 | return True
668 |
669 | #Get info about a service's state variables
670 | def parseServiceStateVars(self,xmlRoot,servicePointer):
671 |
672 | na = 'N/A'
673 | varVals = ['sendEvents','dataType','defaultValue','allowedValues']
674 | serviceStateTable = 'serviceStateTable'
675 | stateVariable = 'stateVariable'
676 | nameTag = 'name'
677 | dataType = 'dataType'
678 | sendEvents = 'sendEvents'
679 | allowedValueList = 'allowedValueList'
680 | allowedValue = 'allowedValue'
681 | allowedValueRange = 'allowedValueRange'
682 | minimum = 'minimum'
683 | maximum = 'maximum'
684 |
685 | #Create the serviceStateVariables entry for this service in ENUM_HOSTS
686 | servicePointer['serviceStateVariables'] = {}
687 |
688 | #Get a list of all state variables associated with this service
689 | try:
690 | stateVars = xmlRoot.getElementsByTagName(serviceStateTable)[0].getElementsByTagName(stateVariable)
691 | except:
692 | #Don't necessarily want to throw an error here, as there may be no service state variables
693 | return False
694 |
695 | #Loop through all state variables
696 | for var in stateVars:
697 | for tag in varVals:
698 | #Get variable name
699 | try:
700 | varName = str(var.getElementsByTagName(nameTag)[0].childNodes[0].data)
701 | except:
702 | print 'Failed to get service state variable name for service %s!' % servicePointer['fullName']
703 | continue
704 |
705 | servicePointer['serviceStateVariables'][varName] = {}
706 | try:
707 | servicePointer['serviceStateVariables'][varName]['dataType'] = str(var.getElementsByTagName(dataType)[0].childNodes[0].data)
708 | except:
709 | servicePointer['serviceStateVariables'][varName]['dataType'] = na
710 | try:
711 | servicePointer['serviceStateVariables'][varName]['sendEvents'] = str(var.getElementsByTagName(sendEvents)[0].childNodes[0].data)
712 | except:
713 | servicePointer['serviceStateVariables'][varName]['sendEvents'] = na
714 |
715 | servicePointer['serviceStateVariables'][varName][allowedValueList] = []
716 |
717 | #Get a list of allowed values for this variable
718 | try:
719 | vals = var.getElementsByTagName(allowedValueList)[0].getElementsByTagName(allowedValue)
720 | except:
721 | pass
722 | else:
723 | #Add the list of allowed values to the ENUM_HOSTS dictionary
724 | for val in vals:
725 | servicePointer['serviceStateVariables'][varName][allowedValueList].append(str(val.childNodes[0].data))
726 |
727 | #Get allowed value range for this variable
728 | try:
729 | valList = var.getElementsByTagName(allowedValueRange)[0]
730 | except:
731 | pass
732 | else:
733 | #Add the max and min values to the ENUM_HOSTS dictionary
734 | servicePointer['serviceStateVariables'][varName][allowedValueRange] = []
735 | try:
736 | servicePointer['serviceStateVariables'][varName][allowedValueRange].append(str(valList.getElementsByTagName(minimum)[0].childNodes[0].data))
737 | servicePointer['serviceStateVariables'][varName][allowedValueRange].append(str(valList.getElementsByTagName(maximum)[0].childNodes[0].data))
738 | except:
739 | pass
740 | return True
741 |
742 | #Update the command completer
743 | def updateCmdCompleter(self,struct):
744 | indexOnlyList = {
745 | 'host' : ['get','details','summary'],
746 | 'save' : ['info']
747 | }
748 | hostCommand = 'host'
749 | subCommandList = ['info']
750 | sendCommand = 'send'
751 |
752 | try:
753 | structPtr = {}
754 | topLevelKeys = {}
755 | for key,val in struct.iteritems():
756 | structPtr[str(key)] = val
757 | topLevelKeys[str(key)] = None
758 |
759 | #Update the subCommandList
760 | for subcmd in subCommandList:
761 | self.completer.commands[hostCommand][subcmd] = None
762 | self.completer.commands[hostCommand][subcmd] = structPtr
763 |
764 | #Update the indexOnlyList
765 | for cmd,data in indexOnlyList.iteritems():
766 | for subcmd in data:
767 | self.completer.commands[cmd][subcmd] = topLevelKeys
768 |
769 | #This is for updating the sendCommand key
770 | structPtr = {}
771 | for hostIndex,hostData in struct.iteritems():
772 | host = str(hostIndex)
773 | structPtr[host] = {}
774 | if hostData.has_key('deviceList'):
775 | for device,deviceData in hostData['deviceList'].iteritems():
776 | structPtr[host][device] = {}
777 | if deviceData.has_key('services'):
778 | for service,serviceData in deviceData['services'].iteritems():
779 | structPtr[host][device][service] = {}
780 | if serviceData.has_key('actions'):
781 | for action,actionData in serviceData['actions'].iteritems():
782 | structPtr[host][device][service][action] = None
783 | self.completer.commands[hostCommand][sendCommand] = structPtr
784 | except Exception,e:
785 | print "Error updating command completer structure; some command completion features might not work..."
786 | return
787 |
788 | ################## Action Functions ######################
789 | #These functions handle user commands from the shell
790 |
791 | #Actively search for UPNP devices
792 | def msearch(argc,argv,hp):
793 | defaultST = "upnp:rootdevice"
794 | #Fix coda "
795 | st = "schemas-upnp-org"
796 | myip = ''
797 | lport = hp.port
798 |
799 | if argc >= 3:
800 | if argc == 4:
801 | st = argv[1]
802 | searchType = argv[2]
803 | searchName = argv[3]
804 | else:
805 | searchType = argv[1]
806 | searchName = argv[2]
807 | st = "urn:%s:%s:%s:%s" % (st,searchType,searchName,hp.UPNP_VERSION.split('.')[0])
808 | else:
809 | st = defaultST
810 |
811 | #Build the request
812 | request = "M-SEARCH * HTTP/1.1\r\n"\
813 | "HOST:%s:%d\r\n"\
814 | "ST:%s\r\n" % (hp.ip,hp.port,st)
815 | for header,value in hp.msearchHeaders.iteritems():
816 | request += header + ':' + value + "\r\n"
817 | request += "\r\n"
818 |
819 | print "Entering discovery mode for '%s', Ctl+C to stop..." % st
820 | print ''
821 |
822 | #Have to create a new socket since replies will be sent directly to our IP, not the multicast IP
823 | server = hp.createNewListener(myip,lport)
824 | if server == False:
825 | print 'Failed to bind port %d' % lport
826 | return
827 |
828 | hp.send(request,server)
829 | while True:
830 | try:
831 | hp.parseSSDPInfo(hp.listen(1024,server),False,False)
832 | except Exception, e:
833 | print 'Discover mode halted...'
834 | break
835 |
836 | #Passively listen for UPNP NOTIFY packets
837 | def pcap(argc,argv,hp):
838 | print 'Waiting for Sky+HD Box. This may take up to 30 seconds...'
839 | search = True
840 | while search:
841 | try:
842 | result = hp.parseSSDPInfo(hp.listen(1024,False),False,False)
843 | if result == 'complete':
844 | search = False
845 | except Exception, e:
846 | print "Search halted..."
847 | break
848 |
849 | #Manipulate M-SEARCH header values
850 | def head(argc,argv,hp):
851 | if argc >= 2:
852 | action = argv[1]
853 | #Show current headers
854 | if action == 'show':
855 | for header,value in hp.msearchHeaders.iteritems():
856 | print header,':',value
857 | return
858 | #Delete the specified header
859 | elif action == 'del':
860 | if argc == 3:
861 | header = argv[2]
862 | if hp.msearchHeaders.has_key(header):
863 | del hp.msearchHeaders[header]
864 | print '%s removed from header list' % header
865 | return
866 | else:
867 | print '%s is not in the current header list' % header
868 | return
869 | #Create/set a headers
870 | elif action == 'set':
871 | if argc == 4:
872 | header = argv[2]
873 | value = argv[3]
874 | hp.msearchHeaders[header] = value
875 | print "Added header: '%s:%s" % (header,value)
876 | return
877 |
878 | showHelp(argv[0])
879 |
880 | #Manipulate application settings
881 | def seti(argc,argv,hp):
882 | if argc >= 2:
883 | action = argv[1]
884 | if action == 'uniq':
885 | hp.UNIQ = toggleVal(hp.UNIQ)
886 | print "Show unique hosts set to: %s" % hp.UNIQ
887 | return
888 | elif action == 'debug':
889 | hp.DEBUG = toggleVal(hp.DEBUG)
890 | print "Debug mode set to: %s" % hp.DEBUG
891 | return
892 | elif action == 'verbose':
893 | hp.VERBOSE = toggleVal(hp.VERBOSE)
894 | print "Verbose mode set to: %s" % hp.VERBOSE
895 | return
896 | elif action == 'version':
897 | if argc == 3:
898 | hp.UPNP_VERSION = argv[2]
899 | print 'UPNP version set to: %s' % hp.UPNP_VERSION
900 | else:
901 | showHelp(argv[0])
902 | return
903 | elif action == 'iface':
904 | if argc == 3:
905 | hp.IFACE = argv[2]
906 | print 'Interface set to %s, re-binding sockets...' % hp.IFACE
907 | if hp.initSockets(hp.ip,hp.port,hp.IFACE):
908 | print 'Interface change successful!'
909 | else:
910 | print 'Failed to bind new interface - are you sure you have root privilages??'
911 | hp.IFACE = None
912 | return
913 | elif action == 'socket':
914 | if argc == 3:
915 | try:
916 | (ip,port) = argv[2].split(':')
917 | port = int(port)
918 | hp.ip = ip
919 | hp.port = port
920 | hp.cleanup()
921 | if hp.initSockets(ip,port,hp.IFACE) == False:
922 | print "Setting new socket %s:%d failed!" % (ip,port)
923 | else:
924 | print "Using new socket: %s:%d" % (ip,port)
925 | except Exception, e:
926 | print 'Caught exception setting new socket:',e
927 | return
928 | elif action == 'show':
929 | print 'Multicast IP: ',hp.ip
930 | print 'Multicast Port: ',hp.port
931 | print 'Network Interface: ',hp.IFACE
932 | print 'Number of known hosts: ',len(hp.ENUM_HOSTS)
933 | print 'UPNP Version: ',hp.UPNP_VERSION
934 | print 'Debug mode: ',hp.DEBUG
935 | print 'Verbose mode: ',hp.VERBOSE
936 | print 'Show only unique hosts:',hp.UNIQ
937 | print 'Using log file: ',hp.LOG_FILE
938 | return
939 |
940 | showHelp(argv[0])
941 | return
942 |
943 | #Host command. It's kind of big.
944 | def host(argc,argv,hp):
945 |
946 | indexList = []
947 | indexError = "Host index out of range. Try the 'host list' command to get a list of known hosts"
948 | if argc >= 2:
949 | action = argv[1]
950 | if action == 'list':
951 | if len(hp.ENUM_HOSTS) == 0:
952 | print "No known hosts - try running the 'msearch' or 'pcap' commands"
953 | return
954 | for index,hostInfo in hp.ENUM_HOSTS.iteritems():
955 | print "\t[%d] %s" % (index,hostInfo['name'])
956 | return
957 | elif action == 'details':
958 | hostInfo = False
959 | if argc == 3:
960 | try:
961 | index = int(argv[2])
962 | except Exception, e:
963 | print indexError
964 | return
965 |
966 | if index < 0 or index >= len(hp.ENUM_HOSTS):
967 | print indexError
968 | return
969 | hostInfo = hp.ENUM_HOSTS[index]
970 |
971 | try:
972 | #If this host data is already complete, just display it
973 | if hostInfo['dataComplete'] == True:
974 | hp.showCompleteHostInfo(index,False)
975 | else:
976 | print "Can't show host info because I don't have it. Please run 'host get %d'" % index
977 | except KeyboardInterrupt, e:
978 | pass
979 | return
980 |
981 | elif action == 'summary':
982 | if argc == 3:
983 |
984 | try:
985 | index = int(argv[2])
986 | hostInfo = hp.ENUM_HOSTS[index]
987 | except:
988 | print indexError
989 | return
990 |
991 | print 'Host:',hostInfo['name']
992 | print 'XML File:',hostInfo['xmlFile']
993 | for deviceName,deviceData in hostInfo['deviceList'].iteritems():
994 | print deviceName
995 | for k,v in deviceData.iteritems():
996 | try:
997 | v.has_key(False)
998 | except:
999 | print "\t%s: %s" % (k,v)
1000 | print ''
1001 | return
1002 |
1003 | elif action == 'info':
1004 | output = hp.ENUM_HOSTS
1005 | dataStructs = []
1006 | for arg in argv[2:]:
1007 | try:
1008 | arg = int(arg)
1009 | except:
1010 | pass
1011 | output = output[arg]
1012 | try:
1013 | for k,v in output.iteritems():
1014 | try:
1015 | v.has_key(False)
1016 | dataStructs.append(k)
1017 | except:
1018 | print k,':',v
1019 | continue
1020 | except:
1021 | print output
1022 |
1023 | for struct in dataStructs:
1024 | print struct,': {}'
1025 | return
1026 |
1027 | elif action == 'get':
1028 | hostInfo = False
1029 | if argc == 3:
1030 | try:
1031 | index = int(argv[2])
1032 | except:
1033 | print indexError
1034 | return
1035 | if index < 0 or index >= len(hp.ENUM_HOSTS):
1036 | print "Host index out of range. Try the 'host list' command to get a list of known hosts"
1037 | return
1038 | else:
1039 | hostInfo = hp.ENUM_HOSTS[index]
1040 |
1041 | #If this host data is already complete, just display it
1042 | if hostInfo['dataComplete'] == True:
1043 | print 'Data for this host has already been enumerated!'
1044 | return
1045 |
1046 | try:
1047 | #Get extended device and service information
1048 | if hostInfo != False:
1049 | print "Loading Sky+HD box info for %s (this could take a few seconds)..." % hostInfo['name']
1050 | if hostInfo['dataComplete'] == False:
1051 | (xmlHeaders,xmlData) = hp.getXML(hostInfo['xmlFile'])
1052 | if xmlData == False:
1053 | print 'Failed to request host XML file:',hostInfo['xmlFile']
1054 | return
1055 | if hp.getHostInfo(xmlData,xmlHeaders,index) == False:
1056 | print "Failed to get device/service info for %s..." % hostInfo['name']
1057 | return
1058 | print 'Successfully loaded control data!'
1059 | hp.updateCmdCompleter(hp.ENUM_HOSTS)
1060 | return
1061 | except KeyboardInterrupt, e:
1062 | return
1063 |
1064 | elif action == 'send':
1065 | #Send SOAP requests
1066 | index = False
1067 | inArgCounter = 0
1068 |
1069 | if argc != 6:
1070 | showHelp(argv[0])
1071 | return
1072 | else:
1073 | try:
1074 | index = int(argv[2])
1075 | except:
1076 | print indexError
1077 | return
1078 | deviceName = argv[3]
1079 | serviceName = argv[4]
1080 | actionName = argv[5]
1081 | hostInfo = hp.ENUM_HOSTS[index]
1082 | actionArgs = False
1083 | sendArgs = {}
1084 | retTags = []
1085 | controlURL = False
1086 | fullServiceName = False
1087 |
1088 | #Get the service control URL and full service name
1089 | try:
1090 | controlURL = hostInfo['proto'] + hostInfo['name']
1091 | controlURL2 = hostInfo['deviceList'][deviceName]['services'][serviceName]['controlURL']
1092 | if not controlURL.endswith('/') and not controlURL2.startswith('/'):
1093 | controlURL += '/'
1094 | controlURL += controlURL2
1095 | except Exception,e:
1096 | print 'Caught exception:',e
1097 | print "Are you sure you've run 'host get %d' and specified the correct service name?" % index
1098 | return False
1099 |
1100 | #Get action info
1101 | try:
1102 | actionArgs = hostInfo['deviceList'][deviceName]['services'][serviceName]['actions'][actionName]['arguments']
1103 | fullServiceName = hostInfo['deviceList'][deviceName]['services'][serviceName]['fullName']
1104 | except Exception,e:
1105 | print 'Caught exception:',e
1106 | print "Are you sure you've specified the correct action?"
1107 | return False
1108 |
1109 | for argName,argVals in actionArgs.iteritems():
1110 | actionStateVar = argVals['relatedStateVariable']
1111 | stateVar = hostInfo['deviceList'][deviceName]['services'][serviceName]['serviceStateVariables'][actionStateVar]
1112 |
1113 |
1114 | if argVals['direction'].lower() == 'in':
1115 | if argName != "InstanceID":
1116 | print "Required argument:"
1117 | print "\tArgument Name: ",argName
1118 | print "\tData Type: ",stateVar['dataType']
1119 | if stateVar.has_key('allowedValueList'):
1120 | print "\tAllowed Values:",stateVar['allowedValueList']
1121 | if stateVar.has_key('allowedValueRange'):
1122 | print "\tValue Min: ",stateVar['allowedValueRange'][0]
1123 | print "\tValue Max: ",stateVar['allowedValueRange'][1]
1124 | if stateVar.has_key('defaultValue'):
1125 | print "\tDefault Value: ",stateVar['defaultValue']
1126 | prompt = "\tSet %s value to: " % argName
1127 | try:
1128 | #Get user input for the argument value
1129 | if argName == "InstanceID":
1130 | argc = 1
1131 | argv = ["0"]
1132 | else:
1133 | (argc,argv) = getUserInput(hp,prompt)
1134 |
1135 | if argv == None:
1136 | print 'Stopping send request...'
1137 | return
1138 | uInput = ''
1139 |
1140 | if argc > 0:
1141 | inArgCounter += 1
1142 |
1143 | for val in argv:
1144 | uInput += val + ' '
1145 |
1146 | uInput = uInput.strip()
1147 | if stateVar['dataType'] == 'bin.base64' and uInput:
1148 | uInput = base64.encodestring(uInput)
1149 |
1150 | sendArgs[argName] = (uInput.strip(),stateVar['dataType'])
1151 | except KeyboardInterrupt:
1152 | return
1153 | print ''
1154 | else:
1155 | retTags.append((argName,stateVar['dataType']))
1156 |
1157 | #Remove the above inputs from the command history
1158 | while inArgCounter:
1159 | readline.remove_history_item(readline.get_current_history_length()-1)
1160 | inArgCounter -= 1
1161 |
1162 | #print 'Requesting',controlURL
1163 | soapResponse = hp.sendSOAP(hostInfo['name'],fullServiceName,controlURL,actionName,sendArgs)
1164 | if soapResponse != False:
1165 | #It's easier to just parse this ourselves...
1166 | for (tag,dataType) in retTags:
1167 | tagValue = hp.extractSingleTag(soapResponse,tag)
1168 | if dataType == 'bin.base64' and tagValue != None:
1169 | tagValue = base64.decodestring(tagValue)
1170 | print tag,':',tagValue
1171 | return
1172 |
1173 |
1174 | showHelp(argv[0])
1175 | return
1176 |
1177 | #Save data
1178 | def save(argc,argv,hp):
1179 | suffix = '%s_%s.mir'
1180 | uniqName = ''
1181 | saveType = ''
1182 | fnameIndex = 3
1183 |
1184 | if argc >= 2:
1185 | if argv[1] == 'help':
1186 | showHelp(argv[0])
1187 | return
1188 | elif argv[1] == 'data':
1189 | saveType = 'struct'
1190 | if argc == 3:
1191 | index = argv[2]
1192 | else:
1193 | index = 'data'
1194 | elif argv[1] == 'info':
1195 | saveType = 'info'
1196 | fnameIndex = 4
1197 | if argc >= 3:
1198 | try:
1199 | index = int(argv[2])
1200 | except Exception, e:
1201 | print 'Host index is not a number!'
1202 | showHelp(argv[0])
1203 | return
1204 | else:
1205 | showHelp(argv[0])
1206 | return
1207 |
1208 | if argc == fnameIndex:
1209 | uniqName = argv[fnameIndex-1]
1210 | else:
1211 | uniqName = index
1212 | else:
1213 | showHelp(argv[0])
1214 | return
1215 |
1216 | fileName = suffix % (saveType,uniqName)
1217 | if os.path.exists(fileName):
1218 | print "File '%s' already exists! Please try again..." % fileName
1219 | return
1220 | if saveType == 'struct':
1221 | try:
1222 | fp = open(fileName,'w')
1223 | pickle.dump(hp.ENUM_HOSTS,fp)
1224 | fp.close()
1225 | print "Host data saved to '%s'" % fileName
1226 | except Exception, e:
1227 | print 'Caught exception saving host data:',e
1228 | elif saveType == 'info':
1229 | try:
1230 | fp = open(fileName,'w')
1231 | hp.showCompleteHostInfo(index,fp)
1232 | fp.close()
1233 | print "Host info for '%s' saved to '%s'" % (hp.ENUM_HOSTS[index]['name'],fileName)
1234 | except Exception, e:
1235 | print 'Failed to save host info:',e
1236 | return
1237 | else:
1238 | showHelp(argv[0])
1239 |
1240 | return
1241 |
1242 | #Parse control data
1243 | def control(argc,argv,hp):
1244 | ptr = eval("host")
1245 | args = ['host','send','0','SkyControl','SkyPlay',argv[1].capitalize()]
1246 | ptr(6,args,hp)
1247 | print "Sent "+argv[1].capitalize()+" command"
1248 |
1249 | #Load data
1250 | def load(argc,argv,hp):
1251 | if argc == 2 and argv[1] != 'help':
1252 | loadFile = argv[1]
1253 |
1254 | try:
1255 | fp = open(loadFile,'r')
1256 | hp.ENUM_HOSTS = {}
1257 | hp.ENUM_HOSTS = pickle.load(fp)
1258 | fp.close()
1259 | hp.updateCmdCompleter(hp.ENUM_HOSTS)
1260 | print 'Host data restored:'
1261 | print ''
1262 | host(2,['host','list'],hp)
1263 | return
1264 | except Exception, e:
1265 | print 'Caught exception while restoring host data:',e
1266 |
1267 | showHelp(argv[0])
1268 |
1269 | #Open log file
1270 | def log(argc,argv,hp):
1271 | if argc == 2:
1272 | logFile = argv[1]
1273 | try:
1274 | fp = open(logFile,'a')
1275 | except Exception, e:
1276 | print 'Failed to open %s for logging: %s' % (logFile,e)
1277 | return
1278 | try:
1279 | hp.LOG_FILE = fp
1280 | ts = []
1281 | for x in time.localtime():
1282 | ts.append(x)
1283 | theTime = "%d-%d-%d, %d:%d:%d" % (ts[0],ts[1],ts[2],ts[3],ts[4],ts[5])
1284 | hp.LOG_FILE.write("\n### Logging started at: %s ###\n" % theTime)
1285 | except Exception, e:
1286 | print "Cannot write to file '%s': %s" % (logFile,e)
1287 | hp.LOG_FILE = False
1288 | return
1289 | print "Commands will be logged to: '%s'" % logFile
1290 | return
1291 | showHelp(argv[0])
1292 |
1293 | #Show help
1294 | def help(argc,argv,hp):
1295 | showHelp(False)
1296 |
1297 | #Debug, disabled by default
1298 | def debug(argc,argv,hp):
1299 | command = ''
1300 | if hp.DEBUG == False:
1301 | print 'Debug is disabled! To enable, try the seti command...'
1302 | return
1303 | if argc == 1:
1304 | showHelp(argv[0])
1305 | else:
1306 | for cmd in argv[1:]:
1307 | command += cmd + ' '
1308 | command = command.strip()
1309 | print eval(command)
1310 | return
1311 | #Quit!
1312 | def exit(argc,argv,hp):
1313 | quit(argc,argv,hp)
1314 |
1315 | #Quit!
1316 | def quit(argc,argv,hp):
1317 | if argc == 2 and argv[1] == 'help':
1318 | showHelp(argv[0])
1319 | return
1320 | print 'Bye!'
1321 | hp.cleanup()
1322 | sys.exit(0)
1323 |
1324 | ################ End Action Functions ######################
1325 |
1326 | #Show command help
1327 | def showHelp(command):
1328 | #Detailed help info for each command
1329 | helpInfo = {
1330 | 'help' : {
1331 | 'longListing':
1332 | 'Description:\n'\
1333 | '\tLists available commands and command descriptions\n\n'\
1334 | 'Usage:\n'\
1335 | '\t%s\n'\
1336 | '\t help',
1337 | 'quickView':
1338 | 'Show program help'
1339 | },
1340 | 'control' : {
1341 | 'longListing':
1342 | 'Description:\n'\
1343 | '\tSend a control message to the Sky+HD Box\n\n'\
1344 | 'Usage:\n'\
1345 | '\t%s',
1346 | 'quickView':
1347 | 'Send a control message to the Sky+HD Box'
1348 | },
1349 | 'quit' : {
1350 | 'longListing' :
1351 | 'Description:\n'\
1352 | '\tQuits the interactive shell\n\n'\
1353 | 'Usage:\n'\
1354 | '\t%s',
1355 | 'quickView' :
1356 | 'Exit this shell'
1357 | },
1358 | 'exit' : {
1359 |
1360 | 'longListing' :
1361 | 'Description:\n'\
1362 | '\tExits the interactive shell\n\n'\
1363 | 'Usage:\n'\
1364 | '\t%s',
1365 | 'quickView' :
1366 | 'Exit this shell'
1367 | },
1368 | 'save' : {
1369 | 'longListing' :
1370 | 'Description:\n'\
1371 | '\tSaves current host information to disk.\n\n'\
1372 | 'Usage:\n'\
1373 | '\t%s > [file prefix]\n'\
1374 | "\tSpecifying 'data' will save the raw host data to a file suitable for importing later via 'load'\n"\
1375 | "\tSpecifying 'info' will save data for the specified host in a human-readable format\n"\
1376 | "\tSpecifying a file prefix will save files in for format of 'struct_[prefix].mir' and info_[prefix].mir\n\n"\
1377 | 'Example:\n'\
1378 | '\t> save data wrt54g\n'\
1379 | '\t> save info 0 wrt54g\n\n'\
1380 | 'Notes:\n'\
1381 | "\to Data files are saved as 'struct_[prefix].mir'; info files are saved as 'info_[prefix].mir.'\n"\
1382 | "\to If no prefix is specified, the host index number will be used for the prefix.\n"\
1383 | "\to The data saved by the 'save info' command is the same as the output of the 'host details' command.",
1384 | 'quickView' :
1385 | 'Save current host data to file'
1386 | },
1387 | 'seti' : {
1388 | 'longListing' :
1389 | 'Description:\n'\
1390 | '\tAllows you to view and edit application settings.\n\n'\
1391 | 'Usage:\n'\
1392 | '\t%s | iface | socket >\n'\
1393 | "\t'show' displays the current program settings\n"\
1394 | "\t'uniq' toggles the show-only-uniq-hosts setting when discovering UPNP devices\n"\
1395 | "\t'debug' toggles debug mode\n"\
1396 | "\t'verbose' toggles verbose mode\n"\
1397 | "\t'version' changes the UPNP version used\n"\
1398 | "\t'iface' changes the network interface in use\n"\
1399 | "\t'socket' re-sets the multicast IP address and port number used for UPNP discovery\n\n"\
1400 | 'Example:\n'\
1401 | '\t> seti socket 239.255.255.250:1900\n'\
1402 | '\t> seti uniq\n\n'\
1403 | 'Notes:\n'\
1404 | "\tIf given no options, 'seti' will display the current application settings",
1405 | 'quickView' :
1406 | 'Show/define application settings'
1407 | },
1408 | 'head' : {
1409 | 'longListing' :
1410 | 'Description:\n'\
1411 | '\tAllows you to view, set, add and delete the SSDP header values used in SSDP transactions\n\n'\
1412 | 'Usage:\n'\
1413 | '\t%s | set >\n'\
1414 | "\t'set' allows you to set SSDP headers used when sending M-SEARCH queries with the 'msearch' command\n"\
1415 | "\t'del' deletes a current header from the list\n"\
1416 | "\t'show' displays all current header info\n\n"\
1417 | 'Example:\n'\
1418 | '\t> head show\n'\
1419 | '\t> head set MX 3',
1420 | 'quickView' :
1421 | 'Show/define SSDP headers'
1422 | },
1423 | 'host' : {
1424 | 'longListing' :
1425 | 'Description:\n'\
1426 | "\tAllows you to query host information and iteract with a host's actions/services.\n\n"\
1427 | 'Usage:\n'\
1428 | '\t%s [host index #]\n'\
1429 | "\t'list' displays an index of all known UPNP hosts along with their respective index numbers\n"\
1430 | "\t'get' gets detailed information about the specified host\n"\
1431 | "\t'details' gets and displays detailed information about the specified host\n"\
1432 | "\t'summary' displays a short summary describing the specified host\n"\
1433 | "\t'info' allows you to enumerate all elements of the hosts object\n"\
1434 | "\t'send' allows you to send SOAP requests to devices and services *\n\n"\
1435 | 'Example:\n'\
1436 | '\t> host list\n'\
1437 | '\t> host get 0\n'\
1438 | '\t> host summary 0\n'\
1439 | '\t> host info 0 deviceList\n'\
1440 | '\t> host send 0 \n\n'\
1441 | 'Notes:\n'\
1442 | "\to All host commands support full tab completion of enumerated arguments\n"\
1443 | "\to All host commands EXCEPT for the 'host send', 'host info' and 'host list' commands take only one argument: the host index number.\n"\
1444 | "\to The host index number can be obtained by running 'host list', which takes no futher arguments.\n"\
1445 | "\to The 'host send' command requires that you also specify the host's device name, service name, and action name that you wish to send,\n\t in that order (see the last example in the Example section of this output). This information can be obtained by viewing the\n\t 'host details' listing, or by querying the host information via the 'host info' command.\n"\
1446 | "\to The 'host info' command allows you to selectively enumerate the host information data structure. All data elements and their\n\t corresponding values are displayed; a value of '{}' indicates that the element is a sub-structure that can be further enumerated\n\t (see the 'host info' example in the Example section of this output).",
1447 | 'quickView' :
1448 | 'View and send host list and host information'
1449 | },
1450 | 'pcap' : {
1451 | 'longListing' :
1452 | 'Description:\n'\
1453 | '\tPassively listens for SSDP NOTIFY messages from UPNP devices\n\n'\
1454 | 'Usage:\n'\
1455 | '\t%s',
1456 | 'quickView' :
1457 | 'Passively listen for UPNP hosts'
1458 | },
1459 | 'msearch' : {
1460 | 'longListing' :
1461 | 'Description:\n'\
1462 | '\tActively searches for UPNP hosts using M-SEARCH queries\n\n'\
1463 | 'Usage:\n'\
1464 | "\t%s [device | service] [ | ]\n"\
1465 | "\tIf no arguments are specified, 'msearch' searches for upnp:rootdevices\n"\
1466 | "\tSpecific device/services types can be searched for using the 'device' or 'service' arguments\n\n"\
1467 | 'Example:\n'\
1468 | '\t> msearch\n'\
1469 | '\t> msearch service WANIPConnection\n'\
1470 | '\t> msearch device InternetGatewayDevice',
1471 | 'quickView' :
1472 | 'Actively locate UPNP hosts'
1473 | },
1474 | 'load' : {
1475 | 'longListing' :
1476 | 'Description:\n'\
1477 | "\tLoads host data from a struct file previously saved with the 'save data' command\n\n"\
1478 | 'Usage:\n'\
1479 | '\t%s ',
1480 | 'quickView' :
1481 | 'Restore previous host data from file'
1482 | },
1483 | 'log' : {
1484 | 'longListing' :
1485 | 'Description:\n'\
1486 | '\tLogs user-supplied commands to a log file\n\n'\
1487 | 'Usage:\n'\
1488 | '\t%s ',
1489 | 'quickView' :
1490 | 'Logs user-supplied commands to a log file'
1491 | }
1492 | }
1493 |
1494 |
1495 | try:
1496 | print helpInfo[command]['longListing'] % command
1497 | except:
1498 | for command,cmdHelp in helpInfo.iteritems():
1499 | print "%s\t\t%s" % (command,cmdHelp['quickView'])
1500 |
1501 | #Display usage
1502 | def usage():
1503 | print '''
1504 | Command line usage: %s [OPTIONS]
1505 |
1506 | -s Load previous host data from struct file
1507 | -l Log user-supplied commands to log file
1508 | -i Specify the name of the interface to use (Linux only, requires root)
1509 | -u Disable show-uniq-hosts-only option
1510 | -d Enable debug mode
1511 | -v Enable verbose mode
1512 | -h Show help
1513 | ''' % sys.argv[0]
1514 | sys.exit(1)
1515 |
1516 | #Check command line options
1517 | def parseCliOpts(argc,argv,hp):
1518 | try:
1519 | opts,args = getopt.getopt(argv[1:],'s:l:i:udvh')
1520 | except getopt.GetoptError, e:
1521 | print 'Usage Error:',e
1522 | usage()
1523 | else:
1524 | for (opt,arg) in opts:
1525 | if opt == '-s':
1526 | print ''
1527 | load(2,['load',arg],hp)
1528 | print ''
1529 | elif opt == '-l':
1530 | print ''
1531 | log(2,['log',arg],hp)
1532 | print ''
1533 | elif opt == '-u':
1534 | hp.UNIQ = toggleVal(hp.UNIQ)
1535 | elif opt == '-d':
1536 | hp.DEBUG = toggleVal(hp.DEBUG)
1537 | print 'Debug mode enabled!'
1538 | elif opt == '-v':
1539 | hp.VERBOSE = toggleVal(hp.VERBOSE)
1540 | print 'Verbose mode enabled!'
1541 | elif opt == '-h':
1542 | usage()
1543 | elif opt == '-i':
1544 | networkInterfaces = []
1545 | requestedInterface = arg
1546 | interfaceName = None
1547 | found = False
1548 |
1549 | #Get a list of network interfaces. This only works on unix boxes.
1550 | try:
1551 | if thisSystem() != 'Windows':
1552 | fp = open('/proc/net/dev','r')
1553 | for line in fp.readlines():
1554 | if ':' in line:
1555 | interfaceName = line.split(':')[0].strip()
1556 | if interfaceName == requestedInterface:
1557 | found = True
1558 | break
1559 | else:
1560 | networkInterfaces.append(line.split(':')[0].strip())
1561 | fp.close()
1562 | else:
1563 | networkInterfaces.append('Run ipconfig to get a list of available network interfaces!')
1564 | except Exception,e:
1565 | print 'Error opening file:',e
1566 | print "If you aren't running Linux, this file may not exist!"
1567 |
1568 | if not found and len(networkInterfaces) > 0:
1569 | print "Failed to find interface '%s'; try one of these:\n" % requestedInterface
1570 | for iface in networkInterfaces:
1571 | print iface
1572 | print ''
1573 | sys.exit(1)
1574 | else:
1575 | if not hp.initSockets(False,False,interfaceName):
1576 | print 'Binding to interface %s failed; are you sure you have root privilages??' % interfaceName
1577 |
1578 | #Toggle boolean values
1579 | def toggleVal(val):
1580 | if val:
1581 | return False
1582 | else:
1583 | return True
1584 |
1585 | #Prompt for user input
1586 | def getUserInput(hp,shellPrompt):
1587 | defaultShellPrompt = 'skyRemote> '
1588 | if shellPrompt == False:
1589 | shellPrompt = defaultShellPrompt
1590 |
1591 | try:
1592 | uInput = raw_input(shellPrompt).strip()
1593 | argv = uInput.split()
1594 | argc = len(argv)
1595 | except KeyboardInterrupt, e:
1596 | print '\n'
1597 | if shellPrompt == defaultShellPrompt:
1598 | quit(0,[],hp)
1599 | return (0,None)
1600 | if hp.LOG_FILE != False:
1601 | try:
1602 | hp.LOG_FILE.write("%s\n" % uInput)
1603 | except:
1604 | print 'Failed to log data to log file!'
1605 |
1606 | return (argc,argv)
1607 |
1608 | #Main
1609 | def main(argc,argv):
1610 | #Table of valid commands - all primary commands must have an associated function
1611 | appCommands = {
1612 | 'help' : {
1613 | 'help' : None
1614 | },
1615 | 'quit' : {
1616 | 'help' : None
1617 | },
1618 | 'exit' : {
1619 | 'help' : None
1620 | },
1621 | 'save' : {
1622 | 'data' : None,
1623 | 'info' : None,
1624 | 'help' : None
1625 | },
1626 | 'load' : {
1627 | 'help' : None
1628 | },
1629 | 'seti' : {
1630 | 'uniq' : None,
1631 | 'socket' : None,
1632 | 'show' : None,
1633 | 'iface' : None,
1634 | 'debug' : None,
1635 | 'version' : None,
1636 | 'verbose' : None,
1637 | 'help' : None
1638 | },
1639 | 'head' : {
1640 | 'set' : None,
1641 | 'show' : None,
1642 | 'del' : None,
1643 | 'help': None
1644 | },
1645 | 'control' : {
1646 | 'help' : None
1647 | },
1648 | 'host' : {
1649 | 'list' : None,
1650 | 'info' : None,
1651 | 'get' : None,
1652 | 'details' : None,
1653 | 'send' : None,
1654 | 'summary' : None,
1655 | 'help' : None
1656 | },
1657 | 'pcap' : {
1658 | 'help' : None
1659 | },
1660 | 'msearch' : {
1661 | 'device' : None,
1662 | 'service' : None,
1663 | 'help' : None
1664 | },
1665 | 'log' : {
1666 | 'help' : None
1667 | },
1668 | 'debug': {
1669 | 'command' : None,
1670 | 'help' : None
1671 | }
1672 | }
1673 |
1674 | #The load command should auto complete on the contents of the current directory
1675 | for file in os.listdir(os.getcwd()):
1676 | appCommands['load'][file] = None
1677 |
1678 | #Initialize upnp class
1679 | hp = upnp(False,False,None,appCommands);
1680 |
1681 | #Set up tab completion and command history
1682 | readline.parse_and_bind("tab: complete")
1683 | readline.set_completer(hp.completer.complete)
1684 |
1685 | #Set some default values
1686 | hp.UNIQ = True
1687 | hp.VERBOSE = False
1688 | action = False
1689 | funPtr = False
1690 |
1691 | #Check command line options
1692 | parseCliOpts(argc,argv,hp)
1693 |
1694 | skyFuncPtr = eval('pcap')
1695 | skyFuncPtr(0,'pcap',hp)
1696 |
1697 | loadPtr = eval('host')
1698 | loadPtr(3,['host','get','0'],hp)
1699 |
1700 | print 'Ready for input. You can start with "control pause" and "control play"'
1701 |
1702 | #Main loop
1703 | while True:
1704 | #Drop user into shell
1705 | (argc,argv) = getUserInput(hp,False)
1706 | if argc == 0:
1707 | continue
1708 | action = argv[0]
1709 | funcPtr = False
1710 |
1711 | #Parse actions
1712 | try:
1713 | if appCommands.has_key(action):
1714 | funcPtr = eval(action)
1715 | except:
1716 | funcPtr = False
1717 | action = False
1718 |
1719 | if callable(funcPtr):
1720 | if argc == 2 and argv[1] == 'help':
1721 | showHelp(argv[0])
1722 | else:
1723 | try:
1724 | funcPtr(argc,argv,hp)
1725 | except KeyboardInterrupt:
1726 | print 'Action interrupted by user...'
1727 | print ''
1728 | continue
1729 | print 'Invalid command. Valid commands are:'
1730 | print ''
1731 | showHelp(False)
1732 | print ''
1733 |
1734 |
1735 | if __name__ == "__main__":
1736 | try:
1737 | main(len(sys.argv),sys.argv)
1738 | except Exception, e:
1739 | print 'Caught main exception:',e
1740 | sys.exit(1)
1741 |
1742 |
--------------------------------------------------------------------------------