├── .gitignore
├── .gitmodules
├── LICENSE
├── README.md
├── connection_management.py
├── constants.py
├── database_management.py
├── indicator_classes.py
├── method_menu.py
├── parser_classes.py
├── presentation.py
└── youtube_rss.py
/.gitignore:
--------------------------------------------------------------------------------
1 | *.swp
2 | log
3 | __pycache__
4 |
--------------------------------------------------------------------------------
/.gitmodules:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/SimonDaNinja/youtube_rss/96604624ad8c09248f927fb707474e2b7269afd1/.gitmodules
--------------------------------------------------------------------------------
/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 | # YouTube\_RSS
2 |
3 | YouTube\_RSS is a simple YouTube client I've made for fun. The goal is to have a simple
4 | user interface for those who want to preserve their privacy when using YouTube, but who
5 | still want to be able to keep track of their favourite channels, etc.
6 |
7 | YouTube\_RSS manages subscriptions to channels using RSS, rather than YouTube's
8 | internal subscription system that requires a privacy violating Google account.
9 |
10 | It also (optionally) uses Tor to hide the IP address of the user.
11 |
12 | ## Dependencies
13 |
14 | YouTube\_RSS is developed and tested on Ubuntu Linux. It will probably work just fine in
15 | similar Unix-like operating systems, but probably not on Windows (at least not without
16 | a little bit of pain).
17 |
18 | The following python modules are used and may need to be installed, e.g. using pip:
19 | ```
20 | aiohttp
21 | aiohttp-socks
22 | feedparser
23 | urllib3
24 | ```
25 |
26 | The program also assumes that [mpv](https://github.com/mpv-player/mpv) is
27 | installed in the environment. In, for example, Ubuntu, this can be accomplished
28 | by running `sudo apt-get install mpv`. [youtube-dl](https://github.com/ytdl-org) also
29 | needs to be installed (I use the latest version on their [official website](https://youtube-dl.org/), and
30 | at the time of this writing, the version in the Ubuntu rebository seems too old to work
31 | the way this project uses it).
32 |
33 | For using Tor, YouTube\_RSS assumes that Tor is installed and currently running
34 | on port `9050` (which is the default for the Tor daemon anyway). It also requires that
35 | torsocks is installed.
36 |
37 | ## Disclaimer
38 |
39 | Note that while I am enthusiastic about privacy and security,
40 | I am not a professional, and may have missed something important. However, the surface to protect
41 | should be relatively small, and I've taken care to get rid of DNS-leaks, etc. as well as I can.
42 | If you are more knowledgable than I, then I would appreciate input on how to make YouTube\_RSS
43 | more privacy preserving and secure.
44 |
45 | # Manual
46 | Most of the way the application works is self-explanatory; I won't tell you that to search for a
47 | video, you enter the "search for video" option (although I guess I just did), but rather focus on
48 | the things not immediately obvious when opening the program.
49 |
50 | ## Key binds
51 | The keybindings are designed so that the user can do almost everything necessary by just
52 | using the arrow keys (except, of course, when writing search queries), or by using the
53 | `hjkl` keys for vi users.
54 |
55 | When in a menu, the user can press `KEY_UP` or `k` to move to the previous menu item.
56 |
57 | When in a menu, the user can press `KEY_DOWN` or `j` to move to the next menu item.
58 |
59 | When in a menu, the user can press `g` (lower case) to go to the first menu item.
60 |
61 | When in a menu, the user can press `G` (upper case) to go to the last menu item.
62 |
63 | When in a menu, the user can type a number and then press either `Enter` or `l` or `KEY_RIGHT`
64 | to jump to the item indicated by the number typed by the user.
65 |
66 | When in a menu, the user can press `ENTER`, `l` or `KEY_RIGHT` to select the highlighted item, if no
67 | number has been typed since last jump.
68 |
69 | When in a menu, the user can press `q`, `-C`, `h` or `KEY_LEFT` to go back to the previous menu.
70 |
71 | When browsing subscriptions, in the menu where channels are displayed as menu items, the user can press
72 | `a` to toggle all entries of the currently highlighted channel as seen or unseen
73 |
74 | When browsing subscriptions, in the menu where videos from a particular channel are displayed as menu
75 | items, the user can press `a` to toggle the highlighted entry as seen or unseen
76 |
77 | ## Thumbnails
78 | YouTube\_RSS used to support thumbnails, using
79 | [ueberzug](https://github.com/seebye/ueberzug), but no longer does, since that project
80 | has sadly been discontinued.
81 |
82 | If you used YouTube\_RSS with thumbnails in the past, you need to manually delete
83 | thumbnail files, which are stored under `~/.youtube_rss/thumbnails`.
84 |
--------------------------------------------------------------------------------
/connection_management.py:
--------------------------------------------------------------------------------
1 | import feedparser
2 | import asyncio
3 | import aiohttp
4 | import constants
5 | import urllib
6 | import subprocess
7 | from aiohttp_socks import ProxyConnector
8 | import parser_classes
9 | from aiohttp_socks import ProxyType
10 | import time
11 | import secrets
12 | import os
13 | import shutil
14 |
15 |
16 | # manages socks5 auths used for Tor stream isolation
17 | class CircuitManager:
18 | def __init__(self, nCircuits = 15, ttl = 600):
19 | self.ttl = ttl
20 | self.nCircuits = 15
21 | self.i = 0
22 | self.expiryTime = 0
23 |
24 | def initiateCircuitAuths(self):
25 | self.circuitAuths=[generateNewSocks5Auth() for i in range(self.nCircuits)]
26 |
27 | def getAuth(self):
28 | # if ttl is over, reinitiate circuit auth list
29 | if self.expiryTime < time.time():
30 | self.initiateCircuitAuths()
31 | self.expiryTime = time.time() + self.ttl
32 | # circulate over the various auths so that you don't use the same circuit all the
33 | # time
34 | self.i += 1
35 | return self.circuitAuths[self.i%self.nCircuits]
36 |
37 | # use this function to generate new socks5 authentication (for tor stream
38 | # isolation)
39 | def generateNewSocks5Auth(userNameLen = 30, passwordLen = 30):
40 | rnd = secrets.SystemRandom()
41 | alphaNumeric = "QWERTYUIOPASDFGHJKLZXCVBNMqwertyuiopasdfghjklzxcvbnm1234567890"
42 | username = "".join([rnd.choice(alphaNumeric) for i in range(userNameLen)])
43 | password = "".join([rnd.choice(alphaNumeric) for i in range(passwordLen)])
44 | return username, password
45 |
46 | # use this function to get content (typically hypertext or xml) using HTTP from YouTube
47 | async def getHttpContent(url, useTor, semaphore, auth=None, contentType='text'):
48 | if useTor:
49 | if auth is not None:
50 | username, password = auth
51 | else:
52 | username = None
53 | password = None
54 | connector = ProxyConnector(proxy_type=ProxyType.SOCKS5, host = "127.0.0.1",
55 | port = 9050, username=username, password = password, rdns = True)
56 | else:
57 | connector = None
58 |
59 | # This cookie lets us avoid the YouTube consent page
60 | cookies = {'CONSENT':'YES+'}
61 | headers = {'Accept-Language':'en-US'}
62 | await semaphore.acquire()
63 | async with aiohttp.ClientSession(connector=connector, cookies = cookies) as session:
64 | session.headers['Accept-Language']='en-US'
65 | async with session.get(url, headers=headers) as response:
66 | if contentType == 'text':
67 | result = await response.text()
68 | elif contentType == 'bytes':
69 | result = await response.read()
70 | else:
71 | raise ValueError(f"unknown content type: {contentType}")
72 | semaphore.release()
73 | return result
74 |
75 | # if you have a channel id, you can use this function to get the rss address
76 | def getRssAddressFromChannelId(channelId):
77 | return f"https://www.youtube.com/feeds/videos.xml?channel_id={channelId}"
78 |
79 | # use this function to get a list of query results from searching for a channel
80 | # results are of the type ChannelQueryObject
81 | async def getChannelQueryResults(query, useTor=False, auth=None):
82 | url = 'https://youtube.com/results?search_query=' + urllib.parse.quote(query) + \
83 | '&sp=EgIQAg%253D%253D'
84 | semaphore = asyncio.Semaphore(constants.MAX_CONNECTIONS)
85 | getTask = asyncio.create_task(getHttpContent(url, useTor=useTor, semaphore=semaphore,
86 | auth=auth))
87 | htmlContent = await getTask
88 | parser = parser_classes.ChannelQueryParser()
89 | parser.feed(htmlContent)
90 | return parser.resultList
91 |
92 | # use this function to get a list of query results from searching for a video
93 | # results are of the type VideoQueryObject
94 | async def getVideoQueryResults(query, useTor=False, auth=None):
95 | url = 'https://youtube.com/results?search_query=' + urllib.parse.quote(query) + \
96 | '&sp=EgIQAQ%253D%253D'
97 | semaphore = asyncio.Semaphore(constants.MAX_CONNECTIONS)
98 | getTask = asyncio.create_task(getHttpContent(url, semaphore=semaphore, useTor=useTor,
99 | auth=auth))
100 | htmlContent = await getTask
101 | parser = parser_classes.VideoQueryParser()
102 | parser.feed(htmlContent)
103 |
104 | return parser.resultList
105 |
106 | # use this function to get rss entries from channel id
107 | async def getRssEntriesFromChannelId(channelId, semaphore, useTor=False, auth=None):
108 | rssAddress = getRssAddressFromChannelId(channelId)
109 | getTask = asyncio.create_task(getHttpContent(rssAddress, useTor, semaphore=semaphore,
110 | auth=auth))
111 | rssContent = await getTask
112 | entries = feedparser.parse(rssContent)['entries']
113 | return entries
114 |
115 |
116 |
117 | # use this function to open a YouTube video url in mpv
118 | def openUrlInMpv(url, useTor=False, maxResolution=1080, circuitManager = None):
119 | try:
120 | command = []
121 | if useTor:
122 | auth = circuitManager.getAuth()
123 | command.append('torsocks')
124 | command.append('-u')
125 | command.append(auth[0])
126 | command.append('-p')
127 | command.append(auth[1])
128 | command += ['mpv', \
129 | f'--ytdl-format=bestvideo[height=?{maxResolution}]+bestaudio/best']
130 | command.append(url)
131 | mpvProcess = subprocess.Popen(command, stdout = subprocess.DEVNULL,
132 | stderr = subprocess.STDOUT)
133 | mpvProcess.wait()
134 | result = mpvProcess.poll()
135 | except KeyboardInterrupt:
136 | mpvProcess.kill()
137 | mpvProcess.wait()
138 | result = -1
139 | return result == 0
140 |
141 | # use this function to get the data we care about from the entries found by the RSS parser
142 | def getRelevantDictFromFeedParserDict(feedparserDict):
143 | outputDict = {
144 | 'id' : feedparserDict['id'],
145 | 'link' : feedparserDict['link'],
146 | 'title' : feedparserDict['title'],
147 | 'thumbnail' : feedparserDict['media_thumbnail'][0]['url'],
148 | 'seen' : False
149 | }
150 | return outputDict
151 |
152 |
--------------------------------------------------------------------------------
/constants.py:
--------------------------------------------------------------------------------
1 | import os
2 |
3 | HOME = os.environ.get('HOME')
4 | YOUTUBE_RSS_DIR = '/'.join([HOME,'.youtube_rss'])
5 | DATABASE_PATH = '/'.join([YOUTUBE_RSS_DIR, 'database'])
6 | LOG_PATH = '/'.join([YOUTUBE_RSS_DIR, 'log'])
7 |
8 | ANY_INDEX = -1
9 | MAX_CONNECTIONS=30
10 |
--------------------------------------------------------------------------------
/database_management.py:
--------------------------------------------------------------------------------
1 | import json
2 | import os
3 | import constants
4 | import asyncio
5 | import connection_management
6 |
7 | # Database is always stored as a dict()
8 |
9 | # use this function to read database from json string
10 | def parseDatabaseContent(content):
11 | return json.loads(content)
12 |
13 | # use this function to read database from json file
14 | def parseDatabaseFile(filename):
15 | with open(filename, 'r') as filePointer:
16 | return json.load(filePointer)
17 |
18 | # use this function to return json representation of database as string
19 | def getDatabaseString(database):
20 | return json.dumps(database, indent=4)
21 |
22 | # use this function to write json representation of database to file
23 | def outputDatabaseToFile(database, filename):
24 | with open(filename, 'w') as filePointer:
25 | return json.dump(database, filePointer, indent=4)
26 |
27 | # use this function to initialize the database (dict format so it's easy to save as json)
28 | def initiateYouTubeRssDatabase():
29 | database = {}
30 | database['feeds'] = {}
31 | database['id to title'] = {}
32 | database['title to id'] = {}
33 | return database
34 |
35 | # use this function to remove a subscription from the database by channel title
36 | def removeSubscriptionFromDatabaseByChannelTitle(database, channelTitle):
37 | if channelTitle not in database['title to id']:
38 | return
39 | channelId = database['title to id'][channelTitle]
40 | removeSubscriptionFromDatabaseByChannelId(database, channelId)
41 | return
42 |
43 | # use this function to remove a subscription from the database by channel ID
44 | def removeSubscriptionFromDatabaseByChannelId(database, channelId):
45 | if channelId not in database['id to title']:
46 | return
47 | channelTitle = database['id to title'].pop(channelId)
48 | database['title to id'].pop(channelTitle)
49 | database['feeds'].pop(channelId)
50 | outputDatabaseToFile(database, constants.DATABASE_PATH)
51 |
52 | # use this function to retrieve new RSS entries for a subscription and add them to
53 | # a database
54 | async def refreshSubscriptionsByChannelId(channelIdList, useTor=False,
55 | auth=None):
56 | database = parseDatabaseFile(constants.DATABASE_PATH)
57 | localFeeds = database['feeds']
58 | tasks = []
59 |
60 | semaphore = asyncio.Semaphore(constants.MAX_CONNECTIONS)
61 |
62 | for channelId in channelIdList:
63 | localFeed = localFeeds[channelId]
64 | tasks.append(asyncio.create_task(refreshSubscriptionByChannelId(channelId, localFeed,
65 | semaphore=semaphore, useTor=useTor, auth=auth)))
66 |
67 | for task in tasks:
68 | await task
69 |
70 | outputDatabaseToFile(database, constants.DATABASE_PATH)
71 |
72 | async def refreshSubscriptionByChannelId(channelId, localFeed, semaphore, useTor=False,
73 | auth=None):
74 | task = asyncio.create_task(connection_management.getRssEntriesFromChannelId(channelId,
75 | semaphore=semaphore, useTor=useTor, auth=auth))
76 | remoteFeed = await task
77 | if remoteFeed is not None:
78 | remoteFeed.reverse()
79 | for entry in remoteFeed:
80 | filteredEntry = connection_management.getRelevantDictFromFeedParserDict(entry)
81 |
82 | filteredEntryIsNew = True
83 | for i, localEntry in enumerate(localFeed):
84 | if localEntry['id'] == filteredEntry['id']:
85 | filteredEntryIsNew = False
86 | # in case any relevant data about the entry is changed, update it
87 | filteredEntry['seen'] = localEntry['seen']
88 | localFeed[i] = filteredEntry
89 | break
90 | if filteredEntryIsNew:
91 | localFeed.insert(0, filteredEntry)
92 |
93 | # use this function to add a subscription to the database
94 | def addSubscriptionToDatabase(channelId, channelTitle, refresh=False,
95 | useTor=False, circuitManager=None):
96 | database = parseDatabaseFile(constants.DATABASE_PATH)
97 | database['feeds'][channelId] = []
98 | database['id to title'][channelId] = channelTitle
99 | database['title to id'][channelTitle] = channelId
100 | outputDatabaseToFile(database, constants.DATABASE_PATH)
101 | auth = None
102 | if circuitManager is not None and useTor:
103 | auth = circuitManager.getAuth()
104 | if refresh:
105 | asyncio.run(refreshSubscriptionsByChannelId( [channelId], useTor=useTor,
106 | auth=auth))
107 |
--------------------------------------------------------------------------------
/indicator_classes.py:
--------------------------------------------------------------------------------
1 | # Parent to all indicator classes
2 | class IndicatorClass:
3 | def __init__(self):
4 | raise InstantiateIndicatorClassError
5 |
6 | class NoCanvas(IndicatorClass):
7 | def __init__(self):
8 | pass
9 |
10 | def __exit__(self, dummy1, dummy2, dummy3):
11 | pass
12 |
13 | def __enter__(self):
14 | pass
15 |
16 | # returned from menu method to indicate that application flow should step
17 | # closer to the root menu
18 | class ReturnFromMenu(IndicatorClass):
19 | pass
20 |
21 | # indicates whether selection query should return by index, item or both
22 | class QueryStyle(IndicatorClass):
23 | pass
24 |
25 | # indicates that selection query should return by index
26 | class IndexQuery(QueryStyle):
27 | pass
28 |
29 | # indicates that selection query should return by item
30 | class ItemQuery(QueryStyle):
31 | pass
32 |
33 | # indicates that selection query should return by both item and index
34 | class CombinedQuery(QueryStyle):
35 | pass
36 |
37 | """
38 | Exception classes
39 | """
40 |
41 | class InstantiateIndicatorClassError(Exception):
42 | def __init__(self, message="Can't instantiate an indicator class!"):
43 | self.message = message
44 | Exception.__init__(self, self.message)
45 |
--------------------------------------------------------------------------------
/method_menu.py:
--------------------------------------------------------------------------------
1 | import constants
2 | import presentation
3 | import indicator_classes
4 | import database_management
5 |
6 | """
7 | classes
8 | """
9 |
10 | class MethodMenuDecision:
11 | def __init__(self, description, function, *args, **kwargs):
12 | self.function = function
13 | self.args = args
14 | self.kwargs = kwargs
15 | self.description = description
16 |
17 | def __str__(self):
18 | return str(self.description)
19 |
20 | def executeDecision(self):
21 | return self.function(*self.args, **self.kwargs)
22 |
23 | class FeedVideoDescriber:
24 | def __init__(self, video):
25 | self.video = video
26 |
27 | def __str__(self):
28 | return self.video['title'] + (' (unseen!)' if not self.video['seen'] else '')
29 |
30 | class VideoQueryObjectDescriber:
31 | def __init__(self, videoQueryObject):
32 | self.videoQueryObject = videoQueryObject
33 |
34 | def __str__(self):
35 | return self.videoQueryObject.title
36 |
37 | class FeedDescriber:
38 | def __init__(self, feed, channelTitle):
39 | self.feed = feed
40 | self.channelTitle = channelTitle
41 |
42 | def __str__(self):
43 | return ''.join([self.channelTitle, ': (', str(sum([1 for video in self.feed
44 | if not video['seen']])),'/',str(len(self.feed)), ')'])
45 |
46 | class AdHocKey:
47 | def __init__(self, key, item, activationIndex = constants.ANY_INDEX):
48 | self.key = key
49 | self.item = item
50 | self.activationIndex = activationIndex
51 |
52 | def isValidIndex(self, index):
53 | if self.activationIndex == constants.ANY_INDEX:
54 | return True
55 | else:
56 | return index == self.activationIndex
57 |
58 | def __eq__(self,other):
59 | if isinstance(other, int):
60 | return other == self.key
61 | if isinstance(other, chr):
62 | return other == chr(self.key)
63 | if isinstance(other, AdHocKey):
64 | return other.key == self.key and other.item == self.item and \
65 | other.activationIndex == self.activationIndex
66 | else:
67 | raise TypeError
68 |
69 | class MarkAllAsReadKey(AdHocKey):
70 | def __init__(self, channelId, activationIndex, database, key=ord('a')):
71 | item = MethodMenuDecision(
72 | f"mark all by {channelId} as read",
73 | doMarkChannelAsRead,
74 | database,
75 | channelId
76 | )
77 | AdHocKey.__init__(self, key=key, item=item, activationIndex=activationIndex)
78 |
79 | class MarkEntryAsReadKey(AdHocKey):
80 | def __init__(self, video, activationIndex, key=ord('a')):
81 | item = MethodMenuDecision(
82 | "mark video as read",
83 | lambda video : video.update({'seen':(not video['seen'])}),
84 | video
85 | )
86 | AdHocKey.__init__(self, key=key, item=item, activationIndex=activationIndex)
87 |
88 | """
89 | functions
90 | """
91 |
92 | # this is a function for managing menu hierarchies; once called, a menu presents
93 | # application flows available to the user. If called from a flow selected in a previous
94 | # method menu, the menu becomes a new branch one step further from the root menu
95 | def doMethodMenu(query, menuOptions, showItemNumber = True, adHocKeys = []):
96 | index = 0
97 | try:
98 | while True:
99 | methodMenuDecision, index = presentation.doSelectionQuery(query, menuOptions,
100 | initialIndex=index, queryStyle=indicator_classes.CombinedQuery,
101 | showItemNumber=showItemNumber, adHocKeys=adHocKeys)
102 | try:
103 | result = methodMenuDecision.executeDecision()
104 | except KeyboardInterrupt:
105 | result = None
106 | pass
107 | if result is indicator_classes.ReturnFromMenu:
108 | return
109 | except KeyboardInterrupt:
110 | return
111 |
112 | def doNotifyAndReturnFromMenu(message):
113 | presentation.doNotify(message)
114 | return indicator_classes.ReturnFromMenu
115 |
116 | # this function is an application level flow which when selected from a method menu simply
117 | # returns to the preceding menu (one step closer to the root menu)
118 | def doReturnFromMenu():
119 | return indicator_classes.ReturnFromMenu
120 |
121 | # this function is used in processing of a particular AdHocKey
122 | def doMarkChannelAsRead(database, channelId):
123 | allAreAlreadyMarkedAsRead = True
124 | for video in database['feeds'][channelId]:
125 | if not video['seen']:
126 | allAreAlreadyMarkedAsRead = False
127 | break
128 | for video in database['feeds'][channelId]:
129 | video['seen'] = not allAreAlreadyMarkedAsRead
130 | database_management.outputDatabaseToFile(database, constants.DATABASE_PATH)
131 |
--------------------------------------------------------------------------------
/parser_classes.py:
--------------------------------------------------------------------------------
1 | from html.parser import HTMLParser
2 | import re
3 |
4 | """
5 | Parser classes
6 | """
7 |
8 | # Parser used for extracting an RSS Address from channel page HTML
9 | class RssAddressParser(HTMLParser):
10 |
11 | def __init__(self):
12 | super(RssAddressParser, self).__init__(convert_charrefs=True)
13 | self.rssAddress = None
14 |
15 | def handle_starttag(self, tag, attrs):
16 | attrDict = dict(attrs)
17 | if 'type' in attrDict and attrDict['type'] == 'application/rss+xml':
18 | self.rssAddress = attrDict['href']
19 |
20 | # Parser used for extracting information about channels from YouTube channel query HTML
21 | class ChannelQueryParser(HTMLParser):
22 |
23 | def __init__(self):
24 | super(ChannelQueryParser, self).__init__(convert_charrefs=True)
25 | self.isScriptTag = False
26 | self.resultList = None
27 |
28 | def handle_starttag(self, tag, attrs):
29 | if tag == 'script':
30 | self.isScriptTag = True
31 |
32 | def handle_data(self, data):
33 | if self.isScriptTag:
34 | self.isScriptTag = False
35 | if 'var ytInitialData' in data:
36 | pattern = re.compile('"channelRenderer":\{"channelId":"([^"]+)",' + \
37 | '"title":\{"simpleText":"([^"]+)"')
38 | tupleList = pattern.findall(data)
39 | resultList = []
40 | for tup in tupleList:
41 | resultList.append(ChannelQueryObject(channelId = tup[0],
42 | title = tup[1]))
43 | self.resultList = resultList
44 |
45 | # Parser used for extracting information about channels from YouTube channel query HTML
46 | class VideoQueryParser(HTMLParser):
47 |
48 | def __init__(self):
49 | super(VideoQueryParser, self).__init__(convert_charrefs=True)
50 | self.isScriptTag = False
51 | self.resultList = None
52 |
53 | def handle_starttag(self, tag, attrs):
54 | if tag == 'script':
55 | self.isScriptTag = True
56 |
57 | def handle_data(self, data):
58 | if self.isScriptTag:
59 | self.isScriptTag = False
60 | if 'var ytInitialData' in data:
61 | pattern = re.compile('videoId":"([^"]+)","thumbnail":\{"thumbnails":' + \
62 | '\[\{"url":"([^"]+)","width":[0-9]+,"height":[0-9]+\},\{"url"' + \
63 | ':"[^"]+","width":[0-9]+,"height":[0-9]+\}\]\},"title":\{' + \
64 | '"runs":\[\{"text":"[^"]+"\}\],"accessibility":\{' + \
65 | '"accessibilityData":\{"label":"([^"]+)"\}')
66 | tupleList = pattern.findall(data)
67 | resultList = []
68 | for tup in tupleList:
69 | resultList.append(VideoQueryObject(videoId = tup[0],
70 | thumbnail = tup[1], title = tup[2]))
71 | self.resultList = resultList
72 |
73 | """
74 | help classes
75 | """
76 | # contains information from one result item from channel query
77 | class ChannelQueryObject:
78 | def __init__(self, channelId = None, title = None):
79 | self.channelId = channelId
80 | self.title = title
81 |
82 | def __str__(self):
83 | return f"{self.title} -- (channel ID {self.channelId})"
84 |
85 | # contains information from one result item from video query
86 | class VideoQueryObject:
87 | def __init__(self, videoId = None, thumbnail=None, title = None):
88 | self.videoId = videoId
89 | self.thumbnail = thumbnail
90 | self.title = title
91 | if videoId is not None:
92 | self.url = f"http://youtube.com/watch?v={videoId}"
93 | else:
94 | self.url = None
95 |
96 | def __str__(self):
97 | return f"{self.title}"
--------------------------------------------------------------------------------
/presentation.py:
--------------------------------------------------------------------------------
1 | import curses
2 | import inspect
3 | import indicator_classes
4 | import asyncio
5 |
6 | HIGHLIGHTED = 1
7 | NOT_HIGHLIGHTED = 2
8 |
9 |
10 | # This function displays a message while the user waits for a function to execute
11 | def doWaitScreen(message, cb, *args, **kwargs):
12 | return curses.wrapper(doWaitScreenNcurses, message, cb, *args, **kwargs)
13 |
14 | # This function is where the Ncurses level of doWaitScreen starts.
15 | # It should never be called directly, but always through doWaitScreen!
16 | def doWaitScreenNcurses(stdscr, message, cb, *args, **kwargs):
17 | curses.curs_set(0)
18 | curses.init_pair(HIGHLIGHTED, curses.COLOR_BLACK, curses.COLOR_WHITE)
19 | curses.init_pair(NOT_HIGHLIGHTED, curses.COLOR_WHITE, curses.COLOR_BLACK)
20 | printMenu(message, [], stdscr, 0, showItemNumber=False)
21 | if inspect.iscoroutinefunction(cb):
22 | return asyncio.run(cb(*args, **kwargs))
23 | else:
24 | return cb(*args, **kwargs)
25 |
26 | # This Function gets a yes/no response to some query from the user
27 | def doYesNoQuery(query):
28 | return curses.wrapper(doYnQueryNcurses, query)
29 |
30 | # This function is where the Ncurses level of doYesNoQuery starts.
31 | # It should never be called directly, but always through doYesNoQuery!
32 | def doYnQueryNcurses(stdscr, query):
33 | return doSelectionQueryNcurses(stdscr, query, ['yes','no'],
34 | indicator_classes.ItemQuery, showItemNumber=False) == 'yes'
35 |
36 | # This function lets the user choose an object from a list
37 | def doSelectionQuery(query, options, queryStyle=indicator_classes.ItemQuery,
38 | initialIndex=None, showItemNumber=True, adHocKeys=[]):
39 | return curses.wrapper(doSelectionQueryNcurses, query, options,
40 | queryStyle=queryStyle, initialIndex=initialIndex,
41 | showItemNumber=showItemNumber, adHocKeys=adHocKeys)
42 |
43 | # This function is where the Ncurses level of doSelectionQuery starts.
44 | # It should never be called directly, but always through doSelectionQuery!
45 | def doSelectionQueryNcurses(stdscr, query, options,
46 | queryStyle=indicator_classes.ItemQuery, initialIndex=None, showItemNumber=True,
47 | adHocKeys=[]):
48 | curses.curs_set(0)
49 | curses.init_pair(HIGHLIGHTED, curses.COLOR_BLACK, curses.COLOR_WHITE)
50 | curses.init_pair(NOT_HIGHLIGHTED, curses.COLOR_WHITE, curses.COLOR_BLACK)
51 | jumpNumList = []
52 | if initialIndex is not None:
53 | choiceIndex = initialIndex
54 | else:
55 | choiceIndex = 0
56 | while True:
57 | printMenu(query, options, stdscr, choiceIndex, showItemNumber=showItemNumber,
58 | jumpNumStr = ''.join(jumpNumList))
59 | key = stdscr.getch()
60 | # Ad hoc keys should always take first precedence
61 |
62 | if key in adHocKeys:
63 | for adHocKey in adHocKeys:
64 | if adHocKey.isValidIndex(choiceIndex):
65 | if queryStyle is indicator_classes.ItemQuery:
66 | return adHocKey.item
67 | elif queryStyle is indicator_classes.IndexQuery:
68 | return choiceIndex
69 | elif queryStyle is indicator_classes.CombinedQuery:
70 | return adHocKey.item, choiceIndex
71 |
72 | elif key in [curses.KEY_UP, ord('k')]:
73 | jumpNumList = []
74 | choiceIndex = (choiceIndex-1)%len(options)
75 | elif key in [curses.KEY_DOWN, ord('j')]:
76 | jumpNumList = []
77 | choiceIndex = (choiceIndex+1)%len(options)
78 | elif key in [ord(digit) for digit in '1234567890']:
79 | if len(jumpNumList) < 6:
80 | jumpNumList.append(chr(key))
81 | elif key in [curses.KEY_BACKSPACE, ord('\b'), ord('\x7f')]:
82 | if jumpNumList:
83 | jumpNumList.pop()
84 | elif key == ord('g'):
85 | jumpNumList = []
86 | choiceIndex = 0
87 | elif key == ord('G'):
88 | jumpNumList = []
89 | choiceIndex = len(options)-1
90 | elif key in [ord('q'), ord('h'), curses.KEY_LEFT]:
91 | raise KeyboardInterrupt
92 | elif key in [curses.KEY_ENTER, 10, 13, ord('l'), curses.KEY_RIGHT]:
93 | if jumpNumList:
94 | jumpNum = int(''.join(jumpNumList))
95 | choiceIndex = min(jumpNum-1, len(options)-1)
96 | jumpNumList = []
97 | elif queryStyle is indicator_classes.ItemQuery:
98 | return options[choiceIndex]
99 | elif queryStyle is indicator_classes.IndexQuery:
100 | return choiceIndex
101 | elif queryStyle is indicator_classes.CombinedQuery:
102 | return options[choiceIndex], choiceIndex
103 | else:
104 | raise UnknownQueryStyle(f"Unknown query style: {queryStyle}")
105 |
106 |
107 | # This function displays a piece of information to the user until they confirm having
108 | # seen it
109 | def doNotify(message):
110 | doSelectionQuery(message, ['ok'], showItemNumber=False)
111 |
112 | # This function gets a string of written input from the user
113 | def doGetUserInput(query, maxInputLength=40):
114 | return curses.wrapper(doGetUserInputNcurses, query, maxInputLength=maxInputLength)
115 |
116 | # This function is where the Ncurses level of doGetUserInput starts.
117 | # It should never be called directly, but always through doGetUserInput!
118 | def doGetUserInputNcurses(stdscr, query, maxInputLength=40):
119 | curses.curs_set(0)
120 | curses.init_pair(HIGHLIGHTED, curses.COLOR_BLACK, curses.COLOR_WHITE)
121 | curses.init_pair(NOT_HIGHLIGHTED, curses.COLOR_WHITE, curses.COLOR_BLACK)
122 | curses.curs_set(0)
123 | curserPosition = 0
124 | userInputChars = []
125 | while True:
126 | printMenu(query, [''.join(userInputChars), ''.join(['—' if i==curserPosition else
127 | ' ' for i in range(maxInputLength)])], stdscr, 0,
128 | xAlignment=maxInputLength//2, showItemNumber=False)
129 | key = stdscr.getch()
130 | if key in [curses.KEY_BACKSPACE, ord('\b'), ord('\x7f')]:
131 | deleteIndex = curserPosition-1
132 | if deleteIndex >= 0 : userInputChars.pop(curserPosition-1)
133 | curserPosition = max(0, curserPosition-1)
134 | elif key in [curses.KEY_DC]:
135 | deleteIndex = curserPosition+1
136 | if deleteIndex <= len(userInputChars) : userInputChars.pop(curserPosition)
137 | elif key in [curses.KEY_ENTER, 10, 13]:
138 | return ''.join(userInputChars)
139 | elif key == curses.KEY_LEFT:
140 | curserPosition = max(0, curserPosition-1)
141 | elif key == curses.KEY_RIGHT:
142 | curserPosition = min(len(userInputChars), curserPosition+1)
143 | elif key == curses.KEY_RESIZE:
144 | pass
145 | elif len(userInputChars) < maxInputLength:
146 | userInputChars.insert(curserPosition,chr(key))
147 | curserPosition = min(maxInputLength, curserPosition+1)
148 |
149 | # This function is used to visually represent a query and a number of menu items to the
150 | # user, by using nCurses. It is used for all text printing in the program (even where
151 | # no application level menu is presented, i.e by simply not providing a query and no
152 | # menu objects)
153 | def printMenu(query, menu, stdscr, choiceIndex, xAlignment=None, showItemNumber=True,
154 | jumpNumStr=''):
155 | stdscr.clear()
156 | height, width = stdscr.getmaxyx()
157 | screenCenterX = width//2
158 | screenCenterY = height//2
159 | nRowsToPrint = (len(menu)+2)
160 |
161 | if xAlignment is not None:
162 | itemX = max(min(screenCenterX - xAlignment, width-2),0)
163 | elif menu:
164 | menuWidth = max([len(f"{i+1}: {item}" if showItemNumber else str(item)) for i,
165 | item in enumerate(menu)])
166 | itemX = max(screenCenterX - menuWidth//2, 0)
167 | else:
168 | itemX = None
169 |
170 | if itemX != 0 and itemX is not None:
171 | itemX = max(min(itemX, width-2),0)
172 |
173 | jumpNumStr = jumpNumStr[:max(min(len(jumpNumStr), width-1),0)]
174 | if jumpNumStr:
175 | stdscr.addstr(0,0,jumpNumStr)
176 |
177 | offset = 0
178 | titleY = screenCenterY-nRowsToPrint//2
179 | if nRowsToPrint >= height-2:
180 | yTitleTheoretical = screenCenterY - nRowsToPrint//2
181 | ySelectedTheoretical = (yTitleTheoretical + 2 + choiceIndex)
182 | yLastTheoretical = yTitleTheoretical + nRowsToPrint-1
183 | offset = min(max(ySelectedTheoretical-screenCenterY, yTitleTheoretical),
184 | yLastTheoretical - (height-2))
185 | titleY -= offset
186 |
187 | titleX = max(screenCenterX-(len(query)//2),0)
188 | if titleX != 0:
189 | titleX = max(min(abs(titleX), width)*(titleX//abs(titleX)),0)
190 | if len(query) >= width-1:
191 | query = query[0:width-1]
192 | if titleY >= 0 and titleY= width-1:
197 | itemString = itemString[:max((width-itemX-2),0)]
198 | attr = curses.color_pair(HIGHLIGHTED if i == choiceIndex else NOT_HIGHLIGHTED)
199 | stdscr.attron(attr)
200 | itemY = screenCenterY - nRowsToPrint//2 + i + 2 - offset
201 | if itemY >= 0 and itemY < height-1 and itemString:
202 | stdscr.addstr(itemY, itemX, itemString)
203 | stdscr.attroff(attr)
204 | stdscr.refresh()
205 |
206 | """
207 | Exception classes
208 | """
209 |
210 | # indicates that the provided query style is not supported
211 | class UnknownQueryStyle(Exception):
212 | pass
213 |
--------------------------------------------------------------------------------
/youtube_rss.py:
--------------------------------------------------------------------------------
1 | #! /usr/bin/env python3
2 |
3 | # SimonDaNinja/youtube_rss - a set of tools for supporting development
4 | # of anonymous RSS-based YouTube client applications
5 |
6 | # Copyright (C) 2021 Simon Liljestrand
7 |
8 | # This program is free software: you can redistribute it and/or modify
9 | # it under the terms of the GNU General Public License as published by
10 | # the Free Software Foundation, either version 3 of the License, or
11 | # (at your option) any later version.
12 |
13 | # This program is distributed in the hope that it will be useful,
14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 | # GNU General Public License for more details.
17 |
18 | # You should have received a copy of the GNU General Public License
19 | # along with this program. If not, see .
20 |
21 | # Contact by email: simon@simonssoffa.xyz
22 |
23 | import socket
24 | import os
25 | import aiohttp
26 | import argparse
27 | import presentation
28 | import indicator_classes
29 | import constants
30 | import connection_management
31 | import shutil
32 | import database_management
33 | import method_menu
34 |
35 | """
36 | Application control flow
37 | """
38 |
39 | # this is the application level flow entered when the user has chosen to search for a
40 | # video
41 | def doInteractiveSearchForVideo(useTor=False, circuitManager=None):
42 | query = presentation.doGetUserInput("Search for video: ")
43 | querying = True
44 | while querying:
45 | try:
46 | auth = None
47 | if useTor and circuitManager is not None:
48 | auth = circuitManager.getAuth()
49 | resultList = presentation.doWaitScreen("Getting video results...",
50 | connection_management.getVideoQueryResults, query,
51 | useTor=useTor, auth=auth)
52 | if resultList:
53 | menuOptions = [
54 | method_menu.MethodMenuDecision(
55 | method_menu.VideoQueryObjectDescriber(result),
56 | playVideo,
57 | result.url,
58 | useTor=useTor,
59 | circuitManager=circuitManager
60 | ) for result in resultList
61 | ]
62 | menuOptions.insert(0, method_menu.MethodMenuDecision("[Go back]", method_menu.doReturnFromMenu))
63 | method_menu.doMethodMenu(f"Search results for '{query}':",menuOptions)
64 | querying = False
65 | else:
66 | presentation.doNotify("no results found")
67 | querying = False
68 | except Exception as e:
69 | if not presentation.doYesNoQuery(f"Something went wrong! Try again?"):
70 | querying = False
71 |
72 |
73 | # this is the application level flow entered when the user has chosen to subscribe to a
74 | # new channel
75 | def doInteractiveChannelSubscribe(useTor=False, circuitManager=None):
76 | query = presentation.doGetUserInput("Enter channel to search for: ")
77 | querying = True
78 | while querying:
79 | try:
80 | auth = None
81 | if useTor and circuitManager is not None:
82 | auth = circuitManager.getAuth()
83 | resultList = presentation.doWaitScreen("Getting channel results...",
84 | connection_management.getChannelQueryResults, query, useTor=useTor,
85 | auth=auth)
86 | if resultList:
87 | menuOptions = [
88 | method_menu.MethodMenuDecision(
89 | str(result),
90 | doChannelSubscribe,
91 | result=result,
92 | useTor=useTor,
93 | circuitManager=circuitManager
94 | ) for result in resultList
95 | ]
96 | menuOptions.insert(0, method_menu.MethodMenuDecision('[Go back]', method_menu.doReturnFromMenu))
97 | method_menu.doMethodMenu(f"search results for '{query}', choose which " + \
98 | "channel to supscribe to", menuOptions)
99 | querying = False
100 | else:
101 | if not presentation.doYesNoQuery("No results found. Try again?"):
102 | querying = False
103 | except Exception as e:
104 | if not presentation.doYesNoQuery("Something went wrong. Try again?"):
105 | querying = False
106 |
107 | # this is the application level flow entered when the user has chosen a channel that it
108 | # wants to subscribe to
109 | def doChannelSubscribe(result, useTor, circuitManager):
110 | database = presentation.doWaitScreen('', database_management.parseDatabaseFile, constants.DATABASE_PATH)
111 | refreshing = True
112 | if result.channelId in database['feeds']:
113 | presentation.doNotify("Already subscribed to this channel!")
114 | return
115 | while refreshing:
116 | try:
117 | presentation.doWaitScreen(f"getting data from feed for {result.title}...",
118 | database_management.addSubscriptionToDatabase, result.channelId,
119 | result.title, refresh=True, useTor=useTor,
120 | circuitManager=circuitManager)
121 | refreshing = False
122 | except Exception as e:
123 | if not presentation.doYesNoQuery("Something went wrong. Try again?"):
124 | doChannelUnsubscribe(result.title)
125 | querying = False
126 | refreshing = False
127 | return indicator_classes.ReturnFromMenu
128 |
129 | # this is the application level flow entered when the user has chosen to unsubscribe to
130 | # a channel
131 | def doInteractiveChannelUnsubscribe():
132 | database = presentation.doWaitScreen('', database_management.parseDatabaseFile, constants.DATABASE_PATH)
133 | if not database['title to id']:
134 | presentation.doNotify('You are not subscribed to any channels')
135 | return
136 | menuOptions = [
137 | method_menu.MethodMenuDecision(
138 | channelTitle,
139 | doChannelUnsubscribe,
140 | channelTitle
141 | ) for channelTitle in database['title to id']
142 | ]
143 | menuOptions.insert(0, method_menu.MethodMenuDecision('[Go back]', method_menu.doReturnFromMenu))
144 | method_menu.doMethodMenu("Which channel do you want to unsubscribe from?", menuOptions)
145 |
146 | # this is the application level flow entered when the user has chosen a channel that it
147 | # wants to unsubscribe from
148 | def doChannelUnsubscribe(channelTitle):
149 | database = presentation.doWaitScreen('', database_management.parseDatabaseFile, constants.DATABASE_PATH)
150 | database_management.removeSubscriptionFromDatabaseByChannelTitle(database, channelTitle)
151 | database_management.outputDatabaseToFile(database, constants.DATABASE_PATH)
152 | return indicator_classes.ReturnFromMenu
153 |
154 | # this is the application level flow entered when the user has chosen to browse
155 | # its current subscriptions
156 | def doInteractiveBrowseSubscriptions(useTor, circuitManager):
157 | database = presentation.doWaitScreen('', database_management.parseDatabaseFile, constants.DATABASE_PATH)
158 | menuOptions = [
159 | method_menu.MethodMenuDecision(
160 | method_menu.FeedDescriber(
161 | database['feeds'][database['title to id'][channelTitle]],
162 | channelTitle
163 | ), doSelectVideoFromSubscription,
164 | database,
165 | channelTitle,
166 | useTor,
167 | circuitManager
168 | ) for channelTitle in database['title to id']
169 | ]
170 |
171 | adHocKeys = [
172 | method_menu.MarkAllAsReadKey(
173 | channelId,
174 | i+1,
175 | database
176 | ) for i, channelId in enumerate(database['feeds'])
177 | ]
178 |
179 | if not menuOptions:
180 | presentation.doNotify('You are not subscribed to any channels')
181 | return
182 |
183 | menuOptions.insert(0, method_menu.MethodMenuDecision('[Go back]', method_menu.doReturnFromMenu))
184 | method_menu.doMethodMenu("Which channel do you want to watch a video from?", menuOptions,
185 | adHocKeys = adHocKeys)
186 |
187 | # this is the application level flow entered when the user has chosen a channel while
188 | # browsing its current subscriptions;
189 | # the user now gets to select a video from the channel to watch
190 | def doSelectVideoFromSubscription(database, channelTitle, useTor, circuitManager):
191 | channelId = database['title to id'][channelTitle]
192 | videos = database['feeds'][channelId]
193 | menuOptions = [
194 | method_menu.MethodMenuDecision(
195 | method_menu.FeedVideoDescriber(video),
196 | doPlayVideoFromSubscription,
197 | database,
198 | video,
199 | useTor,
200 | circuitManager
201 | ) for video in videos
202 | ]
203 |
204 | adHocKeys = [
205 | method_menu.MarkEntryAsReadKey(
206 | video,
207 | i+1
208 | ) for i, video in enumerate(videos)
209 | ]
210 | database_management.outputDatabaseToFile(database, constants.DATABASE_PATH)
211 | menuOptions.insert(0, method_menu.MethodMenuDecision("[Go back]", method_menu.doReturnFromMenu))
212 | method_menu.doMethodMenu("Which video do you want to watch?", menuOptions,
213 | adHocKeys=adHocKeys)
214 | database_management.outputDatabaseToFile(database, constants.DATABASE_PATH)
215 |
216 | # this is the application level flow entered when the user has selected a video to watch
217 | # while browsing its current subscriptions
218 | def doPlayVideoFromSubscription(database, video, useTor, circuitManager):
219 | result = playVideo(video['link'], useTor, circuitManager = circuitManager)
220 | if not video['seen']:
221 | video['seen'] = result
222 | database_management.outputDatabaseToFile(database, constants.DATABASE_PATH)
223 |
224 | # this is the application level flow entered when the user is watching any video from
225 | # YouTube
226 | def playVideo(videoUrl, useTor=False, circuitManager = None):
227 | resolutionMenuList = [1080, 720, 480, 240]
228 | maxResolution = presentation.doSelectionQuery("Which maximum resolution do you want to use?",
229 | resolutionMenuList)
230 | result = False
231 | while not result:
232 | result = presentation.doWaitScreen("playing video...", connection_management.openUrlInMpv,
233 | videoUrl, useTor=useTor, maxResolution=maxResolution, circuitManager = circuitManager)
234 | if result or not presentation.doYesNoQuery(f"Something went wrong when playing the " + \
235 | "video. Try again?"):
236 | break
237 | return result
238 |
239 | # this is the application level flow entered when the user has chosen to refresh its
240 | # subscriptions
241 | def doRefreshSubscriptions(useTor=False, circuitManager=None):
242 | database = presentation.doWaitScreen('', database_management.parseDatabaseFile,
243 | constants.DATABASE_PATH)
244 | channelIdList = list(database['id to title'])
245 | refreshing = True
246 | while refreshing:
247 | try:
248 | auth = None
249 | if useTor and circuitManager is not None:
250 | auth = circuitManager.getAuth()
251 | presentation.doWaitScreen("refreshing subscriptions...",
252 | database_management.refreshSubscriptionsByChannelId, channelIdList,
253 | useTor=useTor, auth=auth)
254 | refreshing = False
255 | except aiohttp.client_exceptions.ClientConnectionError:
256 | if not presentation.doYesNoQuery("Something went wrong. Try again?"):
257 | refreshing = False
258 |
259 | def doStartupMenu():
260 | menuOptions = [
261 | method_menu.MethodMenuDecision(
262 | "Yes",
263 | doStartupWithTor
264 | ), method_menu.MethodMenuDecision(
265 | "No",
266 | doMainMenu
267 | )
268 | ]
269 | method_menu.doMethodMenu("Do you want to use tor?", menuOptions, showItemNumber=False)
270 |
271 | def doStartupWithTor():
272 | with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
273 | result = sock.connect_ex(('127.0.0.1',9050))
274 | if result != 0:
275 | menuOptions = [
276 | method_menu.MethodMenuDecision(
277 | "Yes",
278 | doMainMenu
279 | ), method_menu.MethodMenuDecision(
280 | "No",
281 | method_menu.doNotifyAndReturnFromMenu,
282 | "Can't find Tor daemon. Exiting program."
283 | )
284 | ]
285 | method_menu.doMethodMenu("Tor daemon not found on port 9050! " + \
286 | "Continue without tor?", menuOptions, showItemNumber=False)
287 | else:
288 | doMainMenu(useTor=True, circuitManager=connection_management.CircuitManager())
289 | return indicator_classes.ReturnFromMenu
290 |
291 |
292 |
293 | def doMainMenu(useTor=False, circuitManager=None):
294 | menuOptions = [
295 | method_menu.MethodMenuDecision(
296 | "Search for video",
297 | doInteractiveSearchForVideo,
298 | useTor=useTor,
299 | circuitManager=circuitManager
300 | ), method_menu.MethodMenuDecision(
301 | "Refresh subscriptions",
302 | doRefreshSubscriptions,
303 | useTor=useTor,
304 | circuitManager=circuitManager
305 | ), method_menu.MethodMenuDecision(
306 | "Browse subscriptions",
307 | doInteractiveBrowseSubscriptions,
308 | useTor = useTor,
309 | circuitManager = circuitManager
310 | ), method_menu.MethodMenuDecision(
311 | "Subscribe to new channel",
312 | doInteractiveChannelSubscribe,
313 | useTor=useTor,
314 | circuitManager=circuitManager
315 | ), method_menu.MethodMenuDecision(
316 | "Unsubscribe from channel",
317 | doInteractiveChannelUnsubscribe,
318 | ), method_menu.MethodMenuDecision(
319 | "Quit",
320 | method_menu.doReturnFromMenu
321 | )
322 | ]
323 | method_menu.doMethodMenu("What do you want to do?", menuOptions)
324 | return indicator_classes.ReturnFromMenu
325 |
326 | ################
327 | # main section #
328 | ################
329 |
330 | if __name__ == '__main__':
331 |
332 | parser = argparse.ArgumentParser(description="A YouTube-client for managing subscriptions and watching videos anonymously over Tor without a Google account.")
333 | parser.add_argument('--use-thumbnails', action='store_true')
334 | args = parser.parse_args()
335 |
336 | if args.use_thumbnails:
337 | presentation.doNotify("Flag '--use-thumbnails' is no longer supported (see README for more info)!")
338 |
339 | if not os.path.isdir(constants.YOUTUBE_RSS_DIR):
340 | os.mkdir(constants.YOUTUBE_RSS_DIR)
341 | if not os.path.isfile(constants.DATABASE_PATH):
342 | database = database_management.initiateYouTubeRssDatabase()
343 | presentation.doWaitScreen('', database_management.outputDatabaseToFile, database, constants.DATABASE_PATH)
344 | else:
345 | database = presentation.doWaitScreen('', database_management.parseDatabaseFile, constants.DATABASE_PATH)
346 |
347 | doStartupMenu()
348 |
--------------------------------------------------------------------------------