├── .gitignore
├── .gitmodules
├── LICENSE
├── Makefile
├── README.md
├── native
├── textern.json.in
└── textern.py
└── webex
├── background.js
├── content.js
├── manifest.json
├── options.css
├── options.html
├── options.js
└── shortcut.js
/.gitignore:
--------------------------------------------------------------------------------
1 | *.pyc
2 | /native/textern.json
3 |
--------------------------------------------------------------------------------
/.gitmodules:
--------------------------------------------------------------------------------
1 | [submodule "native/inotify_simple"]
2 | path = native/inotify_simple
3 | url = https://github.com/chrisjbillington/inotify_simple
4 |
--------------------------------------------------------------------------------
/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 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
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 | {project} Copyright (C) {year} {fullname}
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 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | ifneq ($(USER),1)
2 | PREFIX ?= /usr/local
3 | MOZILLA_PREFIX ?= /usr
4 | LIBDIR ?= /usr/lib64
5 | MOZILLA_NATIVE ?= $(LIBDIR)/mozilla/native-messaging-hosts
6 | else
7 | PREFIX ?= $(HOME)/.local
8 | MOZILLA_NATIVE ?= $(HOME)/.mozilla/native-messaging-hosts
9 | endif
10 |
11 | LIBEXEC ?= $(PREFIX)/libexec
12 |
13 | .PHONY: all
14 | all:
15 | @echo "No build step. Available targets:"
16 | @echo "native-install install native app"
17 | @echo "native-uninstall uninstall native app"
18 | @echo "xpi create XPI webex archive"
19 | @echo
20 | @echo "Set USER=1 to target user directories instead."
21 |
22 | # make phony and don't depend on .in file in case $USER changes
23 | .PHONY: native/textern.json
24 | native/textern.json:
25 | sed -e 's|@@NATIVE_PATH@@|$(LIBEXEC)/textern/textern.py|' $@.in > $@
26 |
27 | .PHONY: native-install
28 | native-install: native/textern.json
29 | @if ! test -f native/inotify_simple/.git; then echo "Missing inotify_simple submodule! Try 'git submodule update --init'."; false; fi
30 | mkdir -p $(DESTDIR)$(MOZILLA_NATIVE)
31 | cp -f native/textern.json $(DESTDIR)$(MOZILLA_NATIVE)
32 | mkdir -p $(DESTDIR)$(LIBEXEC)/textern
33 | cp -rf native/textern.py native/inotify_simple $(DESTDIR)$(LIBEXEC)/textern
34 |
35 | .PHONY: native-uninstall
36 | native-uninstall:
37 | rm -f $(DESTDIR)$(MOZILLA_NATIVE)/textern.json
38 | rm -rf $(DESTDIR)$(LIBEXEC)/textern
39 |
40 | .PHONY: xpi
41 | xpi:
42 | @rm -f textern.xpi && cd webex && zip -r -FS ../textern.xpi *
43 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Textern
2 |
3 | Textern is a Firefox add-on that allows you to edit text
4 | areas in web pages using an external editor.
5 |
6 | The add-on is divided into two parts:
7 |
8 | - the WebExtension, which is available from AMO [here](https://addons.mozilla.org/addon/textern/), and
9 | - the native application, which handles text editor
10 | launching and monitoring.
11 |
12 | The native application currently only supports Linux with
13 | Python 3.5. Patches to add support for other platforms are
14 | welcome!
15 |
16 | ## Installation
17 |
18 | To clone the repository:
19 |
20 | ```sh
21 | $ git clone --recurse-submodules https://github.com/jlebon/textern
22 | $ cd textern
23 | ```
24 |
25 | IMPORTANT: make sure that your git checkout includes
26 | submodules (either use the `--recurse-submodules` when
27 | running `git clone` as shown above, or use
28 | `git submodule update --init` if already cloned).
29 |
30 | To install the native app, run:
31 |
32 | ```sh
33 | $ sudo make native-install
34 | ```
35 |
36 | To uninstall it, run:
37 |
38 | ```sh
39 | $ sudo make native-uninstall
40 | ```
41 |
42 | On distros which do not use `/usr/lib64` (such as
43 | Debian/Ubuntu), you'll want to override `LIBDIR`:
44 |
45 | ```sh
46 | $ sudo make native-install LIBDIR=/usr/lib
47 | ```
48 |
49 | If you do not have root privileges or wish to only install
50 | the native app for the current user, run:
51 |
52 | ```sh
53 | $ make native-install USER=1
54 | ```
55 |
56 | ## Usage
57 |
58 | Once both the WebExtension and the native application are
59 | installed, you can select any textbox and press Ctrl+Shift+D
60 | to open an external editor. The textarea will flash yellow
61 | upon launching the text editor, as well as whenever the file
62 | is saved.
63 |
64 | By default, gedit is opened. You can change both the key
65 | mapping as well as the configured editor in the addon
66 | preferences. Additional parameters may be passed to the
67 | editor. For example:
68 |
69 | ```json
70 | ["myeditor", "--custom-arg"]
71 | ```
72 |
73 | will launch `myeditor --custom-arg /path/to/file.txt`. You
74 | may use `%s` as a variable for the file path if don't want
75 | it to be the last argument.
76 |
77 | If your editor supports it, you can also use `%l` and `%c`
78 | to pass the line and column number of the caret position.
79 | (The capitalized versions `%L` and `%C` also exist which are
80 | smaller by one for text editors that count from zero). For
81 | example, passing this information to `gvim` (or `vim`):
82 |
83 | ```json
84 | ["gvim", "-f", "+set nofixeol", "+call setcursorcharpos(%l, %c)"]
85 | ```
86 |
87 | Example for emacs:
88 |
89 | ```json
90 | ["emacs", "%s", "--eval", "(progn (goto-line %l) (move-to-column (1- %c)))"]
91 | ```
92 |
93 | ### Terminal editors
94 |
95 | If you would like to use a terminal editor such as vim or
96 | emacs, you will need to modify the configuration such that
97 | Textern starts a terminal emulator which runs the text
98 | editor. For example, for `nvim` this could look like
99 |
100 | ```json
101 | ["xterm", "-e", "nvim", "+call cursor(%l,%c)"]
102 | ```
103 |
104 | Here, `xterm` is the terminal emulator, `-e` instructs it to
105 | start a program, which is `nvim` (the editor we're actually
106 | interested in) with the given parameters.
107 |
108 | This works similarly with `konsole` or `gnome-terminal`
109 | instead of `xterm`. For example, starting `vim` with
110 | `gnome-terminal`:
111 |
112 | ```json
113 | ["gnome-terminal", "--wait", "--", "vim", "+call cursor(%l,%c)"]
114 | ```
115 |
116 | Note that by default the `gnome-terminal` process won't wait
117 | for the spawned process to finish before exiting so you'll
118 | need to make sure you add the `--wait` flag.
119 |
120 | With `konsole`, you may need to ensure it runs in its own process
121 | with the either the `--separate` or `--nofork` flag:
122 |
123 | ```json
124 | ["konsole", "--separate", "-e", "vim", "+normal %lG%c|"]
125 | ```
126 |
127 | ### GUI editors
128 |
129 | Non-terminal-based editors can also suffer from the same
130 | waiting problem described above. For example, gedit does not
131 | fork and thus can be used directly:
132 |
133 | ```json
134 | ["gedit"]
135 | ```
136 |
137 | On the other hand, `gvim` by default will fork and detach.
138 | One must thus make sure to pass the `-f` switch for it to
139 | stay in the foreground:
140 |
141 | ```json
142 | ["gvim", "-f"]
143 | ```
144 |
145 | #### Flatpak
146 |
147 | Flatpak-packaged editors should work fine, as long as the
148 | application has access to the `XDG_RUNTIME_DIR` directory.
149 | For example, to use the GNOME gedit flatpak, use:
150 |
151 | ```json
152 | ["flatpak", "run", "--filesystem=xdg-run/textern", "org.gnome.gedit"]
153 | ```
154 |
155 | ### Enabling backups
156 |
157 | Textern has experimental support for backing up text to a
158 | separate location to allow recovering data inadvertently
159 | lost by closing a tab or Firefox too soon. To enable this
160 | feature, enter a path to the backup directory in the addon
161 | preferences page. Note no shell expansion is performed on
162 | the path (use e.g. `/home/jlebon` instead of `~`).
163 |
164 | **All files** older than 24 hours are deleted from the
165 | backup directory (i.e., not just those files that Textern
166 | created). If there are files in the directory that Textern
167 | fails to delete, then Textern will misbehave. For this
168 | reason, make sure the backup directory is exclusively used
169 | by Textern.
170 |
171 | Note this feature is experimental and subject to change.
172 |
173 | ## Troubleshooting
174 |
175 | Some things to try if it doesn't work properly:
176 |
177 | * Ensure you are running the latest version of Firefox
178 | * Try configuring Textern to launch using a different shortcut
179 | * Try configuring Textern to use the following as the external editor: `["sh", "-c", "echo foobar > $0"]` (that should just echo foobar into the textarea box)
180 | * Check the browser console for errors (Ctrl+Shift+J)
181 | * Check the extension's console for errors (Go to `about:debugging`, find Textern in the list of extensions, and click Inspect)
182 | * Make sure you cloned the repo with `--recurse-submodules` (see installation instructions above)
183 | * Try re-installing but for your local user (`make native-install USER=1` instead of `sudo make native-install`)
184 | * Check if Textern is running in the background (`ps aux | grep textern`)
185 |
186 | ### Firejail
187 |
188 | [Firejail](https://firejail.wordpress.com/) is a sandboxing program to restrict what your browser can do. It will prevent Textern from working.
189 |
190 | If you install Textern with USER=1, and your firejail instance is not using apparmor, then add to /etc/firejail/firejail.local:
191 |
192 | whitelist ${HOME}/.local/libexec/textern/
193 | noblacklist ${PATH}/python3*
194 | noblacklist /usr/lib/python3*
195 |
196 | If apparmor is enabled, then add the Python lines to firejail.local and see [issue 52](#52).
197 |
198 | ## Related Projects
199 |
200 | ### It's All Text!
201 |
202 | https://github.com/docwhat/itsalltext/
203 |
204 | This is the project that inspired this add-on.
205 | Unfortunately, it is not compatible with WebExtensions and
206 | thus cannot be installed on Firefox 57 or later.
207 |
208 | ### Tridactyl
209 |
210 | https://github.com/cmcaine/tridactyl
211 |
212 | Generic addon that adds Vim-like bindings to Firefox,
213 | including an `:editor` command which provides similar
214 | functionality to Textern.
215 |
216 | ### withExEditor
217 |
218 | https://github.com/asamuzaK/withExEditor
219 |
220 | Similar to Textern and supports WebExtensions. Native app is
221 | cross-platform but requires Node.js.
222 |
223 | ### GhostText
224 |
225 | https://github.com/GhostText/GhostText
226 |
227 | Uses editor-specific plugins to provide two-way on-the-fly
228 | sync between webpage and editor.
229 |
--------------------------------------------------------------------------------
/native/textern.json.in:
--------------------------------------------------------------------------------
1 | {
2 | "name": "textern",
3 | "description": "Edit text with an external editor.",
4 | "path": "@@NATIVE_PATH@@",
5 | "type": "stdio",
6 | "allowed_extensions": [ "textern@jlebon.com" ]
7 | }
8 |
--------------------------------------------------------------------------------
/native/textern.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 | # vim: set et ts=4 tw=80:
3 | # This file is part of Textern.
4 | # Copyright (C) 2017-2018 Jonathan Lebon
5 | # Copyright (C) 2018 Oleg Broytman
6 | # SPDX-License-Identifier: GPL-3.0-or-later
7 |
8 | import asyncio
9 | import json
10 | import os
11 | import shutil
12 | import struct
13 | import sys
14 | import tempfile
15 | import urllib.parse
16 | import time
17 |
18 | try:
19 | from inotify_simple import INotify, flags
20 | except ImportError:
21 | # fall-back to the old import pattern for git-submodule use-case (PR#57)
22 | from inotify_simple.inotify_simple import INotify, flags
23 |
24 |
25 | BACKUP_RETENTION_SECS = 24 * 60 * 60
26 |
27 |
28 | class TmpManager():
29 |
30 | def __init__(self):
31 | try:
32 | tmpdir_parent = os.path.join(
33 | os.environ['XDG_RUNTIME_DIR'], 'textern')
34 | os.makedirs(tmpdir_parent)
35 | except FileExistsError:
36 | pass
37 | except (KeyError, OSError):
38 | tmpdir_parent = None
39 | self._backupdir = ""
40 | self.tmpdir = tempfile.mkdtemp(prefix="textern-", dir=tmpdir_parent)
41 | self._tmpfiles = {} # relfn --> opaque
42 |
43 | def __enter__(self):
44 | return self
45 |
46 | def __exit__(self, exc_type, exc_val, exc_tb):
47 | shutil.rmtree(self.tmpdir)
48 |
49 | def __contains__(self, relfn):
50 | return relfn in self._tmpfiles
51 |
52 | def update_backupdir(self, val):
53 | self._backupdir = val
54 | if self._backupdir != "":
55 | os.makedirs(self._backupdir, exist_ok=True)
56 | now = time.time()
57 | for path in os.listdir(self._backupdir):
58 | fn = os.path.join(self._backupdir, path)
59 | if not os.path.isfile(fn):
60 | continue
61 | stbuf = os.stat(fn)
62 | if now - stbuf.st_mtime > BACKUP_RETENTION_SECS:
63 | os.unlink(fn)
64 |
65 | def new(self, text, url, extension, opaque):
66 | sanitized_url = urllib.parse.quote(url, safe='')
67 | f, absfn = tempfile.mkstemp(dir=self.tmpdir,
68 | prefix=(sanitized_url + '-'),
69 | suffix=("." + extension))
70 | # this itself will cause a harmless inotify event, though as a cool
71 | # side effect, we get an initial highlighting of the text area which is
72 | # nice feedback that the command was received
73 | os.write(f, text.encode("utf-8"))
74 | os.close(f)
75 | relfn = os.path.basename(absfn)
76 | assert relfn not in self._tmpfiles
77 | self._tmpfiles[relfn] = opaque
78 | return absfn
79 |
80 | def delete(self, absfn):
81 | relfn = os.path.basename(absfn)
82 | assert relfn in self._tmpfiles
83 | self._tmpfiles.pop(relfn)
84 | os.unlink(absfn)
85 |
86 | def backup(self, relfn):
87 | if self._backupdir == "":
88 | return
89 | assert relfn in self._tmpfiles
90 | absfn = os.path.join(self.tmpdir, relfn)
91 | if os.stat(absfn).st_size > 0:
92 | shutil.copyfile(absfn, os.path.join(self._backupdir, relfn))
93 |
94 | def get(self, relfn):
95 | assert relfn in self._tmpfiles
96 | with open(os.path.join(self.tmpdir, relfn), encoding='utf-8') as f:
97 | return f.read(), self._tmpfiles[relfn]
98 |
99 |
100 | def main():
101 | with INotify() as ino, TmpManager() as tmp_mgr:
102 | ino.add_watch(tmp_mgr.tmpdir, flags.CLOSE_WRITE)
103 | loop = asyncio.get_event_loop()
104 | loop.add_reader(sys.stdin.buffer, handle_stdin, tmp_mgr)
105 | loop.add_reader(ino.fd, handle_inotify_event, ino, tmp_mgr)
106 | loop.run_forever()
107 | loop.close()
108 |
109 |
110 | def handle_stdin(tmp_mgr):
111 | # In theory, these reads could block, since we only know that there is some
112 | # data, but not that all the data is there. We could be more strict here by
113 | # reading in a separate thread. In practice, we're trusting that we're
114 | # talking with Firefox and that readiness implies a full message (length +
115 | # content) is ready to be read.
116 | loop = asyncio.get_event_loop()
117 | raw_length = sys.stdin.buffer.read(4)
118 | if len(raw_length) == 0:
119 | loop.stop()
120 | return
121 | length = struct.unpack('@I', raw_length)[0]
122 | raw_message = sys.stdin.buffer.read(length)
123 | if len(raw_message) != length:
124 | raise Exception("expected %d bytes, but got %d" % (length,
125 | len(raw_message)))
126 | message = json.loads(raw_message.decode('utf-8'))
127 | loop.create_task(handle_message(tmp_mgr, message))
128 |
129 |
130 | def get_final_editor_args(editor_args, absfn, line, column):
131 | final_editor_args = []
132 | fn_added = False
133 | for arg in editor_args:
134 | if '%s' in arg:
135 | arg = arg.replace('%s', absfn)
136 | fn_added = True
137 | if '%l' in arg:
138 | arg = arg.replace('%l', str(line+1))
139 | if '%L' in arg:
140 | arg = arg.replace('%L', str(line))
141 | if '%c' in arg:
142 | arg = arg.replace('%c', str(column+1))
143 | if '%C' in arg:
144 | arg = arg.replace('%C', str(column))
145 | final_editor_args.append(arg)
146 | if not fn_added:
147 | final_editor_args.append(absfn)
148 | return final_editor_args
149 |
150 |
151 | async def handle_message(tmp_mgr, msg):
152 | await message_handlers[msg["type"]](tmp_mgr, msg["payload"])
153 |
154 |
155 | def offset_to_line_and_column(text, offset):
156 | offset = max(0, min(len(text), offset))
157 | text = text[:offset]
158 | line = text.count('\n')
159 | if line == 0:
160 | column = offset
161 | else:
162 | column = len(text[text.rindex('\n')+1:])
163 | # NB: these are zero-based indexes
164 | return line, column
165 |
166 |
167 | async def handle_message_new_text(tmp_mgr, msg):
168 |
169 | # create a new tempfile for it
170 | absfn = tmp_mgr.new(msg["text"], msg["url"],
171 | msg["prefs"]["extension"], msg["id"])
172 |
173 | # for now, we get preferences as part of new_text updates; in the future, we
174 | # may add a `set_prefs` message dedicated to this
175 | tmp_mgr.update_backupdir(msg["prefs"].get("backupdir", ""))
176 | editor_args = json.loads(msg["prefs"]["editor"])
177 |
178 | line, column = offset_to_line_and_column(msg["text"], msg["caret"])
179 |
180 | editor_args = get_final_editor_args(editor_args, absfn, line, column)
181 | try:
182 | proc = await asyncio.create_subprocess_exec(
183 | *editor_args,
184 | stdout=asyncio.subprocess.DEVNULL,
185 | stderr=asyncio.subprocess.DEVNULL
186 | )
187 | except FileNotFoundError:
188 | send_error("could not find editor '%s'" % editor_args[0])
189 | else:
190 | await proc.wait()
191 | if proc.returncode != 0:
192 | send_error("editor '%s' did not exit successfully"
193 | % editor_args[0])
194 | finally:
195 | send_death_notice(msg["id"])
196 | tmp_mgr.delete(absfn)
197 |
198 |
199 | message_handlers = {
200 | "new_text": handle_message_new_text,
201 | }
202 |
203 |
204 | def handle_inotify_event(ino, tmp_mgr):
205 | for event in ino.read():
206 | # this check is relevant in the case where we're handling the inotify
207 | # event caused by tmp_mgr.new(), but then an exception occurred in
208 | # handle_message() which caused the tmpfile to already be deleted
209 | if event.name in tmp_mgr:
210 | text, id = tmp_mgr.get(event.name)
211 | send_text_update(id, text)
212 | tmp_mgr.backup(event.name)
213 |
214 |
215 | def send_text_update(id, text):
216 | send_raw_message("text_update", {"id": id, "text": text})
217 |
218 |
219 | def send_death_notice(id):
220 | send_raw_message("death_notice", {"id": id})
221 |
222 |
223 | def send_error(error):
224 | send_raw_message("error", {"error": error})
225 |
226 |
227 | def send_raw_message(type, payload):
228 |
229 | # This is *also* potentially blocking, so to be more strict we'd delegate
230 | # this to a thread. Though in practice, we expect Firefox to clear the pipe
231 | # quickly enough.
232 |
233 | # writing as part of the event loop here means we don't have to lock stdout
234 | raw_msg = json.dumps({"type": type, "payload": payload}).encode('utf-8')
235 | sys.stdout.buffer.write(struct.pack('@I', len(raw_msg)))
236 | sys.stdout.buffer.write(raw_msg)
237 | sys.stdout.buffer.flush()
238 |
239 |
240 | def dbg(*args):
241 | print(*args, file=sys.stderr)
242 | sys.stderr.flush()
243 |
244 |
245 | if __name__ == "__main__":
246 | sys.exit(main())
247 |
--------------------------------------------------------------------------------
/webex/background.js:
--------------------------------------------------------------------------------
1 | /* vim: set et ts=4 tw=92:
2 | * Copyright (C) 2017-2018 Jonathan Lebon
3 | * This file is part of Textern.
4 | * SPDX-License-Identifier: GPL-3.0-or-later
5 | */
6 |
7 | "use strict";
8 |
9 | var port = undefined;
10 |
11 | var activeDocs = [];
12 |
13 | function logError(error) {
14 | console.log(`Error: ${error}`);
15 | }
16 |
17 | function assertNoResponse(response) {
18 | console.assert(response == undefined);
19 | }
20 |
21 | function notifyError(error) {
22 | browser.notifications.create({
23 | type: "basic",
24 | title: "Textern",
25 | message: "Error: " + error + "."
26 | });
27 | }
28 |
29 | function contentSetActiveText(tid, eid, text) {
30 | var sender = browser.tabs.sendMessage(tid, {type: "set_text", id: eid, text: text});
31 | /* XXX: treat this error specially and notify? e.g. if tab was closed */
32 | sender.then(assertNoResponse, logError);
33 | }
34 |
35 | function handleNativeMessage(msg) {
36 | if (msg.type == "text_update") {
37 | var [tid, eid] = msg.payload.id.split("_").map(x => { return parseInt(x); });
38 | if (tid == NaN || eid == NaN) {
39 | console.log(`Invalid id: ${id}`);
40 | return;
41 | }
42 | contentSetActiveText(tid, eid, msg.payload.text);
43 | } else if (msg.type == "death_notice") {
44 | unregisterDoc(msg.payload.id);
45 | } else if (msg.type == "error") {
46 | notifyError(msg.payload.error);
47 | } else {
48 | console.log(`Unknown native message type: ${msg.type}`);
49 | }
50 | }
51 |
52 | function unregisterDoc(id) {
53 |
54 | var i = activeDocs.indexOf(id);
55 | if (i == -1) {
56 | console.log(`Error: document id ${id} isn't being edited`);
57 | return;
58 | }
59 |
60 | activeDocs.splice(i, 1);
61 | if (activeDocs.length == 0) {
62 | port.disconnect();
63 | port = undefined;
64 | }
65 | }
66 |
67 | function registerDoc(tid, eid, text, caret, url) {
68 |
69 | var id = `${tid}_${eid}`;
70 | if (activeDocs.indexOf(id) != -1) {
71 | console.log(`Error: document id ${id} is already being edited`);
72 | notifyError("this text is already being edited");
73 | return;
74 | }
75 |
76 | activeDocs.push(id);
77 | if (port == undefined) {
78 | port = browser.runtime.connectNative("textern");
79 | port.onMessage.addListener((response) => {
80 | handleNativeMessage(response);
81 | });
82 | port.onDisconnect.addListener((p) => {
83 | console.log("Disconnected from helper");
84 | if (p.error) {
85 | logError(p.error);
86 | }
87 | activeDocs = [];
88 | port = undefined;
89 | });
90 | }
91 |
92 | browser.storage.local.get({
93 | editor: "[\"gedit\", \"+%l:%c\"]",
94 | extension: "txt",
95 | backupdir: ""
96 | }).then(values => {
97 | port.postMessage({
98 | type: "new_text",
99 | payload: {
100 | id: id,
101 | text: text,
102 | caret: caret,
103 | url: url,
104 | prefs: {
105 | editor: values.editor,
106 | extension: values.extension,
107 | backupdir: values.backupdir
108 | }
109 | }
110 | });
111 | }, logError);
112 | }
113 |
114 | function handleRegisterText(tabId, message) {
115 | registerDoc(tabId, message.id, message.text, message.caret, message.url);
116 | }
117 |
118 | function onMessage(message, sender, respond) {
119 | if (sender.id != "textern@jlebon.com")
120 | return;
121 | var tabId = sender.tab.id;
122 | if (message.type == "register_text")
123 | handleRegisterText(tabId, message);
124 | else
125 | console.log(`Unknown message type: ${message.type}`);
126 | }
127 |
128 | browser.runtime.onMessage.addListener(onMessage);
129 |
--------------------------------------------------------------------------------
/webex/content.js:
--------------------------------------------------------------------------------
1 | /* vim: set et ts=4 tw=92:
2 | * Copyright (C) 2017-2018 Jonathan Lebon
3 | * This file is part of Textern.
4 | * SPDX-License-Identifier: GPL-3.0-or-later
5 | */
6 |
7 | "use strict";
8 |
9 | var elements = new Map(); /* id --> e */
10 |
11 | function logError(error) {
12 | console.log(`Error: ${error}`);
13 | }
14 |
15 | function assertNoResponse(response) {
16 | console.assert(response == undefined);
17 | }
18 |
19 | function notifyError(error) {
20 | browser.notifications.create({
21 | type: "basic",
22 | title: "Textern",
23 | message: "Error: " + error + "."
24 | });
25 | }
26 |
27 | function watchElement(e) {
28 | /* these are IDs we assign ourselves, unrelated to its DOM id */
29 | if (!("texternId" in e))
30 | e.texternId = elements.size;
31 | elements.set(e.texternId, e);
32 | return e.texternId;
33 | }
34 |
35 | // Check if this is a GMail message body
36 | function isGmailMessageBody(e) {
37 | return e.baseURI.startsWith("https://mail.google") &&
38 | e.attributes["aria-label"].textContent == "Message Body";
39 | }
40 |
41 | function gmailGetText(e) {
42 | return e.innerText
43 | // non-breakable space to space
44 | .replaceAll("\u00A0", " ")
45 | // innerText gets confused by
for empty newlines
46 | // resulting in two newlines. undo that.
47 | .replaceAll("\n\n", "\n");
48 | }
49 |
50 | function gmailSetText(e, text) {
51 | e.innerHTML = "";
52 | var lines = text.split("\n");
53 | for (i = 0; i < lines.length; i++) {
54 | var div = document.createElement('div');
55 | div.textContent = lines[i].replaceAll(" ", "\u00A0");
56 | if (lines[i].trim().length == 0) {
57 | div.appendChild(document.createElement('br'));
58 | }
59 | e.appendChild(div);
60 | }
61 | }
62 |
63 | /* special hack for Slack: https://github.com/jlebon/textern/issues/61 */
64 | function isSlackMessage(e) {
65 | return (window.location.hostname.endsWith(".slack.com") &&
66 | e.classList.contains("ql-editor"));
67 | }
68 |
69 | function slackGetText(e) {
70 | /* each line is a different
element */
71 | var text = "";
72 | for (i = 0; i < e.children.length; i++) {
73 | if (i > 0) {
74 | text += "\n";
75 | }
76 | text += e.children[i].textContent;
77 | }
78 | return text;
79 | }
80 |
81 | function slackSetText(e, text) {
82 | e.innerHTML = "";
83 | var lines = text.split("\n");
84 | for (i = 0; i < lines.length; i++) {
85 | var p = document.createElement('p');
86 | p.textContent = lines[i];
87 | if (lines[i].length == 0) {
88 | p.appendChild(document.createElement('br'));
89 | }
90 | e.appendChild(p);
91 | }
92 | }
93 |
94 | function registerText(event) {
95 | var e = event.target;
96 | if (e.nodeName == "TEXTAREA") {
97 | var id = watchElement(e);
98 | /* don't use href directly to not bring in e.g. url params */
99 | var simple_url = window.location.hostname + window.location.pathname
100 | browser.runtime.sendMessage("textern@jlebon.com", {
101 | type: "register_text",
102 | id: id,
103 | text: e.value,
104 | caret: e.selectionStart,
105 | url: simple_url
106 | }).then(assertNoResponse, logError);
107 | } else if ((e.nodeName == "DIV") && e.contentEditable) {
108 | var id = watchElement(e);
109 | /* don't use href directly to not bring in e.g. url params */
110 | var simple_url = window.location.hostname + window.location.pathname;
111 | var text = "";
112 | if (isSlackMessage(e)) {
113 | text = slackGetText(e);
114 | } else if (isGmailMessageBody(e)) {
115 | text = gmailGetText(e);
116 | } else {
117 | text = e.innerText;
118 | }
119 | browser.runtime.sendMessage("textern@jlebon.com", {
120 | type: "register_text",
121 | id: id,
122 | text: text,
123 | caret: 0,
124 | url: simple_url
125 | }).then(assertNoResponse, logError);
126 | } else {
127 | notifyError("no text field selected");
128 | }
129 | }
130 |
131 | function rgb(r, g, b) {
132 | return 'rgb(' + ([r, g, b].join()) + ')';
133 | }
134 |
135 | const ANIMATION_DURATION_S = 500.0;
136 | const ANIMATION_N_STEPS = 10;
137 |
138 | function fadeBackground(e) {
139 | if ("texternOrigBackgroundColor" in e)
140 | return; /* if there's already an animation in progress, don't start a new one */
141 | e.texternOrigBackgroundColor = e.style.backgroundColor;
142 | e.style.backgroundColor = rgb(255, 255, 0);
143 | var i = 0;
144 | var timerId = window.setInterval(function() {
145 | if (i < ANIMATION_N_STEPS) {
146 | e.style.backgroundColor = rgb(255, 255, i*(255/ANIMATION_N_STEPS));
147 | i++;
148 | } else {
149 | e.style.backgroundColor = e.texternOrigBackgroundColor;
150 | delete e.texternOrigBackgroundColor;
151 | window.clearInterval(timerId);
152 | }
153 | }, ANIMATION_DURATION_S / ANIMATION_N_STEPS);
154 | }
155 |
156 | function setText(id, text) {
157 | var e = elements.get(id);
158 | if (e.nodeName == "TEXTAREA") {
159 | e.value = text;
160 | /* send input event to make website (p.e. tiddlywiki.com) aware of updated text */
161 | e.dispatchEvent(new Event('input', {}));
162 | } else if ((e.nodeName == "DIV") && e.contentEditable) {
163 | if (isSlackMessage(e)) {
164 | slackSetText(e, text);
165 | } else if (isGmailMessageBody(e)) {
166 | gmailSetText(e, text);
167 | } else {
168 | e.innerText = text;
169 | }
170 | }
171 | fadeBackground(e);
172 | }
173 |
174 | function onMessage(message, sender, respond) {
175 | if (sender.id != "textern@jlebon.com")
176 | return;
177 | if (message.type == "set_text")
178 | setText(message.id, message.text);
179 | else {
180 | console.log(`Unknown message type: ${message.type}`);
181 | }
182 | }
183 |
184 | browser.runtime.onMessage.addListener(onMessage);
185 |
186 | var currentShortcut = undefined;
187 | function registerShortcut(force) {
188 | browser.storage.local.get({shortcut: "Ctrl+Shift+D"}).then(val => {
189 | if ((val.shortcut == currentShortcut) && !force)
190 | return; /* no change */
191 | if (currentShortcut != undefined)
192 | shortcut.remove(currentShortcut);
193 | currentShortcut = val.shortcut;
194 | shortcut.add(currentShortcut, registerText);
195 | });
196 | }
197 |
198 | registerShortcut(true);
199 |
200 | /* meh, we just re-apply the shortcut -- XXX: should check what actually changed */
201 | browser.storage.onChanged.addListener(function(changes, areaName) {
202 | registerShortcut(false);
203 | });
204 |
205 | /* we also want to make sure we re-register whenever the number of iframes changes */
206 | var lastNumFrames = window.frames.length;
207 | const observer = new MutationObserver(function() {
208 | if (window.frames.length != lastNumFrames) {
209 | registerShortcut(true);
210 | lastNumFrames = window.frames.length;
211 | }
212 | });
213 | observer.observe(document, {childList: true, subtree: true});
214 |
--------------------------------------------------------------------------------
/webex/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Textern",
3 | "description": "Edit text in your favourite external editor!",
4 | "homepage_url": "https://github.com/jlebon/textern",
5 | "manifest_version": 2,
6 | "version": "0.8",
7 |
8 | "browser_specific_settings": {
9 | "gecko": {
10 | "id": "textern@jlebon.com",
11 | "strict_min_version": "57.0"
12 | }
13 | },
14 |
15 | "background": {
16 | "scripts": ["background.js"]
17 | },
18 |
19 | "content_scripts": [
20 | {
21 | "matches": [""],
22 | "js": ["shortcut.js", "content.js"]
23 | }
24 | ],
25 |
26 | "options_ui": {
27 | "page": "options.html"
28 | },
29 |
30 | "permissions": ["notifications", "nativeMessaging", "storage"]
31 | }
32 |
--------------------------------------------------------------------------------
/webex/options.css:
--------------------------------------------------------------------------------
1 | /* vim: set et ts=4 tw=92:
2 | * Copyright (C) 2017-2018 Jonathan Lebon
3 | * This file is part of Textern.
4 | * SPDX-License-Identifier: GPL-3.0-or-later
5 | */
6 |
7 | form > * {
8 | font-size: 120%;
9 | margin-bottom: 5px;
10 | margin-left: 5px;
11 | }
12 |
13 | form > span {
14 | padding-left: 10px;
15 | }
16 |
17 | form > input, form > label {
18 | display: block;
19 | }
20 |
21 | form > input {
22 | width: 80%;
23 | }
24 |
25 | form > button {
26 | height: 1.75em;
27 | width: 7em;
28 | margin-top: 10px;
29 | text-align: center;
30 | }
31 |
--------------------------------------------------------------------------------
/webex/options.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/webex/options.js:
--------------------------------------------------------------------------------
1 | /* vim: set et ts=4 tw=92:
2 | * Copyright (C) 2017-2018 Jonathan Lebon
3 | * This file is part of Textern.
4 | * SPDX-License-Identifier: GPL-3.0-or-later
5 | */
6 |
7 | "use strict";
8 |
9 | function onError(error) {
10 | console.log(`Error: ${error}`);
11 | }
12 |
13 | function saveOptions(e) {
14 | e.preventDefault();
15 | browser.storage.local.set({
16 | editor: document.querySelector("#editor").value,
17 | shortcut: document.querySelector("#shortcut").value,
18 | extension: document.querySelector("#extension").value,
19 | backupdir: document.querySelector("#backupdir").value
20 | });
21 | document.querySelector("#saved").innerHTML = '\u2713';
22 | }
23 |
24 | function clearCheckmark(e) {
25 | document.querySelector("#saved").innerHTML = "";
26 | }
27 |
28 | function restoreOptions() {
29 |
30 | browser.storage.local.get("editor").then(result => {
31 | document.querySelector("#editor").value =
32 | result.editor || "[\"gedit\", \"+%l:%c\"]";
33 | }, onError);
34 |
35 | browser.storage.local.get("shortcut").then(result => {
36 | document.querySelector("#shortcut").value = result.shortcut || "Ctrl+Shift+D";
37 | }, onError);
38 |
39 | browser.storage.local.get("extension").then(result => {
40 | document.querySelector("#extension").value = result.extension || "txt";
41 | }, onError);
42 |
43 | browser.storage.local.get("backupdir").then(result => {
44 | document.querySelector("#backupdir").value = result.backupdir || "";
45 | }, onError);
46 | }
47 |
48 | document.addEventListener("DOMContentLoaded", restoreOptions);
49 | document.querySelector("form").addEventListener("submit", saveOptions);
50 | document.querySelectorAll("form > input").forEach(
51 | function(value, key, listObj, argument) {
52 | value.addEventListener("input", clearCheckmark);
53 | }
54 | )
55 |
--------------------------------------------------------------------------------
/webex/shortcut.js:
--------------------------------------------------------------------------------
1 | /**
2 | * http://www.openjs.com/scripts/events/keyboard_shortcuts/
3 | * Version : 2.01.B
4 | * By Binny V A
5 | * License : BSD
6 | *
7 | * Adapted by Jonathan Lebon .
8 | */
9 | shortcut = {
10 | 'all_shortcuts':{},//All the shortcuts are stored in this array
11 | 'add': function(shortcut_combination,callback,opt) {
12 | //Provide a set of default options
13 | var default_options = {
14 | 'type':'keydown',
15 | 'propagate':false,
16 | 'disable_in_input':false,
17 | 'target':window,
18 | 'keycode':false
19 | }
20 | if(!opt) opt = default_options;
21 | else {
22 | for(var dfo in default_options) {
23 | if(typeof opt[dfo] == 'undefined') opt[dfo] = default_options[dfo];
24 | }
25 | }
26 |
27 | var ele = opt.target;
28 | if(typeof opt.target == 'string') ele = document.getElementById(opt.target);
29 | var ths = this;
30 | shortcut_combination = shortcut_combination.toLowerCase();
31 |
32 | //The function to be called at keypress
33 | var func = function(e) {
34 | if(opt['disable_in_input']) { //Don't enable shortcut keys in Input, Textarea fields
35 | var element;
36 | if(e.target) element=e.target;
37 | else if(e.srcElement) element=e.srcElement;
38 | if(element.nodeType==3) element=element.parentNode;
39 |
40 | if(element.tagName == 'INPUT' || element.tagName == 'TEXTAREA') return;
41 | }
42 |
43 | //Find Which key is pressed
44 | if (e.keyCode) code = e.keyCode;
45 | else if (e.which) code = e.which;
46 | var character = String.fromCharCode(code).toLowerCase();
47 |
48 | if(code == 188) character=","; //If the user presses , when the type is onkeydown
49 | if(code == 190) character="."; //If the user presses , when the type is onkeydown
50 |
51 | var keys = shortcut_combination.split("+");
52 | //Key Pressed - counts the number of valid keypresses - if it is same as the number of keys, the shortcut function is invoked
53 | var kp = 0;
54 |
55 | //Work around for stupid Shift key bug created by using lowercase - as a result the shift+num combination was broken
56 | var shift_nums = {
57 | "`":"~",
58 | "1":"!",
59 | "2":"@",
60 | "3":"#",
61 | "4":"$",
62 | "5":"%",
63 | "6":"^",
64 | "7":"&",
65 | "8":"*",
66 | "9":"(",
67 | "0":")",
68 | "-":"_",
69 | "=":"+",
70 | ";":":",
71 | "'":"\"",
72 | ",":"<",
73 | ".":">",
74 | "/":"?",
75 | "\\":"|"
76 | }
77 | //Special Keys - and their codes
78 | var special_keys = {
79 | 'esc':27,
80 | 'escape':27,
81 | 'tab':9,
82 | 'space':32,
83 | 'return':13,
84 | 'enter':13,
85 | 'backspace':8,
86 |
87 | 'scrolllock':145,
88 | 'scroll_lock':145,
89 | 'scroll':145,
90 | 'capslock':20,
91 | 'caps_lock':20,
92 | 'caps':20,
93 | 'numlock':144,
94 | 'num_lock':144,
95 | 'num':144,
96 |
97 | 'pause':19,
98 | 'break':19,
99 |
100 | 'insert':45,
101 | 'home':36,
102 | 'delete':46,
103 | 'end':35,
104 |
105 | 'pageup':33,
106 | 'page_up':33,
107 | 'pu':33,
108 |
109 | 'pagedown':34,
110 | 'page_down':34,
111 | 'pd':34,
112 |
113 | 'left':37,
114 | 'up':38,
115 | 'right':39,
116 | 'down':40,
117 |
118 | 'f1':112,
119 | 'f2':113,
120 | 'f3':114,
121 | 'f4':115,
122 | 'f5':116,
123 | 'f6':117,
124 | 'f7':118,
125 | 'f8':119,
126 | 'f9':120,
127 | 'f10':121,
128 | 'f11':122,
129 | 'f12':123
130 | }
131 |
132 | var modifiers = {
133 | shift: { wanted:false, pressed:false},
134 | ctrl : { wanted:false, pressed:false},
135 | alt : { wanted:false, pressed:false},
136 | meta : { wanted:false, pressed:false} //Meta is Mac specific
137 | };
138 |
139 | if(e.ctrlKey) modifiers.ctrl.pressed = true;
140 | if(e.shiftKey) modifiers.shift.pressed = true;
141 | if(e.altKey) modifiers.alt.pressed = true;
142 | if(e.metaKey) modifiers.meta.pressed = true;
143 |
144 | for(var i=0; k=keys[i],i 1) { //If it is a special key
161 | if(special_keys[k] == code) kp++;
162 |
163 | } else if(opt['keycode']) {
164 | if(opt['keycode'] == code) kp++;
165 |
166 | } else { //The special keys did not match
167 | if(character == k) kp++;
168 | else {
169 | if(shift_nums[character] && e.shiftKey) { //Stupid Shift key bug created by using lowercase
170 | character = shift_nums[character];
171 | if(character == k) kp++;
172 | }
173 | }
174 | }
175 | }
176 |
177 | if(kp == keys.length &&
178 | modifiers.ctrl.pressed == modifiers.ctrl.wanted &&
179 | modifiers.shift.pressed == modifiers.shift.wanted &&
180 | modifiers.alt.pressed == modifiers.alt.wanted &&
181 | modifiers.meta.pressed == modifiers.meta.wanted) {
182 | callback(e);
183 |
184 | if(!opt['propagate']) { //Stop the event
185 | //e.cancelBubble is supported by IE - this will kill the bubbling process.
186 | e.cancelBubble = true;
187 | e.returnValue = false;
188 |
189 | //e.stopPropagation works in Firefox.
190 | if (e.stopPropagation) {
191 | e.stopPropagation();
192 | e.preventDefault();
193 | }
194 | return false;
195 | }
196 | }
197 | }
198 | this.all_shortcuts[shortcut_combination] = {
199 | 'callback':func,
200 | 'target':ele,
201 | 'event': opt['type']
202 | };
203 | //Attach the function with the event
204 |
205 | ele.addEventListener(opt['type'], func, true);
206 |
207 | // special-case window: in that case, we want to make sure to attach to
208 | // all the nested frames too
209 | if (ele === window) {
210 | for (i = 0; i < window.frames.length; i++) {
211 | try {
212 | window.frames[i].addEventListener(opt['type'], func, true);
213 | } catch(err) {
214 | console.log(`Failed to add shortcut on window frame ${i}: ${err}`);
215 | }
216 | }
217 | }
218 | },
219 |
220 | //Remove the shortcut - just specify the shortcut and I will remove the binding
221 | 'remove':function(shortcut_combination) {
222 | shortcut_combination = shortcut_combination.toLowerCase();
223 | var binding = this.all_shortcuts[shortcut_combination];
224 | delete(this.all_shortcuts[shortcut_combination])
225 | if(!binding) return;
226 | var type = binding['event'];
227 | var ele = binding['target'];
228 | var callback = binding['callback'];
229 |
230 | ele.removeEventListener(type, callback, true);
231 | if (ele === window) {
232 | for (i = 0; i < window.frames.length; i++) {
233 | try {
234 | window.frames[i].removeEventListener(type, callback, true);
235 | } catch(err) {}
236 | }
237 | }
238 | }
239 | }
240 |
--------------------------------------------------------------------------------